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

Enabling DNS

DME

YANG

Copy
POST http://<IP_Address>/api/mo/sys/dns.json 
{
  "topSystem": {
    "children": [
      {
        "dnsEntity": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}
Response
{
    imdata": []
}

Copy
<System>
  <dns-items>
    <adminSt>enabled</adminSt>
  </dns-items>
</System>

Configuring DNS

Using the NX-API REST, you can enable DNS configuration that would be enabled by the following CLI commands:

ip domain-lookup <CR>
ip domain-name <default domain name> [use-vrf <vrf-name>] <CR>
ip domain-list [use-vrf <vrf-name>] <CR>
ip name-server [<IPv4|IPv6 address>] use-vrf <vrf-name> <CR>
ip host <name> <IPv4 address>
ipv6 host <IPv6 address>

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

CLI Commands

“ip domain-list”, “ip domain-name”, and “ip name-server” are supported under non-default (i.e. user specified) VRF mode as well as VRF “default” mode. The other commands mentioned in this document are supported under default VRF only and the value must be “default” for them when specifying dns:Prof.name.

“default” VRF
ip domain-name <name>
ip domain-list <name>
ip name-server <addr>

non-default VRF
vrf context <vrf>
ip domain-name <name>
ip domain-list <name>
ip name-server <addr>

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

Enabling DNS

Enables DNS-based address translation. This feature is enabled by default.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip domain-lookup

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
dnsEntity	sys/dns

dnsEntity Properties

The following table contains information about the dnsEntity 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
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

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

Disabling DNS

Enables DNS-based address translation. This feature is enabled by default.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

no ip domnewDomain-lookup

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

MO	DN
topSystem	sys
dnsEntity	sys/dns

dnsEntity Properties

Property Name	Data Type	Description	Values
adminSt	nw:AdminSt (scalar:Enum8)	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled

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

Defining the Default Domain Name

Defines the default domain name that Cisco NX-OS uses to complete unqualified host names. You can optionally define a VRF that Cisco NX-OS uses to resolve this domain name if it cannot be resolved in the VRF that you configured this domain name under.

Cisco NX-OS appends the default domain name to any hostname that does not contain a complete domain name before starting a domain-name lookup.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip domain-name newDom

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsDom	sys/dns/prof-{[name]}/vrf-{[name]}/dom

dnsProf Properties

The following table contains information about the dnsProf 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
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsDom Properties

The following table contains information about the dnsDom 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
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

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

Defining Additional Domain Names

Defines additional domain names that Cisco NX-OS can use to complete unqualified hostnames. You can optionally define a VRF that Cisco NX-OS uses to resolve these domain names if they cannot be resolved in the VRF that you configured this domain name under.

Cisco NX-OS uses each entry in the domain list to append that domain name to any hostname that does not contain a complete domain name before starting a domain-name lookup. Cisco NX-OS continues this process for each entry in the domain list until it finds a match.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip domain-list newList

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsDomExt	sys/dns/prof-{[name]}/vrf-{[name]}/domext-{[name]}

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsDomExt Properties

The following table contains information about the dnsDomExt 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
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

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

Defining IPv4 Name Servers

Defines up to six name servers. The address can be either an IPv4 address or an IPv6 address.

You can optionally define a VRF that Cisco NX-OS uses to reach this name server if it cannot be reached in the VRF that you configured this name server under.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip name-server 128.66.0.0

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsProvider	sys/dns/prof-{[name]}/vrf-{[name]}/prov-{[addr]}

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsProvider Properties

The following table contains information about the dnsProvider 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
addr	address:Ip	IP address of the provider	Value must match ipv4 or ipv6 known format

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

Defining IPv6 Name Servers

Defines up to six name servers. The address can be either an IPv4 address or an IPv6 address.

You can optionally define a VRF that Cisco NX-OS uses to reach this name server if it cannot be reached in the VRF that you configured this name server under.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip name-server 2001:DB8::0

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsProvider	sys/dns/prof-{[name]}/vrf-{[name]}/prov-{[addr]}

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsProvider Properties

Property Name	Data Type	Description	Values
addr	address:Ip	IP address of the provider	Value must match ipv4 or ipv6 known format

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

Defining Static IPv4 Hostname-to-Address Mappings

Defines static hostname-to-address mappings in the hostname cache. The address can be either an IPv4 address or an IPv6 address.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ip host test 128.66.0.0

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv4Host	sys/dns/prof-{[name]}/host-{name}/ipv4host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

The following table contains information about the dnsHost 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
name	string:Basic	Host Name	A sequence of characters

dnsIpv4Host Properties

The following table contains information about the dnsIpv4Host 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
addr	address:IPv4	IPv4 Address Of Hostname	Value must match ipv4 format

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

Defining IPv6 Static Hostname-to-Address Mappings

Defines static hostname-to-address mappings in the hostname cache. The address can be either an IPv4 address or an IPv6 address.

CLI Commands

The CLI commands and options listed below are the equivalent to the payload example displayed in the pane on the right.

ipv6 host test6 2001:DB8::0

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv6Host	sys/dns/prof-{[name]}/host-{name}/ipv6host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

Property Name	Data Type	Description	Values
name	string:Basic	Host Name	A sequence of characters

dnsIpv6Host Properties

The following table contains information about the dnsIpv6Host 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
addr	address:IPv6	IPv6 Address Of Hostname	Value must match ipv6 format

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 Name for the IPv4 Host

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.

ip host Name_1 1.2.3.4

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv4Host	sys/dns/prof-{[name]}/host-{name}/ipv4host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

Property Name	Data Type	Description	Values
name	string:Basic	Host Name	A sequence of characters

dnsIpv4Host Properties

Property Name	Data Type	Description	Values
addr	address:IPv4	IPv4 Address Of Hostname	Value must match ipv4 format

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 Name for the IPv4 Host

CLI Commands

no ip host Name_1 1.2.3.4

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv4Host	sys/dns/prof-{[name]}/host-{name}/ipv4host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

Property Name	Data Type	Description	Values
name	string:Basic	Host Name	A sequence of characters

dnsIpv4Host 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

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 Name for the IPv6 Host

CLI Commands

ipv6 host Name_1 1:2::3:4

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv6Host	sys/dns/prof-{[name]}/host-{name}/ipv6host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

Property Name	Data Type	Description	Values
name	string:Basic	Host Name	A sequence of characters

dnsIpv6Host Properties

Property Name	Data Type	Description	Values
addr	address:IPv6	IPv6 Address Of Hostname	Value must match ipv6 format

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 Name for the IPv6 Host

CLI Commands

no ipv6 host Name_1 1:2::3:4

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

MO	DN
dnsEntity	sys/dns
dnsProf	sys/dns/prof-{[name]}
dnsHost	sys/dns/prof-{[name]}/host-{name}
dnsIpv6Host	sys/dns/prof-{[name]}/host-{name}/ipv6host

dnsProf Properties

Property Name	Data Type	Description	Values
name	pol:ObjName (naming:Name256)	Object name	MAX SIZE: 64

dnsHost Properties

Property Name	Data Type	Description	Values
name	string:Basic	Host Name	A sequence of characters

dnsIpv6Host 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

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