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 a Description

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/intf.json
{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "descr": "SampleString_123",
            "id": "po1.2"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>po1.2</id>
        <descr>SampleString_123</descr>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

Configuring a Port-Channel Subinterface

Configuring a Description

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 port-channel 1.2
description SampleString_123

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
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-{[id]}

l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
descr	naming:Descr1024 (string:Basic)	Description	MAX SIZE: 254
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

Deleting a Description

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

CLI Commands

interface port-channel 1.2
no description SampleString_123

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

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-{[id]}

l3EncRtdIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 (string:Basic)	Description	MAX SIZE: 254
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 Description

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

CLI Commands

interface port-channel 1-3
description SampleString_123

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
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po3]
pcAggrIf	sys/intf/aggr-[po2]
pcAggrIf	sys/intf/aggr-[po1]

pcAggrIf Properties

The following table contains information about the pcAggrIf 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
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

pcAggrIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

pcAggrIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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

Deleting a Description

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

CLI Commands

interface port-channel 1-3
no description SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po3]
pcAggrIf	sys/intf/aggr-[po2]
pcAggrIf	sys/intf/aggr-[po1]

pcAggrIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

pcAggrIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

pcAggrIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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 Description

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

CLI Commands

interface port-channel 1.2
description SampleString_123

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po1.2]

l3EncRtdIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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

Deleting a Description

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

CLI Commands

interface port-channel 1.2
no description SampleString_123

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po1.2]

l3EncRtdIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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 UPDOWN and CHANGE Messages

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

CLI Commands

interface port-channel 123.345
logging event port link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Interface Link Logging Enable	SELECTION: 1 - default 2 - enable 3 - disable DEFAULT: default

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 UPDOWN and CHANGE Messages

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

CLI Commands

interface port-channel 123.345
no logging event port link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Interface Link Logging Enable	SELECTION: 1 - default 2 - enable 3 - disable DEFAULT: default

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 UPDOWN and CHANGE Messages (Using the Default Value)

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

CLI Commands

interface port-channel 123.345
logging event port link-status default

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Interface Link Logging Enable	SELECTION: 1 - default 2 - enable 3 - disable DEFAULT: default

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 UPDOWN and CHANGE Messages (Using the Default Value)

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

CLI Commands

interface port-channel 123.345
no logging event port link-status default

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Interface Link Logging Enable	SELECTION: 1 - default 2 - enable 3 - disable DEFAULT: default

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 SNMP LINKUP and LINKDOWN Traps

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

CLI Commands

interface port-channel 123.345
snmp trap link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
snmpTrap	scalar:Enum8	Administrative Port Snmp Trap State	DEFAULT: disable

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 SNMP LINKUP and LINKDOWN Traps

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

CLI Commands

interface port-channel 123.345
no snmp trap link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[po123.345]

l3EncRtdIf 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
snmpTrap	scalar:Enum8	Administrative Port Snmp Trap State	DEFAULT: disable

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