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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an HTTPS Key File

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "nxapiInst": {
          "attributes": {
            "certFile": "bootflash:/ssl.crt"
}}}]}}
Response
{
    imdata:[]
}

Copy
POST:  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:
<System xmlns="http://cisco.com/ns/yang/cisco-nx-os-device">
  <nxapi-items>
    <certFile>bootflash:/ssl.crt</certFile>
  </nxapi-items>
</System>

Configuring NX-API Management

Configuring an HTTPS Key File

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

nxapi certificate httpscrt certfile ssl.crt

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
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

The following table contains information about the nxapiInst 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
certFile	os:OsString (naming:Name)	Certificate file for NX-API	RANGE: [0 , 256]

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

Enabling an NX-API Certificate

Note: You cannot enable a certificate in the same request used to configure a key and/or certificate file; the request to enable the certificate must be sent separately.

CLI Commands

nxapi certificate enable

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
certEnable	scalar:Bool	Certificate status of NX-API	SELECTION: true or false

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

Setting SSL Protocols

The nxapi ssl protocols TLSv1 TLSv1.1 TLSv1.2 command enables the TLS versions specified in the string. The no nxapi ssl protocols TLSv1 TLSv1.1 TLSv1.2 form of the command changes it to default (by default only TLS1.1 and TLS1.2 will be enabled).

CLI Commands

nxapi ssl protocols TLSv1 TLSv1.1 TLSv1.2

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
sslProtocols	nxapi:SslProtocols (os:OsString)	String of space separated SSL protocols to be supported	RANGE: [0 , 256] DEFAULT: TLSv1.2

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

Unconfiguring the SSL Protocols

CLI Commands

no nxapi ssl protocols TLSv1 TLSv1.1 TLSv1.2

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
sslProtocols	nxapi:SslProtocols (os:OsString)	String of space separated SSL protocols to be supported	RANGE: [0 , 256] DEFAULT: TLSv1.2

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

Configuring an HTTPS Certificate File

CLI Commands

nxapi certificate httpscrt certfile volatile:/server.crt

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
certFile	os:OsString (naming:Name)	Certificate file for NX-API	RANGE: [0 , 256]

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

Configuring a VRF to be Used for NX-API Management

CLI Commands

nxapi use-vrf management

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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 VRF to be Used for NX-API Management

CLI Commands

no nxapi use-vrf management

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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

Configuring a Default VRF

CLI Commands

nxapi use-vrf default

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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 Default VRF

CLI Commands

no nxapi use-vrf default

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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

Configuring a VRF to be Used for NX-API Communication

CLI Commands

nxapi use-vrf VRF_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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 VRF to be Used for NX-API Communication

CLI Commands

no nxapi use-vrf VRF_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
useVrf	os:OsString (naming:Name)	Vrf for NX-API	RANGE: [0 , 256]

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

Configuring a Port Number

CLI Commands

nxapi http port 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
httpPort	nxapi:HttpPort (scalar:Sint32)	HTTP Port	RANGE: [-1 , 65535] DEFAULT: -1

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 Port Number

CLI Commands

no nxapi http port 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
httpPort	nxapi:HttpPort (scalar:Sint32)	HTTP Port	RANGE: [-1 , 65535] DEFAULT: -1

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

Configuring a Port Number (HTTPS Private Key)

CLI Commands

nxapi https port 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
httpsPort	nxapi:HttpsPort (scalar:Sint32)	HTTPS Port	RANGE: [-1 , 65535] DEFAULT: 443

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 Port Number (HTTPS Private Key)

CLI Commands

no nxapi https port 123

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
httpsPort	nxapi:HttpsPort (scalar:Sint32)	HTTPS Port	RANGE: [-1 , 65535] DEFAULT: 443

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

Configuring to Allow Weak Ciphers

The nxapi ssl ciphers weak example enables the weak ciphers for NGINX. The no nxapi ssl ciphers weak example changes it to default (by default weak ciphers is disabled).

CLI Commands

nxapi ssl ciphers weak

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
sslCiphersWeak	scalar:Bool	Enable Weak Ciphers for SSL	SELECTION: true or false DEFAULT: 0

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

Unconfiguring Weak Ciphers

CLI Commands

no nxapi ssl ciphers weak

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nxapiInst	sys/nxapi

nxapiInst Properties

Property Name	Data Type	Description	Values
sslCiphersWeak	scalar:Bool	Enable Weak Ciphers for SSL	SELECTION: true or false DEFAULT: 0

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