Switch Port Mapper Tool Switch Port Mapper Tool Switch Port Mapper Tool - Available in Professional Edition


The Switch Port Mapper utility of OpUtils software discovers the devices plugged into each port of a specified switch. The tool is useful for system and network engineers to gain visibility into the IP, MAC, status and availability of ports. Since this is a real-time discovery you can also view the operational status and port speed of each port.

Switch Port Mapper Settings

Click the Settings link from the Switch Port Mapper tool to view/modify the values. Click Save after changing the values.

General Settings

Click the General tab under Switch Port Mapper settings to configure the following:

  1. Resolve DNS - Select this option to resolve the DNS name of the connected devices during every scan.

  2. Show all the Switch Ports - The Switch Port Mapper, by default, will only list the ports that have a matching port in the Bridge MIB. All the other ports will be excluded from the result view. To view all the switch ports even if no matching port is available in the Bridge MIB, select this option.

  3. Exclude Trunk Ports - Select this option to exclude the trunk ports while exporting the switch port mapping results. When more than one MAC Address is learned in a port, OpUtils assumes it to be a trunk port.

  4. Stack Port Classification - If more than 10 MAC Addresses are learned in a port, the port is classified as a stack port. You can configure this from here.

  5. Number of Threads - Specify the number of threads that OpUtils use for Switch Port Mapping. OpUtils allocates one thread to a switch for scanning and when completed the next switch in queue is taken for scanning. This cycle continues till all the switches are scanned. When the switch count is high and if you wish the scanning to be completed faster, you can increase the number of threads to a maximum of 25. Increasing the number of threads will increase the CPU and Memory usage considerably. Hence, ensure that your system is capable of handling this high resource requirement before increasing the thread count.

Publish Mapping Results

OpUtils provides an option to auto-publish the switch port mapping results to a csv file. This helps to view the history of port mapping details later. Click the Publish tab under Switch Port Mapper settings to publish the results of the scan to a csv file automatically.

  1. Enable Auto-Publish - Select this option to enable publishing the results to a CSV file automatically. This option is selected by default.

  2. Publish Directory - Specify a location to store the published results. The default location is <OpUtils_Home>/webapps/SPMHistory

  3. Create a consolidated CSV file for all the switches - Select this option to create a consolidated CSV file containing the mapping results of all the switches scanned. It may be noted that you will be getting a consolidated reports only at the group-level, i.e., a single report for all the switches in a particular group. Also, the consolidated report will only be created whenever a scheduled scan happens for a particular group and not during manual scans.

Configure Email Alerts to Notify Port State Changes

Switch Port Mapper generates alerts to notify various events. Click the Alert tab under Switch Port Mapper settings to configure alert settings:

  1. Policy to move a port from "Transient" to "Available" state - Specify the continuous period of inactivity after which the ports will be declared as Available. If the ports are currently down and are down for less than the period specified here, the ports are shown as Transient.

  2. Enable Email Alert - Select this option and specify the email addresses. You can select to receive the alerts on the following cases:

    1. A port becomes 'Available' or 'Used'

    2. The device connected in a port changes

    3. A new device is added to a port (Ex: VoIP device is added along with computer)

    4. A device is removed from a port (Ex: VoIP device is removed)

    5. A port is administratively disabled (by a source other than OpUtils)

    6. Multiple devices are detected in a port

    7. Virtual IP Addresses are detected for a device

    8. The Switch do not respond to SNMP queries

    9. The port utilization falls below a defined value.

  3. Alert Cleanup Policy: Specify the maximum number of Alerts to be stored in the database, the default being 2000. When you delete the older alerts, you have an option to save them as a csv file for future reference.

Switch Port State Diagram

Top

Schedule Scanning of Switches

Click Scheduler link to schedule periodic scanning of switches. While you schedule scanning, you can logically group the switches to a task and scan them separately. A switch cannot exist in more than one task.

  1. Click Scheduler link from top-right. This opens the schedules tasks and lists all the tasks that have been already created.

  2. Click Add Task to create a new task.

  3. Provide a name for the task and choose the switches to be added to this task. The "Available Switches" will list all the switches that have been added in the Switch Port Mapper tool.

  4. Select Enable from the scheduler combo and specify the interval to perform the scan:

    1. Hourly - to update every 6, 8, or 12 hours from the specified time

    2. Daily - to update everyday. You need to specify the starting time.

    3. Weekly - to update on specific day(s) in a week. You need to specify the starting time and the day(s) on which the update should happen.

    4. Monthly - to update on a specific day every month(s). You need to specify starting time, select a day and select a month/months.

    5. Once Only - to run the tool only once at the scheduled time.

  5. Click Save to save the changes.

