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 Auto-Detection for the DCBX Version

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "lldpEntity": {
          "children": [
            {
              "lldpInst": {
                "children": [
                  {
                    "lldpIf": {
                      "attributes": {
                        "id": "eth1/3",
                        "portDCBXPVer": "auto"
                      }
                    }
                  },
                  {
                    "lldpIf": {
                      "attributes": {
                        "id": "eth1/2",
                        "portDCBXPVer": "auto"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/3"
                }
              }
            },
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <lldp-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/3</id>
          <portDCBXPVer>auto</portDCBXPVer>
        </If-list>
        <If-list>
          <id>eth1/2</id>
          <portDCBXPVer>auto</portDCBXPVer>
        </If-list>
      </if-items>
    </inst-items>
  </lldp-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/3</id>
      </PhysIf-list>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring the DCBXP Version

The Data Center Bridging Exchange Protocol (DCBXP) is an extension of LLDP. It is used to announce, exchange, and negotiate node parameters between peers. DCBXP parameters are packaged as DCBXP TLVs in the LLDP packet. If CEE is used, DCBXP will use an acknowledgment mechanism over LLDP. When the port comes up, DCBX TLVs are sent and any DCBX TLVs received are processed. By default, the DCBX protocol is set to auto-detect, and the latest protocol version supported by both the peers is used.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

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

Configuring Auto-Detection for the DCBX Version

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.

interface ethernet 1/2-3
lldp dcbx version 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
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpIf Properties

The following table contains information about the lldpIf 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
portDCBXPVer	lldp:DCBXPVerType (scalar:Enum8)	DCBXP Version	SELECTION: auto CEE DEFAULT: auto

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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 CEE Version of DCBX

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

CLI Commands

interface ethernet 1/2-3
lldp dcbx version cee
Note: The link may need to be reset for the change to take effect.

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpIf 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
portDCBXPVer	lldp:DCBXPVerType (scalar:Enum8)	DCBXP Version	SELECTION: auto CEE DEFAULT: auto

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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 CEE Version of DCBX

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

CLI Commands

interface ethernet 1/2-3
no lldp dcbx version cee

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpIf 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
portDCBXPVer	lldp:DCBXPVerType (scalar:Enum8)	DCBXP Version	SELECTION: auto CEE DEFAULT: auto

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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 IEEE version of DCBX

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

CLI Commands

interface ethernet 1/2-3
lldp dcbx version ieee
Note: The link may need to be reset for the change to take effect.

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpIf 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
portDCBXPVer	lldp:DCBXPVerType (scalar:Enum8)	DCBXP Version	SELECTION: auto CEE DEFAULT: auto

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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 IEEE 802.1 Version of DCBX

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

CLI Commands

interface ethernet 1/2-3
no lldp dcbx version ieee

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpIf 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
portDCBXPVer	lldp:DCBXPVerType (scalar:Enum8)	DCBXP Version	SELECTION: auto CEE DEFAULT: auto

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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