Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Local SNMP Users

DME

YANG

Copy
POST http://<IP_Address>/api/mo/sys/snmp/inst.json
{
  "snmpInst": {
    "children": [
      {
        "snmpLocalUser": {
          "attributes": {
            "authpwd": "Cisco@123",
            "authtype": "md5",
            "isenforcepriv": "yes",
            "islocalizedkey": "no",
            "privpwd": "Cisco@123",
            "privtype": "des",
            "userName": "user1"
          },
          "children": [
            {
              "snmpUserGroup": {
                "attributes": {
                  "groupName": "network-admin"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <snmp-items>
    <inst-items>
      <lclUser-items>
        <LocalUser-list>
          <userName>user1</userName>
          <authpwd>Cisco@123</authpwd>
          <authtype>md5</authtype>
          <isenforcepriv>true</isenforcepriv>
          <islocalizedkey>false</islocalizedkey>
          <privpwd>Cisco@123</privpwd>
          <privtype>des</privtype>
          <group-items>
            <UserGroup-list>
              <groupName>network-admin</groupName>
            </UserGroup-list>
          </group-items>
        </LocalUser-list>
      </lclUser-items>
    </inst-items>
  </snmp-items>
</System>

Configuring SNMP

The Simple Network Management Protocol (SNMP) is an application-layer protocol that provides a message format for communication between SNMP managers and agents. SNMP provides a standardized framework and a common language used for the monitoring and management of devices in a network.

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure SNMP on Cisco Nexus 3000 and 9000 Series switches and to show how the REST APIs correspond to the CLI commands.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 7.x.

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring Local SNMP Users

Configures an SNMP user with authentication and privacy parameters.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right.

snmp-server user user1 auth md5 Cisco@123 priv Cisco@123 localizedkey
snmp-server user user1 enforcePriv
snmp-server user user1 network-admin

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Remote SNMP Users

Configures an SNMP user.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server user user2 auth md5 Cisco@123 priv Cisco@123 localizedkey engineID 1:2:3:4:5:6:7:8

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Creating SNMP Communities

You can create SNMP communities for SNMPv1 or SNMPv2c.

Setting SNMP Community Access Rights to Read Only

Sets the access rights to read-only.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server community comm1 ro

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Setting SNMP Community Access Rights of the Specified Group

Uses the access rights of the specified group.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server community comm1 group group1

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Assigning an ACL to Filter SNMP Requests

Assigns an ACL to filter SNMP requests.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server community ComName1 use-ipv4acl IPV4Name1 use-ipv6acl IPV6Name1

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Configuring a Source Interface for SNMP Notifications

You can configure SNMP to use the IP address of an interface as the source IP address for notifications. When a notification is generated, its source IP address is based on the IP address of this configured interface.

You can configure a source interface as follows:

All notifications sent to all SNMP notification receivers.
All notifications sent to a specific SNMP notification receiver. This configuration overrides the global source interface configuration.

Configuring a Source Interface for SNMP Notifications

Configures a source interface for sending out SNMPv2 informs.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server source-interface inform ethernet 1/1

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

Configuring a Source Interface for Sending SNMPv2 Traps

Configures a source interface for sending out SNMPv2 informs.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

snmp-server source-interface traps ethernet 1/1

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference: http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload: https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/