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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Ingress PG Shared Buffer Usage

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/pltfm.json
{
  "platformEntity": {
    "children": [
      {
        "platformQos": {
          "attributes": {
            "pgShare": "Enabled"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <pltfm-items>
    <qos-items>
      <pgShare>Enabled</pgShare>
    </qos-items>
  </pltfm-items>
</System>

Configuring Cisco Nexus 9000 (Cisco-ASIC based) Platform QoS

Configuring the Ingress PG Shared Buffer Usage

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.

platform qos ing-pg-share

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
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

The following table contains information about the platformQos 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
pgShare	platform:ConfigState (scalar:Enum8)	PG Shared Buffer Usage	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Enabled

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 Ingress PG Shared Buffer Usage

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

CLI Commands

no platform qos ing-pg-share

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
pgShare	platform:ConfigState (scalar:Enum8)	PG Shared Buffer Usage	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Enabled

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 Include IPG in Shaping/Policing

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

CLI Commands

platform qos include ipg

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
ipg	platform:ConfigState (scalar:Enum8)	Include IPG in shape/police	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Disabled

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 Configuration for Including IPG in Shaping/Policing

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

CLI Commands

no platform qos include ipg

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
ipg	platform:ConfigState (scalar:Enum8)	Include IPG in shape/police	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Disabled

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

Enabling QoS Classification on NS Only in Hardware

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

CLI Commands

platform qos classify ns-only

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
classify	platform:ConfigState (scalar:Enum8)	Qos classification	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Disabled

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

Disabling QoS Classification on NS Only in Hardware

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

CLI Commands

no platform qos classify ns-only

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
classify	platform:ConfigState (scalar:Enum8)	Qos classification	SELECTION: 0 - Disabled 1 - Enabled DEFAULT: Disabled

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

Enabling the PG Minimum Value

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

CLI Commands

platform qos ing-pg-no-min pgmin 1

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
pgMinValue	scalar:UByte	PG Min Value	RANGE: [0 , 32] DEFAULT: 0
pgNoMin	scalar:Bool	PG no-min	SELECTION: true or false DEFAULT: false

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

Disabling the PG Minimum Value

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

CLI Commands

no platform qos ing-pg-no-min pgmin 1

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
pgMinValue	scalar:UByte	PG Min Value	RANGE: [0 , 32] DEFAULT: 0
pgNoMin	scalar:Bool	PG no-min	SELECTION: true or false DEFAULT: false

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 PG Headroom Reservation Percent

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

CLI Commands

platform qos ing-pg-hdrm-reserve percent 79

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
pgHdrmReserve	scalar:UByte	Percent of Hdrm to reserve	RANGE: [20 , 100] DEFAULT: 100

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 PG Headroom Reservation Percent

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

CLI Commands

no platform qos ing-pg-hdrm-reserve percent 79

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformQos	sys/pltfm/qos

platformQos Properties

Property Name	Data Type	Description	Values
pgHdrmReserve	scalar:UByte	Percent of Hdrm to reserve	RANGE: [20 , 100] DEFAULT: 100

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 Minimum/Reserved Buffer Selection for a QoS Group

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

CLI Commands

platform qos min-buffer qos-group default

Verifying a DME Configuration

MO	DN
topSystem	sys
platformEntity	sys/pltfm

platformEntity Properties

The following table contains information about the platformEntity 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
qosMinBuffer	platform:QosMinBuffer (scalar:Enum8)	qos min-buffer qos-group	SELECTION: 0 - all 1 - none 2 - default DEFAULT: all

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 Minimum/Reserved Buffer Selection for a QoS Group

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

CLI Commands

no platform qos min-buffer qos-group default

Verifying a DME Configuration

MO	DN
topSystem	sys
platformEntity	sys/pltfm

platformEntity Properties

Property Name	Data Type	Description	Values
qosMinBuffer	platform:QosMinBuffer (scalar:Enum8)	qos min-buffer qos-group	SELECTION: 0 - all 1 - none 2 - default DEFAULT: all

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