Add Cisco Catalyst Switch

You can add Cisco Catalyst Switch entities using the Add Entity UI or using the cloud agent command line interface (omcli) with the appropriate JSON files.

Step 1: Prepare Cisco Catalyst Switch for monitoring.

Prerequisites

To enable monitoring of the Cisco Ethernet (Catalyst) Switch, you will need to provide the SNMPv1/v2 or SNMPv3 credentials in the JSON credential file. Read-only access is sufficient for Cisco Catalyst Switch monitoring. For more information on how to configure an SNMP user for a Cisco Catalyst Switch, see http://www.cisco.com/c/en/us/td/docs/switches/lan/catalyst2960/software/release/12-2_55_se/configuration/guide/scg_2960/swsnmp.html#78160

Step 2: Decide how you want to add the Cisco Catalyst Switch.

You can add Cisco Catalyst Switch entities using one of two ways:

  • Add them from UI
  • Use the agent's omcli add_entity command with the appropriate JSON files

Adding Entities from the UI

  1. From the Management Cloud main menu, select Administration, Discovery, and then Add Entity. The Add Entity page displays.
  2. Select the Cisco Catalyst Switch Entity Type.
  3. Enter the following UI properties.
    Cisco Catalyst Ethernet Switch UI Fields
    • Entity Name: Name of your Cisco Catalyst Ethernet Switch in Oracle Management Cloud
    • Dispatch URL: snmp://<Fully qualified host name or IP address of Cisco Catalyst Ethernet Switch>
    • SNMP Port: Port where Cisco Catalyst Ethernet Switch listens for SNMP requests - 161 by default (optional)
    • SNMP Timeout: Timeout for SNMP requests in seconds - 30 secs by default (optional)
    • Cloud Agent: Cloud agent monitoring the host where Cisco Catalyst Ethernet Switch is installed.

    Monitoring Credentials

    SNMP V1/V2

    • Community String: The SNMPv2c community string.

    SNMP V3

    • Username: SNMPv3 username.
    • Authorization Password: Password used for authentication.
    • Authorization Protocol: Protocol used for authentication (MD5 or SHA)
    • Privacy Password: Password used for encryption.

See Add Entities from the Console for detailed instructions on using the Add Entity UI.

Using omcli and the Appropriate JSON Files

  1. Download and extract the required JSON file(s) from the master JSON zip file. See the table below for the specific JSON files you'll need.
  2. Edit the file(s) and specify the requisite properties shown below.
    Cisco Catalyst Ethernet Switch JSON Files and Properties

    Definition File: omc_cisco_eth_switch_sample.json

    • name: Your Cisco Ethernet (Catalyst) Switch entity name.
    • displayName: Your Cisco Ethernet (Catalyst) Switch entity display name.
    • timezoneRegion: Time zone of your entity. It is recommended that you use the long values IANA-maintained TZ database time zones. For example: America/New_York
    • omc_dispatch_url: Under “value”, following the string snmp://, provide the fully qualified hostname or IP address of the Cisco Ethernet (Catalyst) Switch.
    • omc_snmp_port: Under “value”, provide the port where the Cisco Ethernet (Catalyst) Switch listens for SNMP requests, 161 by default.
    • omc_snmp_timeout: Under “value”, provide the timeout for SNMP requests in seconds, 10 by default.
    • omc_snmp_version: Under “value”, provide the SNMP version used to monitor the Cisco Ethernet (Catalyst) Switch.

      Note:

      This is an optional property which is used only with SNMPV1Creds and allowed values are "1" or "2c". The default value is "2c".

    Do not remove the square brackets.

    Credential Files

    Choose the creds json file according to what SNMP credentials you'd like to use - SNMP v2c or SNMP v3.

    omc_cisco_eth_switch_snmpv2c_sample_creds.json

    • COMMUNITY: SNMPv2c community string

    omc_cisco_eth_switch_snmpv3_sample_creds.json

    • authUser: SNMPv3 username
    • authPwd: password used for authentication
    • authProtocol: protocol used for authentication - supply either MD5 or SHA
    • privPwd: password used for encryption

  3. Add the entity using omcli.
    omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]] 
  4. Verify the status of the newly added entity.
    omcli status_entity agent DEFINITION_FILE

See step 4. Adding Entities to Your Service of Add Entities Using JSON Files for more information.

Step 3: (Optional but recommended) Set up alerts.

To enable lights-out monitoring, you can set up alert rules to generate alerts and send notifications if your entities have performance issues.

See Set Up Alert Rules and Set Up Alert Thresholds and Notifications.

Troubleshooting

If you run into any issues regarding discovery or monitoring of Cisco Catalyst Switch, see the following: