Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Max Input and Output Packet Rate

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/pktmgr.json
{
  "pktmgrEntity": {
    "children": [
      {
        "pktmgrInst": {
          "attributes": {
            "rateLimitDirection": "both",
            "rateLimitPps": "26977"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <pktmgr-items>
    <inst-items>
      <rateLimitDirection>both</rateLimitDirection>
      <rateLimitPps>26977</rateLimitPps>
    </inst-items>
  </pktmgr-items>
</System>

Configuring Rate Limits

Configuring the Max Input and Output Packet Rate

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.

rate-limit cpu direction both pps 26977 action log

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.

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

The following table contains information about the pktmgrInst 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 Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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 Max Input and Output Packet Rate

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

CLI Commands

no rate-limit cpu direction both pps 26977 action log

Verifying a DME Configuration

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

Property Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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

Configuring the Max Input Packet Rate

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

CLI Commands

rate-limit cpu direction input pps 26977 action log

Verifying a DME Configuration

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

Property Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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 Max Input Packet Rate

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

CLI Commands

no rate-limit cpu direction input pps 26977 action log

Verifying a DME Configuration

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

Property Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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

Configuring the Max Output Packet Rate

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

CLI Commands

rate-limit cpu direction output pps 26977 action log

Verifying a DME Configuration

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

Property Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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 Max Output Packet Rate

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

CLI Commands

no rate-limit cpu direction output pps 26977 action log

Verifying a DME Configuration

MO	DN
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst

pktmgrInst Properties

Property Name	Data Type	Description	Values
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] 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

Configuring a Rate Limiter

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

CLI Commands

int po1
rate-limit cpu direction both pps 1000 action log

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.

MO	DN
topSystem	sys
pktmgrEntity	sys/pktmgr
pktmgrInst	sys/pktmgr/inst
pktmgrIf	sys/pktmgr/inst/if-[po1]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po1]

pktmgrIf Properties

The following table contains information about the pktmgrIf 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 Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
rateLimitDirection	pktmgr:RateLimitDirection (scalar:Enum8)	Rate Limit Direction	SELECTION: 1 - input 2 - output 3 - both 4 - unspecified DEFAULT: unspecified
rateLimitPps	pktmgr:RateLimitPps (scalar:Sint32)	Rate Limit Pps	RANGE: [-1 , 100000] DEFAULT: unspecified

pcAggrIf Properties

The following table contains information about the pcAggrIf 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 Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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