Executing Ping NVE, Traceroute NVE, and Path Trace NVE

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

Creating an oDn

DME

Copy
POST http://<mgmt0_IP>/api/node/mo/sys/action/lsubj-[].json
{"actionLSubj": 
   {"attributes": 
   {
        "oDn": ""
   }
}

An oDN must be created before executing ping NVE, traceroute NVE, or path trace NVE.

Creating an oDn

This example demonstrates how to create an oDn to enable executing ping NVE, traceroute NVE, or path trace NVE.

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

Executing Ping NVE

The following NGOAM commands are the executable commands; these actions will start once POST request is issued. Results for these executable commands are stored as children objects and can be retrieved by a GET request. To start an executable command, a POST must be issued with these mandatory fields:

session - A character string to identify the unique execution.
adminSt - Set to 1 to activate the session and specify one of the destination fields such as dstIp, dstIpv6, and dstMAC.

The rest of the fields are optional and need to be specified for a given use case. Different session names create a different instance of the objects with result objects as children. If any other property is changed, it creates new exec request in the backend and results are appended to the the same exec object.

Note: The POST fields are optional. See the GET request for all available fields.

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

ping nve ip 12.0.22.1 profile 1 vni 31000 count 10000

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/

Querying the Ping NVE

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/

Executing Traceroute NVE

The POST fields are optional. See the GET request for all available fields.

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

traceroute nve ip 33.33.33.2 vrf vni-31000 src 33.33.33.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/

Querying the Traceroute NVE

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/

Executing Path Trace NVE

The POST fields are optional. See the GET request for all available fields.

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

pathtrace nve ip 12.0.22.1 vni 31000 req-stats

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/

Querying the Path Trace NVE

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/

Clearing a Session

Issue a DELETE oDn request to clear sessions created using the REST API.

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/