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

Disabling a Port-Channel Range

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/intf.json
{
  "interfaceEntity": {
    "children": [
      {
        "pcAggrIf": {
          "attributes": {
            "adminSt": "down",
            "id": "po11",
            "userCfgdFlags": "admin_state"
}}},{
        "pcAggrIf": {
          "attributes": {
            "adminSt": "down",
            "id": "po10",
            "userCfgdFlags": "admin_state"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po11</id>
        <adminSt>down</adminSt>
        <userCfgdFlags>admin_state</userCfgdFlags>
      </AggrIf-list>
      <AggrIf-list>
        <id>po10</id>
        <adminSt>down</adminSt>
        <userCfgdFlags>admin_state</userCfgdFlags>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

Configuring a Port-Channel Interface Range

Disabling a Port-Channel Range

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 10-11
shutdown

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
pcAggrIf	sys/intf/aggr-{[id]}

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
adminSt	l1:AdminSt (scalar:Enum8)	Administrative port state	SELECTION: 1 - down 2 - up DEFAULT: up
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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

Forcefully Disable a Port-Channel Range

CLI Commands

interface port-channel 10-11
shutdown force

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

pcAggrIf Properties

Property Name	Data Type	Description	Values
adminSt	l1:AdminSt (scalar:Enum8)	Administrative port state	SELECTION: 1 - down 2 - up DEFAULT: up
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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

Restarting a Disabled Port-Channel Range

CLI Commands

interface port-channel 10-11
no shutdown

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

pcAggrIf Properties

Property Name	Data Type	Description	Values
adminSt	l1:AdminSt (scalar:Enum8)	Administrative port state	SELECTION: 1 - down 2 - up DEFAULT: up
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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

Restarting a Forcefully Disabled Port-Channel Range

CLI Commands

interface port-channel 10-11
no shutdown force

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

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}

pcAggrIf Properties

Property Name	Data Type	Description	Values
adminSt	l1:AdminSt (scalar:Enum8)	Administrative port state	SELECTION: 1 - down 2 - up DEFAULT: up
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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

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 Interface Throughput Delay

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

CLI Commands

interface port-channel 1-3
delay 15965329

Verifying a DME Configuration

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

pcAggrIf Properties

Property Name	Data Type	Description	Values
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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 Interface Throughput Delay

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

CLI Commands

interface port-channel 1-3
no delay 15965329

Verifying a DME Configuration

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

pcAggrIf Properties

Property Name	Data Type	Description	Values
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
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