Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Configuring to Test Each Sample Directly
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/snmp/inst/rmon.json

{
  "snmpRmon": {
    "children": [
      {
        "snmpHcAlarm": {
          "attributes": {
            "fallingEvntIndx": "12",
            "fallingThr": "1",
            "num": "20",
            "oid": "1.3.6.1.2.1.2.2.1.14.16777216",
            "owner": "SamStr_1",
            "risingEvntIndx": "123",
            "risingThr": "1234",
            "sampleInterval": "2900",
            "sampleType": "absolute",
            "startupAlarm": "risingorfalling"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <snmp-items>
    <inst-items>
      <rmon-items>
        <hcalarm-items>
          <HcAlarm-list>
            <num>20</num>
            <fallingEvntIndx>12</fallingEvntIndx>
            <fallingThr>1</fallingThr>
            <oid>1.3.6.1.2.1.2.2.1.14.16777216</oid>
            <owner>SamStr_1</owner>
            <risingEvntIndx>123</risingEvntIndx>
            <risingThr>1234</risingThr>
            <sampleInterval>2900</sampleInterval>
            <sampleType>absolute</sampleType>
            <startupAlarm>risingorfalling</startupAlarm>
          </HcAlarm-list>
        </hcalarm-items>
      </rmon-items>
    </inst-items>
  </snmp-items>
</System>

Configuring RMON Alarms

You can set an alarm on any MIB object that resolves into an SNMP INTEGER type. The specified object must be an existing SNMP MIB object in standard dot notation (for example, 1.3.6.1.2.1.2.2.1.14 represents ifInOctets.14).

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

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

Configuring to Test Each Sample Directly

Configuring to Test Each Sample Directly

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

rmon hcalarm 20 1.3.6.1.2.1.2.2.1.14.16777216 2900 absolute startupalarm 3 rising-threshold 1234 123 falling-threshold 1 12 owner SamStr_1


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
snmpHcAlarm sys/snmp/inst/rmon/hcalarm-20
snmpRmon sys/snmp/inst/rmon


snmpHcAlarm Properties

The following table contains information about the snmpHcAlarm 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
fallingEvntIndxsnmp:EventIndx
(scalar:Uint16)		RMON alarm falling threshold event crossing
RANGE: [1 , 65535]
DEFAULT: 1
fallingThrsnmp:HcThrshld
(scalar:Uint64)		RMON alarm falling thresholdRANGE: [0, 18446744073709551615]
numsnmp:EventNum
(scalar:Uint16)		RMON alarm number
RANGE: [1 , 65535]
oidstring:Basic
MIB object to monitorA sequence of characters
ownersnmp:OwnerType
(string:Basic)		RMON alarm ownerA sequence of characters
risingEvntIndxsnmp:EventIndx
(scalar:Uint16)		RMON alarm rising threshold event crossing
RANGE: [1 , 65535]
DEFAULT: 1
risingThrsnmp:HcThrshld
(scalar:Uint64)		Alarm rising threshold valueRANGE: [0, 18446744073709551615]
sampleIntervalsnmp:smplIntvl
(scalar:Uint32)		RMON alarm sample interval
RANGE: [1 , 700000]
DEFAULT: 1
sampleTypesnmp:smplType
(scalar:Enum8)		RMON sample interval typeSELECTION:
0 - unspecified
1 - absolute
2 - delta
DEFAULT: unspecified
startupAlarmsnmp:startupAlarmType
(scalar:Enum8)		RMON startup alarmSELECTION:
0 - unspecified
1 - rising
2 - falling
3 - risingorfalling
DEFAULT: unspecified


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

Deleting the Config to Test Each Sample Directly

Deleting the Config to Test Each Sample Directly

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no rmon hcalarm 20 1.3.6.1.2.1.2.2.1.14.16777216 2900 absolute startupalarm 3 rising-threshold 1234 123 falling-threshold 1 12 owner SamStr_1


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
snmpHcAlarm sys/snmp/inst/rmon/hcalarm-20
snmpRmon sys/snmp/inst/rmon


snmpHcAlarm Properties

The following table contains information about the snmpHcAlarm 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
numsnmp:EventNum
(scalar:Uint16)		RMON alarm number
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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

Configuring To Test Delta Between Samples

Configuring To Test Delta Between Samples

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

rmon hcalarm 20 1.3.6.1.2.1.2.2.1.14.16777216 2900 delta startupalarm 3 rising-threshold 1234 123 falling-threshold 1 12 owner SamStr_1


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
snmpHcAlarm sys/snmp/inst/rmon/hcalarm-20
snmpRmon sys/snmp/inst/rmon


snmpHcAlarm Properties

The following table contains information about the snmpHcAlarm 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
fallingEvntIndxsnmp:EventIndx
(scalar:Uint16)		RMON alarm falling threshold event crossing
RANGE: [1 , 65535]
DEFAULT: 1
fallingThrsnmp:HcThrshld
(scalar:Uint64)		RMON alarm falling thresholdRANGE: [0, 18446744073709551615]
numsnmp:EventNum
(scalar:Uint16)		RMON alarm number
RANGE: [1 , 65535]
oidstring:Basic
MIB object to monitorA sequence of characters
ownersnmp:OwnerType
(string:Basic)		RMON alarm ownerA sequence of characters
risingEvntIndxsnmp:EventIndx
(scalar:Uint16)		RMON alarm rising threshold event crossing
RANGE: [1 , 65535]
DEFAULT: 1
risingThrsnmp:HcThrshld
(scalar:Uint64)		Alarm rising threshold valueRANGE: [0, 18446744073709551615]
sampleIntervalsnmp:smplIntvl
(scalar:Uint32)		RMON alarm sample interval
RANGE: [1 , 700000]
DEFAULT: 1
sampleTypesnmp:smplType
(scalar:Enum8)		RMON sample interval typeSELECTION:
0 - unspecified
1 - absolute
2 - delta
DEFAULT: unspecified
startupAlarmsnmp:startupAlarmType
(scalar:Enum8)		RMON startup alarmSELECTION:
0 - unspecified
1 - rising
2 - falling
3 - risingorfalling
DEFAULT: unspecified


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

Deleting the Config To Test Delta Between Samples

Deleting the Config To Test Delta Between Samples

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no rmon hcalarm 20 1.3.6.1.2.1.2.2.1.14.16777216 2900 delta startupalarm 3 rising-threshold 1234 123 falling-threshold 1 12 owner SamStr_1


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
snmpHcAlarm sys/snmp/inst/rmon/hcalarm-20
snmpRmon sys/snmp/inst/rmon


snmpHcAlarm Properties

The following table contains information about the snmpHcAlarm 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
numsnmp:EventNum
(scalar:Uint16)		RMON alarm number
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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