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 VDC Id

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "nwVdc": {
          "attributes": {
            "id": "1",
            "name": "nxosv2"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <vdc-items>
    <Vdc-list>
      <id>1</id>
      <name>nxosv2</name>
    </Vdc-list>
  </vdc-items>
</System>

Configuring Virtual Device Contexts

Cisco NX-OS can segment operating system and hardware resources into virtual device contexts (VDCs) that emulate virtual devices. The Cisco Nexus 9000 Series switches currently do not support multiple VDCs. All switch resources are managed in the default VDC.

Configuring a VDC Id

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.

vdc nxosv2 id 1

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
nwVdc	sys/vdc-1

nwVdc Properties

The following table contains information about the nwVdc properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	DEFAULT: 1
name	string:Basic	The name of the object.	RANGE: [0 , 63] DEFAULT: switch

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 IPv4 Route Memory Limits

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

CLI Commands

vdc nxosv2
limit-resource m4route-mem minimum 41 maximum 41

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

The following table contains information about the resmgrLimRes 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
m4rtMemMax	scalar:Uint16	Maxiimum route memory to allocate for multicast Ipv4	RANGE: [3 , 150] DEFAULT: 58
m4rtMemMin	scalar:Uint16	Minimum route memory to allocate for multicast Ipv4	RANGE: [3 , 150] DEFAULT: 58

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting IPv4 Route Memory Limits

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

CLI Commands

vdc nxosv2
no limit-resource m4route-mem minimum 41 maximum 41

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
m4rtMemMax	scalar:Uint16	Maxiimum route memory to allocate for multicast Ipv4	RANGE: [3 , 150] DEFAULT: 58
m4rtMemMin	scalar:Uint16	Minimum route memory to allocate for multicast Ipv4	RANGE: [3 , 150] DEFAULT: 58

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring IPv6 Route Memory Limits

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

CLI Commands

vdc nxosv2
limit-resource m6route-mem minimum 17 maximum 17

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
m6rtMemMax	scalar:Uint16	Maximum route memory to allocate for multicast Ipv6	RANGE: [3 , 20] DEFAULT: 8
m6rtMemMin	scalar:Uint16	Minimum route memory to allocate for multicast Ipv6	RANGE: [3 , 20] DEFAULT: 8

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting IPv6 Route Memory Limits

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

CLI Commands

vdc nxosv2
no limit-resource m6route-mem minimum 17 maximum 17

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
m6rtMemMax	scalar:Uint16	Maximum route memory to allocate for multicast Ipv6	RANGE: [3 , 20] DEFAULT: 8
m6rtMemMin	scalar:Uint16	Minimum route memory to allocate for multicast Ipv6	RANGE: [3 , 20] DEFAULT: 8

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring IPv4 Route Memory Limits

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

CLI Commands

vdc nxosv2
limit-resource u4route-mem minimum 441 maximum 441

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
u4rtMemMax	scalar:Uint16	Maximum route memory to allocate for unicast Ipv4	RANGE: [1 , 768] DEFAULT: 248
u4rtMemMin	scalar:Uint16	Minimum route memory to allocate for unicast Ipv4	RANGE: [1 , 768] DEFAULT: 248

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting IPv4 Route Memory Limits

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

CLI Commands

vdc nxosv2
no limit-resource u4route-mem minimum 441 maximum 441

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
u4rtMemMax	scalar:Uint16	Maximum route memory to allocate for unicast Ipv4	RANGE: [1 , 768] DEFAULT: 248
u4rtMemMin	scalar:Uint16	Minimum route memory to allocate for unicast Ipv4	RANGE: [1 , 768] DEFAULT: 248

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring IPv6 Route Memory Limits

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

CLI Commands

vdc nxosv2
limit-resource u6route-mem minimum 258 maximum 258

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
u6rtMemMax	scalar:Uint16	Maximum route memory to allocate for unicast Ipv6	RANGE: [1 , 512] DEFAULT: 96
u6rtMemMin	scalar:Uint16	Minimum route memory to allocate for unicast Ipv6	RANGE: [1 , 512] DEFAULT: 96

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting IPv6 Route Memory Limits

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

CLI Commands

vdc nxosv2
no limit-resource u6route-mem minimum 258 maximum 258

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
u6rtMemMax	scalar:Uint16	Maximum route memory to allocate for unicast Ipv6	RANGE: [1 , 512] DEFAULT: 96
u6rtMemMin	scalar:Uint16	Minimum route memory to allocate for unicast Ipv6	RANGE: [1 , 512] DEFAULT: 96

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring VLAN Limits

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

CLI Commands

vdc nxosv2
limit-resource vlan minimum 1431 maximum 1431

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vlanMax	scalar:Uint16	Maximum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 4094
vlanMin	scalar:Uint16	Minimum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 16

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting VLAN Limits

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

CLI Commands

vdc nxosv2
no limit-resource vlan minimum 1431 maximum 1431

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vlanMax	scalar:Uint16	Maximum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 4094
vlanMin	scalar:Uint16	Minimum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 16

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring VLAN Limits to Max Value Equals Min Value

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

CLI Commands

vdc nxosv2
limit-resource vlan minimum 1431 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vlanMax	scalar:Uint16	Maximum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 4094
vlanMin	scalar:Uint16	Minimum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 16

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting VLAN Limits to Max Value Equals Min Value

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

CLI Commands

vdc nxosv2
no limit-resource vlan minimum 1431 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vlanMax	scalar:Uint16	Maximum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 4094
vlanMin	scalar:Uint16	Minimum VLANs to allocate	RANGE: [16 , 4094] DEFAULT: 16

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring VRF Resource Limits

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

CLI Commands

vdc nxosv2
limit-resource vrf minimum 595 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vrfMax	scalar:Uint16	Maximum vrf resources to allocate	RANGE: [2 , 4096] DEFAULT: 4096
vrfMin	scalar:Uint16	Minimum vrf resources to allocate	RANGE: [2 , 4096] 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

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Deleting VRF Resource Limits

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

CLI Commands

vdc nxosv2
no limit-resource vrf minimum 595 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
vrfMax	scalar:Uint16	Maximum vrf resources to allocate	RANGE: [2 , 4096] DEFAULT: 4096
vrfMin	scalar:Uint16	Minimum vrf resources to allocate	RANGE: [2 , 4096] 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

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

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

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

Configuring the Port Channel Limits

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

CLI Commands

vdc nxosv2
limit-resource port-channel minimum 1 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1
resmgrLimRes	sys/vdc-1/limres
topSystem	sys

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
poMax	scalar:Uint16	Maximum port channels to allocate	RANGE: [0 , 511] DEFAULT: 511
poMin	scalar:Uint16	Minimum port channels to allocate	RANGE: [0 , 511] 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 the Port Channel Limits

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

CLI Commands

vdc nxosv2
no limit-resource port-channel minimum 1 maximum equal-to-min

Verifying a DME Configuration

MO	DN
nwVdc	sys/vdc-1
resmgrLimRes	sys/vdc-1/limres
topSystem	sys

nwVdc Properties

Property Name	Data Type	Description	Values
id	l2:VdcId (scalar:Uint16)	An identifier .	RANGE: [0, 65535] DEFAULT: 1

resmgrLimRes Properties

Property Name	Data Type	Description	Values
poMax	scalar:Uint16	Maximum port channels to allocate	RANGE: [0 , 511] DEFAULT: 511
poMin	scalar:Uint16	Minimum port channels to allocate	RANGE: [0 , 511] 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