Configuring QoS Policy Maps

This section contains payload examples and CLIs to demonstrate many of the QoS policy map configuration options and to show how the REST APIs correspond to the CLI commands.

Defining a Policy Map

Defining a Policy Map
POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
{
 "ipqosPMapEntity": {
   "children": [
     {
       "ipqosPMapInst": {
         "attributes": {
           "matchType": "match-all",
           "name": "foo"
}}}]}}
{
    imdata:[]
}
<System>
  <ipqos-items>
    <queuing-items>
      <p-items>
        <name-items>
          <PMapInst-list>
            <name>foo</name>
            <matchType>match-all</matchType>
          </PMapInst-list>
        </name-items>
      </p-items>
    </queuing-items>
  </ipqos-items>
</System>

This example creates a named object that represents a set of policies that are to be applied to a set of traffic classes.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

policy-map type queuing foo

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
ipqosPMapEntity sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p
ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}


ipqosPMapInst Properties

The following table contains information about the ipqosPMapInst 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
matchTypeipqos:QoSMatchType
(scalar:Enum8)
Match-any, match-all or match-firstSELECTION:
0 - match-any
1 - match-all
2 - match-first
DEFAULT: match-all
nameipqos:PMapName
(string:Basic)
Name of policy-map
MAX SIZE: 39


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 CoS Marking

