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 Fixed Restore Multiplier

DME

YANG

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

Copy
<System>
  <pltfm-items>
    <priorflowctrlwd-items>
      <fixedRestoreMultiplier>1</fixedRestoreMultiplier>
    </priorflowctrlwd-items>
  </pltfm-items>
</System>

Configuring Priority Flow Control

You can configure PFC on a per-port basis to enable the no-drop behavior for the CoS as defined by the active network QoS policy. PFC can be configured in one of these modes:

auto—Enables the no-drop CoS values to be advertised by the DCBXP and negotiated with the peer. A successful negotiation enables PFC on the no-drop CoS. Any failures because of a mismatch in the capability of peers causes the PFC not to be enabled. (7.0(3)I3(1) and later)
on—Enables PFC on the local port regardless of the capability of the peers.
off—Disables PFC on the local port.

For more information, see the Cisco Nexus 9000 Series NX-OS Quality of Service Configuration Guide.

Configuring Fixed Restore Multiplier

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.

priority-flow-control fixed-restore multiplier 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.

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

The following table contains information about the platformPriorFlowCtrlWd 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
fixedRestoreMultiplier	scalar:UByte	PFC WD Fixed shutdown multiplier	RANGE: [0 , 100] 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 Fixed Restore Multiplier

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

CLI Commands

no priority-flow-control fixed-restore multiplier 1

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
fixedRestoreMultiplier	scalar:UByte	PFC WD Fixed shutdown multiplier	RANGE: [0 , 100] 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 the Watch Dog Interval

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

CLI Commands

priority-flow-control watch-dog interval 305

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
interval	scalar:Uint16	PFC WD poll interval	RANGE: [100 , 1000] DEFAULT: 100

Related Documentation

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

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

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

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

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

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

Deleting the Watch Dog Interval

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

CLI Commands

no priority-flow-control watch-dog interval 305

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
interval	scalar:Uint16	PFC WD poll interval	RANGE: [100 , 1000] DEFAULT: 100

Related Documentation

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

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

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

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

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

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

Configuring the Auto-Restore Multiplier

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

CLI Commands

priority-flow-control auto-restore multiplier 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.

MO	DN
topSystem	sys
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
autoRestoreMultiplier	scalar:UByte	PFC WD Auto shutdown multiplier	RANGE: [0 , 100] DEFAULT: 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 Auto-Restore Multiplier

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

CLI Commands

no priority-flow-control auto-restore multiplier 1

MO	DN
topSystem	sys
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
autoRestoreMultiplier	scalar:UByte	PFC WD Auto shutdown multiplier	RANGE: [0 , 100] DEFAULT: 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

Configuring a Shutdown Multiplier

Configuring a Shutdown Muliplier

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

CLI Commands

priority-flow-control watch-dog shutdown-multiplier 9

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
shutdownMultiplier	scalar:UByte	PFC WD Shutdown multiplier	RANGE: [1 , 10] DEFAULT: 1

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 Shutdown Multiplier

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

CLI Commands

no priority-flow-control watch-dog shutdown-multiplier 9

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
shutdownMultiplier	scalar:UByte	PFC WD Shutdown multiplier	RANGE: [1 , 10] DEFAULT: 1

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 global PFCWatch-dog forced-on mode

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

CLI Commands

`priority-flow-control watch-dog forced on

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
forcedOn	platform:ConfigOnOff (scalar:Enum8)	PFC WD forced on	SELECTION: 0 - off 1 - on DEFAULT: off

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 global PFCWatch-dog forced-on mode

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

CLI Commands

no priority-flow-control watch-dog forced on

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
forcedOn	platform:ConfigOnOff (scalar:Enum8)	PFC WD forced on	SELECTION: 0 - off 1 - on DEFAULT: off

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

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

CLI Commands

priority-flow-control watch-dog-interval on

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
cfgMode	platform:ConfigOnOff (scalar:Enum8)	PFC WD enabled	SELECTION: 0 - off 1 - on DEFAULT: off

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

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

CLI Commands

no priority-flow-control watch-dog-interval on

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
cfgMode	platform:ConfigOnOff (scalar:Enum8)	PFC WD enabled	SELECTION: 0 - off 1 - on DEFAULT: off

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 Internal Interface Multiplier

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

CLI Commands

priority-flow-control watch-dog internal-interface-multiplier 1

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
internalIntfMultiplier	scalar:UByte	PFC WD Internal interface multiplier	RANGE: [0 , 10] DEFAULT: 2

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 Internal Interface Multiplier

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

CLI Commands

no priority-flow-control watch-dog internal-interface-multiplier 1

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformPriorFlowCtrlWd	sys/pltfm/priorflowctrlwd

platformPriorFlowCtrlWd Properties

Property Name	Data Type	Description	Values
internalIntfMultiplier	scalar:UByte	PFC WD Internal interface multiplier	RANGE: [0 , 10] DEFAULT: 2

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 Shared Pool Buffer Reservation

CLI Commands

hardware profile pfc mmu buffer-reservation 45

MO	DN
platformPfcMmuBuffer	sys/pltfm/pfcmmubuffer

platformPfcMmuBuffer Properties

The following table contains information about the platformPfcMmuBuffer 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
bufferReservation	platform:pfcMmuBufferRes (scalar:Uint16)	Percentage of shared pool buffers to be reserved	RANGE: [0 , 100] DEFAULT: 5

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 Shared Pool Buffer Reservation

CLI Commands

no hardware profile pfc mmu buffer-reservation 45

MO	DN
platformPfcMmuBuffer	sys/pltfm/pfcmmubuffer

platformPfcMmuBuffer Properties

Property Name	Data Type	Description	Values

Property Name	Data Type	Description	Values
bufferReservation	platform:pfcMmuBufferRes (scalar:Uint16)	Percentage of shared pool buffers to be reserved	RANGE: [0 , 100] DEFAULT: 5

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 Percentage of Shared Pool Buffers to be Reserved

Note: This example was added in Release 9.2(2)

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the opt-left corner of the pane on the right to view the JSON payload. Click the YANG tab to view the XML payload.

hardware profile pfc mmu buffer-reservation 20

Note: The property information for this example was added in Release 9.3(3).

MO	DN
platformEntity	sys/pltfm
platformPfcMmuBuffer	sys/pltfm/pfcmmubuffer

platformPfcMmuBuffer Properties

Property Name	Data Type	Description	Values
bufferReservation	platform:pfcMmuBufferRes (scalar:Uint16)	Percentage of shared pool buffers to be reserved	RANGE: [0 , 100]
mmuBufferState	platform:pfcMmuBufferSt (scalar:Enum8)	Pfc Buffer monitor state	SELECTION: 0 - disable 1 - enable DEFAULT: enable

Related Documentation

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

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

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

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

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

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

Disabling the Reserved Percentage of Shared Pool Buffers

Note: This example was added in Release 9.2(2)

CLI Commands

no hardware profile pfc mmu buffer-reservation 20

Note: The property information for this example was added in Release 9.3(3).

MO	DN
platformEntity	sys/pltfm
platformPfcMmuBuffer	sys/pltfm/pfcmmubuffer

platformPfcMmuBuffer Properties

Property Name	Data Type	Description	Values
bufferReservation	platform:pfcMmuBufferRes (scalar:Uint16)	Percentage of shared pool buffers to be reserved	RANGE: [0 , 100]
mmuBufferState	platform:pfcMmuBufferSt (scalar:Enum8)	Pfc Buffer monitor state	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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