Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Configuring an RMON Event
DME
YANG
Copy
POST http://<IP_Address>/api/mo/sys/snmp/inst/rmon.json

{
  "snmpRmon": {
    "children": [
      {
        "snmpEvent": {
          "attributes": {
            "description": "",
            "log": "no",
            "num": "1",
            "owner": "",
            "trap": "trap1"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <snmp-items>
    <inst-items>
      <rmon-items>
        <event-items>
          <Event-list>
            <num>1</num>
            <description></description>
            <log>no</log>
            <owner></owner>
            <trap>trap1</trap>
          </Event-list>
        </event-items>
      </rmon-items>
    </inst-items>
  </snmp-items>
</System>

Configuring RMON Events

You can configure RMON events to associate with RMON alarms. You can reuse the same event with multiple RMON alarms.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

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

Configuring an RMON Event

Configuring an RMON Event

Configures an RMON event. Ensure that you have configured an SNMP user and enabled SNMP notifications.


CLI Commands

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

rmon event 1 trap trap1

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
snmpRmon sys/snmp/inst/rmon
snmpEvent sys/snmp/inst/rmon/event-{num}


snmpEvent Properties

The following table contains information about the snmpEvent properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
descriptionsnmp:DescType
(string:Basic)		rmon event descriptionA sequence of characters
logsnmp:LogEnableType
(scalar:Enum8)		Whether to generate / not log when alarm event is firedSELECTION:
0 - no
1 - yes
DEFAULT: no
numsnmp:EventNum
(scalar:Uint16)		rmon event number
RANGE: [1 , 65535]
ownersnmp:OwnerType
(string:Basic)		rmon event ownerA sequence of characters
trapsnmp:TrapCommType
(string:Basic)		rmon event descriptionA sequence of characters


Related Documentation

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

Querying a Pattern to Match (RMON)

Querying a Pattern to Match (RMON)
CLI Output
switch# show running | section rmon   
rmon event 1 log trap public description FATAL(1) owner PMON@FATAL   
rmon event 2 log trap public description CRITICAL(2) owner PMON@CRITICAL   
rmon event 3 log trap public description ERROR(3) owner PMON@ERROR   
rmon event 4 log trap public description WARNING(4) owner PMON@WARNING   
rmon event 5 log trap public description INFORMATION(5) owner PMON@INFO

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
snmpRmon sys/snmp/inst/rmon
snmpEvent sys/snmp/inst/rmon/event-{num}


snmpRmon Properties

The following table contains information about the snmpRmon properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
dn
reference:BinRef		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
persistentOnReload
mo:Persistent
scalar:Enum8		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)


    • snmpEvent Properties

    The following table contains information about the snmpEvent properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

    Property NameData TypeDescriptionValues
    descriptionsnmp:DescType
    (string:Basic)    		rmon event descriptionA sequence of characters
    logsnmp:LogEnableType
    (scalar:Enum8)    		Whether to generate / not log when alarm event is firedSELECTION:
    0 - no
    1 - yes
    DEFAULT: no
    numsnmp:EventNum
    (scalar:Uint16)    		rmon event number
    RANGE: [1 , 65535]
    ownersnmp:OwnerType
    (string:Basic)    		rmon event ownerA sequence of characters
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    trapsnmp:TrapCommType
    (string:Basic)    		rmon event descriptionA sequence of characters


    Related Documentation

    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

    Next