Cisco Nexus 3000 and 9000 Series NX-API REST SDK and API, Release 7.x

NX-OS 7(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an Interface as a Trunk Port and Enabling a List of Allowed VLANs

DME

Copy
POST http://<IP_Address>/api/mo/sys.json
{
"topSystem": {
    "children": [
        {
        "l1PhysIf": {
            "attributes": {
                "rn": "phys-[eth3/21]",
                "id": "eth3/21",
                "descr": "MDT test: trunk port",
                "layer": "Layer2",
                "mode": "trunk",
                "mtu": "9216",
                "adminSt": "up",
                "trunkLog": "enable",
                "trunkVlans": "2-150",
                "snmpTrapSt": "disable"
}}}}}

Configuring Interfaces

Cisco NX-OS supports multiple configuration parameters for each of the interface types supported. Most of these parameters are covered in this guide but some are described in other documents.

For more information, see the Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide, Release 7.x.

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

Configuring an Interface as a Trunk Port and Enabling a List of Allowed VLANs

The example in this section configures an interface as a trunk port and enables a list of trunk VLANs. When this API call executes, an l1PhysIf object named "phys-[eth3/21]" (/sys/intf/phys-[eth3/21]/) is created in the MO database, as well as several other objects that are required for port channel functionality.

The phys-[eth3/21] object holds the configuration for the interface that is configured as a trunk port.

To verify that the interface configuration was created, issue an HTTP GET request to query the following URI.

http://<IP_Address>/api/mo/sys/intf/phys-[eth3/21].json

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

QUERY PARAMETERS

No query parameters

Querying a Trunk Port Configuration

The example in this section queries the trunk port interface configuration that was specified in the previous POST request.

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/

HTTP Request

QUERY PARAMETERS

No query parameters

Configuring an Interface as a Layer 2 Access Port and Enabling an Access VLAN

This example configures an interface as a layer 2 access port and enables an access VLAN.

When the POST request executes, the l1PhysIf object that was created in the previous POST request "phys-[eth3/21]" (/sys/intf/phys-[eth3/21]/) is reconfigured to be a layer 2 access port.

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/

Verifying an Interface Configuration was Created

To verify that the interface configuration was created, issue an HTTP GET request to query the following URI:

QUERY PARAMETERS

No query parameters

Issuing a Shut or No Shut of the Interface

The example in this section shows how to issue a shut or no shut for an interface. In this example, the interface that was first configured to be a trunk port and then reconfigured to be a layer 2 access port, as shown in previous sections, is brought up.

If the interface is up and you want to bring it down, change "adminSt": "up" to "adminSt": "down"

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/

QUERY PARAMETERS

No query parameters

Verifying the Shut or No Shut of the Interface

To verify that the shut or no shut command was successful, perform an HTTP GET operation.

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/

Configuring an IPv4 Address for an Interface

Configuring ACL TCAM Region with e-racl TCAM Carving

The HTTP request in this example assigns an IPv4 address to an interface.

Note: This example was added in Release 7.0(3)I6(1).

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/

QUERY PARAMETERS

No query parameters

Configuring User Flags

User configured flags (REST property userCfgdFlags in l1PhysIf and pcAggrIf MOs) are used to indicate that a property (layer, admin state, and/or mtu) has been configured by the user.
If these flags are not set, you may experience configuration loss (for layer, admin state, and MTU) on the reload of the system. Interfaces with the “admin_layer” and/or “admin_state” value set for “userCfgdFlags” will be unaffected by the system default switchport and system default switchport shutdown commands (respectively). User configured flags are automatically set correctly when CLI is executed, and only must be manually set for REST.

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/

Configuring the System Default Switchport Settings

Configuring the System Default Switchport

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

CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

system default switchport

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/

Deleting the System Default Switchport

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

CLI Command

no system default switchport

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/

Configuring the System Default Switchport Admin State (Down)

Configuring the System Default Switchport Admin State

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

CLI Command

system default switchport shutdown

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/

Configuring the System Default Switchport Admin State (Up)

Configuring the System Default Switchport

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

CLI Command

no system default switchport down

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/

Configuring Breakout Profiles

Configuring a Breakout Profile

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

CLI Command

The CLI command below is the equivalent of the payload example 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 or the YANG tab to view the XML payload.

interface breakout-profile 50g-2x-only

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/

Deleting a Breakout Profile

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

CLI Command

no interface breakout-profile 50g-2x-only

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/

Creating a Subinterface under a Main Interface

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/

The example in this section creates a subinterface under a main interface.

QUERY PARAMETERS

No query parameters

Querying the State of a Subinterface

The example in this section queries the state of a specified subinterface.

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/

QUERY PARAMETERS

No query parameters

Configuring the DNS Source Interface

Configures the DNS Source Interface

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

ip dns source-interface loopback 111

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/

Configuring the Source Interface Feature for a TFTP Client

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip tftp source-interface loopback 111

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/

Configuring Network Address Translation (NAT)

Enable Network Address Translation (NAT)

Network Address Translation (NAT) enables private IP internetworks that use nonregistered IP addresses to connect to the Internet. NAT operates on a device, usually connecting two networks, and translates private (not globally unique) IP addresses in the internal network into legal IP addresses before packets are forwarded to another network.

Before you can use the NX-API REST NAT configuration APIs, you must enable NAT on the switch.

Follow these steps to enable NAT.

Enter global configuration mode:

config t
Enable the NAT feature:

switch(config)# feature nat

NAT configuration mode is now active. You can now issue NX-API REST NAT configuration calls.

Note: This example was added in Release 7.0(3)I6(1).

Configuring tcp-timeout for NAT Translation Table

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat translation tcp-timeout 100

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/

Configuring udp-timeout for NAT Translation Table

Configures udp-timeout for a NAT translation table.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat translation udp-timeout 101

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/

Configuring Timeout for NAT Translation Table

Configures timeout for NAT translation table.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat translation timeout 102

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/

Configuring Maximum Size of NAT Table for All Hosts

Configures the maximum size of NAT the table for all hosts.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat translation max-entries all-host 103

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/

Configuring Maximum Size of NAT Table

Configures the maximum size of the NAT table.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat translation max-entries 104

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/

Creating a NAT Pool with Network Mask

Creates a NAT pool with a network mask.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat pool pool5 netmask 255.0.255.0

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/

Deleting a NAT Pool with Network Mask

Deletes a NAT pool with a network mask.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

no ip nat pool pool5 netmask 255.0.255.0

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/

Creating a NAT Pool with Prefix Length

Creates a NAT pool with a prefix length.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat pool pool5 prefix-length 24

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/

Deleting a NAT Pool with Prefix Length

Deletes a NAT pool with a prefix length.

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

CLI Commands

no ip nat pool pool5 prefix-length 24

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/

Creating a NAT Pool with Network Mask

Creates a NAT pool with a network mask.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat pool pool5 20.1.1.1 20.1.1.5 netmask 255.0.255.0

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/

Deleting a NAT Pool with Network Mask

Deletes a NAT pool with a network mask.

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

CLI Commands

no ip nat pool pool5 20.1.1.1 20.1.1.5 netmask 255.0.255.0

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/

Creating NAT Pool with Prefix Length

Creating a NAT Pool with Prefix Length

Creates a NAT pool with a prefix length.

Note: This example was added in Release 7.0(3)I6(1).

CLI Commands

ip nat pool pool5 20.1.1.1 20.1.1.5 prefix-length 3

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/

Deleting a NAT Pool with Prefix Length

Deletes a NAT pool with a prefix length.

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

CLI Commands

no ip nat pool pool5 20.1.1.1 20.1.1.5 prefix-length 3

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/

Configuring the Link Mac-Up Timer

Note: This example was added in Release 7.0(3)I7(7).

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
link mac-up timer 100

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
l1PhysIf	sys/intf/phys-[eth1/2]

l1PhysIf Properties

The following table contains information about the l1PhysIf 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	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
linkMacUpTimer		The timer value	0-120 (in seconds)

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 Link Mac-Up Timer

Note: This example was added in Release 7.0(3)I7(7).

CLI Commands

interface ethernet 1/2
no link mac-up timer

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}

l1PhysIf 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
linkMacUpTimer		The timer value	0-120 (in seconds)

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 DFE Adaptive Tuning for an Interface

Note: This example was added in Release 7.0(3)I7(7).

CLI Commands

interface ethernet 1/2
link dfe adaptive-tuning

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

l1PhysIf Properties

Property Name	Data Type	Description	Values
dfeAdaptiveTuning			enable (default) or disable
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 DFE Adaptive Tuning for an Interface

Note: This example was added in Release 7.0(3)I7(7).

CLI Commands

interface ethernet 1/2
no link dfe adaptive-tuning

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}

l1PhysIf Properties

Property Name	Data Type	Description	Values
dfeAdaptiveTuning			enable (default) or disable
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