How to see (not only) UDT port information in IPAM

If you are an active user of IP Address Manager and User Device Tracker, you know that having port, IP address & connected user information is important during troubleshooting. Understanding of who is using given IP address and where an IP address is physically connected is critical for IT engineers so they can focus on specific device or user if needed. It is also important if an user that is currently using such IP address is expected to use it according to your IP subnet rules. IPAM and UDT are well integrated via single web console but there is a way how you can see UDT related information directly within your IPAM subnet detail page and save your time.

IPAM and UDT already have this data so we prepared a small script that can help you to see port, AD account or port history link directly in one row in IPAM. So the output may look like this:

If you are missing a module, download links are provided for evaluation - only IPAM and UDT are required.

This script will allow you to pull data from modules other than UDT also (NetFlow for example). If you are a skilled power shell user, you may edit our script and modify the data you would like to see in IPAM. It uses custom properties so it should be something you are familiar if you have used IPAM before. IPAM custom properties are bit different than custom properties you may know from NPM or SAM. IPAM has "string" and "url" types of custom properties.

First, you need to meet these requirements before installation:

1. You need the Orion SDK - download here. Please refer to SDK setup issue or how to set-executionpolicy unrestricted articles in case of issues.
2. Create ALL of the following REQUIRED custom fields/properties in IPAM exactly as you can see below:

Populated by - UDT

• 1. 1.      Switch
     1. a.      Field Type - Text
     2. b.      Max String Length - 100
     3. c.      Description - Name of the Switch the IP is plugged into
  2. 2.      Port_Link
     1. a.      Field Type - URL
     2. b.      Link Title – Port History
     3. c.      Max String Length – 500
     4. d.      Description – Link to Port Details in UDT

1. 1. 3.      Interface
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – Interface name where the IP was last seen

1. 1. 4.      ConnectionType
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – Direct vs Indirect connection
   2. 5.      VLAN
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – VLAN the IP belongs to
   3. 6.      MACAddress
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – MacAddress for the IP
   4. 7.      SwitchIP
      1. a.      Field Type - Text
      2. b.      Link Title – Port History
      3. c.      Max String Length - 100
      4. d.      Description – IP Address of the switch
   5. 8.      IPDetails
      1. a.      Field Type - URL
      2. b.      Link Title – Port History
      3. c.      Max String Length - 500
      4. d.      Description – Link directly to the IP Details in UDT
   6. 9.      ADAccount
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – AD Account most recently logged in
   7. 10.  AccountLogonTime
      1. a.      Field Type - Text
      2. b.      Max String Length - 100
      3. c.      Description – Login Time

Populated by - NTA

• 1. 1.      NetFlowData
     1. a.      Field Type - Text
     2. b.      Link Title – IP Traffic
     3. c.      Max String Length - 500
     4. d.      Description – Link to Netflow data filtered for the IP

Populated by - VNQM

• 1. 1.      Extension
     1. a.      Field Type - Text
     2. b.      Max String Length - 100
     3. c.      Description – IP Phone extension in VNQM
  2. 2.      PhoneDetails
     1. a.      Field Type - URL
     2. b.      Link Title – Phone
     3. c.      Max String Length - 100
     4. d.      Description – Link Direct to IP Phone details in VNQM

Populated by – NCM

• 1. 1.      NCMID
     1. a.      Field Type - URL
     2. b.      Link Title – NCM Node
     3. c.      Max String Length - 100
     4. d.      Description – Link Direct to NCM Node Details
  2. 2.      NCMConfig
     1. a.      Field Type - Text
     2. b.      Link Title – Config
     3. c.      Max String Length - 100
     4. d.      Description – Link Direct to NCM Config

Now it's time to open the script and fill in credentials and variables (the pink text in the image below):

• IPAMDBUsername – The username used to connect to the IPAM Database
• IPAMDBPassword – The password used to connect to the IPAM Database
• IPAMdbServer – The IP address of the IPAM Database server
• IPAMdatabaseName – The Name of the IPAM Database
• integratedAPIServer – The IP address of the IPAM server
• integratedAPIUserName – Account used to login to the webconsole - with permissions to all modules
• integratedAPIPassword – Password used to login to the webconsole

Once you prepare your credentials you can run the script.

You should run the script from windows command line (open the Windows Start menu -> All Programs -> Accessories -> Command Prompt). You need to run the script a couple of times to make sure all of the credentials and properties setup correctly.  Once you have done that you should be able to schedule it as a recurring windows task.

1. • NOTE: The script will tell you how long it took to run… a good idea or the best idea is to not schedule it to run more frequently than the time it takes to complete.
   • EXAMPLE: If it takes 5 minutes to run, I would schedule it to run every 30.

The final step is to configure the UI and display your new columns in the IP Address view. Click on the column and select new custom properties from the list.

If you want to see data from SAM or SEUM you may modify script and your custom properties accordingly.

DISCLAIMER: This script offers a great sneak peek at integration we’re working on productizing and we’d love to get your feedback on this concept – see this IPAM post for more info.  HOWEVER, we must point out that this script is NOT officially supported by SolarWinds support and they will NOT take cases on this functionality.  Any bugs or problems with the script-based integration are subject to thwack forum support ONLY, so please keep that in mind when deciding if it’s something you want to try in your production environment.  Happy testing!

Script download link