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

Enabling LLDP Reception on an Interface

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/<DN>
{
  "topSystem": {
    "children": [
      {
        "lldpEntity": {
          "children": [
            {
              "lldpInst": {
                "children": [
                  {
                    "lldpIf": {
                      "attributes": {
                        "adminRxSt": "enabled",
                        "id": "eth1/3"
                      }
                    }
                  },
                  {
                    "lldpIf": {
                      "attributes": {
                        "adminRxSt": "enabled",
                        "id": "eth1/2"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <lldp-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/3</id>
          <adminRxSt>enabled</adminRxSt>
        </If-list>
        <If-list>
          <id>eth1/2</id>
          <adminRxSt>enabled</adminRxSt>
        </If-list>
      </if-items>
    </inst-items>
  </lldp-items>
</System>

Configuring LLDP on the if-gig-ether-all Command Mode

Enabling LLDP Reception on an Interface

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 receive

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
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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
adminRxSt	lldp:AdminSt (scalar:Enum8)	Receive admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Reception on an Interface

CLI Commands

interface ethernet 1/2-3
no lldp receive

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

lldpIf Properties

Property Name	Data Type	Description	Values
adminRxSt	lldp:AdminSt (scalar:Enum8)	Receive admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
lldp tlv-set management-address 1.2.3.4

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv4	address:Ip	Tlv ipv4	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set management-address 1.2.3.4

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv4	address:Ip	Tlv ipv4	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
lldp tlv-set management-address 1:2::3:4 ipv6

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv6	address:Ip	Tlv ipv6	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set management-address 1:2::3:4 ipv6

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv6	address:Ip	Tlv ipv6	Value must match ipv4 or ipv6 known format

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 VLAN ID That has an SVI IP That Should be Used as a Management Address in Management-TLV of LLDPDU Default

CLI Commands

interface ethernet 1/2-3
lldp tlv-set vlan 1

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetVlan	lldp:MgmtVlanId (scalar:Uint16)	Tlv vlan	RANGE: [0 , 4094] 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 a VLAN ID That has an SVI IP That Should be Used as a Management Address in Management-TLV of LLDPDU Default

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set vlan 1

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetVlan	lldp:MgmtVlanId (scalar:Uint16)	Tlv vlan	RANGE: [0 , 4094] 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

Enabling LLDP Transmission on an Interface

CLI Commands

interface ethernet 1/2-3
lldp transmit

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

lldpIf Properties

Property Name	Data Type	Description	Values
adminTxSt	lldp:AdminSt (scalar:Enum8)	Transmit admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Transmission on an Interface

CLI Commands

interface ethernet 1/2-3
no lldp transmit

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

lldpIf Properties

Property Name	Data Type	Description	Values
adminTxSt	lldp:AdminSt (scalar:Enum8)	Transmit admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
lldp tlv-set management-address 1.2.3.4

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv4	address:Ip	Tlv ipv4	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set management-address 1.2.3.4

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv4	address:Ip	Tlv ipv4	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
lldp tlv-set management-address 1:2::3:4 ipv6

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv6	address:Ip	Tlv ipv6	Value must match ipv4 or ipv6 known format

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 to be Sent in Management-TLV of LLDPDU

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set management-address 1:2::3:4 ipv6

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetMgmtIpv6	address:Ip	Tlv ipv6	Value must match ipv4 or ipv6 known format

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 VLAN ID That has an SVI IP That Should be Used as a Management Address in Management-TLV of LLDPDU Default

CLI Commands

interface ethernet 1/2-3
lldp tlv-set vlan 1

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetVlan	lldp:MgmtVlanId (scalar:Uint16)	Tlv vlan	RANGE: [0 , 4094] 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 a VLAN ID That has an SVI IP That Should be Used as a Management Address in Management-TLV of LLDPDU Default

CLI Commands

interface ethernet 1/2-3
no lldp tlv-set vlan 1

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

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 or Vlan100
tlvSetVlan	lldp:MgmtVlanId (scalar:Uint16)	Tlv vlan	RANGE: [0 , 4094] 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

Enabling LLDP Transmission on an Interface

CLI Commands

interface ethernet 1/2-3
lldp transmit

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

lldpIf Properties

Property Name	Data Type	Description	Values
adminTxSt	lldp:AdminSt (scalar:Enum8)	Transmit admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 Transmission on an Interface

CLI Commands

interface ethernet 1/2-3
no lldp transmit

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

MO	DN
topSystem	sys
lldpEntity	sys/lldp
lldpInst	sys/lldp/inst
lldpIf	sys/lldp/inst/if-{[id]}

lldpIf Properties

Property Name	Data Type	Description	Values
adminTxSt	lldp:AdminSt (scalar:Enum8)	Transmit admin state	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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