Connectrix: MDS How to Enable REST-API on an MDS NX-API Switch

Summary: How to configure REST-API on Connectrix MDS switch. Connectrix MDS 9000 NX-API is an RPC-style API for taking and running CLI commands. Based on HTTP or HTTPS protocols, as common to other Representational State Transfer (REST) API frameworks, it allows programmatic access to an MDS switch. ...

This article applies to This article does not apply to This article is not tied to any specific product. Not all product versions are identified in this article.
Check out other resources

Instructions

The following is the procedure to enable REST-API on a Connectrix MDS switch:

  1. Ensure that the switch is accessible through the management interface. See the Configuring the Management Interface section in the Cisco MDS 9000 Series Fundamentals Configuration GuideThis hyperlink is taking you to a website outside of Dell Technologies. to enable the management interface.
  2. Enable the NX-API Feature, enter into configuration mode, and enable NX-API:
switch# configure terminal
switch(config)# feature nxapi
  1. Configure HTTP and HTTPS Ports for NX-API (Optional):
To configure the HTTP port: 
switch(config)# nxapi http port 8080
 To configure the HTTPS port: 
switch(config)# nxapi https port 8443
  1. Install an Identity Certificate for NX-API HTTPS Connections (Optional): 
Install a certificate with an unencrypted private key: 
switch(config)# nxapi certificate certfile key keyfile

Install a certificate with an encrypted private key:

switch(config)# nxapi certificate certfile key keyfile password passphrase

Use an already installed certificate from the trustpoint repository:

switch(config)# nxapi trustpoint label

  1. Verify NX-API Settings:

switch# show nxapi
switch# show feature


To disable NX-API: 

Switch# conf t 
switch(config)# no feature nxapi

NX-API may be accessed through the following URLs after it is configured on the MDS switch:

HTTP: http://switch_ip_address:port-number/ins

HTTPs: https://switch_ip_address:port-number/ins

Additional Information

Cisco MDS Series Programmability Guide This hyperlink is taking you to a website outside of Dell Technologies.

Affected Products

Connectrix MDS-Series Firmware
Article Properties
Article Number: 000224000
Article Type: How To
Last Modified: 04 Jun 2025
Version:  3
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.