Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Loading...
Enabling QoS Policy Statistics
DME
YANG
Copy
POST http://<mgmt-ip>/api/mo/sys/ipqos.json

{
    "ipqosEntity": {
        "attributes": {
             "qosPoliciesStatsState": "enabled",
        }
    }
}

Response
{
    imdata:[]
}

Copy
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:52afd1a2-edcc-4f9f-81d4-e962a9dcd9d1"><nc:edit-config>
    <nc:target>
      <nc:running/>
    </nc:target>
    <nc:config>
      <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
        <ipqos-items nc:operation="merge">
          <qosPoliciesStatsState>enabled</qosPoliciesStatsState>
        </ipqos-items>
      </System>
    </nc:config>
  </nc:edit-config>
</nc:rpc>

Configuring Policing (Cisco Nexus 3500 QoS Commands)

Enabling QoS Policy Statistics

Enabling QoS Policy Statistics

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.

qos qos-policies statistics


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
ipqosEntity sys/ipqos


ipqosEntity Properties

The following table contains information about the ipqosEntity 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
qosPoliciesStatsStateipqos:statsState
(scalar:Enum8)		Globally enable/disable QoS-Policies statisticsSELECTION:
0 - enabled
1 - disabled
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 Policy Statistics

Disabling QoS Policy Statistics

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 qos qos-policies statistics


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
ipqosEntity sys/ipqos


ipqosEntity Properties

The following table contains information about the ipqosEntity 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
qosPoliciesStatsStateipqos:statsState
(scalar:Enum8)		Globally enable/disable QoS-Policies statisticsSELECTION:
0 - enabled
1 - disabled
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

Configuring a Descriptions for a QoS Class Map

Configuring a Descriptions for a QoS Class Map

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.

class-map type qos class-map-name
 description test dme

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
ipqosDescription sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/c/name-{name}/Description


ipqosDescription Properties

The following table contains information about the ipqosDescription 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
valipqos:DescStr
(string:Basic)		Description string
MAX SIZE: 200


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 a Descriptions for a QoS Class Map

Deleting a Descriptions for a QoS Class Map

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.

class-map type qos class-map-name
 no description test dme

Configuring a Descriptions for a QoS Policy Map

Configuring a Descriptions for a QoS Policy Map

When using DME for queuing and network-qos class-maps and policy-maps, use the above payloads only, but change the URL as below for the corresponding types:

  • For queuing class-maps: http:///api/mo/sys/ipqos/queuing/c/name-/Description.json
  • For queuing policy-map: http:///api/mo/sys/ipqos/queuing/p/name-/Description.json
  • For network-qos class-maps: http:///api/mo/sys/ipqos/nw/c/name-/Description.json
  • For network-qos policy-maps: http:///api/mo/sys/ipqos/nw/p/name-/Description.json

When using YANG, use the corresponding paths for queuing and network-qos class-maps and policy-maps (ipqos-items/queuing-items/c-items_or_p-items/ and ipqos-items/nw-items/c-items_or_p-items).

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.

policy-map type qos policy-map-name
 description test dme


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
ipqosDescription sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/c/name-{name}/Description


ipqosDescription Properties

The following table contains information about the ipqosDescription 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
valipqos:DescStr
(string:Basic)		Description string
MAX SIZE: 200


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 a Descriptions for a QoS Policy Map

Deleting a Descriptions for a QoS Policy Map

When using YANG, use the corresponding paths for queuing and network-qos class-maps and policy-maps (ipqos-items/queuing-items/c-items_or_p-items/ and ipqos-items/nw-items/c-items_or_p-items).

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.

policy-map type qos policy-map-name
 no description test dme

Configuring the Priority-Flow-Control Mode

Configuring the Priority-Flow-Control Mode

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.

priority-flow-control override-interface mode off


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
ipqosEntity sys/ipqos
ipqosGlobalPriorFlowCtrl sys/ipqos/globalpriorflowctrl


ipqosGlobalPriorFlowCtrl Properties

The following table contains information about the ipqosGlobalPriorFlowCtrl 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
overrideInterfaceipqos:OverrideIntfMode
(scalar:Enum8)		Enable/Disable priority-flow-control override-interface mode offSELECTION:
0 - disabled
1 - off
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 Priority-Flow-Control Mode

Deleting the Priority-Flow-Control Mode

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 priority-flow-control override-interface mode off


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
ipqosEntity sys/ipqos
ipqosGlobalPriorFlowCtrl sys/ipqos/globalpriorflowctrl


ipqosGlobalPriorFlowCtrl Properties

The following table contains information about the ipqosGlobalPriorFlowCtrl 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
overrideInterfaceipqos:OverrideIntfMode
(scalar:Enum8)		Enable/Disable priority-flow-control override-interface mode offSELECTION:
0 - disabled
1 - off
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

Next