About NX-API

Cisco MDS NX-API brings programmatic access to Cisco MDS 9000 Series switches.

Cisco MDS NX-API is an RPC-style API that accepts CLI commands and returns the command output in a structured response. Based on HTTP or HTTPS protocols, common to Representational State Transfer (REST) APIs, it is a web service API that provides remote access to the configuration and monitoring capabilities of Cisco MDS NX-OS CLI. When coupled with a programming language like Python, it facilitates network automation of Cisco MDS 9000 Series switches.

Cisco MDS NX-API supports certain show and configuration commands that are noninteractive (commands that do not prompt the user to enter input).

For more information, see the Cisco MDS 9000 Series NX-OS Programmability Guide, Release 8.x

Note: The CLI outputs provided in the document are sample outputs. The outputs will vary based on your Cisco MDS 9000 device. The parameter description table lists some of the common field "values" and not all the supported field "values". The sample outputs are just for reference.