NX-API REST

This chapter contains the following topics:

About NX-API REST

NX-API REST

On Cisco Nexus 3400-S platform switches, you perform configuration tasks by using command-line interfaces (CLIs) that run only on the device. NX-API REST improves the accessibility of the Cisco NX-OS configuration by providing HTTP or HTTPS APIs that:

  • Make specific CLIs available outside of the switch.

  • Enable configurations that would require issuing many CLI commands by combining configuration actions in relatively few HTTP or HTTPS operations.

NX-API REST supports show commands, basic and advanced switch configurations, and Linux Bash.

NX-API REST uses HTTP or HTTPS as its transport. CLIs are encoded into the HTTP or HTTPS POST body. The NX-API REST backend uses the Nginx HTTP server. The Nginx process, and all its children processes, are under Linux cgroup protection where the CPU and memory usage is capped. If the Nginx resource usage exceeds the cgroup limitations, the Nginx process is restarted and restored.

For more information about the Cisco Nexus 3400-S Series NX-API REST SDK, see Cisco Nexus NX-API References.