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 a Virtual IP Address with Advertise Disabled on a Specified Port (TCP)

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/itd/inst.json
{
  "itdInst": {
    "children": [
      {
        "itdService": {
          "attributes": {
            "name": "Service_Name"
          },
          "children": [
            {
              "itdVirtualIPv4": {
                "attributes": {
                  "active": "no",
                  "advertise": "no",
                  "deviceGroup": "dg1",
                  "ip": "2.2.3.4",
                  "port": "1",
                  "protocol": "TCP",
                  "subnet": "255.255.255.0"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <itd-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>Service_Name</name>
          <vipv4-items>
            <VirtualIPv4-list>
              <ip>2.2.3.4</ip>
              <subnet>255.255.255.0</subnet>
              <protocol>TCP</protocol>
              <port>1</port>
              <active>false</active>
              <advertise>false</advertise>
              <deviceGroup>dg1</deviceGroup>
            </VirtualIPv4-list>
          </vipv4-items>
        </Service-list>
      </service-items>
    </inst-items>
  </itd-items>
</System>

Configuring a Virtual IP Address

Configuring a Virtual IP Address with Advertise Disabled on a Specified Port (TCP)

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 ip 2.2.3.4 255.255.255.0 tcp 1 advertise disable device-group dg1

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
itdVirtualIPv4	sys/itd/inst/service-Service_Name/vipv4-2.2.3.4-subnet-255.255.255.0-protocol-TCP-port-1

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

itdVirtualIPv4 Properties

The following table contains information about the itdVirtualIPv4 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:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
subnet	address:IPv4	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 Virtual IP Address with Advertise Disabled on a Specified Port (TCP)

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

CLI Commands

itd Service_Name
no virtual ip 2.2.3.4 255.255.255.0 tcp 1 advertise disable device-group dg1

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
itdVirtualIPv4	sys/itd/inst/service-Service_Name/vipv4-2.2.3.4-subnet-255.255.255.0-protocol-TCP-port-1

itdService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

itdVirtualIPv4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
subnet	address:IPv4	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

Configuring a Virtual IP Address with Advertise Disabled on a Specified Port (UDP)

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

CLI Commands

itd Service_Name
virtual ip 10.2.3.4 255.255.255.0 udp 5060 advertise disable device-group dg1

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
itdVirtualIPv4	sys/itd/inst/service-Service_Name/vipv4-10.2.3.4-subnet-255.255.255.0-protocol-UDP-port-5060

itdService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

itdVirtualIPv4 Properties

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:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
subnet	address:IPv4	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 Virtual IP Address with Advertise Disabled on a Specified Port (UDP)

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

CLI Commands

itd Service_Name
no virtual ip 10.2.3.4 255.255.255.0 udp 5060 advertise disable device-group dg1

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
itdVirtualIPv4	sys/itd/inst/service-Service_Name/vipv4-10.2.3.4-subnet-255.255.255.0-protocol-UDP-port-5060

itdService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

itdVirtualIPv4 Properties

Property Name	Data Type	Description	Values
ip	address:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
subnet	address:IPv4	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

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

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

CLI Commands

itd Service_Name
virtual ip 1.2.3.4 1.2.3.4 udp 1 advertise enable active device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
itdVirtualIPv4	sys/itd/inst/service-Service_Name/vipv4-1.2.3.4-subnet-1.2.3.4-protocol-UDP-port-1

itdService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

itdVirtualIPv4 Properties

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:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
subnet	address:IPv4	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 Virtual IP Address with Advertise Enabled on a Specified Port (UDP)

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

CLI Commands

itd Service_Name
no virtual ip 1.2.3.4 1.2.3.4 udp 1 advertise enable active device-group SampleString_123

Verifying a DME Configuration

MO	DN
itdInst	sys/itd/inst
itdService	sys/itd/inst/service-Service_Name
sys/itd/inst/service-Service_Name/vipv4-1.2.3.4-subnet-1.2.3.4-protocol-UDP-port-1

itdService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

itdVirtualIPv4 Properties

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:IPv4	The IP address.	Value must match ipv4 format
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0, 65535]
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
subnet	address:IPv4	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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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