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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring Hardware Profile Latency

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/pltfm/latencymonitor.json
{
  "platformLatencyMonitor": {
    "attributes": {
      "dn": "sys/pltfm/latencymonitor",
      "latencyMonitorState": "Enable",
      "latencyMonitorThreshholdAvg": "1000000",
      "latencyMonitorThreshholdMax": "2000000",
      "rn": "latencymonitor",
      "sampling": "3"
    }
  }
}
Response
{
    imdata:[]
}

Copy
<nc:rpc xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:4f26102c-a047-4fd9-9951-ac99a5e64946">
  <nc:edit-config>
    <nc:target>
      <nc:running/>
    </nc:target>
    <config>
      <System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
        <pltfm-items>
          <latencymonitor-items nc:operation="merge">
            <latencyMonitorState>Enable</latencyMonitorState>
          </latencymonitor-items>
        </pltfm-items>
      </System>
    </config>
  </nc:edit-config>
</nc:rpc>

Configuring Hardware Profile Settings on the Cisco Nexus 3500 Platform

Configuring Hardware Profile Latency

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

CLI Commands

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

hardware profile latency monitor threshold-avg 1000000 threshold-max 2000000 sampling 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.

MO	DN
platformLatencyMonitor	sys/pltfm/latencymonitor

platformLatencyMonitor Properties

The following table contains information about the platformLatencyMonitor 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
latencyMonitorState	platform:latencyMonitorSt (scalar:Enum8)	Latency monitor state	SELECTION: 0 - Disable 1 - Enable DEFAULT: Disable
latencyMonitorThreshholdAvg	platform:latencyMonitorThreshholdAv (scalar:Uint32)	Average latency monitor threshold	RANGE: [300 , 20000000] DEFAULT: 1000000
latencyMonitorThreshholdMax	platform:latencyMonitorThreshholdMx (scalar:Uint32)	Maximum latency monitor threshold	RANGE: [300 , 20000000] DEFAULT: 2000000
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
sampling	platform:latencyMonitorSampling (scalar:Uint32)	Latency Monitor Sampling	RANGE: [1 , 30] DEFAULT: 3

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 Hardware Profile Buffer SPAN Threshold

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

CLI Commands

hardware profile buffer qosgroup 0 threshold 60

MO	DN
platformEntity	sys/pltfm
platformProfile	sys/pltfm/profile

platformEntity Properties

The following table contains information about the platformEntity 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

platformProfile Properties

The following table contains information about the platformProfile 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
spanBufferThresh	platform:ThresPercentage (scalar:UByte)	buffer span threshold	RANGE: [0 , 100] 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 Hardware Profile Buffer QoS Group Threshold

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

CLI Commands

hardware profile buffer qosgroup 0 threshold 30

MO	DN
platformProfile	sys/pltfm/profile

platformProfile Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
qosGrp0BufferThresh	platform:ThresPercentage (scalar:UByte)	buffer qos group 0 threshold	RANGE: [0 , 100] DEFAULT: 95
rn	reference:BinRN	Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

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