Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Configuring the Hardware Buffer Poll-interval
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/pltfm/profile.json

{
  "platformProfile": {
    "children": [
      {
        "platformModule": {
          "attributes": {
            "infoPollInt": "19637",
            "moduleId": "1"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <pltfm-items>
    <profile-items>
      <module-items>
        <Module-list>
          <moduleId>1</moduleId>
          <infoPollInt>19637</infoPollInt>
        </Module-list>
      </module-items>
    </profile-items>
  </pltfm-items>
</System>

Configuring the Hardware Buffer Utilization Thresholds

Configuring the Hardware Buffer Poll-interval

Configuring the Hardware Buffer Poll-interval

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.

hardware profile buffer info poll-interval module 1 timer 19637


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
platformProfile sys/pltfm/profile
platformModule sys/pltfm/profile/module-1


platformModule Properties

The following table contains information about the platformModule 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
infoPollIntplatform:Interval
(scalar:Uint32)		buffer info poll-interval timer
RANGE: [500 , 60000]
DEFAULT: 5000
moduleIdplatform:slotNumber
(scalar:Uint16)		Module number on the switch
RANGE: [0 , 32]
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

Unconfiguring the Hardware Buffer Poll-interval

Unconfiguring the Hardware Buffer Poll-interval

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.

no hardware profile buffer info poll-interval module 1 timer 19637


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
platformProfile sys/pltfm/profile
platformModule sys/pltfm/profile/module-1


platformModule Properties

The following table contains information about the platformModule 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
infoPollIntplatform:Interval
(scalar:Uint32)		buffer info poll-interval timer
RANGE: [500 , 60000]
DEFAULT: 5000
moduleIdplatform:slotNumber
(scalar:Uint16)		Module number on the switch
RANGE: [0 , 32]
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 Port Egress Buffer Usage Threshold

Configuring Port Egress Buffer Usage Threshold

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.

hardware profile buffer info port-threshold module 1 threshold 38


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
platformProfile sys/pltfm/profile
platformModule sys/pltfm/profile/module-1


platformModule Properties

The following table contains information about the platformModule 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
infoPortThreshplatform:portThresPercentage
(scalar:UByte)		buffer info port-threshold threshold
RANGE: [1, 95]
DEFAULT: 90
moduleIdplatform:slotNumber
(scalar:Uint16)		Module number on the switch
RANGE: [0 , 32]
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 Port Egress Buffer Usage Threshold

Deleting Port Egress Buffer Usage Threshold

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.

no hardware profile buffer info port-threshold module 1 threshold 38


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
platformProfile sys/pltfm/profile
platformModule sys/pltfm/profile/module-1


platformModule Properties

The following table contains information about the platformModule 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
infoPortThreshplatform:portThresPercentage
(scalar:UByte)		buffer info port-threshold threshold
RANGE: [1, 95]
DEFAULT: 90
moduleIdplatform:slotNumber
(scalar:Uint16)		Module number on the switch
RANGE: [0 , 32]
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

Next