Top

Adding Switches for Mapping

Adding Switches Manually

  1. Click the Switch Port Mapper tab

  2. Click the Add Switch link available in the Switch Port Mapper tool. This will open a dialog to accept the switch input.

  3. Select the Add Manually option.

  4. Select the Group to which the switch has to be added.

  5. Specify the Switch Name and its corresponding SNMP Read Community string.

  6. Select the Get System Details option to retrieve the device details of the connected devices through SNMP. The SNMP community string specified in Admin --> Settings --> SNMP tab is used for this purpose.

  7. If you wish to perform an SNMP sweep of the subnets prior to scanning the switch, select the Do SNMP Sweep Before Scanning the Switch option and specify the subnet inputs. You can add multiple subnets here. This will enhance the MAC resolution of the devices connected to the switch,

  8. Click the Add Switch button. The switch gets added under the Switches tab.

  9. The added switch will be automatically mapped in the background and the status is shown in the status column. Repeat step four and five adding more switches.

Importing Switch Inputs from a CSV File

When you have a large number of switches in your network, adding switches one by one manually is a painful job. In such cases, importing the switch inputs from a csv file will be very handy. Create a csv file as below and import this file to the Switch Port Mapper tool.

 

  1. The CSV file should contain the following fields: Tree Hierarchy, Switch Name, SNMP Community, SNMP Version, Task Name, Subnet Address, Subnet Mask, User Name, Context Name, Authentication Protocol, Authentication Password, Encryption Protocol, and Encryption Password.

  2. Mandatory Fields:

    1. For SNMP V1 & v2: Switch Name, SNMP Community and SNMP Version

    2. For SNMP v3: Switch Name, SNMP Version and User Name

  3. If you have more than one subnets added for a switch you can add them as comma separated within double quotes. For example, "192.168.112.0, 192.168.111.0"

  4. All the subnets specified here should be subnetted to class C. This means that the first three octets should only be 255. This is to avoid unnecessary traffic.

 

Sample CSV entry:

 

Tree Hierarchy, Switch Name, SNMP Community, SNMP Version, Task Name, Subnet Address, Subnet Mask, User Name, Context Name, Authentication Protocol, Authentication Password, Encryption Protocol, and Encryption Password

Zohocorp\\ME\\India,procurve2524,public,v1,First Floor,192.168.112.0,255.255.255.0

Zohocorp\\ME\\India,192.168.109.4,public,v2,Admin Team,"192.168.113.0,192.168.113.128","255.255.255.128,255.255.255.128"

Zohocorp\\ME\\USA,3com4400,public,v1,Test

Zohocorp\\ME\\USA,foundry2402,public,v1,Default Group,10.1.23.0,255.255.255.128

Zohocorp\\ME\\USA,catalyst2900,public,v2,First Floor,132.232.2.0,255.255.255.0

Zohocorp\\ME\\UK,cisco2081,,v3,Default,,,authUser,auth,MD5,authUser,AES-128,oputils12

Zohocorp\\ME\\UK,cisco0587,,v3,Default,"192.168.49.0,192.168.40.0","255.255.255.0,255.255.255.128",authUser1,auth1,MD5,authUser1

 

To import this CSV file,

  1. Click the Add Switch link available in the Switch Port Mapper tool. This will open a dialog to accept the switch input.

  2. Select the Import From CSV option.

  3. Browse to select the CSV file. The CSV file should contain the Switch Name / IP Address, Switch Community, Group Name, Subnet Address, and Subnet Mask as comma separated values. The Subnet Address and Subnet Mask are optional. If you are not specifying the group, just add a comma after the switch community. When the Group Name is not specified, the switch gets added to the Default Group. If you specify a non-existing group, it gets created. Multiple switch inputs should be in a separate line.

  4. Click Import CSV.

The switches gets added and the import details are displayed in the top. The Switch Port Mapper will scan five switches at a time and the remaining switches are shown as Yet to Scan. If any errors are obtained during scan, the same is shown as Scanning Failed. Clicking the failed count will show the details of the errors from where you can modify and scan them again.

 

 

Note

 

1. Only Switches and Hubs that support the BRIDGE-MIB can be mapped because device details for Switches and Hubs that do not support a BRIDGE-MIB cannot be discovered.

