Cisco Switch Data Collection Policy
Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.
For specific prerequisites and supported configurations for a specific vendor, see the Certified Configurations Guide.
After adding the policy: For some policies, collections can be run on-demand using the button on the Collector Administration page action bar. The button is only displayed if the policy vendor is supported.
On-demand collection allows you to select which probes and devices to run collection against. This action collects data the same as a scheduled run, plus logging information for troubleshooting purposes. For probe descriptions, refer to the policy.
Requirement: Interconnected switches, which share the same VSAN, must be configured in the same Data Collector policy for Cisco Switches.
Use a read-only account for the REST API Collection Method. The account must allow to execute every command mentioned in the table below on every Cisco switch for which you configure the collection policy. Collection runs only show commands over NX-API (no configuration).
Table: Permissions Required for policy credentials
Permissions: | ||||
|---|---|---|---|---|
show clock | show interface counters | show version | ||
show fcdomain vsan <VSAN_ID> | show interface counters detailed | show vsan | ||
show fcns database detail | show interface transceiver | show zone active vsan <VSAN_ID> | ||
show fcs database | show inventory | show zone vsan <VSAN_ID> | ||
show flogi database | show module | show zoneset active vsan <VSAN_ID> | ||
show interface | show nxapi | show zoneset vsan <VSAN_ID> | ||
show interface capabilities | show topology | |||
To add the policy:
- Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
- Select a Data Collector from the list. Search for a Collector if required.
- Click Add Policy, and then select the vendor-specific entry in the menu.
Note:
Data collection for Cisco switches uses SMI, but a non-default port number is not configurable.
- Depending on the collection method you want to configure, specify Data Collector properties and add or select the parameters as required. Mandatory parameters are denoted by an asterisk (*)
Selecting an option from Collection Method list sets the interface with which you chose to connect to the Cisco Switch.
For REST API collection method:
Field
Description
Sample Values
Collector Domain
The domain identifies the top level of your host group hierarchy. The name was supplied during the installation process. All newly discovered hosts are added to the root host group associated with this domain. Typically, only one Domain will be available in the drop-down list.
If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
To find your Domain name, click your login name and select My Profile from the menu. Your Domain name is displayed in your profile settings.
yourdomain
Policy Domain
The Collector Domain is the domain that was supplied during the Data Collector installation process. The Policy Domain is the domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain.
The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain.
Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
192.1.1.1
Collection Method
Select REST API from the list.
Cisco Switch REST API Server Address
Enter the IP address of the Cisco switch. Only a single IP address is supported. Specify a physical device IP address or a fully qualified switch.
192.1.1.1
HTTPS Enabled
Select if Cisco Switch REST API Server Address is HTTPS-enabled.
User ID*
Enter user ID for accessing the switch. This typically would be an administrator privilege, but must be a minimum privilege of a view-only user.
Administrator
Password*
Enter the and passcode for accessing the switch. The password is encrypted prior to saving in the database and is never visible in any part of the application.
Password1
Repeat Password
Enter the same passcode again.
Password1
Credentials Override
Configure switches to override the default credentials.
Click Add to add credentials for a switch.
Select a row to manage (Edit or Delete) the switch credentials.
Note:
To discover other switches which are not part of defined server, configure advance parameter CISCO_SWITCH_DISCOVERY_VIA_CREDENTIALS_OVERRIDE with value Y.
Exclude Switches
Enter comma separated switch WWN values that to be excluded from collection.
10:00:00:60:69:90:04:9F, 100000606990049F
Switch Details
Check the box to collect switch details.
Click the clock icon to create a schedule. Every Minute, Hourly, Daily, Weekly, and Monthly schedules may be created. Advanced use of native CRON strings is also available.
Examples of CRON expressions:
*/30 * * * * means every 30 minutes
*/20 9-18 * * * means every 20 minutes between the hours of 9am and 6pm
*/10 * * * 1-5 means every 10 minutes Mon - Fri.
Note:
Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
FC Port Statistics Active
Check the box if you want to collect FC Port statistics. This may have a performance impact, which can be optimized with the FC Port schedule.
Zone Data
Check the box if you want to collect the zone related data. This may have a performance impact, which can be optimized with the zone data schedule.
Notes
Enter or edit notes for your data collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well.
For SMI-S collection method:
Field
Description
Sample Values
Collector Domain
The domain identifies the top level of your host group hierarchy. The name was supplied during the installation process. All newly discovered hosts are added to the root host group associated with this domain. Typically, only one Domain will be available in the drop-down list.
If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
To find your Domain name, click your login name and select My Profile from the menu. Your Domain name is displayed in your profile settings.
yourdomain
Policy Domain
The Collector Domain is the domain that was supplied during the Data Collector installation process. The Policy Domain is the domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain.
The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain.
Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
192.1.1.1
Collection Method
Select SMI-S from the list.
Cisco Switch or DCNM SMI Agent IP address*
Enter the IP address of the Cisco switch. Multiple switch IP addresses, separated by commas, can be entered for this field. Interconnected switches, which share the same VSAN, must be included in the same Data Collector policy.
If you are using the Data Center Network Manager (DCNM) for central control, a separate Data Collector policy is needed for each DCNM. Enter the DCNM SMI agent address (and optionally, its port number) in the format: <ip_address>:<port_number>
For DCNM v6.2.x, you will need a valid (or temporary) license in order for the SMI agent to be able to get data.
192.1.1.1
User ID*
Use the User ID and passcode for accessing the switch. This typically would be an administrator privilege, but must be a minimum privilege of a view-only user.
Administrator
Password*
Note:
The password is encrypted prior to saving in the database and is never visible in any part of the application.
Password1
Repeat Password
Enter the same passcode again.
Password1
Switch Details
Check the box to collect switch details.
Click the clock icon to create a schedule. Every Minute, Hourly, Daily, Weekly, and Monthly schedules may be created. Advanced use of native CRON strings is also available.
Examples of CRON expressions:
*/30 * * * * means every 30 minutes
*/20 9-18 * * * means every 20 minutes between the hours of 9am and 6pm
*/10 * * * 1-5 means every 10 minutes Mon - Fri.
Note:
Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
FC Port Statistics Active
Check the box if you want to collect FC Port statistics. This may have a performance impact, which can be optimized with the FC Port schedule.
Zone Data
Check the box if you want to collect the zone related data. This may have a performance impact, which can be optimized with the zone data schedule.
Notes
Enter or edit notes for your Data Collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well.