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

Configuring a Virtual IPv6 Address with Advertise Enabled on a Specified Port (UDP)

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdVirtualIPv6": {
                "attributes": {
                  "active": "no",
                  "advertise": "yes",
                  "deviceGroup": "SampleString_123",
                  "ip": "1:2::3:4",
                  "port": "1",
                  "prefix": "12",
                  "protocol": "UDP"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <vipv6-items>
            <VirtualIPv6-list>
              <ip>1:2::3:4</ip>
              <prefix>12</prefix>
              <protocol>UDP</protocol>
              <port>1</port>
              <active>false</active>
              <advertise>true</advertise>
              <deviceGroup>SampleString_123</deviceGroup>
            </VirtualIPv6-list>
          </vipv6-items>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

Configuring a Virtual IPv6 Address

Configuring a Virtual IPv6 Address with Advertise Enabled on a Specified Port (UDP)

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.

itd Service_Name
virtual IPv6 1:2::3:4 0012 udp 1 advertise enable device-group SampleString_123

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
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
itdVirtualIPv6	sys/itd/inst/service-Service_Name/vipv6-1:2::3:4-prefix-12-protocol-UDP-port-1

itdVirtualIPv6 Properties

The following table contains information about the itdVirtualIPv6 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
active	scalar:Bool	A property for indicating if the new hop is active or backup.	SELECTION: true or false
advertise	scalar:Bool	SELECTION: true or false
deviceGroup	itd:DevGrpNameType (string:Basic)	MAX SIZE: 31
ip	address:IPv6	The IP address.	Value must match ipv6 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
prefix	itd:Prefix (scalar:Uint32)	IP address/mask to be reached.	RANGE: [0 , 128] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol

itdService Properties

The following table contains information about the itdService 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	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

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 Virtual IPv6 Address with Advertise Enabled on a Specified Port (UDP)