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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Specifying a Command Alias

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "vshdCliAlias": {
          "attributes": {
            "aliasCmd": "interface ethernet",
            "aliasName": "ethint"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <clialias-items>
    <CliAlias-list>
      <aliasName>ethint</aliasName>
      <aliasCmd>interface ethernet</aliasCmd>
    </CliAlias-list>
  </clialias-items>
</System>

Configuring Command Aliases

For information about command aliases, see the Cisco Nexus 9000 Series NX-OS Fundamentals Configuration Guide: https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html

Specifying a Command Alias

Note: This example was added in Release 9.3(1).

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.

cli alias name ethint interface ethernet

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
vshdCliAlias	sys/clialias-{aliasName}

vshdCliAlias Properties

The following table contains information about the vshdCliAlias 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
aliasCmd	string:Basic	Alias command definition	RANGE: [0 , 1023]
aliasName	string:Basic	Name of the alias	A sequence of characters

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 Command Alias

Note: This example was added in Release 9.3(1).

CLI Commands

no cli alias name ethint interface ethernet

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

MO	DN
topSystem	sys
vshdCliAlias	sys/clialias-{aliasName}

vshdCliAlias Properties

Property Name	Data Type	Description	Values
aliasName	string:Basic	Name of the alias	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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

Checking for Exact Match Only

Note: This example was added in Release 9.3(3).

CLI Commands

cli alias check loose

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
vshdCliAliasCheck	sys/clialiascheck

vshdCliAliasCheck Properties

The following table contains information about the vshdCliAliasCheck 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
mode	vshd:ModeType (scalar:Enum8)	strict check for cli alias	SELECTION: 0 - default 1 - strict 2 - loose DEFAULT: default

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 Checking for Exact Match Only

Note: This example was added in Release 9.3(3).

CLI Commands

no cli alias check loose

Verifying a DME Configuration

MO	DN
topSystem	sys
vshdCliAliasCheck	sys/clialiascheck

vshdCliAliasCheck Properties

Property Name	Data Type	Description	Values
mode	vshd:ModeType (scalar:Enum8)	strict check for cli alias	SELECTION: 0 - default 1 - strict 2 - loose DEFAULT: default

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

Checking for Exact and Partial Match Keyword

Note: This example was added in Release 9.3(3).

CLI Commands

cli alias check strict

Verifying a DME Configuration

MO	DN
topSystem	sys
vshdCliAliasCheck	sys/clialiascheck

vshdCliAliasCheck Properties

Property Name	Data Type	Description	Values
mode	vshd:ModeType (scalar:Enum8)	strict check for cli alias	SELECTION: 0 - default 1 - strict 2 - loose DEFAULT: default

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 Checking for Exact and Partial Match Keyword

Note: This example was added in Release 9.3(3).

CLI Commands

no cli alias check strict

Verifying a DME Configuration

MO	DN
topSystem	sys
vshdCliAliasCheck	sys/clialiascheck

vshdCliAliasCheck Properties

Property Name	Data Type	Description	Values
mode	vshd:ModeType (scalar:Enum8)	strict check for cli alias	SELECTION: 0 - default 1 - strict 2 - loose DEFAULT: default

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 Variable

Note: This example was added in Release 9.3(3).

CLI Commands

cli var name SampleString_123 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
vshdCliVar	sys/clivar-SampleString_123

vshdCliVar Properties

The following table contains information about the vshdCliVar 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
varName	string:Basic	Specify a variable name	A sequence of characters
varValue	string:Basic	Specify a variable value	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 Variable

Note: This example was added in Release 9.3(3).

CLI Commands

no cli var name SampleString_123 123:12

Verifying a DME Configuration

MO	DN
topSystem	sys
vshdCliVar	sys/clivar-SampleString_123

vshdCliVar Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
varName	string:Basic	Specify a variable name	A sequence of characters

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