Configuring CoS Marking
POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p/name-map1.json
{
  "ipqosPMapInst": {
    "attributes": {
      "matchType": "match-all",
      "name": "map1"
    },
    "children": [
      {
        "ipqosMatchCMap": {
          "attributes": {
            "name": "class1",
            "userSetBit": "1"
          },
          "children": [
            {
              "ipqosSetCos": {
                "attributes": {
                  "val": "1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipqos-items>
    <dflt-items>
      <p-items>
        <name-items>
          <PMapInst-list>
            <name>map1</name>
            <matchType>match-all</matchType>
            <cmap-items>
              <MatchCMap-list>
                <name>class1</name>
                <userSetBit>1</userSetBit>
                <setCos-items>
                  <val>1</val>
                </setCos-items>
              </MatchCMap-list>
            </cmap-items>
          </PMapInst-list>
        </name-items>
      </p-items>
    </dflt-items>
  </ipqos-items>
</System>

This example sets the CoS value to cos-value. The value can range from 0 to 7.


CLI Commands

The CLI commands and options 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 or the YANG tab to view the XML payload.

policy-map map1
 class class1
  set cos 1

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
ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
ipqosSetCos sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setCos


ipqosPMapInst Properties

The following table contains information about the ipqosPMapInst 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
matchTypeipqos:QoSMatchType
(scalar:Enum8)
Match-any, match-all or match-firstSELECTION:
0 - match-any
1 - match-all
2 - match-first
DEFAULT: match-all
nameipqos:PMapName
(string:Basic)
Name of policy-map
MAX SIZE: 39


ipqosMatchCMap Properties

The following table contains information about the ipqosMatchCMap 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
nameipqos:CMapName
(string:Basic)
Match using class-map
MAX SIZE: 39
userSetBit
scalar:Uint64
NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetCos Properties

    The following table contains information about the ipqosSetCos 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:CosNewNone
    (scalar:Enum8)
    Cos valueSELECTION:
    0 - 0
    1 - 1
    2 - 2
    3 - 3
    4 - 4
    5 - 5
    6 - 6
    7 - 7
    8 - None
    DEFAULT: None


    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

    Setting the QoS Group

    Setting the QoS Group
    
    POST http://<IP_Address>/api/mo/sys/ipqos/dflt/p/name-p1.json
     
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "class-default",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetQoSGrp": {
                    "attributes": {
                      "id": "3"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <userSetBit>1</userSetBit>
                    <setGrp-items>
                      <id>3</id>
                    </setGrp-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example configures one or more qos-group values to match on for classification of traffic into this class map.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type qos p1
     class class-default
      set qos-group 3

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetQoSGrp sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setGrp


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetQoSGrp Properties

    The following table contains information about the ipqosSetQoSGrp 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
    idipqos:QoSGrpId
    (scalar:Uint16)
    QoS group ID
    RANGE: [0 , 7]


    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 Dynamic Load Balancing

    Disabling Dynamic Load Balancing
    
    POST http://<IP_Address>/api/mo/sys/ipqos/dflt/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "class1",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetDlbDisable": {
                    "attributes": {
                      "uid": "0"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class1</name>
                    <userSetBit>1</userSetBit>
                    <setDlbDisable-items>
                      <uid>0</uid>
                    </setDlbDisable-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example disables DLB.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map p1
     class class1
      set dlb-disable

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetDlbDisable sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setDlbDisable


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetDlbDisable Properties

    The following table contains information about the ipqosSetDlbDisable 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
    uid
    scalar:Uint16
    A unique identifier for this object.


    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 DSCP Marking

    Configuring DSCP Marking
    
    POST http://<IP_Address>/api/mo/sys/ipqos/dflt/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "class1",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetDscp": {
                    "attributes": {
                      "tunnel": "no",
                      "val": "cs6"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class1</name>
                    <userSetBit>1</userSetBit>
                    <setDscp-items>
                      <tunnel>false</tunnel>
                      <val>cs6</val>
                    </setDscp-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example sets the DSCP value.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map p1
     class class1
      set dscp cs6

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetDscp sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setDscp


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetDscp Properties

    The following table contains information about the ipqosSetDscp 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
    tunnelscalar:Bool
    tunnel on or offSELECTION: true or false
    valipqos:Dscp
    (scalar:UByte)
    Dscp value
    RANGE: [0 , 63]
    DEFAULT: 0


    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 Bandwidth

    Configuring Bandwidth
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "c-in-q1",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetBW": {
                    "attributes": {
                      "val": "40"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-in-q1</name>
                    <userSetBit>1</userSetBit>
                    <setBW-items>
                      <val>40</val>
                    </setBW-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

    This example assigns a minimum rate of the interface bandwidth to an output queue as the percentage of the underlying interface link rate. The range is from 0 to 100.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type queuing p1
     class type queuing c-in-q1
      bandwidth percent 40

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetBW sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setBW


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetBW Properties

    The following table contains information about the ipqosSetBW 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:Percent
    (scalar:UByte)
    Available bandwidth
    RANGE: [0 , 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

    Setting the MTU

    Setting the MTU
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/nw/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "c-nq1",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetMTU": {
                    "attributes": {
                      "value": "2000"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <nw-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-nq1</name>
                    <userSetBit>1</userSetBit>
                    <mtu-items>
                      <value>2000</value>
                    </mtu-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </nw-items>
      </ipqos-items>
    </System>
    

    The example sets the MTU size.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type network-qos p1
     class type network-qos c-nq1
      mtu 2000

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetMTU sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/mtu


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetMTU Properties

    The following table contains information about the ipqosSetMTU 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
    valueipqos:MTU
    (scalar:Uint16)
    Set MTU value
    RANGE: [576 , 9216]
    DEFAULT: 1500


    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 Pause to Network QoS Policy Class

    Configuring Pause to Network QoS Policy Class
    
    POST http://<IP_Address>/api/mo/sys/ipqos/nw/p/name-p2.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "name": "p2"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "class3",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosPause": {
                    "attributes": {
                      "bufferSize": "50000",
                      "pauseThreshold": "40000",
                      "pfcCos0": "no",
                      "pfcCos1": "no",
                      "pfcCos2": "yes",
                      "pfcCos3": "no",
                      "pfcCos4": "no",
                      "pfcCos5": "no",
                      "pfcCos6": "no",
                      "pfcCos7": "no",
                      "resumeThreshold": "25000"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <nw-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p2</name>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class3</name>
                    <userSetBit>1</userSetBit>
                    <pause-items>
                      <bufferSize>50000</bufferSize>
                      <pauseThreshold>40000</pauseThreshold>
                      <pfcCos0>false</pfcCos0>
                      <pfcCos1>false</pfcCos1>
                      <pfcCos2>true</pfcCos2>
                      <pfcCos3>false</pfcCos3>
                      <pfcCos4>false</pfcCos4>
                      <pfcCos5>false</pfcCos5>
                      <pfcCos6>false</pfcCos6>
                      <pfcCos7>false</pfcCos7>
                      <resumeThreshold>25000</resumeThreshold>
                    </pause-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </nw-items>
      </ipqos-items>
    </System>
    

    This example specifies the buffer threshold settings for pause and resume.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type network-qos p2
     class type network-qos class3
      pause buffer-size 50000 pause-threshold 40000 resume-threshold 25000 pfc-cos 2

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosPause sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/pause


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosPause Properties

    The following table contains information about the ipqosPause 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
    bufferSizeipqos:BuffSize
    (scalar:Uint64)
    size in bytes
    RANGE: [5000 , 12582913]
    DEFAULT: 12582913
    pauseThresholdipqos:XoffBytes
    (scalar:Uint64)
    xoff bytes
    RANGE: [0 , 12582912]
    pfcCos0scalar:Bool
    Configure pfc-cos 0 valueSELECTION: true or false
    pfcCos1scalar:Bool
    Configure pfc-cos 1 valueSELECTION: true or false
    pfcCos2scalar:Bool
    Configure pfc-cos 2 valueSELECTION: true or false
    pfcCos3scalar:Bool
    Configure pfc-cos 3 valueSELECTION: true or false
    pfcCos4scalar:Bool
    Configure pfc-cos 4 valueSELECTION: true or false
    pfcCos5scalar:Bool
    Configure pfc-cos 5 valueSELECTION: true or false
    pfcCos6scalar:Bool
    Configure pfc-cos 6 valueSELECTION: true or false
    pfcCos7scalar:Bool
    Configure pfc-cos 7 valueSELECTION: true or false
    resumeThresholdipqos:XonBytes
    (scalar:Uint64)
    xon bytes
    RANGE: [0 , 12582912]


    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 Police to a Policy Class

    Configuring Police to a Policy Class
    
    POST http://<IP-Address>/api/mo/sys/ipqos/dflt/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "class2",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosPolice": {
                    "attributes": {
                      "bcRate": "200",
                      "bcUnit": "ms",
                      "beRate": "unspecified",
                      "beUnit": "unspecified",
                      "cirRate": "8000",
                      "cirUnit": "bps",
                      "conformAction": "unspecified",
                      "conformSetCosTransmit": "0",
                      "conformSetDscpTransmit": "default",
                      "conformSetPrecTransmit": "routine",
                      "conformSetQosGrpTransmit": "0",
                      "exceedAction": "unspecified",
                      "exceedSetCosTransmit": "0",
                      "exceedSetDscpTransmit": "default",
                      "exceedSetPrecTransmit": "routine",
                      "exceedSetQosGrpTransmit": "0",
                      "pirRate": "unspecified",
                      "pirUnit": "unspecified",
                      "violateAction": "unspecified",
                      "violateSetCosTransmit": "0",
                      "violateSetDscpTransmit": "default",
                      "violateSetPrecTransmit": "routine",
                      "violateSetQosGrpTransmit": "0"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class2</name>
                    <userSetBit>1</userSetBit>
                    <police-items>
                      <bcRate>200</bcRate>
                      <bcUnit>ms</bcUnit>
                      <beRate>unspecified</beRate>
                      <beUnit>unspecified</beUnit>
                      <cirRate>8000</cirRate>
                      <cirUnit>bps</cirUnit>
                      <conformAction>unspecified</conformAction>
                      <conformSetCosTransmit>0</conformSetCosTransmit>
                      <conformSetDscpTransmit>default</conformSetDscpTransmit>
                      <conformSetPrecTransmit>routine</conformSetPrecTransmit>
                      <conformSetQosGrpTransmit>0</conformSetQosGrpTransmit>
                      <exceedAction>unspecified</exceedAction>
                      <exceedSetCosTransmit>0</exceedSetCosTransmit>
                      <exceedSetDscpTransmit>default</exceedSetDscpTransmit>
                      <exceedSetPrecTransmit>routine</exceedSetPrecTransmit>
                      <exceedSetQosGrpTransmit>0</exceedSetQosGrpTransmit>
                      <pirRate>unspecified</pirRate>
                      <pirUnit>unspecified</pirUnit>
                      <violateAction>unspecified</violateAction>
                      <violateSetCosTransmit>0</violateSetCosTransmit>
                      <violateSetDscpTransmit>default</violateSetDscpTransmit>
                      <violateSetPrecTransmit>routine</violateSetPrecTransmit>
                      <violateSetQosGrpTransmit>0</violateSetQosGrpTransmit>
                    </police-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example shows how to configure policing.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type qos match-first p1
     class type qos class2
      police cir 8000 bc 200 ms

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosPolice sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/sharedpolicer-{policerName}/police


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosPolice Properties

    The following table contains information about the ipqosPolice 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
    bcRateipqos:BurstRate
    (scalar:Uint64)
    CIR burst
    RANGE: [0 , 536870912]
    bcUnitipqos:BurstRateUnit
    (scalar:Enum8)
    CIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    beRateipqos:BurstRate
    (scalar:Uint64)
    PIR burst
    RANGE: [0 , 536870912]
    beUnitipqos:BurstRateUnit
    (scalar:Enum8)
    PIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    cirRateipqos:PoliceRate
    (scalar:Uint64)
    CIR
    RANGE: [0 , 100000000000]
    cirUnitipqos:RateUnit
    (scalar:Enum8)
    CIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    conformActionipqos:PoliceAction
    (scalar:Enum8)
    Conform actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    conformSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for conforming traffic
    RANGE: [0 , 7]
    conformSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for conforming traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    conformSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for conforming trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    conformSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for conforming traffic
    RANGE: [0 , 7]
    exceedActionipqos:PoliceAction
    (scalar:Enum8)
    Exceed actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    exceedSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for exceeding traffic
    RANGE: [0 , 7]
    exceedSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for exceeding traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    exceedSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for exceeding trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    exceedSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for exceeding traffic
    RANGE: [0 , 7]
    pirRateipqos:PoliceRate
    (scalar:Uint64)
    PIR
    RANGE: [0 , 100000000000]
    pirUnitipqos:RateUnit
    (scalar:Enum8)
    PIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    violateActionipqos:PoliceAction
    (scalar:Enum8)
    Violate actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    violateSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for violating traffic
    RANGE: [0 , 7]
    violateSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for violating traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    violateSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for violating trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    violateSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for violating traffic
    RANGE: [0 , 7]


    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

    Setting a Priority Level to a Queuing Policy Class

    Setting a Priority Level to a Queuing Policy Class
    
    POST http://<IP_Address>/api/mo/sys/ipqos/queuing/p/name-p1.json 
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "c-in-q1",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosQueueLimit": {
                    "attributes": {
                      "QueueLimitUnit": "none",
                      "QueueLimitVal": "2000",
                      "dynamic": "0"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-in-q1</name>
                    <userSetBit>1</userSetBit>
                    <QueueLimit-items>
                      <QueueLimitUnit>none</QueueLimitUnit>
                      <QueueLimitVal>2000</QueueLimitVal>
                      <dynamic>0</dynamic>
                    </QueueLimit-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

    This example assigns a tail drop threshold based on the queue size in bytes, kilobytes, or megabytes or allows the queue’s threshold size to be determined dynamically depending on the number of free cells available. The device drops packets that exceed the specified threshold.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type queuing p1
     class type queuing c-in-q1
      queue-limit 2000

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosQueueLimit sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/QueueLimit


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosQueueLimit Properties

    The following table contains information about the ipqosQueueLimit 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
    QueueLimitUnitipqos:QueueLimitUnit
    (scalar:Enum8)
    Bytes/kbytes/mbytesSELECTION:
    0 - none
    1 - packets
    2 - bytes
    3 - kbytes
    4 - mbytes
    5 - gbytes
    6 - ms
    7 - us
    8 - perc
    DEFAULT: none
    QueueLimitValipqos:QueueLimit
    (scalar:Uint64)
    Value in bytes/kbytes/mbytes
    RANGE: [0 , 12582912]
    DEFAULT: none
    dynamicipqos:QueueLimitDynamic
    (scalar:UByte)
    Queue-limit dynamic value
    RANGE: [0 , 10]
    DEFAULT: none


    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 WRED on Egress Queues

    Configuring WRED on Egress Queues
    
    POST http://<IP_Address>/api/mo/sys/ipqos/queuing/p/name-p1.json
     
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
    },
    "children": [
      {
        "ipqosMatchCMap": {
          "attributes": {
            "name": "c-out-q1",
            "userSetBit": "1"
          },
          "children": [
            {
              "ipqosRandomDetect": {
                "attributes": {
                  "capAverage": "no",
                  "dropAvail": "0",
                  "ecn": "no",
                  "maxThreshold": "0",
                  "maxThresholdUnit": "none",
                  "minThreshold": "0",
                  "minThresholdUnit": "none",
                  "weight": "0"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-in-q1</name>
                    <userSetBit>1</userSetBit>
                    <RandDet-items>
                      <capAverage>false</capAverage>
                      <dropAvail>0</dropAvail>
                      <ecn>false</ecn>
                      <maxThreshold>0</maxThreshold>
                      <maxThresholdUnit>none</maxThresholdUnit>
                      <minThreshold>0</minThreshold>
                      <minThresholdUnit>none</minThresholdUnit>
                      <weight>0</weight>
                    </RandDet-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

    This example configures WRED on the specified queuing class.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type queuing p1
     class type queuing c-in-q1
      random-detect

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosRandomDetect sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/RandDet


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosRandomDetect Properties

    The following table contains information about the ipqosRandomDetect 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
    capAveragescalar:Bool
    cap averageSELECTION: true or false
    dropAvailipqos:DropAvailRange
    (scalar:UByte)
    drop availability range
    RANGE: [0 , 100]
    ecnscalar:Bool
    ecn flagSELECTION: true or false
    maxThresholdipqos:ThreshVal
    (scalar:Uint32)
    max threshold
    RANGE: [0 , 52428800]
    DEFAULT: 0
    maxThresholdUnitipqos:ThreshUnit
    (scalar:Enum8)
    max thresholdSELECTION:
    0 - none
    1 - packets
    2 - bytes
    3 - kbytes
    4 - mbytes
    DEFAULT: none
    minThresholdipqos:ThreshVal
    (scalar:Uint32)
    min threshold
    RANGE: [0 , 52428800]
    DEFAULT: 0
    minThresholdUnitipqos:ThreshUnit
    (scalar:Enum8)
    min thresholdSELECTION:
    0 - none
    1 - packets
    2 - bytes
    3 - kbytes
    4 - mbytes
    DEFAULT: none
    weightipqos:Weight
    (scalar:UByte)
    weight range
    RANGE: [0 , 15]


    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 Traffic Shaping

    Configuring Traffic Shaping
    
    POST http://<IP_Address>/api/mo/sys/ipqos/queuing/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
    },
    "children": [
    {
    "ipqosMatchCMap": {
      "attributes": {
        "name": "c-in-q2",
        "userSetBit": "1"
    },
    "children": [
    {
      "ipqosShape": {
        "attributes": {
          "max": "40000",
          "maxRateUnit": "bps",
          "min": "8000",
          "minRateUnit": "bps"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-in-q2</name>
                    <userSetBit>1</userSetBit>
                    <shape-items>
                      <max>40000</max>
                      <maxRateUnit>bps</maxRateUnit>
                      <min>8000</min>
                      <minRateUnit>bps</minRateUnit>
                    </shape-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

    This example assigns a minimum and maximum bit rate on an output queue.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type queuing p1
     class type queuing c-in-q2
      shape min 8000 bps max 40000

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosShape sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/shape


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosShape Properties

    The following table contains information about the ipqosShape 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
    maxipqos:ShapeRate
    (scalar:Uint64)
    Maximum shape rate
    RANGE: [0 , 400000000000]
    maxRateUnitipqos:RateUnit
    (scalar:Enum8)
    Maximum shape rate unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    minipqos:ShapeRate
    (scalar:Uint64)
    Minimum shape rate
    RANGE: [0 , 400000000000]
    minRateUnitipqos:RateUnit
    (scalar:Enum8)
    Minimum shape rate unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    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

    Removing the Bandwidth Limit

    Removing the Bandwidth Limit
    
    POST http://<IP_Address>/api/mo/sys/ipqos/queuing/p/name-p1.json
    
    {
      "ipqosPMapInst": {
        "attributes": {
          "matchType": "match-all",
          "name": "p1"
        },
        "children": [
          {
            "ipqosMatchCMap": {
              "attributes": {
                "name": "c-in-q2",
                "userSetBit": "1"
              },
              "children": [
                {
                  "ipqosSetBW": {
                    "attributes": {
                      "status": "deleted"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>p1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-in-q2</name>
                    <userSetBit>1</userSetBit>
                    <setBW-items xc:operation="delete">
                    </setBW-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

    This example removes the bandwidth specification from this class.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    policy-map type queuing p1
     class type queuing c-in-q2
      no bandwidth percent 30

    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
    ipqosPMapInst sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}
    ipqosMatchCMap sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}
    ipqosSetBW sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/p/name-{name}/cmap-{name}/setBW


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosSetBW Properties

    The following table contains information about the ipqosSetBW 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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

    QoS on an Interface (input)

    QoS on an Interface (input)
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/policy/in/intf-[eth1/4].json
    
    {
      "ipqosIf": {
        "attributes": {
          "name": "eth1/4"
        },
        "children": [
          {
            "ipqosInst": {
              "attributes": {
                "name": "foo",
                "stats": "yes"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <policy-items>
            <in-items>
              <intf-items>
                <If-list>
                  <name>eth1/4</name>
                  <pmap-items>
                    <name>foo</name>
                    <stats>true</stats>
                  </pmap-items>
                </If-list>
              </intf-items>
            </in-items>
          </policy-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example adds the policy map to the input packets of an interface.

    An instance of the interface for QoS must be initialized before configuring QoS. The interface can be any of the following types:

    • ethernet - Ethernet IEEE 802.3z
    • loopback - Loopback interface
    • mgmt - Management interface
    • port-channel - Port Channel interface

    Note: Sub-interfaces and breakout ports for the above are also supported.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    interface eth1/4
     service-policy type qos input foo

    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
    ipqosIf sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out/intf-{[name]}


    ipqosIf Properties

    The following table contains information about the ipqosIf 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
    namenw:IfId
    (base:IfIndex)
    Interface name in a short form. eth1/1 or pc1Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    ipqosInst Properties

    The following table contains information about the ipqosInst 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
    nameipqos:PMapName
    (string:Basic)
    Policy-map Name
    MAX SIZE: 39
    statsscalar:Bool
    turn on/off statisticsSELECTION: true or false
    DEFAULT: true


    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

    QoS on an Interface (output)

    QoS on an interface (output)
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/policy/out/intf-[eth1/4].json
    
    {
      "ipqosIf": {
        "attributes": {
          "name": "eth1/4"
        },
        "children": [
          {
            "ipqosInst": {
              "attributes": {
                "name": "foo",
                "stats": "yes"
    }}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <policy-items>
            <out-items>
              <intf-items>
                <If-list>
                  <name>eth1/4</name>
                  <pmap-items>
                    <name>foo</name>
                    <stats>true</stats>
                  </pmap-items>
                </If-list>
              </intf-items>
            </out-items>
          </policy-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example adds the policy map to the output packets of an interface.

    An instance of the interface for QoS must be initialized before configuring QoS. The interface can be any of the following types:

    • ethernet - Ethernet IEEE 802.3z
    • loopback - Loopback interface
    • mgmt - Management interface
    • port-channel - Port Channel interface

    Note: Sub-interfaces and breakout ports for the above are also supported.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    interface eth 1/4
     service-policy type qos output foo

    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
    ipqosIf sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out/intf-{[name]}


    ipqosIf Properties

    The following table contains information about the ipqosIf 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
    namenw:IfId
    (base:IfIndex)
    Interface name in a short form. eth1/1 or pc1Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


    ipqosInst Properties

    The following table contains information about the ipqosInst 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
    nameipqos:PMapName
    (string:Basic)
    Policy-map Name
    MAX SIZE: 39
    statsscalar:Bool
    turn on/off statisticsSELECTION: true or false
    DEFAULT: true


    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

    QoS on the System

    QoS on the system (input)
    
    POST http://<mgmt0_IP>/api/mo/sys.json
    
    {
      "topSystem": {
        "children": [
    {
    "ipqosEntity": {
      "children": [
    {
      "ipqosQueuing": {
        "children": [
    {
    "ipqosServPol": {
      "children": [
    {
      "ipqosIngress": {
        "children": [
    {
    "ipqosSystem": {
      "attributes": {
        "userSetBit": "0"
    }}}]}},
    {
      "ipqosEgress": {
        "children": [
    {
    "ipqosSystem": {
      "attributes": {
        "userSetBit": "0"
    }}}]}}]}}]}},
    {
      "ipqosNwQoS": {
        "children": [
    {
    "ipqosServPol": {
      "children": [
    {
      "ipqosIngress": {
        "children": [
    {
    "ipqosSystem": {
      "attributes": {
        "userSetBit": "0"
    }}}]}},
    {
      "ipqosEgress": {
        "children": [
    {
    "ipqosSystem": {
      "attributes": {
        "userSetBit": "0"
    }}}]}}]}}]}},
    {
      "ipqosDefaultQoS": {
        "children": [
    {
    "ipqosServPol": {
      "children": [
    {
      "ipqosIngress": {
        "children": [
    {
    "ipqosSystem": {
      "children": [
    {
      "ipqosInst": {
        "attributes": {
          "name": "foo",
          "stats": "yes"
    }}}]}}]}}]}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <policy-items>
            <in-items>
              <sys-items>
                <userSetBit>0</userSetBit>
              </sys-items>
            </in-items>
            <out-items>
              <sys-items>
                <userSetBit>0</userSetBit>
              </sys-items>
            </out-items>
          </policy-items>
        </queuing-items>
        <nw-items>
          <policy-items>
            <in-items>
              <sys-items>
                <userSetBit>0</userSetBit>
              </sys-items>
            </in-items>
            <out-items>
              <sys-items>
                <userSetBit>0</userSetBit>
              </sys-items>
            </out-items>
          </policy-items>
        </nw-items>
        <dflt-items>
          <policy-items>
            <in-items>
              <sys-items>
                <pmap-items>
                  <name>foo</name>
                  <stats>true</stats>
                </pmap-items>
              </sys-items>
            </in-items>
          </policy-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

    This example has all nw, queuing and dos policies being applied at the system level.


    CLI Commands

    The CLI commands and options 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 or the YANG tab to view the XML payload.

    system qos
     service-policy type qos input foo

    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
    topSystem sys
    ipqosEntity sys/bd/vlanconfig-{[accEncap]}/ipqos
    ipqosQueuing sys/bd/vlanconfig-{[accEncap]}/ipqos/queuing
    ipqosServPol sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy
    ipqosServPol sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy
    ipqosServPol sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy
    ipqosIngress sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/in
    ipqosIngress sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/in
    ipqosIngress sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/in
    ipqosSystem sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out/sys
    ipqosSystem sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out/sys
    ipqosEgress sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out
    ipqosEgress sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt/policy/out
    ipqosNwQoS sys/bd/vlanconfig-{[accEncap]}/ipqos/nw
    ipqosDefaultQoS sys/bd/vlanconfig-{[accEncap]}/ipqos/dflt


    ipqosSystem Properties

    The following table contains information about the ipqosSystem 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
    userSetBit
    scalar:Uint64
    NO COMMENTSSELECTION:
  • 0ull - defaultValue
  • defaultValue: 0ull

  • ipqosInst Properties

    The following table contains information about the ipqosInst 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
    nameipqos:PMapName
    (string:Basic)
    Policy-map Name
    MAX SIZE: 39
    statsscalar:Bool
    turn on/off statisticsSELECTION: true or false
    DEFAULT: true


    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 Committed Information Rate

    Configuring the Committed Information Rate
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "PolMap1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "ClassMapA"
                    },
                    "children": [
                      {
                        "ipqosPolice": {
                          "attributes": {
                            "bcRate": "100",
                            "bcUnit": "bytes",
                            "beRate": "100",
                            "beUnit": "bytes",
                            "cirRate": "100",
                            "cirUnit": "bps",
                            "conformAction": "set-prec-transmit",
                            "conformSetCosTransmit": "0",
                            "conformSetDscpTransmit": "default",
                            "conformSetPrecTransmit": "priority",
                            "conformSetQosGrpTransmit": "0",
                            "exceedAction": "set-prec-transmit",
                            "exceedSetCosTransmit": "0",
                            "exceedSetDscpTransmit": "default",
                            "exceedSetPrecTransmit": "flash",
                            "exceedSetQosGrpTransmit": "0",
                            "pirRate": "100",
                            "pirUnit": "bps",
                            "violateAction": "set-prec-transmit",
                            "violateSetCosTransmit": "0",
                            "violateSetDscpTransmit": "default",
                            "violateSetPrecTransmit": "flash",
                            "violateSetQosGrpTransmit": "0"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>PolMap1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>ClassMapA</name>
                    <police-items>
                      <bcRate>100</bcRate>
                      <bcUnit>bytes</bcUnit>
                      <beRate>100</beRate>
                      <beUnit>bytes</beUnit>
                      <cirRate>100</cirRate>
                      <cirUnit>bps</cirUnit>
                      <conformAction>set-prec-transmit</conformAction>
                      <conformSetCosTransmit>0</conformSetCosTransmit>
                      <conformSetDscpTransmit>0</conformSetDscpTransmit>
                      <conformSetPrecTransmit>priority</conformSetPrecTransmit>
                      <conformSetQosGrpTransmit>0</conformSetQosGrpTransmit>
                      <exceedAction>set-prec-transmit</exceedAction>
                      <exceedSetCosTransmit>0</exceedSetCosTransmit>
                      <exceedSetDscpTransmit>0</exceedSetDscpTransmit>
                      <exceedSetPrecTransmit>flash</exceedSetPrecTransmit>
                      <exceedSetQosGrpTransmit>0</exceedSetQosGrpTransmit>
                      <pirRate>100</pirRate>
                      <pirUnit>bps</pirUnit>
                      <violateAction>set-prec-transmit</violateAction>
                      <violateSetCosTransmit>0</violateSetCosTransmit>
                      <violateSetDscpTransmit>0</violateSetDscpTransmit>
                      <violateSetPrecTransmit>flash</violateSetPrecTransmit>
                      <violateSetQosGrpTransmit>0</violateSetQosGrpTransmit>
                    </police-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 PolMap1
      class ClassMapA
       police cir 100 bps bc 100 bytes pir 100 bps be 100 bytes conform set-prec-transmit 1 exceed set-prec-transmit flash violate set-prec-transmit flash


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-PolMap1
    ipqosMatchCMap sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA
    ipqosPolice sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA/police


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPolice Properties

    The following table contains information about the ipqosPolice 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
    bcRateipqos:BurstRate
    (scalar:Uint64)
    CIR burst
    RANGE: [0 , 536870912]
    bcUnitipqos:BurstRateUnit
    (scalar:Enum8)
    CIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    beRateipqos:BurstRate
    (scalar:Uint64)
    PIR burst
    RANGE: [0 , 536870912]
    beUnitipqos:BurstRateUnit
    (scalar:Enum8)
    PIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    cirRateipqos:PoliceRate
    (scalar:Uint64)
    CIR
    RANGE: [0 , 100000000000]
    cirUnitipqos:RateUnit
    (scalar:Enum8)
    CIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    conformActionipqos:PoliceAction
    (scalar:Enum8)
    Conform actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    conformSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for conforming traffic
    RANGE: [0 , 7]
    conformSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for conforming traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    conformSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for conforming trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    conformSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for conforming traffic
    RANGE: [0 , 7]
    exceedActionipqos:PoliceAction
    (scalar:Enum8)
    Exceed actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    exceedSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for exceeding traffic
    RANGE: [0 , 7]
    exceedSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for exceeding traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    exceedSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for exceeding trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    exceedSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for exceeding traffic
    RANGE: [0 , 7]
    pirRateipqos:PoliceRate
    (scalar:Uint64)
    PIR
    RANGE: [0 , 100000000000]
    pirUnitipqos:RateUnit
    (scalar:Enum8)
    PIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    violateActionipqos:PoliceAction
    (scalar:Enum8)
    Violate actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    violateSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for violating traffic
    RANGE: [0 , 7]
    violateSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for violating traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    violateSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for violating trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    violateSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for violating traffic
    RANGE: [0 , 7]


    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 Committed Information Rate

    Deleting the Committed Information Rate
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "PolMap1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "ClassMapA"
                    },
                    "children": [
                      {
                        "ipqosPolice": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>PolMap1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>ClassMapA</name>
                    <police-items nc:operation="delete">
                    </police-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 PolMap1
      class ClassMapA
       no police cir 100 bps bc 100 bytes pir 100 bps be 100 bytes conform set-prec-transmit 1 exceed set-prec-transmit flash violate set-prec-transmit flash


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-PolMap1
    ipqosMatchCMap sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA
    ipqosPolice sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA/police


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPolice Properties

    The following table contains information about the ipqosPolice 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 the Rate as Percentage of Interface Data-Rate

    Configuring the Rate as Percentage of Interface Data-Rate
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "PolMap1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "ClassMapA"
                    },
                    "children": [
                      {
                        "ipqosPolice": {
                          "attributes": {
                            "bcRate": "100",
                            "bcUnit": "unspecified",
                            "beRate": "100",
                            "beUnit": "kbytes",
                            "cirRate": "100",
                            "cirUnit": "pct",
                            "conformAction": "transmit",
                            "conformSetCosTransmit": "0",
                            "conformSetDscpTransmit": "default",
                            "conformSetPrecTransmit": "routine",
                            "conformSetQosGrpTransmit": "0",
                            "exceedAction": "transmit",
                            "exceedSetCosTransmit": "0",
                            "exceedSetDscpTransmit": "default",
                            "exceedSetPrecTransmit": "routine",
                            "exceedSetQosGrpTransmit": "0",
                            "pirRate": "100",
                            "pirUnit": "gbps",
                            "violateAction": "drop",
                            "violateSetCosTransmit": "0",
                            "violateSetDscpTransmit": "default",
                            "violateSetPrecTransmit": "routine",
                            "violateSetQosGrpTransmit": "0"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>PolMap1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>ClassMapA</name>
                    <police-items>
                      <bcRate>100</bcRate>
                      <bcUnit>unspecified</bcUnit>
                      <beRate>100</beRate>
                      <beUnit>kbytes</beUnit>
                      <cirRate>100</cirRate>
                      <cirUnit>pct</cirUnit>
                      <conformAction>transmit</conformAction>
                      <conformSetCosTransmit>0</conformSetCosTransmit>
                      <conformSetDscpTransmit>0</conformSetDscpTransmit>
                      <conformSetPrecTransmit>routine</conformSetPrecTransmit>
                      <conformSetQosGrpTransmit>0</conformSetQosGrpTransmit>
                      <exceedAction>transmit</exceedAction>
                      <exceedSetCosTransmit>0</exceedSetCosTransmit>
                      <exceedSetDscpTransmit>0</exceedSetDscpTransmit>
                      <exceedSetPrecTransmit>routine</exceedSetPrecTransmit>
                      <exceedSetQosGrpTransmit>0</exceedSetQosGrpTransmit>
                      <pirRate>100</pirRate>
                      <pirUnit>gbps</pirUnit>
                      <violateAction>drop</violateAction>
                      <violateSetCosTransmit>0</violateSetCosTransmit>
                      <violateSetDscpTransmit>0</violateSetDscpTransmit>
                      <violateSetPrecTransmit>routine</violateSetPrecTransmit>
                      <violateSetQosGrpTransmit>0</violateSetQosGrpTransmit>
                    </police-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 PolMap1
      class ClassMapA
       police percent 100 bc 100 pir 100 gbps be 100 kbytes conform transmit exceed transmit violate drop


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-PolMap1
    ipqosMatchCMap sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA
    ipqosPolice sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA/police


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPolice Properties

    The following table contains information about the ipqosPolice 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
    bcRateipqos:BurstRate
    (scalar:Uint64)
    CIR burst
    RANGE: [0 , 536870912]
    bcUnitipqos:BurstRateUnit
    (scalar:Enum8)
    CIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    beRateipqos:BurstRate
    (scalar:Uint64)
    PIR burst
    RANGE: [0 , 536870912]
    beUnitipqos:BurstRateUnit
    (scalar:Enum8)
    PIR burst unitSELECTION:
    0 - unspecified
    1 - bytes
    2 - kbytes
    3 - mbytes
    4 - ms
    5 - us
    6 - packets
    DEFAULT: unspecified
    cirRateipqos:PoliceRate
    (scalar:Uint64)
    CIR
    RANGE: [0 , 100000000000]
    cirUnitipqos:RateUnit
    (scalar:Enum8)
    CIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    conformActionipqos:PoliceAction
    (scalar:Enum8)
    Conform actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    conformSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for conforming traffic
    RANGE: [0 , 7]
    conformSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for conforming traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    conformSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for conforming trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    conformSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for conforming traffic
    RANGE: [0 , 7]
    exceedActionipqos:PoliceAction
    (scalar:Enum8)
    Exceed actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    exceedSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for exceeding traffic
    RANGE: [0 , 7]
    exceedSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for exceeding traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    exceedSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for exceeding trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    exceedSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for exceeding traffic
    RANGE: [0 , 7]
    pirRateipqos:PoliceRate
    (scalar:Uint64)
    PIR
    RANGE: [0 , 100000000000]
    pirUnitipqos:RateUnit
    (scalar:Enum8)
    PIR unitSELECTION:
    0 - unspecified
    1 - bps
    2 - kbps
    3 - mbps
    4 - gbps
    5 - pps
    6 - pct
    DEFAULT: unspecified
    violateActionipqos:PoliceAction
    (scalar:Enum8)
    Violate actionSELECTION:
    0 - unspecified
    1 - transmit
    2 - drop
    3 - set-cos-transmit
    4 - set-dscp-transmit
    5 - set-prec-transmit
    6 - set-qos-transmit
    violateSetCosTransmitipqos:Cos
    (scalar:UByte)
    set cos for violating traffic
    RANGE: [0 , 7]
    violateSetDscpTransmitipqos:Dscp
    (scalar:UByte)
    set dscp for violating traffic
    RANGE: [0 , 63]
    DEFAULT: 0
    violateSetPrecTransmitipqos:Prec
    (scalar:Enum8)
    set precedence for violating trafficSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network
    violateSetQosGrpTransmitipqos:QoSGrpId
    (scalar:Uint16)
    set qos-group for violating traffic
    RANGE: [0 , 7]


    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 Rate as Percentage of Interface Data-Rate

    Deleting the Rate as Percentage of Interface Data-Rate
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "PolMap1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "ClassMapA"
                    },
                    "children": [
                      {
                        "ipqosPolice": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>PolMap1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>ClassMapA</name>
                    <police-items nc:operation="delete">
                    </police-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 PolMap1
      class ClassMapA
       no police percent 100 bc 100 pir 100 gbps be 100 kbytes conform transmit exceed transmit violate drop


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-PolMap1
    ipqosMatchCMap sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA
    ipqosPolice sys/ipqos/dflt/p/name-PolMap1/cmap-ClassMapA/police


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPolice Properties

    The following table contains information about the ipqosPolice 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 OOBST Burst-Detect Thresholds for the Class

    Configuring OOBST Burst-Detect Thresholds for the Class
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "newque-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "c-out-8q-q1"
                    },
                    "children": [
                      {
                        "ipqosBurstDetect": {
                          "attributes": {
                            "fallThresUnit": "bytes",
                            "fallThreshold": "40000",
                            "riseThresUnit": "bytes",
                            "riseThreshold": "4000000"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>newque-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q1</name>
                    <burstdetect-items>
                      <fallThresUnit>bytes</fallThresUnit>
                      <fallThreshold>40000</fallThreshold>
                      <riseThresUnit>bytes</riseThresUnit>
                      <riseThreshold>4000000</riseThreshold>
                    </burstdetect-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing newque-policy
      class type queuing c-out-8q-q1
       burst-detect rise-threshold 4000000 bytes fall-threshold 40000 bytes


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-newque-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-newque-policy/cmap-c-out-8q-q1
    ipqosBurstDetect sys/ipqos/queuing/p/name-newque-policy/cmap-c-out-8q-q1/burstdetect


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosBurstDetect Properties

    The following table contains information about the ipqosBurstDetect 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
    fallThresUnitipqos:ThresUnit
    (scalar:Enum8)
    Fall Threshold Unit for Micro burst detectionSELECTION:
    0 - none
    1 - bytes
    DEFAULT: none
    fallThresholdipqos:Threshold
    (scalar:Uint32)
    Fall Threshold value for Micro burst detection
    RANGE: [0 , 13319072]
    DEFAULT: 0
    riseThresUnitipqos:ThresUnit
    (scalar:Enum8)
    Rise Threshold Unit for Micro burst detectionSELECTION:
    0 - none
    1 - bytes
    DEFAULT: none
    riseThresholdipqos:Threshold
    (scalar:Uint32)
    Rise Threshold value for Micro burst detection
    RANGE: [0 , 13319072]
    DEFAULT: 0


    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 OOBST Burst-Detect Thresholds for the Class

    Deleting OOBST Burst-Detect Thresholds for the Class
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "newque-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "c-out-8q-q1"
                    },
                    "children": [
                      {
                        "ipqosBurstDetect": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>newque-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q1</name>
                    <burstdetect-items nc:operation="delete">
                    </burstdetect-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing newque-policy
      class type queuing c-out-8q-q1
       no burst-detect rise-threshold 4000000 bytes fall-threshold 40000 bytes


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-newque-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-newque-policy/cmap-c-out-8q-q1
    ipqosBurstDetect sys/ipqos/queuing/p/name-newque-policy/cmap-c-out-8q-q1/burstdetect


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosBurstDetect Properties

    The following table contains information about the ipqosBurstDetect 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 Traffic Class Priority

    Configuring Traffic Class Priority
    
    POST http://<mgmt0_IP>/api/mo/sys.json
    
    {
      "topSystem": {
        "children": [
          {
            "ipqosEntity": {
              "children": [
                {
                  "ipqosQueuing": {
                    "children": [
                      {
                        "ipqosPMapEntity": {
                          "children": [
                            {
                              "ipqosPMapInst": {
                                "attributes": {
                                  "matchType": "match-all",
                                  "name": "dme-policy"
                                },
                                "children": [
                                  {
                                    "ipqosMatchCMap": {
                                      "attributes": {
                                        "name": "c-out-8q-q1"
                                      },
                                      "children": [
                                        {
                                          "ipqosPriority": {
                                            "attributes": {
                                              "level": "1"
                                            }
                                          }
                                        },
                                        {
                                          "ipqosSetBW": {
                                            "attributes": {
                                              "val": "50"
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>dme-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q1</name>
                    <prio-items>
                      <level>1</level>
                    </prio-items>
                    <setBW-items>
                      <val>50</val>
                    </setBW-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing dme-policy
      class type queuing c-out-8q-q1
       bandwidth percent 50
        priority


    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
    topSystem sys
    ipqosEntity sys/ipqos
    ipqosQueuing sys/ipqos/queuing
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-dme-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1
    ipqosPriority sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1/prio
    ipqosSetBW sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1/setBW


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPriority Properties

    The following table contains information about the ipqosPriority 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
    levelipqos:PriorityLevel
    (scalar:UByte)
    Optional priority level
    RANGE: [1 , 3]


    ipqosSetBW Properties

    The following table contains information about the ipqosSetBW 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:Percent
    (scalar:UByte)
    Available bandwidth
    RANGE: [0 , 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 Traffic Class Priority

    Deleting the Traffic Class Priority
    
    POST http://<mgmt0_IP>/api/mo/sys.json
    
    {
      "topSystem": {
        "children": [
          {
            "ipqosEntity": {
              "children": [
                {
                  "ipqosQueuing": {
                    "children": [
                      {
                        "ipqosPMapEntity": {
                          "children": [
                            {
                              "ipqosPMapInst": {
                                "attributes": {
                                  "matchType": "match-all",
                                  "name": "dme-policy"
                                },
                                "children": [
                                  {
                                    "ipqosMatchCMap": {
                                      "attributes": {
                                        "name": "c-out-8q-q1"
                                      },
                                      "children": [
                                        {
                                          "ipqosPriority": {
                                            "attributes": {
                                              "status": "deleted"
                                            }
                                          }
                                        },
                                        {
                                          "ipqosSetBW": {
                                            "attributes": {
                                              "val": "50"
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>dme-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q1</name>
                    <prio-items nc:operation="delete">
                    </prio-items>
                    <setBW-items>
                      <val>50</val>
                    </setBW-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing dme-policy
      class type queuing c-out-8q-q1
       bandwidth percent 50
        no priority


    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
    topSystem sys
    ipqosEntity sys/ipqos
    ipqosQueuing sys/ipqos/queuing
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-dme-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1
    ipqosPriority sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1/prio
    ipqosSetBW sys/ipqos/queuing/p/name-dme-policy/cmap-c-out-8q-q1/setBW


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPriority Properties

    The following table contains information about the ipqosPriority 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    ipqosSetBW Properties

    The following table contains information about the ipqosSetBW 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:Percent
    (scalar:UByte)
    Available bandwidth
    RANGE: [0 , 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 Queue Size for the Class

    Configuring the Queue Size for the Class 
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosQueueLimit": {
                          "attributes": {
                            "QueueLimitUnit": "none",
                            "QueueLimitVal": "none",
                            "dynamic": "0"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <QueueLimit-items>
                      <QueueLimitUnit>none</QueueLimitUnit>
                      <QueueLimitVal>12582913</QueueLimitVal>
                      <dynamic>0</dynamic>
                    </QueueLimit-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing q-policy
      class type queuing test-dme
       queue-limit dynamic 0

    /exec/configure/policy-map/type/uf/class


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-q-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-q-policy/cmap-test-dme
    ipqosQueueLimit sys/ipqos/queuing/p/name-q-policy/cmap-test-dme/QueueLimit


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosQueueLimit Properties

    The following table contains information about the ipqosQueueLimit 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
    QueueLimitUnitipqos:QueueLimitUnit
    (scalar:Enum8)
    Bytes/kbytes/mbytesSELECTION:
    0 - none
    1 - packets
    2 - bytes
    3 - kbytes
    4 - mbytes
    5 - gbytes
    6 - ms
    7 - us
    8 - perc
    DEFAULT: none
    QueueLimitValipqos:QueueLimit
    (scalar:Uint64)
    Value in bytes/kbytes/mbytes
    RANGE: [0 , 12582912]
    DEFAULT: 0
    dynamicipqos:QueueLimitDynamic
    (scalar:UByte)
    Queue-limit dynamic value
    RANGE: [0 , 10]


    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 Queue Size for the Class

    Deleting the Queue Size for the Class 
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosQueueLimit": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <QueueLimit-items nc:operation="delete">
                    </QueueLimit-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing q-policy
      class type queuing test-dme
       no queue-limit dynamic 0


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-q-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-q-policy/cmap-test-dme
    ipqosQueueLimit sys/ipqos/queuing/p/name-q-policy/cmap-test-dme/QueueLimit


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosQueueLimit Properties

    The following table contains information about the ipqosQueueLimit 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 the Queue Desired for AFD

    Configuring the Queue Desired for AFD
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "aj-8q-out"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "c-out-8q-q4"
                    },
                    "children": [
                      {
                        "ipqosAfd": {
                          "attributes": {
                            "ecn": "no",
                            "queueDesiredUnit": "bytes",
                            "queueDesiredVal": "100"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>aj-8q-out</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q4</name>
                    <afd-items>
                      <ecn>false</ecn>
                      <queueDesiredUnit>bytes</queueDesiredUnit>
                      <queueDesiredVal>100</queueDesiredVal>
                    </afd-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing aj-8q-out
      class type queuing c-out-8q-q4
       afd queue-desired 100 bytes


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-aj-8q-out
    ipqosMatchCMap sys/ipqos/queuing/p/name-aj-8q-out/cmap-c-out-8q-q4
    ipqosAfd sys/ipqos/queuing/p/name-aj-8q-out/cmap-c-out-8q-q4/afd


    ipqosAfd Properties

    The following table contains information about the ipqosAfd 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
    ecnscalar:Bool
    Approximate Fair Discard ECN flagSELECTION: true or false
    queueDesiredUnitipqos:QueueDesiredUnit
    (scalar:Enum8)
    Units for Approximate Fair Discard valueSELECTION:
    0 - none
    1 - bytes
    2 - kbytes
    3 - mbytes
    DEFAULT: none
    queueDesiredValipqos:QueueDesired
    (scalar:Uint64)
    Approximate Fair Discard value
    RANGE: [1 , 52428800]


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    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 Queue Desired for AFD

    Deleting the Queue Desired for AFD
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "aj-8q-out"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "c-out-8q-q4"
                    },
                    "children": [
                      {
                        "ipqosAfd": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>aj-8q-out</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>c-out-8q-q4</name>
                    <afd-items nc:operation="delete">
                    </afd-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing aj-8q-out
      class type queuing c-out-8q-q4
       no afd queue-desired 100 bytes


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-aj-8q-out
    ipqosMatchCMap sys/ipqos/queuing/p/name-aj-8q-out/cmap-c-out-8q-q4
    ipqosAfd sys/ipqos/queuing/p/name-aj-8q-out/cmap-c-out-8q-q4/afd


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosAfd Properties

    The following table contains information about the ipqosAfd 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 a QoS Group Match

    Configuring a QoS Group Match
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/c.json
    
    {
      "ipqosCMapEntity": {
        "children": [
          {
            "ipqosCMapInst": {
              "attributes": {
                "matchType": "match-any",
                "name": "test-dme"
              },
              "children": [
                {
                  "ipqosQoSGrp": {
                    "attributes": {
                      "id": "1"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <c-items>
            <name-items>
              <CMapInst-list>
                <name>test-dme</name>
                <matchType>match-any</matchType>
                <grp-items>
                  <QoSGrp-list>
                    <id>1</id>
                  </QoSGrp-list>
                </grp-items>
              </CMapInst-list>
            </name-items>
          </c-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing test-dme
      match qos-group 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
    ipqosCMapEntity sys/ipqos/queuing/c
    ipqosCMapInst sys/ipqos/queuing/c/name-test-dme
    ipqosQoSGrp sys/ipqos/queuing/c/name-test-dme/grp-1


    ipqosCMapInst Properties

    The following table contains information about the ipqosCMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:CMapName
    (string:Basic)
    Name of class-map
    MAX SIZE: 39


    ipqosQoSGrp Properties

    The following table contains information about the ipqosQoSGrp 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
    idipqos:CMapQoSGrpId
    (scalar:Uint16)
    QoS group ID
    RANGE: [1 , 7]


    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 QoS Group Match

    Deleting a QoS Group Match
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/c.json
    
    {
      "ipqosCMapEntity": {
        "children": [
          {
            "ipqosCMapInst": {
              "attributes": {
                "matchType": "match-any",
                "name": "test-dme"
              },
              "children": [
                {
                  "ipqosQoSGrp": {
                    "attributes": {
                      "id": "1",
                      "status": "deleted"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <c-items>
            <name-items>
              <CMapInst-list>
                <name>test-dme</name>
                <matchType>match-any</matchType>
                <grp-items>
                  <QoSGrp-list nc:operation="delete">
                    <id>1</id>
                  </QoSGrp-list>
                </grp-items>
              </CMapInst-list>
            </name-items>
          </c-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing test-dme
      no match qos-group 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
    ipqosCMapEntity sys/ipqos/queuing/c
    ipqosCMapInst sys/ipqos/queuing/c/name-test-dme
    ipqosQoSGrp sys/ipqos/queuing/c/name-test-dme/grp-1


    ipqosCMapInst Properties

    The following table contains information about the ipqosCMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:CMapName
    (string:Basic)
    Name of class-map
    MAX SIZE: 39


    ipqosQoSGrp Properties

    The following table contains information about the ipqosQoSGrp 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
    idipqos:CMapQoSGrpId
    (scalar:Uint16)
    QoS group ID
    RANGE: [1 , 7]
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 the Pause and Resume Threshold Buffer Limits in Bytes

    Configuring the Pause and Resume Threshold Buffer Limits in Bytes
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "inq-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosPause": {
                          "attributes": {
                            "bufferSize": "30000",
                            "noDrop": "no",
                            "pauseThreshold": "13000",
                            "pfcCos0": "no",
                            "pfcCos1": "no",
                            "pfcCos2": "no",
                            "pfcCos3": "no",
                            "pfcCos4": "no",
                            "pfcCos5": "no",
                            "pfcCos6": "no",
                            "pfcCos7": "no",
                            "receive": "no",
                            "resumeThreshold": "3000"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>inq-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <pause-items>
                      <bufferSize>30000</bufferSize>
                      <noDrop>false</noDrop>
                      <pauseThreshold>13000</pauseThreshold>
                      <pfcCos0>false</pfcCos0>
                      <pfcCos1>false</pfcCos1>
                      <pfcCos2>false</pfcCos2>
                      <pfcCos3>false</pfcCos3>
                      <pfcCos4>false</pfcCos4>
                      <pfcCos5>false</pfcCos5>
                      <pfcCos6>false</pfcCos6>
                      <pfcCos7>false</pfcCos7>
                      <receive>false</receive>
                      <resumeThreshold>3000</resumeThreshold>
                    </pause-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing inq-policy
      class type queuing test-dme
       pause buffer-size 30000 pause-threshold 13000 resume-threshold 3000


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-inq-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-inq-policy/cmap-test-dme
    ipqosPause sys/ipqos/queuing/p/name-inq-policy/cmap-test-dme/pause


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPause Properties

    The following table contains information about the ipqosPause 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
    bufferSizeipqos:BuffSize
    (scalar:Uint64)
    size in bytes
    RANGE: [5000 , 12582913]
    DEFAULT: 12582913
    noDropscalar:Bool
    Configure pause no-drop modeSELECTION: true or false
    pauseThresholdipqos:XoffBytes
    (scalar:Uint64)
    xoff bytes
    RANGE: [0 , 12582912]
    pfcCos0scalar:Bool
    Configure pfc-cos 0 valueSELECTION: true or false
    pfcCos1scalar:Bool
    Configure pfc-cos 1 valueSELECTION: true or false
    pfcCos2scalar:Bool
    Configure pfc-cos 2 valueSELECTION: true or false
    pfcCos3scalar:Bool
    Configure pfc-cos 3 valueSELECTION: true or false
    pfcCos4scalar:Bool
    Configure pfc-cos 4 valueSELECTION: true or false
    pfcCos5scalar:Bool
    Configure pfc-cos 5 valueSELECTION: true or false
    pfcCos6scalar:Bool
    Configure pfc-cos 6 valueSELECTION: true or false
    pfcCos7scalar:Bool
    Configure pfc-cos 7 valueSELECTION: true or false
    receivescalar:Bool
    Configure pause receive only modeSELECTION: true or false
    resumeThresholdipqos:XonBytes
    (scalar:Uint64)
    xon bytes
    RANGE: [0 , 12582912]


    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 Pause and Resume Threshold Buffer Limits in Bytes

    Deleting the Pause and Resume Threshold Buffer Limits in Bytes
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "inq-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosPause": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>inq-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <pause-items nc:operation="delete">
                    </pause-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing inq-policy
      class type queuing test-dme
       no pause buffer-size 30000 pause-threshold 13000 resume-threshold 3000


    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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-inq-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-inq-policy/cmap-test-dme
    ipqosPause sys/ipqos/queuing/p/name-inq-policy/cmap-test-dme/pause


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPause Properties

    The following table contains information about the ipqosPause 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 an Ingress Priority-Group to which the Traffic is Mapped and Pause Limits are Applied

    Configuring an Ingress Priority-Group to which the Traffic is Mapped and Pause Limits are Applied
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosPausePg": {
                          "attributes": {
                            "val": "1"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <pausepg-items>
                      <val>1</val>
                    </pausepg-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing q-policy
      class type queuing test-dme
       pause priority-group 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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-q-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-q-policy/cmap-test-dme
    ipqosPausePg sys/ipqos/queuing/p/name-q-policy/cmap-test-dme/pausepg


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPausePg Properties

    The following table contains information about the ipqosPausePg 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:PriorityGrpVal
    (scalar:Enum8)
    Priority Group valueSELECTION:
    0 - 0
    1 - 1
    2 - 2
    3 - 3
    4 - 4
    5 - 5
    None
    DEFAULT: None


    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 an Ingress Priority-Group to which the Traffic is Mapped and Pause Limits are Applied

    Deleting an Ingress Priority-Group to which the Traffic is Mapped and Pause Limits are Applied
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/queuing/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q-policy"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "test-dme"
                    },
                    "children": [
                      {
                        "ipqosPausePg": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <queuing-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q-policy</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>test-dme</name>
                    <pausepg-items nc:operation="delete">
                    </pausepg-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </queuing-items>
      </ipqos-items>
    </System>
    

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


    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 queuing q-policy
      class type queuing test-dme
       no pause priority-group 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
    ipqosPMapEntity sys/ipqos/queuing/p
    ipqosPMapInst sys/ipqos/queuing/p/name-q-policy
    ipqosMatchCMap sys/ipqos/queuing/p/name-q-policy/cmap-test-dme
    ipqosPausePg sys/ipqos/queuing/p/name-q-policy/cmap-test-dme/pausepg


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPausePg Properties

    The following table contains information about the ipqosPausePg 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 IEEE 802.1Q Class of Service

    Configuring IEEE 802.1Q Class of Service
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetCos": {
                          "attributes": {
                            "val": "1"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setCos-items>
                      <val>1</val>
                    </setCos-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set cos 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetCos sys/ipqos/dflt/p/name-q1/cmap-class-default/setCos


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosSetCos Properties

    The following table contains information about the ipqosSetCos 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:CosNewNone
    (scalar:Enum8)
    Cos valueSELECTION:
    0 - 0
    1 - 1
    2 - 2
    3 - 3
    4 - 4
    5 - 5
    6 - 6
    7 - 7
    DEFAULT: None


    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 IEEE 802.1Q Class of Service

    Deleting IEEE 802.1Q Class of Service
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetCos": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setCos-items nc:operation="delete">
                    </setCos-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set cos 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetCos sys/ipqos/dflt/p/name-q1/cmap-class-default/setCos


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetCos Properties

    The following table contains information about the ipqosSetCos 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 Disable Dynamic Load Balancing

    Configuring Disable Dynamic Load Balancing
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetDlbDisable": {
                          "attributes": {
                            "uid": "0"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setDlbDisable-items>
                      <uid>0</uid>
                    </setDlbDisable-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set dlb-disable


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetDlbDisable sys/ipqos/dflt/p/name-q1/cmap-class-default/setDlbDisable


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetDlbDisable Properties

    The following table contains information about the ipqosSetDlbDisable 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
    uid
    scalar:Uint16
    A unique identifier for this object.


    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 Disabled Dynamic Load Balancing

    Deleting Disabled Dynamic Load Balancing
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetDlbDisable": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setDlbDisable-items nc:operation="delete">
                    </setDlbDisable-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set dlb-disable


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetDlbDisable sys/ipqos/dflt/p/name-q1/cmap-class-default/setDlbDisable


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetDlbDisable Properties

    The following table contains information about the ipqosSetDlbDisable 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 DSCP in Tunnel Encapsulation

    Configuring DSCP in Tunnel Encapsulation
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetDscp": {
                          "attributes": {
                            "tunnel": "yes",
                            "val": "63"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setDscp-items>
                      <tunnel>true</tunnel>
                      <val>63</val>
                    </setDscp-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set dscp tunnel 63


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetDscp sys/ipqos/dflt/p/name-q1/cmap-class-default/setDscp


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetDscp Properties

    The following table contains information about the ipqosSetDscp 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
    tunnelscalar:Bool
    tunnel on or offSELECTION: true or false
    valipqos:Dscp
    (scalar:UByte)
    Dscp value
    RANGE: [0 , 63]
    DEFAULT: 0


    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 DSCP in Tunnel Encapsulation

    Deleting DSCP in Tunnel Encapsulation
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set dscp tunnel 63


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    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 AF12 DSCP (001100)

    Configuring AF12 DSCP (001100)
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetDscp": {
                          "attributes": {
                            "tunnel": "yes",
                            "val": "af12"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setDscp-items>
                      <tunnel>true</tunnel>
                      <val>12</val>
                    </setDscp-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set dscp tunnel af12


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetDscp sys/ipqos/dflt/p/name-q1/cmap-class-default/setDscp


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetDscp Properties

    The following table contains information about the ipqosSetDscp 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
    tunnelscalar:Bool
    tunnel on or offSELECTION: true or false
    valipqos:Dscp
    (scalar:UByte)
    Dscp value
    RANGE: [0 , 63]
    DEFAULT: 0


    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 AF12 DSCP (001100)

    Deleting AF12 DSCP (001100)
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set dscp tunnel af12


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    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 Push the Label and Set New One on Top

    Configuring to Push the Label and Set New One on Top
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetMplsExperimentalImposition": {
                          "attributes": {
                            "expValue": "1"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setmplsexpimposition-items>
                      <expValue>1</expValue>
                    </setmplsexpimposition-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set mpls experimental imposition 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetMplsExperimentalImposition sys/ipqos/dflt/p/name-q1/cmap-class-default/setmplsexpimposition


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetMplsExperimentalImposition Properties

    The following table contains information about the ipqosSetMplsExperimentalImposition 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
    expValueipqos:MplsExperimentalValue
    (scalar:Enum8)
    Set mpls experimental imposition valueSELECTION:
    0 - 0
    1 - 1
    2 - 2
    3 - 3
    4 - 4
    5 - 5
    6 - 6
    7 - 7
    DEFAULT: None


    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 Push the Label and Set New One on Top

    Deleting the Config to Push the Label and Set New One on Top
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetMplsExperimentalImposition": {
                          "attributes": {
                            "status": "deleted"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setmplsexpimposition-items nc:operation="delete">
                    </setmplsexpimposition-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set mpls experimental imposition 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetMplsExperimentalImposition sys/ipqos/dflt/p/name-q1/cmap-class-default/setmplsexpimposition


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetMplsExperimentalImposition Properties

    The following table contains information about the ipqosSetMplsExperimentalImposition 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
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    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 the Immediate Precedence

    Configuring the Immediate Precedence
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetPrecedence": {
                          "attributes": {
                            "tunnel": "yes",
                            "val": "immediate"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setPrecedence-items>
                      <tunnel>true</tunnel>
                      <val>immediate</val>
                    </setPrecedence-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set precedence tunnel immediate


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetPrecedence sys/ipqos/dflt/p/name-q1/cmap-class-default/setPrecedence


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetPrecedence Properties

    The following table contains information about the ipqosSetPrecedence 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
    tunnelscalar:Bool
    tunnel on or offSELECTION: true or false
    valipqos:Prec
    (scalar:Enum8)
    Precedence valueSELECTION:
    0 - routine
    1 - priority
    2 - immediate
    3 - flash
    4 - flash-override
    5 - critical
    6 - internet
    7 - network


    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

    Unconfiguring the Immediate Precedence

    Unconfiguring the Immediate Precedence
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set precedence tunnel immediate


    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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    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 QoS Group

    Configuring the QoS Group
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
                    },
                    "children": [
                      {
                        "ipqosSetQoSGrp": {
                          "attributes": {
                            "id": "1"
    }}}]}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                    <setGrp-items>
                      <id>1</id>
                    </setGrp-items>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       set qos-group 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default
    ipqosSetQoSGrp sys/ipqos/dflt/p/name-q1/cmap-class-default/setGrp


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    ipqosSetQoSGrp Properties

    The following table contains information about the ipqosSetQoSGrp 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
    idipqos:QoSGrpId
    (scalar:Uint16)
    QoS group ID
    RANGE: [0 , 7]


    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 QoS Group

    Deleting the QoS Group
    
    POST http://<mgmt0_IP>/api/mo/sys/ipqos/dflt/p.json
    
    {
      "ipqosPMapEntity": {
        "children": [
          {
            "ipqosPMapInst": {
              "attributes": {
                "matchType": "match-all",
                "name": "q1"
              },
              "children": [
                {
                  "ipqosMatchCMap": {
                    "attributes": {
                      "name": "class-default"
    }}}]}}]}}
    
    {
        imdata:[]
    }
    
    <System>
      <ipqos-items>
        <dflt-items>
          <p-items>
            <name-items>
              <PMapInst-list>
                <name>q1</name>
                <matchType>match-all</matchType>
                <cmap-items>
                  <MatchCMap-list>
                    <name>class-default</name>
                  </MatchCMap-list>
                </cmap-items>
              </PMapInst-list>
            </name-items>
          </p-items>
        </dflt-items>
      </ipqos-items>
    </System>
    

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


    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 q1
      class class-default
       no set qos-group 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
    ipqosPMapEntity sys/ipqos/dflt/p
    ipqosPMapInst sys/ipqos/dflt/p/name-q1
    ipqosMatchCMap sys/ipqos/dflt/p/name-q1/cmap-class-default


    ipqosPMapInst Properties

    The following table contains information about the ipqosPMapInst 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
    matchTypeipqos:QoSMatchType
    (scalar:Enum8)
    Match-any, match-all or match-firstSELECTION:
    0 - match-any
    1 - match-all
    2 - match-first
    DEFAULT: match-all
    nameipqos:PMapName
    (string:Basic)
    Name of policy-map
    MAX SIZE: 39


    ipqosMatchCMap Properties

    The following table contains information about the ipqosMatchCMap 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
    nameipqos:CMapName
    (string:Basic)
    Match using class-map
    MAX SIZE: 39


    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