2. Multiple devices may seem connected to the single port. This is because, if a Hub is connected to the Switch that is specified (Cascading) and multiple devices are connected directly to that hub, multiple devices appear as if they are connected to the same port of the switch.

 

 

Top

Adding Routers

To resolve the IP Address of the device connected to a switch port, the Switch Port Mapper requires the router, switch, gateway server inputs to be provided in the Global Environment settings. You can use the Add Router link to add these devices and schedule scanning. This will collect the MAC-IP data of the devices in the network and stores them in the database.

Adding Routers Manually

  1. Click the Add Router link available in the Switch Port Mapper tool. This will open a dialog to accept the router/device input.

  2. Select the Add Manually option.

  3. Specify the Device Name and its corresponding SNMP Read Community string.

  4. Click the Add Router button.

Importing Router Inputs from a CSV File

Similar to importing switch inputs, you can also import router inputs through a csv file. Create a csv file containing the Device Name / IP Address and its SNMP Community as comma separated values. Add each device in a separate line. Import this file to the Switch Port Mapper tool.

 

Sample CSV entry:

 

testrouter,public

cisco3620,private

  1. Click the Add Router link available in the Switch Port Mapper tool. This will open a dialog to accept the router/device input.

  2. Select the Import From CSV option.

  3. Browse to select the CSV file. The CSV file should contain the Device Name / IP Address and its SNMP Community as comma separated values. Multiple device inputs should be in a separate line.

  4. Click Import CSV.

Top

Adding Custom Columns to the Switch Port Mapper

Switch Port Mapper allows you to add custom columns both at the port-level and at the switch-level for adding user-defined inputs. These columns can be used to store any specific information about the switch/device connected to that port. To add a custom column, follow the steps below:

  1. Click the Settings link available in the Switch Port Mapper tool.

  2. Select the Custom Column tab. This will list all the columns that have been added already.

  3. Click the Add Custom Field link

  4. Specify the following:

    1. Column Name: Name for this column

    2. Column At: Specify whether this column is for the port level or at the switch level.

    3. Data Type: Specify what type of data you wish to store in this column. It can be String for text, Integer for numbers, Boolean for true or false, or File for adding a file input. You can also define your own data type by clicking the Custom Datatype link.

    4. Size: The size for this column

    5. Default Value: The default value for this column

    6. Description: A brief description about this column.

  5. Click Add Column

  6. The new column gets added to the port/switch-level as defined.

Top

Hierarchical Tree View of the Switches

  1. Helps you to define a hierarchical view of the switches in your network by creating different groups based on the location or usage

  2. Create any number of groups (child nodes) to identify a switch

  3. Add switches to groups

  4. Scan all the switches in a group.

  5. Drag-n-drop switches between groups

 

Viewing Switch Port Mapping Results

Once you have added all the switches, the mapping will be automatically performed and the status of the mapping is displayed. Click the Switch Name / IP Address link from the Switches View or from the Summary Info View to view its details. The following details are shown:

  1. IfIndex: Refers to the port number in the switch.

  2. IfName: The name of the port/interface.

  3. IfDescr: The description of the port/interface.

  4. ifAlias: The user-defined name of the port/interface.

  5. IfType: The port type.

  6. IfSpeed: The maximum speed of the port.

  7. Status: The operation status of the port.

  8. Admin Status: The administrative state of the port/interface.

  9. Availability: Indicates whether the port is Available or Used. Ports that are continuously down for more than 10 days are shown as Available. If the ports are currently down and/or down for less than 10 continuous days, the ports are shown as Transient. You can configure the number of days of inactivity beyond which a port has to be declared as Available from Switch Port Mapper Settings.

  10. Physical Location: The physical location of the connected devices. Refer to Mapping Devices to Physical Location for details.

  11. Connected MAC: The physical address of the connected devices.

  12. IP Address: The IP Address of the connected device.

  13. DNS Name: The DNS name of the connected device.

  14. VLAN ID: The VLAN number of the port.

  15. Device Type: The type of the connected device as Windows, Linux, Switch etc.

  16. VLAN Name: The name of the Virtual LAN.

  17. IfMtu: The size of the largest packet which can be sent/received on the interface, specified in octets.

  18. Duplex: The duplex state of the port as half-duplex, full duplex, etc.

You can select a different Switch using the combo box to view its details.

To Scan the Switches again, use the Scan or Scan All link from the Add/Edit Switch view.

 

