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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Priority Flow Control in Auto Mode

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/intf.json
{
  "interfaceEntity": {
    "children": [
      {
        "l1PhysIf": {
          "attributes": {
            "id": "eth1/2"
          },
          "children": [
            {
              "ipqosPriorFlowCtrl": {
                "attributes": {
                  "mode": "auto",
                  "send_tlv": "no"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <priorflowctrl-items>
          <mode>0</mode>
          <send_tlv>false</send_tlv>
        </priorflowctrl-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring Priority Flow Control on an Ethernet Interface

Configuring Priority Flow Control in Auto Mode

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.

interface eth1/2
priority-flow-control mode auto

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrl	sys/intf/phys-[eth1/2]/priorflowctrl

l1PhysIf Properties

The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrl Properties

The following table contains information about the ipqosPriorFlowCtrl properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
mode	ipqos:PriorFlowCtrlMode (scalar:UByte)	priority-flow-control mode on/off/auto	SELECTION: 0 - auto 1 - on 2 - off DEFAULT: 0
send_tlv	scalar:Bool	send\_tlv used for sending dcbx pfc tlv when pfc mode is on	SELECTION: true or false DEFAULT: false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Forcing Priority Flow Control Off

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

CLI Commands

interface eth1/2
priority-flow-control mode off

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrl	sys/intf/phys-[eth1/2]/priorflowctrl

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrl Properties

Property Name	Data Type	Description	Values
mode	ipqos:PriorFlowCtrlMode (scalar:UByte)	priority-flow-control mode on/off/auto	SELECTION: 0 - auto 1 - on 2 - off DEFAULT: 0
send_tlv	scalar:Bool	send\_tlv used for sending dcbx pfc tlv when pfc mode is on	SELECTION: true or false DEFAULT: false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring DCBX TLV for PFC

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

CLI Commands

interface eth1/2
priority-flow-control mode on send-tlv

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrl	sys/intf/phys-[eth1/2]/priorflowctrl

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrl Properties

Property Name	Data Type	Description	Values
mode	ipqos:PriorFlowCtrlMode (scalar:UByte)	priority-flow-control mode on/off/auto	SELECTION: 0 - auto 1 - on 2 - off DEFAULT: 0
send_tlv	scalar:Bool	send\_tlv used for sending dcbx pfc tlv when pfc mode is on	SELECTION: true or false DEFAULT: false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring PFC Watch-Dog Interval to On

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

CLI Commands

interface eth1/2
priority-flow-control watch-dog-interval on

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrlWd	sys/intf/phys-[eth1/2]/priorflowctrlwd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrlWd Properties

The following table contains information about the ipqosPriorFlowCtrlWd properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
disableAction	scalar:Bool	only generate syslog for stuck queue, no action	SELECTION: true or false DEFAULT: false
interfaceMutiplier	ipqos:PriorFlowCtrlWdIntfMulti (scalar:UByte)	shutdown mutlipler value	RANGE: [1 , 11] DEFAULT: 11
watchDogInterval	ipqos:PriorFlowCtrlWdIntvl (scalar:UByte)	watch dog internal on/off	SELECTION: 1 - on 2 - off (Default)

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 PFC Watch-Dog Interval to Off

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

CLI Commands

interface eth1/2
priority-flow-control watch-dog-interval off

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrlWd	sys/intf/phys-[eth1/2]/priorflowctrlwd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
disableAction	scalar:Bool	only generate syslog for stuck queue, no action	SELECTION: true or false DEFAULT: false
interfaceMutiplier	ipqos:PriorFlowCtrlWdIntfMulti (scalar:UByte)	shutdown mutlipler value	RANGE: [1 , 11] DEFAULT: 11
watchDogInterval	ipqos:PriorFlowCtrlWdIntvl (scalar:UByte)	watch dog internal on/off	SELECTION: 1 - on 2 - off (Default)

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 PFC Watch-Dog Interval

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

CLI Commands

interface eth1/2
no priority-flow-control watch-dog-interval on

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrlWd	sys/intf/phys-[eth1/2]/priorflowctrlwd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
status	mo: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 Priorty Flow Control, Disable Action, and Shutdown Multiplier

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

CLI Commands

interface eth1/2
priority-flow-control watch-dog-interval on disable-action interface-multiplier 7

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrlWd	sys/intf/phys-[eth1/2]/priorflowctrlwd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
disableAction	scalar:Bool	only generate syslog for stuck queue, no action	SELECTION: true or false DEFAULT: false
interfaceMutiplier	ipqos:PriorFlowCtrlWdIntfMulti (scalar:UByte)	shutdown mutlipler value	RANGE: [1 , 11] DEFAULT: 11
watchDogInterval	ipqos:PriorFlowCtrlWdIntvl (scalar:UByte)	watch dog internal on/off	SELECTION: 1 - on 2 - off (Default)

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 Priorty Flow Control, Disable Action, and Shutdown Multiplier

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

CLI Commands

interface eth1/2
no priority-flow-control watch-dog-interval on disable-action interface-multiplier 7

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]
ipqosPriorFlowCtrlWd	sys/intf/phys-[eth1/2]/priorflowctrlwd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

ipqosPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
status	mo: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

Disabling Statistics for a Policy

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

CLI Commands

interface eth1/2
service-policy type qos output pmap_name no-stats

Verifying a DME Configuration

MO	DN
topSystem	sys
ipqosEntity	sys/ipqos
ipqosDefaultQoS	sys/ipqos/dflt
ipqosServPol	sys/ipqos/dflt/policy
ipqosEgress	sys/ipqos/dflt/policy/out
ipqosIf	sys/ipqos/dflt/policy/out/intf-[eth1/2]
ipqosInst	sys/ipqos/dflt/policy/out/intf-[eth1/2]/pmap
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

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 Name	Data Type	Description	Values
name	nw:IfId (base:IfIndex)	Interface name in a short form. eth1/1 or pc1	Must 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 Name	Data Type	Description	Values
name	ipqos:PMapName (string:Basic)	Policy-map Name	MAX SIZE: 39
stats	scalar:Bool	turn on/off statistics	SELECTION: true or false DEFAULT: true

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Enabling Statistics

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

CLI Commands

interface eth1/2
no service-policy type qos output pmap_name

Verifying a DME Configuration

MO	DN
topSystem	sys
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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