Switch Port Usage Reports
You can generate the following Switch Port reports, based on the status of the switch ports.
This section also contains:
You can use the Advanced Search feature to select the devices for which you want to generate reports. For more details on performing advanced search, see Using Advanced Search.
For a detailed description of the features in Device S elector, see Administration of Cisco Prime Lan Management Solution 4.2.
Group Selector can be used to create reports based on device groups. For details, see Using Group Selector.
Trunk ports are classified as follows:
- Link ports — Trunk ports connected to Cisco devices (Switch or Router).
- Non-link ports— Trunk ports connected to end hosts or IP phones.
Report on Recently Down Ports
Report for recently down ports is generated as follows:
- Link ports that were connected to a device in the previous Data Collection, but found unconnected in the current Data Collection
- Access ports that were connected to an endhost in the last UT Major Acquisition cycle, but found unconnected in the current Data Collection
If the ports are still in an Unconnected state when the next UT Major Acquisition cycle runs, they are classified as Unused Up or Unused Down ports. These ports are further moved to the Reclaim Unused Up Ports report or Reclaim Unused Down Ports report.
Reclaim Unused Down Ports Report
Link and access ports can be queried to generate the Unused Down report. It uses ports:
- That are administratively down
and
- That were previously connected to an endhost or a device but are unconnected at least for a period of one day.
You can generate reports on ports that have been in Unused Down state for a specified interval of time.
Note
Reclaim Unused Down Ports will be generated based on the timestamp of data collection. The timestamp would be updated in the database during the first data collection for all the interfaces. From the consecutive data collection, the ports having both admin status and operational status as up will only be updated with the timestamp of the data collection. So when you try to generate Reclaim Unused Down Ports report, the data displayed in the report would be based on the timestamp updated in the database, which is less than the mentioned number of days in Unused For field or less than the mentioned date in Unused Since field that you have selected in the LMS user interface.
Reclaim Unused Up Ports Report
Link and access ports can be queried to generate the Unused Up report. It uses ports:
- That are administratively up
and
- That were previously connected to an endhost or a device but are unconnected at least a day
You can generate reports on ports that have been in Unused Up state for a specified interval of time.
The data provided by the reports will be lost if you reinitialize the database.
Note
Reclaim Unused Up Ports will be generated based on the timestamp of data collection. The timestamp would be updated in the database during the first data collection for all the interfaces. From the consecutive data collection, the ports having both admin status and operational status as up will only be updated with the timestamp of the data collection. So when you try to generate Reclaim Unused Up Ports report, the data displayed in the report would be based on the timestamp updated in the database, which is less than the mentioned number of days in Unused For field or less than the mentioned date in Unused Since field that you have selected in the LMS user interface.
Note
Reclaim Unused Up Ports and Reclaim Unused Down Ports reports are used to generate reports on both link or access ports that were previously connected to an endhost or a device, but are unconnected at least for a day.
Switch Port Summary Report
Switch Port Summary report gives the number of Connected, Free, and Free down ports in each switch.
- Ports that are administratively up but are not connected to a device or endhost are Free Ports.
- Ports that are administratively down and are not connected to a device or endhost are Free Down ports.
This report also displays the sum total of Connected, Free and Free Down ports in each switch. This report lists all the Down ports in a switch, regardless of whether they were previously connected to an endhost or not.
The number for Connected, Free and Free Down ports are given as links. Clicking on them launches a detailed report giving the Port, Port name, Administrative and Operational status of the ports for the selected device.
For details on generating and viewing these reports, see Generating Switch Port Reports.
Switch Port Capacity Report
The Switch Port Capacity report lists switches that have crossed utilization threshold limits, along with the value of percentage port utilization. This report enables you to do capacity planning for network growth.
Port Utilization for each switch is calculated as follows:
% Port Utilization (per switch) = (Number of Connected ports/ Total number of ports) * 100
- Greater than option lists the switches whose port utilization is greater than the specified threshold.
- Less than option lists the switches whose port utilization is less than the specified threshold.
- Between option lists the switches whose port utilization falls between the specified threshold limits.
You can configure these reports as jobs, to get the list of switches that have crossed the threshold limits, at regular intervals. For details on Configuring reports as jobs, see Generating Switch Port Reports.
Using Group Selector
Group Selector allows you to create report jobs based on device groups.The Group Selector displays only the device groups that exist in the network and not the individual devices that form the group.
When a report job is created based on a device group, the group is evaluated at the time of running the job, and devices corresponding to that group are used in the report generation.
In case of devices being included or deleted from the group after scheduling the report job, the report will reflect these changes, since the group information is dynamically evaluated at the time of running the report job.
For example, if you have
1.
Created a user defined group, with devices ranging from 10.77.210.1 to 10.77.210.15.
2.
Scheduled a Switch Port Summary report for this group.
3.
Deleted Device 10.77.210.13 from the group.
When the report job runs at the scheduled time, the report will not contain information on 10.77.210.13.
Group Selector is available for all Switch Port Reports and Switch Port Utilization History Report.
Generating Switch Port Reports
To view a report on Switch Port usage:
Step 1
Select Reports > Switch Port Reports.
Step 2
Select the report you want to view
The Switch Port usage reports are categorised as :
- Switch Port Capacity
- Recently Down
- Reclaim > Unused Down Ports
- Reclaim > Unused Up Ports
- Switch Port Summary
The Report Generator page appears.
- If you select the report for Switch Port Capacity, go to Step 3.
- If you select the report for Unused Up Access Ports or Unused Down Access Ports, go to Step 4.
- If you select either Recently Down or Switch Port Summary, go to Step 5.
Step 3
For Switch Port Capacity report, specify the percentage value of utilization and the condition indicator.
For example, select greater than and 90 from the drop-down list to generate a report on devices, where port utilization exceeds 90%. The utilization percentage drop-down list is editable. It allows you to specify a value, other than the one listed.
Step 4
For report on Unused Up Access Ports or Unused Down Access Ports, either:
- Specify the number of days. The maximum number of days that can be specified is 999.
Or
- Specify the date from which you want to generate the report.
For example, select 30 from the Unused for drop-down list, to generate report for ports that are in unused state for the past 30 days. The Unused for drop-down list is editable. It allows you to specify a value, other than the ones listed.
Step 5
Select the device(s) from the Device Selector or Group Selector, for which you want to view the Port information.
Step 6
Select the Run Type. It represents the periodic interval at which the report is generated. It can be one of the following:
- Immediate
- Once
- Daily
- Weekly
- Monthly
- Quarterly
Step 7
Schedule the report by selecting the date on which you want the report to be generated.
Step 8
Enter Job Description and e-mail address, if any.
Step 9
Enter the Report Publish Path.
The default path is /opt/CSCOpx. You can also specify a directory path to which the report is published.
Note
Cisco Prime LMS does not support Japanese characters and special characters such as, \ / : * ? “ < >. ! % in the file or folder name.
Step 10
Select the Attachment Option to attach the report as a CSV or PDF file.
By default a CSV is sent to the e-mail address specified in the E-Mail ID field. You can alternatively select the PDF format.
Note
The Report Publish Path and Attachment Option is disabled if the Run Type selected is Immediate.
Step 11
Click Submit.
If the Run Type is Immediate, the report is generated.
For other Run Types the report Job ID is displayed. The Job ID is listed in the Job Browser at the bottom of the page.
Using Advanced Search
The Advanced Search feature in Device Selector searches for devices based on a set of search criteria, which you specify in the Advanced Search window. You can either select the search criteria from the drop-down menu or enter Custom Search criteria in the Rule Text area, or use a combination of both.
When you enter the search criteria manually, you can use the Check Syntax button to verify whether the Rule Expression you have entered is correct.
You can define single or multiple search criteria based on which you can search for devices. Table 3-1 describes the device attributes available for defining rules.
Table 3-1 Device Attribute Description
|
|
DiscoveryStatus |
Status of the device after Data Collection has been completed. |
Host name |
Name of the device. |
ImageVersion |
Software version running on the device. |
IPSubnet |
Subnet address of the device IP address. |
IPSubnetMask |
Subnet mask address of the device. |
IPAddress |
Single IP Address—Not a range of addresses. |
SysName |
Name of the device as configured by the Administrator. |
SysObjectID |
SysObjectID of the device. |
SystemContact |
Contact for the device details as entered by the Administrator. |
SystemLocation |
Location of the device as entered by the Administrator. |
Operator
The operator used in forming a rule. The following operators are available:
In addition to the above, the following operators are also available for the variable IPAddress:
- startswith
- endswith
- contains
When the variable DiscoveryStatus is used, only one operator is available, which is equals.
Value
A free flow operand forming the last part of the rule.
When the variable DiscoveryStatus is used, only the following values are available:
- Never_Reachable
- Reachable
- Currently_Unreachable
Interpreting Switch Port Capacity Report
Table 3-2 describes the columns of Switch Port Capacity Report:
Table 3-2 Switch Port Capacity Report
|
|
Device Name |
Name of the device displayed as link. Upon clicking the link, it launches Troubleshooting page where you can perform device-centric activities. |
IP Address |
IP Address (IPv4 or IPv6 Address) of the device displayed as link. Upon clicking the link, it launches Troubleshooting page where you can perform device-centric activities. |
Usage (%) |
Usage of ports in the device, displayed as a percentage. This is the ratio between the connected ports and the total number of ports. Click the Usage link to view a detailed report of all ports in the device. |
Connected Ports/Total Ports |
Actual number of Connected Ports and actual number of total ports in the device. |
For more details on this, see Switch Port Summary Report
Interpreting Switch Port Usage Reports
The following reports have information as described in Table 3-3 :
- Reclaim Unused Up Ports
- Reclaim Unused Down Ports
- Recently Down ports
- Detailed Report on Connected Ports, Free ports and Free Down Ports
Table 3-3 Switch Port Usage Report
|
|
Port |
Port or interface of the device. |
Port Name |
User assigned port name (port label) |
Operating Status |
Operating status of the port |
Admin Status |
Administrative status of the port |
Last Used (For Reports on Unused Up and Unused Down Ports) |
Date and time when the port was last used. |
Switch Port Summary Report
This report has three sections:
The ports that are administratively UP and are connected to a device will be listed here.
The Ports that are administratively UP but are not connected to a device will be listed here.
The ports that are administratively down will be listed here.
Interpreting Summary Report for Switch Ports
The Switch Port Summary Report displays the details given in Table 3-4 .
Table 3-4 Summary Report Field/Column Description
|
|
Device Name |
Name of the device displayed as link. Upon clicking the link, it launches the Troubleshooting page where you can perform device-centric activities. |
IP Address |
IP Address of the device displayed as link. Upon clicking the link, it launches Troubleshooting page where you can perform device-centric activities. |
Connected Ports |
Number of ports that are connected to a device or endhost. Click the number to view the details on the ports. |
Free Ports |
Number of ports that are administratively up but are not connected to any device or endhost. Click the number to view the details of the ports. |
Free Down Ports |
Number of ports that are administratively down and are not connected to any device or endhost. Click the number to view the details of the ports. |
Total Ports |
Total number of ports in that device (Sum of Connected, Free and Free Down ports). |
Port Reports
This section explains the following Port reports generated in LMS 4.2:
Displaying Port Attributes
To display information about the status of the ports in your network:
Step 1
Select Reports > Switch Port > Ports > Port Attributes.
The Port Attributes page appears.
Step 2
Select a device or domain from the list.
Step 3
Select the Scheduling Type.
The default scheduling type is Immediate.
You can set the time and date if you select any of the following scheduling types: Once, Daily, Weekly, Monthly.
Step 4
Enter a description of the job in the Job Description field and enter the e-mail address to which the details has to be sent.
Note
Launching immediate Port Attributes reports for more than 500 devices results in an error. You can schedule reports to run for all devices or launch immediate reports for less than 500 devices.
Step 5
Enter the Report Publish Path.
The default path is /opt/CSCOpx. You can also specify a directory path to which the report is published.
Note
Cisco Prime LMS does not support Japanese characters and special characters such as, \ / : * ? “ < >. ! % in the file or folder name.
Step 6
Check the Attachment Option to attach the report as a CSV or PDF file.
By default a CSV is sent to the e-mail address specified in the E-Mail ID field. You can alternatively select the PDF format.
Note
The Report Publish Path and Attachment Option is disabled if the Run Type selected is Immediate.
Step 7
Click Submit.
A message is displayed:
Job ID was created successfully.
The Job ID is listed in the Job Browser at the bottom of the page.
For more information on Port Attributes, see Interpreting Port Attributes Report.
Interpreting Port Attributes Report
To view the Port Attributes report for a device, select the device from the Go To: list. The Go To: list contains the device name and device IP address.
Alternatively, you can scroll the page to view the report for the selected devices.
The Port Attributes report contains the following information for a device:
Table 3-5 Port Attributes Report Fields
|
|
Port |
Name of the port. Example: Fa4/0 |
Port Description |
Description for the port. Example: Intra-area 0.2.0.0 Resilient link |
Type |
Type of port. Example: 1000Base |
AdminStatus |
Administrative status of the port.Whether port has been brought down intentionally. |
OperStatus |
Operational status of the port.Whether port is active or inactive. |
isLink |
Shows whether the port is connected to another device. |
isTrunk |
Shows whether the port is part of a trunk. If checked, the port is participating in a VLAN trunk. |
Speed |
Speed at which the port is working. |
Duplex Mode |
Shows whether the port is in full-duplex mode or half-duplex mode. |
Protocol Enabled |
Filter protocols on MLS (Multi Layer Switching) devices. Indicates the protocols that are allowed to pass through the port.
- For MLS devices, IP, IPX, and Other are valid options.
- For trunk ports or traditional filtered ports, All is always displayed.
|
Protocol Seen |
Filter protocols on MLS devices. Indicates the protocol forwarded on that port.
- For MLS devices, IP, IPX, and Other are valid options.
- For trunk ports or traditional filtered ports, All is always displayed.
|
VLAN |
Name of the VLAN. |
L2L3 |
Shows whether the port is in Layer 2 or Layer 3, switched or routed. |
Jumbo Frame |
Displays whether Jumbo Frames are enabled or disabled on the port. If you enable JumboFrame, the port supports a frame size greater than the standard Ethernet frame size of 1518 bytes |
Trunk Encapsulation |
Shows the type of trunk encapsulation. Shows whether ISL or IEEE 802.1Q encapsulation is enabled on the switch port. |
Trunk Mode |
Shows the trunk mode. The trunk modes are desirable, on, off, auto, or no negotiate |
isChannel |
Shows whether the port is part of an EtherChannel or not. |
You can export or print the report.
To export the report to a LMS 4.2 server, click the export button at the top right of the page.
To print the page, click the printer icon on the top right of the page.
Note
LMS supports PAgP protocol configured ether-channel ports. However since Nexus devices do not support the PAgP protocol, LMS supports LACP protocol for Nexus devices.
Switch Port Utilization History Report
These reports help you to estimate the usage of ports and devices. You can also generate the reports based on the username of the host, MAC address, IP address, and device name. History reports also display all active wireless clients, which are connected to your network.
This section contains:
Viewing History Reports for Switch Port Utilization
History Report for Switch Port Utilization helps you to view the log in and log out of end hosts for a set of selected devices.
To view the User Tracking history report for Switch Port utilization:
Step 1
Select Reports > Switch Port > Utilization History.
Step 2
Select the devices from Device Selector or the device groups from the Group Selector. For details on Group Selector, see Using Group Selector.
Step 3
Specify the period for which you need the report in the Period area.
You must specify the start and end dates, which defines the period for which User Tracking must generate the report.
If you enter the same value for start and end dates, the application displays an error message.
Step 4
Select a Run type from the drop-down menu, in the Scheduling area to schedule the report generator according to your requirement.
You can schedule it for generating the report immediately, once, daily, weekly, monthly or quarterly. If you choose to generate the report immediately, go to Step 10.
Step 5
Set the date and time for generating the report, in the Scheduling area.
Step 6
Enter a description to identify this job in the Job Description field.
Step 7
Enter a valid e-mail ID in the Email field, of the Job Info area, to receive the report through mail.
Step 8
Enter the Report Publish Path.
The default path is /opt/CSCOpx. You can also specify a directory path to which the report is published.
Note
Cisco Prime LMS does not support Japanese characters and special characters such as, \ / : * ? “ < >. ! % in the file or folder name.
Step 9
Check the Attachment Option to attach the report as a CSV or PDF file.
By default a CSV is sent to the e-mail address specified in the E-Mail ID field. You can alternatively select the PDF format.
Note
The Report Publish Path and Attachment Option is disabled if the Run Type selected is Immediate.
Step 10
Click Submit to generate the report or click Reset to modify the values that you have entered.
Step 11
A message is displayed:
Job ID was created successfully.
The Job ID is listed in the Job Browser at the bottom of the page.
Interpreting History Reports for Switch Ports
The Report lists each switch with its ports and the usage time in hours.
Table 3-6 describes the entries in the History Report for switch ports.
Table 3-6 Switch Port Utilization Report Field Description
|
|
Port |
Lists the names of the ports in the switch. |
Usage Time (Hrs, Mins & Sec) |
Duration of time for which the port is connected to a host or utilized. |
Click the usage time value for a port. The History Report for that port appears.