To view the alerts generated by the Switch Port Mapper tool, click the Alerts tab. Alerts are generated whenever the status of the port changes from "Available to Used" or from "Transient to Available". The Alerts can also be notified through Email. This can be configured from the Switch Port Mapper Settings.

Top

Viewing Switch Port Mapping History

Whenever a switch is scanned using the Switch Port Mapper, the mapping results are published automatically as a csv file and is stored in the file system. You can change the location to publish or to disable this feature from Switch Port Mapper Settings.

 

When you have chosen to auto-publish the results, you can view the previous mapping results from the History tab as below:

  1. Select the History tab from the Switch Port Mapper tool.

  2. This will list the summary of all the switches scanned using Switch Port Mapper. You also have an option to filter the view based on a specific group by selecting it from the Select Group list.

  3. Click the Name/IP Address of the switch to view all its previous mapping results. The date and time of previous mapping is shown for easy identification.

  4. You can either choose to view or download it as a csv from here.

Top

Exporting Switch Port Mapping Results

To export the Switch Port Mapping to a HTML or a PDF format, follow the steps below:

  1. Click the Switch Port Mapper tab

  2. Click a switch whose results has to be exported to view its details.

  3. Click the Export link available in the top-right.

  4. Choose the format for export and click View.

You have an option to auto-publish the Switch Port Mapping results in to a CSV format. You can enable this option from Switch Port Mapper settings. When this option is enabled, OpUtils automatically publish the results in to a CSV file in the following scenarios:

  1. When a scheduled scanning of Switches happen.

  2. When you manually select switches and scan.

Top

Searching a Specific Device using IP/DNS/MAC Address

When you have added all the switches and scanned once, the Switch Port Mapper can then be used to search for a specific device to locate the switch and port to which it is connected.

 

The Search field available in the Switch Port Mapper can be used for this purpose. The Search input can be either the Device MAC Address, IP Address, DNS Name, VLAN ID, IfName, IfAlias Name, Device Type, or Physical Location. You can also select the parameter that you wish to search. This will search all the switches that are scanned to locate the switch and port.

 

Top

Mapping Devices to Physical Location

Switch Port Mapper provides an option to specify the physical location of the connected devices, which can be used for later reference.

 

The location of the connected devices can be manually added using the Import Location as CSV option when you move your mouse over the Actions label available in the Switch Details view. The CSV should contain the IfIndex port and its location as comma separated values and each port should be in a new line.

 

 

Note: To configure SNMP properties click Settings located at the top right corner or click Admin -> Settings. For details read the Configuring SNMP section.

 

Top

Disabling/Enabling the Switch Interfaces

Switch Port Mapper provides an option to administratively disable or enable the switch ports.
  1. From the switch details view, select the ports that you wish to disable or enable.
  2. Move the mouse over the Actions label and select "Administratively Disable Interfaces" or "Administratively Enable Interfaces" to disable or enable a port respectively.
  3. This will open the block/unblock dialog showing the selected ports.
  4. Specify the SNMP Write Community of the switch and click Block Port / Unblock Port

Top

Modifying ifAlias Name of the Switch Interfaces

  1. From the switch details view, select the ports for which you wish to update the ifAlias Name.
  2. Move the mouse over the Actions label and select Modify ifAlias Name. This will open the Modify ifAlias Name dialog showing the ifAlias Names of the selected ports.
  3. Change the names as required.
  4. Specify the SNMP Write Community of the Switch and click Update.

Top

Viewing Switch Usage Reports

The Switch Port Mapper provides the following reports based on the switches added in the tool. The reports can be drilled down to get the complete details and can be exported to PDF, XLS, and CSV formats.

Top

Auditing Switch Port Management

The Switch Port Mapper enables auditing by storing the changes made to the Switch Port Mapper tool. Each and every change is stored in the database along with the user name, date, time of modification, and the details of the modifications/additions/deletions. The change history is maintained for one month and is configurable. The audit details are also published as an XML file for later reference.

 

Auditing Switch Port Mapping is enabled by default and you can configure the period to store the change history as below:

Top

 

See Also

 

Error Messages 

Unknown Host, Unreachable Host, No Response to SNMP Queries
Not a Switch
, Not a Router, Not able to retrieve complete data from the MIB,
Not able to retrieve MAC Address of the Switch

 

Related Tools : Ping, SNMP Ping, MAC Address Resolver

Copyright © 2004-2012, ZOHO Corp. All Rights Reserved.
ManageEngine