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 the Holdtime (in Sec) to be Sent in Packets

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/lldp.json
{
  "lldpEntity": {
    "children": [
      {
        "lldpInst": {
          "attributes": {
            "holdTime": "120"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <lldp-items>
    <inst-items>
      <holdTime>120</holdTime>
    </inst-items>
  </lldp-items>
</System>

Configuring LLDP in Global Mode

Configuring the Holdtime (in Sec) to be Sent in Packets

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.

lldp holdtime 120

Note: The property information for this example was added in Release 9.3(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
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpInst Properties

The following table contains information about the lldpInst 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
holdTime	lldp:HoldTime (scalar:Uint16)	The hold time (in seconds) that a receiving device should hold the information sent by your device before discarding it.	RANGE: [1 , 255] DEFAULT: 120

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 Holdtime (in Sec) to be Sent in Packets

CLI Commands

no lldp holdtime 120

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
holdTime	lldp:HoldTime (scalar:Uint16)	The hold time (in seconds) that a receiving device should hold the information sent by your device before discarding it.	RANGE: [1 , 255] DEFAULT: 120

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 Delay (in Sec) for LLDP Initialisation on any Interface

CLI Commands

lldp reinit 2

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
initDelayTime	lldp:InitDelayTime (scalar:Uint16)	The delay time (in seconds) for LLDP to initialize on any interface.	RANGE: [1 , 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 a Delay (in Sec) for LLDP Initialisation on any Interface

CLI Commands

no lldp reinit 2

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
initDelayTime	lldp:InitDelayTime (scalar:Uint16)	The delay time (in seconds) for LLDP to initialize on any interface.	RANGE: [1 , 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 Rate at Which LLDP Packets are Sent (in Sec)

CLI Commands

lldp timer 30

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
txFreq	lldp:TxFreq (scalar:Uint16)	The transmission frequency of LLDP updates (in seconds).	RANGE: [1 , 254] DEFAULT: 30

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 Rate at Which LLDP Packets are Sent (in Sec)

CLI Commands

no lldp timer 30

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
txFreq	lldp:TxFreq (scalar:Uint16)	The transmission frequency of LLDP updates (in seconds).	RANGE: [1 , 254] DEFAULT: 30

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 Port ID Subtype for LLDP TLV and SNMP MIBs

CLI Commands

lldp portid-subtype 0

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
portIdSubType	lldp:PortIdSubType (scalar:Enum8)	PortId SubType	SELECTION: 0 - long 1 - short DEFAULT: long

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 Port ID Subtype for LLDP TLV and SNMP MIBs

CLI Commands

no lldp portid-subtype 0

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
portIdSubType	lldp:PortIdSubType (scalar:Enum8)	PortId SubType	SELECTION: 0 - long 1 - short DEFAULT: long

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 Management Address TLV

CLI Commands

lldp tlv-select management-address

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Management Address TLV

CLI Commands

no lldp tlv-select management-address

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Port Description TLV

CLI Commands

lldp tlv-select port-description

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Port Description TLV

CLI Commands

no lldp tlv-select port-description

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Port VLAN ID TLV

CLI Commands

lldp tlv-select port-vlan

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Port VLAN ID TLV

CLI Commands

no lldp tlv-select port-vlan

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 an IEEE 8023 DTE Power via MDI TLV

CLI Commands

lldp tlv-select power-management

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 an IEEE 8023 DTE Power via MDI TLV

CLI Commands

no lldp tlv-select power-management

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Capabilities TLV

CLI Commands

lldp tlv-select system-capabilities

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Capabilities TLV

CLI Commands

no lldp tlv-select system-capabilities

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Description TLV

CLI Commands

lldp tlv-select system-description

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Description TLV

CLI Commands

no lldp tlv-select system-description

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Name TLV

CLI Commands

lldp tlv-select system-name

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 System Name TLV

CLI Commands

no lldp tlv-select system-name

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 DCBXP TLVs

CLI Commands

lldp tlv-select dcbxp

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 DCBXP TLVs

CLI Commands

no lldp tlv-select dcbxp

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Management Address TLV v4

CLI Commands

lldp tlv-select management-address v4

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Management Address TLV v4

CLI Commands

no lldp tlv-select management-address v4

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Management Address TLV v6

CLI Commands

lldp tlv-select management-address v6

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 Management Address TLV v6

CLI Commands

no lldp tlv-select management-address v6

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

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

lldpInst Properties

Property Name	Data Type	Description	Values
optTlvSel	lldp:OptTlvSel (scalar:Bitmask16)	The selectors for optional TLVs according to the LLDP protocol (802.1AB) specifications.	SELECTION: 0 - unknown 1 - port-desc 2 - sys-name 4 - sys-desc 8 - sys-cap 16 - mgmt-addr-v4 32 - port-vlan 64 - mgmt-addr-v6 128 - dcbxp 256 - power-mgmt 512 - four-wire-pwr-mgmt DEFAULT: port-desc,sys-name,sys-desc,sys-cap,mgmt-addr-v4,mgmt-addr-v6,port-vlan,dcbxp,power-mgmt,four-wire-pwr-mgmt

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 LLDP on Port Channels

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

CLI Commands

lldp port-channel

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
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst

lldpInst Properties

Property Name	Data Type	Description	Values
pcEnable	lldp:AdminSt (scalar:Enum8)	LLDP enabled on PortChannel	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 LLDP on Port Channels

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

CLI Commands

no lldp port-channel

Verifying a DME Configuration

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

lldpInst Properties

Property Name	Data Type	Description	Values
pcEnable	lldp:AdminSt (scalar:Enum8)	LLDP enabled on PortChannel	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Multiple LLDP Neighbors Per Interface

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

CLI Commands

lldp multi-neighbor

Verifying a DME Configuration

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

lldpInst Properties

Property Name	Data Type	Description	Values
multiPeerEnable	lldp:AdminSt (scalar:Enum8)	LLDP multi-neighbor configuration	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 Multiple LLDP Neighbors Per Interface

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

CLI Commands

no lldp multi-neighbor

Verifying a DME Configuration

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

lldpInst Properties

Property Name	Data Type	Description	Values
multiPeerEnable	lldp:AdminSt (scalar:Enum8)	LLDP multi-neighbor configuration	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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