Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Posting a Task

DME

Copy
POST http://<mgmt0_IP>/api/mo/sys/action.json
{
  "actionLCont": {
    "attributes": {
      "dn": "sys/action"
    },
    "children": [
      {
        "actionLSubj": {
          "attributes": {
            "dn": "sys/action/lsubj-[sys]”
          },
          "children": [
            {
              “topSystemCopyRSLTask”: {
                "attributes": {
                  "adminSt": "start",
                  "dn": "sys/action/lsubj-[sys]/topSystemCopyRSLTask”
                  “freq”: “one-shot”
                }
              }
            }
          ]
        }
      }
    ]
  }
}

Configuring Breakout on High-Bandwidth Interfaces

Cisco NX-OS supports breakout interfaces. The breakout command works at the module level and splits the 40G interface of a module into four 10G interfaces. The module is reloaded and the configuration for the interface is removed when the command is executed. When doing a module/port-level breakout through REST, upon the completion of the action by the switch, you should see the corresponding l1PhysIf MOs get created with the DN as "sys/intf/phys-[id]" as an example.

interface breakout module
interface breakout module port map
show interface brief
show system internal im info interface ethernet 1/1/1
show system internal im info module 1

This section contains payload examples to demonstrate how to use the NX-API REST API to configure breakout on high-bandwidth interfaces.

Posting a Task

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
actionLCont	sys/action
actionLSubj	sys/action/lsubj-{[oDn]}

actionLCont Properties

The following table contains information about the actionLCont 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

actionLSubj Properties

The following table contains information about the actionLSubj 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
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

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 Task

Deleting All Tasks (Example 1)

Deleting All Tasks (Example 2)