Search <book_title>...

APTARE IT Analytics Help

Last Published: 2022-11-10

Product(s): APTARE IT Analytics (10.6)

Brocade switch Data Collector 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 Run button on the Collector Administration page action bar. The Run 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.
- Collection Method using Brocade Switch supports Fabric OS version v8.2.1 and above.
- If the Indications Probe checkbox is selected, SNMP traps are collected instead of Brocade CIM indications. The following four SW traps are supported:
  - swFCPortScn
  - swStateChangeTrap
  - swDeviceStatusTrap
  - swEventTrap
- In Brocade REST API Server Address(es), in Brocade Switch Data Collector policy, configure switch IP address / fully qualified switch name.
- Configured switch should be accessible. If switch is not accessible, collection fails. When any switch in the fabric is not accessible, collector collects basic information of that switch which it can collect without connecting to the switch.
  Note:
  For Configured Switch, Collector also collects Switch information from all other Switches in the Fabric. Collector uses the same User ID and Password, as configured in the Policy, to connect to other Switches.
- While retrieving logical switches, if a switch is not accessible, collector logs a warning message for that switch.

To add the policy

Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
Search for a Collector if required.
Select a Data Collector from the list.
Click Add Policy, and then select the vendor-specific entry in the menu.
Best Practices: Interconnected switches should be configured in the same Data Collector policy.

Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):

Field	Description	Sample Value
Collector Domain	The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector.
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. 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
Brocade SMI agent address*	This field is enabled if Collection Method is SMI-S. Enter the IP address of the Brocade SMI agent and port number in the format: <ip_address>:port_number The port number is NOT required if you want to use the default port numbers: 5988 (http) or 5989 (https).	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
Exclude Switches	Enter a switch WWN - e.g., 10:00:00:60:69:90:04:9F, 100000606990049F Colons within the WWN are NOT required. A comma-separated list is supported.	10:00:00:60:69:90:04:9F, 100000606990049F
Switch Details	Click check box to collect switch details. Click 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	Click check box to collect FC Port statistics. This may have a performance impact, which can be optimized with the FC Port statistics schedule. Click clock icon to create a 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.

Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):

Field	Description	Sample Value
Collector Domain	The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector.
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. 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
Collection Method	The Collection Method sets the interface to connect to Brocade Switch. The available options are: SMI-S: If SMI-S options is selected, specify Brocade SMI agent Address. REST API: If REST API option is selected, specify Brocade REST API Server Address(es).
Brocade SMI agent address*	This field is enabled if Collection Method is SMI-S. Enter the IP address of the Brocade SMI agent and port number in the format: <ip_address>:port_number The port number is NOT required if you want to use the default port numbers: 5988 (http) or 5989 (https).	192.1.1.1
Brocade REST API Server Address(es)*	This field is enabled if Collection Method is REST API. Specify the Principal Switch IP address or fully qualified Switch name for the Brocade Switch. Note: Port number is optional. The format should be: <ip_address>[:port_number]	192.1.1.1:8080
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
Exclude Switches	Enter a switch WWN - e.g., 10:00:00:60:69:90:04:9F, 100000606990049F Colons within the WWN are NOT required. A comma-separated list is supported. Note: For the REST API, principal switch cannot be excluded.	10:00:00:60:69:90:04:9F, 100000606990049F
Switch Details	Click the check 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	Click the check box to collect FC Port statistics. This may have a performance impact, which can be optimized with the FC Port statistics schedule. Click the clock icon to create a schedule.
Indications Probe	If collection method is REST API, SNMP traps details are collected. If collection method is SMI-S, CIM indication details are collected.
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.
Test Connection	Test Connection is supported if REST API option is selected as Collection Method. Test connection message displays the details of the Data Collector connected to the switches as configured in the policy.
SNMP Version	SNMP version is enabled if the Collection Method is REST API and Indications Probe is turned on. Select the SNMP version configured on the switch to receive SNMP traps. The available options are: v1 v2c v3
SNMP Port	SNMP port is enabled if the Collection Method is REST API and Indications Probe is turned on. Specify the UDP port number of the collector configured on the switch at which SNMP traps will be received.	8163
Community Name/Security Name	This field is enabled if the Collection Method is REST API and Indications Probe is turned on. Specify the SNMP community name if the SNMP Version is v1/v2c or the SNMP security name if SNMP Version is v3, as configured on the switch.	public, snmpadmin1
Security Level	This field is enabled if the Collection Method is REST API, Indications Probe is turned on and SNMP version is v3. Select the SNMP security level as configured on the switch. The available options are: noAuthNoPriv: If noAuthNoPriv option is selected, authentication and privacy are disabled. authNoPriv: If authNoPriv option is selected, specify the Authentication Protocol and Authentication Password. Privacy is disabled. authPriv: If authPriv option is selected, specify the Authentication Protocol, Authentication Password, Privacy Protocol and Privacy Password.
Authentication Protocol	This field is enabled if the Collection Method is REST API, Indications Probe is turned on and Security Level is authNoPriv or authPriv. Select the SNMP authentication protocol. The available options are: MD5 and SHA
Authentication Password	This field is enabled if Collection Method is REST API, Indications Probe is turned on and Security Level is authNoPriv. Specify the SNMP authentication password.	Password1
Privacy Protocol	This field is enabled if Indications Probe is turned on and if Security Level is authPriv. Select the SNMP privacy protocol. The available options are: DES and AES128
Privacy Password	This field is enabled if Indications Probe is turned on and if Security Level is authPriv. Specify the SNMP privacy password.	Password1