Netstack Configuration Commands

This section contains payload examples and CLIs to demonstrate many of the netstack configuration commands and to show how the REST APIs correspond to the CLI commands.

Configuring a Secondary IPv4 Address on an Interface

Configuring a Secondary IPv4 Address on an Interface
POST http://<IP_Address>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv4Addr": {
                      "attributes": {
                        "addr": "128.0.0.1/10",
                        "type": "secondary",
                        "tag": "30"
}}}]}}]}}]}}

This example configures a tagged secondary IPv4 address on the Ethernet 1/1 interface. Change the attributes as necessary for your own uses.

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
ipv4Addr sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv4Addr Properties

The following table contains information about the ipv4Addr 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue must match ipv4 or ipv6 known format
typeip:AddrT
(scalar:Enum8)
TypeSELECTION:
1 - primary
2 - secondary
DEFAULT: primary
tagrt:Tag
(scalar:Uint32)
Route Tag
RANGE: [0 , 0xffffffff]
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

Configuring IP Forwarding

Configuring IP Forwarding
POST http://<IP_Address>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "forward": "enabled",
                  "id": "eth1/1"
}}}]}}]}}

This example configures forwarding on interface Ethernet 1/1.

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
forwardnw:AdminSt
(scalar:Enum8)
IP forwardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Reachability

Configuring Reachability
POST http://<IP_Address>/api/mo/sys/icmpv4/inst.json
{
  "icmpv4Inst": {
    "children": [
      {
        "icmpv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "icmpv4If": {
                "attributes": {
                  "ctrl": "port-unreachable,redirect,unreachable",
                  "id": "eth1/1"
}}}]}}]}}

The following example configures ICMPv4 on the interface Ethernet 1/1 such that the ICMPv4 interface is unreachable.

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.

MODN
icmpv4Inst sys/icmpv4/inst
icmpv4Dom sys/icmpv4/inst/dom-{name}
icmpv4If sys/icmpv4/inst/dom-{name}/if-{[id]}


icmpv4Dom Properties

The following table contains information about the icmpv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


icmpv4If Properties

The following table contains information about the icmpv4If 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 NameData TypeDescriptionValues
ctrlicmp:IfControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - port-unreachable
2 - unreachable
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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

Queue 1 Packet when Triggered NS is Sent

Queue 1 Packet when Triggered NS is Sent
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l3LbRtdIf": {
                "attributes": {
                  "id": "lo222"
}}}]}},

      {
        "ipv6Entity": {
          "children": [
            {
              "ipv6Inst": {
                "attributes": {
                  "queuePackets": "enabled"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <intf-items>
    <lb-items>
      <LbRtdIf-list>
        <id>lo222</id>
      </LbRtdIf-list>
    </lb-items>
  </intf-items>
  <ipv6-items>
    <inst-items>
      <queuePackets>enabled</queuePackets>
    </inst-items>
  </ipv6-items>
</System>

Queue 1 packet when a triggered NS is sent.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface loopback 222
 ipv6 queue-packets

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.

MODN
topSystem sys
interfaceEntity sys/intf
l3LbRtdIf sys/intf/lb-{[id]}
ipv6Entity sys/ipv6
ipv6Inst sys/ipv6/inst


l3LbRtdIf Properties

The following table contains information about the l3LbRtdIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6Inst Properties

The following table contains information about the ipv6Inst 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 NameData TypeDescriptionValues
queuePacketsnw:AdminSt
(scalar:Enum8)
Queue-packetsSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Switch ND Packets Received on Core Ports

Switch ND Packets Received on Core Ports
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l3LbRtdIf": {
                "attributes": {
                  "id": "lo222"
}}}]}},

      {
        "ipv6Entity": {
          "children": [
            {
              "ipv6Inst": {
                "attributes": {
                  "switchPackets": "all"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <intf-items>
    <lb-items>
      <LbRtdIf-list>
        <id>lo222</id>
      </LbRtdIf-list>
    </lb-items>
  </intf-items>
  <ipv6-items>
    <inst-items>
      <switchPackets>all</switchPackets>
    </inst-items>
  </ipv6-items>
</System>

Switch ND packets received on core ports.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface loopback 222
 ipv6 switch-packets

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.

MODN
topSystem sys
interfaceEntity sys/intf
l3LbRtdIf sys/intf/lb-{[id]}
ipv6Entity sys/ipv6
ipv6Inst sys/ipv6/inst


l3LbRtdIf Properties

The following table contains information about the l3LbRtdIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6Inst Properties

The following table contains information about the ipv6Inst 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 NameData TypeDescriptionValues
switchPacketsip:SwitchPktTarget
(scalar:Enum8)
Switch-packetsSELECTION:
0 - disabled
1 - all
2 - lla
DEFAULT: disabled


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 IP Source Routing

Enabling IP Source Routing
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
 "ipv4Entity": {
   "children": [
     {
       "ipv4Inst": {
         "attributes": {
           "sourceRoute": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <sourceRoute>enabled</sourceRoute>
    </inst-items>
  </ipv4-items>
</System>

Enables IP source routing.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ip source-route

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
sourceRoutenw:AdminSt
(scalar:Enum8)
Source-RouteSELECTION:
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

Enabling IP Auto Discard

Enabling IP Auto Discard
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
 "ipv4Inst": {
   "children": [
     {
       "ipv4Dom": {
         "attributes": {
           "autoDiscard": "enabled",
           "name": "default"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <autoDiscard>enabled</autoDiscard>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Enables IP auto discard.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ip auto-discard

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
autoDiscardnw:AdminSt
(scalar:Enum8)
Auto-DiscardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


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

Specifying an IPv4 ICMP Error-Source Interface

Specifying an IPv4 ICMP Error-Source Interface
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
 "ipv4Inst": {
   "children": [
     {
       "ipv4Dom": {
         "attributes": {
           "ipIcmpErrorsSrcIntf": "lo2",
           "name": "default"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <ipIcmpErrorsSrcIntf>lo2</ipIcmpErrorsSrcIntf>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Generates ICMP error packets with the source IPv4 address from the configured interface.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ip icmp-errors source-interface loopback 2

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
ipIcmpErrorsSrcIntfnw:IfId
(base:IfIndex)
ICMP errors source-interfaceMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


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

Specifying Internal IPv6 Event Logs for High Availability

Specifying Internal IPv6 Event Logs for High Availability
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
 "ipv6Inst": {
   "children": [
     {
       "ipv6IPv6EventLogs": {
         "attributes": {
           "eventType": "highAvailability",
           "logSize": "small"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <logs-items>
        <IPv6EventLogs-list>
          <eventType>highAvailability</eventType>
          <logSize>small</logSize>
        </IPv6EventLogs-list>
      </logs-items>
    </inst-items>
  </ipv6-items>
</System>

Specifies the internal IPv6 event log for high availability buffer size.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ipv6 internal event-history ha size small

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6IPv6EventLogs sys/ipv6/inst/logs-{eventType}


ipv6IPv6EventLogs Properties

The following table contains information about the ipv6IPv6EventLogs 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 NameData TypeDescriptionValues
eventTypeipv6:IPv6EventType
(scalar:Enum16)
Event Log TypeSELECTION:
0 - ipv6Event
1 - bfdEvent
2 - syslog
3 - ipc
4 - snmp
5 - highAvailability
6 - sdb
logSizeipv6:IPv6EventLogSize
(scalar:Enum8)
Event Log SizeSELECTION:
0 - disabled
1 - small
2 - medium
3 - large
DEFAULT: small


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 Access-List Matching for Locally Generated Traffic

Enabling Access-List Matching for Locally Generated Traffic
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
 "ipv4Entity": {
   "children": [
     {
       "ipv4Inst": {
         "attributes": {
           "accessListMatchLocal": "enabled"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <accessListMatchLocal>enabled</accessListMatchLocal>
    </inst-items>
  </ipv4-items>
</System>

Enables access-list matching for locally generated traffic.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ip access-list match-local-traffic

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
accessListMatchLocalnw:AdminSt
(scalar:Enum8)
Access-List Match LocalSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Specifying IPv4 Load Sharing

Specifying IPv4 Load Sharing
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
 "ipv4Inst": {
   "children": [
     {
       "ipv4IPLoadSharing": {
         "attributes": {
           "concatenation": "disabled",
           "greOuterHash": "disabled",
           "loadShareMode": "srcDestPort"
}}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <iploadsharing-items>
        <concatenation>disabled</concatenation>
        <greOuterHash>disabled</greOuterHash>
        <loadShareMode>srcDestPort</loadShareMode>
      </iploadsharing-items>
    </inst-items>
  </ipv4-items>
</System>

Configures IPv4 load sharing.


CLI Command

The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.

ip load-sharing address source-destination port source-destination

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4IPLoadSharing sys/ipv4/inst/iploadsharing


ipv4IPLoadSharing Properties

The following table contains information about the ipv4IPLoadSharing 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 NameData TypeDescriptionValues
concatenationnw:AdminSt
(scalar:Enum8)
ConcatenationSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
greOuterHashnw:AdminSt
(scalar:Enum8)
GRE Outer HashSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
loadShareModeip:LoadShareFormat
(scalar:Enum8)
Load sharing modeSELECTION:
1 - disabled
2 - destPort
3 - srcDest
4 - srcDestGre
5 - srcDestPort
6 - source
7 - srcDestGTPU
8 - srcDestSymmetric
9 - srcDestInnerAll
10 - srcDestInnerGre
11 - srcDestInnerGreSymmetric
12 - srcDestIPv6FlowLabel
13 - srcDestTTL
14 - srcDestUDF
DEFAULT: disabled


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 Hash Polynomial CRC32 HI

Configuring Hash Polynomial CRC32 HI
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
  "ipv4Entity": {
    "children": [
      {
        "ipv4Inst": {
          "attributes": {
            "hardwareEcmpHashPolynomial": "CRC32HI"
          }
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <hardwareEcmpHashPolynomial>CRC32HI</hardwareEcmpHashPolynomial>
    </inst-items>
  </ipv4-items>
</System>

Note: This example was added in Release 9.2(2).


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.

hardware ecmp hash-polynomial CRC32HI

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
hardwareEcmpHashPolynomialip:HardwareEcmpHashPolynomialT
(scalar:Enum8)
hardware Ecmp Hash-PolynomialSELECTION:
0 - CRC16
1 - CRC32HI
DEFAULT: CRC16


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 Hash Polynomial CRC16

Configuring Hash Polynomial CRC16
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
  "ipv4Entity": {
    "children": [
      {
        "ipv4Inst": {
          "attributes": {
            "hardwareEcmpHashPolynomial": "CRC16"
          }
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <hardwareEcmpHashPolynomial>CRC16</hardwareEcmpHashPolynomial>
    </inst-items>
  </ipv4-items>
</System>

Note: This example was added in Release 9.2(2).


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.

hardware ecmp hash-polynomial CRC16

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
hardwareEcmpHashPolynomialip:HardwareEcmpHashPolynomialT
(scalar:Enum8)
hardware Ecmp Hash-PolynomialSELECTION:
0 - CRC16
1 - CRC32HI
DEFAULT: CRC16


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 Hash Polynomial Configuration

Deleting a Hash Polynomial Configuration
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
  "ipv4Entity": {
    "children": [
      {
        "ipv4Inst": {
          "attributes": {
            "hardwareEcmpHashPolynomial": "CRC16"
          }
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <hardwareEcmpHashPolynomial>CRC16</hardwareEcmpHashPolynomial>
    </inst-items>
  </ipv4-items>
</System>

Note: This example was added in Release 9.2(2).


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.

no hardware ecmp hash-polynomial

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
hardwareEcmpHashPolynomialip:HardwareEcmpHashPolynomialT
(scalar:Enum8)
hardware Ecmp Hash-PolynomialSELECTION:
0 - CRC16
1 - CRC32HI
DEFAULT: CRC16


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 Hash Concatenation

Configuring a Hash Concatenation
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
    "ipv4Entity": {
      "children": [
        {
          "ipv4Inst": {
            "attributes": {
              "hardwareEcmpHashOffsetConcat": "enabled",
              "hardwareEcmpHashOffsetValue": "3"
            }
          }
        }
      ]
    }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <hardwareEcmpHashOffsetConcat>enabled</hardwareEcmpHashOffsetConcat>
      <hardwareEcmpHashOffsetValue>3</hardwareEcmpHashOffsetValue>
    </inst-items>
  </ipv4-items>
</System>

Note: This example was added in Release 9.2(2).


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.

hardware ecmp hash-offset 3 concatenation

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
hardwareEcmpHashOffsetConcatnw:AdminSt
(scalar:Enum8)
hardware Ecmp HashOffset ConcatenationSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
hardwareEcmpHashOffsetValuescalar:Uint16
hardware Ecmp HashOffset Value
RANGE: [0 , 63]
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

Deleting a Hash Concatenation Configuration

Deleting a Hash Concatenation Configuration
POST http://<mgmt0_IP>/api/mo/sys/ipv4.json
{
  "ipv4Entity": {
    "children": [
      {
        "ipv4Inst": {
          "attributes": {
            "hardwareEcmpHashOffsetConcat": "disabled",
            "hardwareEcmpHashOffsetValue": "0"
          }
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <hardwareEcmpHashOffsetConcat>disabled</hardwareEcmpHashOffsetConcat>
      <hardwareEcmpHashOffsetValue>0</hardwareEcmpHashOffsetValue>
    </inst-items>
  </ipv4-items>
</System>

Note: This example was added in Release 9.2(2).


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.

no hardware ecmp hash-offset

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.

MODN
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst


ipv4Inst Properties

The following table contains information about the ipv4Inst 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 NameData TypeDescriptionValues
hardwareEcmpHashOffsetConcatnw:AdminSt
(scalar:Enum8)
hardware Ecmp HashOffset ConcatenationSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
hardwareEcmpHashOffsetValuescalar:Uint16
hardware Ecmp HashOffset Value
RANGE: [0 , 63]
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

Configuring IP Drop Glean

Configuring IP Drop Glean
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ipv4Entity": {
          "children": [
            {
              "ipv4Inst": {
                "children": [
                  {
                    "ipv4Dom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "ipv4If": {
                            "attributes": {
                              "dropGlean": "enabled",
                              "id": "vlan1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan1"
                }
              }
            },
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>vlan1</id>
              <dropGlean>enabled</dropGlean>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan1</id>
      </If-list>
    </svi-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release


CLI Commands

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

interface ethernet 1/2
 interface vlan 1
  ip drop-glean

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.

MODN
topSystem sys
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}
l1PhysIf sys/intf/phys-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
dropGleannw:AdminSt
(scalar:Enum8)
ip drop-glean enabled/disabledSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


sviIf Properties

The following table contains information about the sviIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

The following table contains information about the l1PhysIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 the IP Drop Glean Configuration

Deleting the IP Drop Glean Configuration
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "ipv4Entity": {
          "children": [
            {
              "ipv4Inst": {
                "children": [
                  {
                    "ipv4Dom": {
                      "attributes": {
                        "name": "default"
                      },
                      "children": [
                        {
                          "ipv4If": {
                            "attributes": {
                              "dropGlean": "disabled",
                              "id": "vlan1"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan1"
                }
              }
            },
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
} 
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>vlan1</id>
              <dropGlean>disabled</dropGlean>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan1</id>
      </If-list>
    </svi-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release


CLI Commands

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

interface ethernet 1/2
 interface vlan 1
  no ip drop-glean

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.

MODN
topSystem sys
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}
l1PhysIf sys/intf/phys-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
dropGleannw:AdminSt
(scalar:Enum8)
ip drop-glean enabled/disabledSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


sviIf Properties

The following table contains information about the sviIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


l1PhysIf Properties

The following table contains information about the l1PhysIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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

Sending ICMP Redirect Messages

Sending ICMP Redirect Messages
POST http://<mgmt0_IP>/api/mo/sys/icmpv4/inst.json
{
 "icmpv4Inst": {
   "children": [
     {
       "icmpv4Dom": {
         "attributes": {
           "name": "default"
         },
         "children": [
           {
             "icmpv4If": {
               "attributes": {
                 "ctrl": "port-unreachable,redirect",
                 "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <icmpv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <ctrl>port-unreachable,redirect</ctrl>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </icmpv4-items>
</System>

Enables sending redirects.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip redirects

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.

MODN
icmpv4Inst sys/icmpv4/inst
icmpv4Dom sys/icmpv4/inst/dom-{name}
icmpv4If sys/icmpv4/inst/dom-{name}/if-{[id]}


icmpv4Dom Properties

The following table contains information about the icmpv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


icmpv4If Properties

The following table contains information about the icmpv4If 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 NameData TypeDescriptionValues
ctrlicmp:IfControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - port-unreachable
2 - unreachable
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 IP Address on an Interface

Configuring an IP Address on an Interface
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv4Addr": {
                      "attributes": {
                        "addr": "4.4.4.4/5",
                        "tag": "111"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <addr-items>
                <Addr-list>
                  <addr>4.4.4.4/5</addr>
                  <tag>111</tag>
                </Addr-list>
              </addr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Configures an IP address on an interface.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip address 4.4.4.4/5 tag 111

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
ipv4Addr sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv4Addr Properties

The following table contains information about the ipv4Addr 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue must match ipv4 or ipv6 known format
tagrt:Tag
(scalar:Uint32)
Route Tag
RANGE: [0 , 0xffffffff]
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

Configuring Additional IP Addresses on an Interface

Configuring Additional IP Addresses on an Interface
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv4Addr": {
                      "attributes": {
                        "addr": "4.4.4.4/5",
                        "tag": "111",
                        "type": "secondary"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <addr-items>
                <Addr-list>
                  <addr>4.4.4.4/5</addr>
                  <tag>111</tag>
                  <type>secondary</type>
                </Addr-list>
              </addr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Configures additional IP addresses on an interface.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip address 4.4.4.4/5 secondary tag 323

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
ipv4Addr sys/ipv4/inst/dom-{name}/if-{[id]}/addr-{[addr]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv4Addr Properties

The following table contains information about the ipv4Addr 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue must match ipv4 or ipv6 known format
tagrt:Tag
(scalar:Uint32)
Route Tag
RANGE: [0 , 0xffffffff]
DEFAULT: 0
typeip:AddrT
(scalar:Enum8)
TypeSELECTION:
1 - primary
2 - secondary
DEFAULT: primary


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 IP Forwarding on an Interface

Enabling IP Forwarding on an Interface
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "forward": "enabled",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <forward>enabled</forward>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Enables IP forwarding on an interface.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip forward

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
forwardnw:AdminSt
(scalar:Enum8)
IP forwardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 IP-Directed Broadcast ACL Policy

Enabling an IP-Directed Broadcast ACL Policy
POST http://<mgmt0_IP>/api/mo/sys/ipv4/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "acl": "ACL_Policy_Name",
                  "directedBroadcast": "enabled",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <acl>ACL_Policy_Name</acl>
              <directedBroadcast>enabled</directedBroadcast>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Enables an IP-directed broadcast ACL policy.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip directed-broadcast ACL_Policy_Name

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
aclstring:Basic
IP directed broadcast ACL
RANGE: [0 , 63]
directedBroadcastscalar:Enum8
IP directed broadcast
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 the Sending of ICMP Unreachables (other than port-unreachable)

Enabling the Sending of ICMP Unreachables (other than port-unreachable)
POST http://<mgmt0_IP>/api/mo/sys/icmpv4/inst.json
{
  "icmpv4Inst": {
    "children": [
      {
        "icmpv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "icmpv4If": {
                "attributes": {
                  "ctrl": "port-unreachable,redirect,unreachable",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <icmpv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <ctrl>port-unreachable,redirect,unreachable</ctrl>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </icmpv4-items>
</System>

Enables the sending of ICMP unreachables (other than port-unreachable).


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip unreachables

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.

MODN
icmpv4Inst sys/icmpv4/inst
icmpv4Dom sys/icmpv4/inst/dom-{name}
icmpv4If sys/icmpv4/inst/dom-{name}/if-{[id]}


icmpv4Dom Properties

The following table contains information about the icmpv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


icmpv4If Properties

The following table contains information about the icmpv4If 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 NameData TypeDescriptionValues
ctrlicmp:IfControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - port-unreachable
2 - unreachable
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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

Enable Sending an ICMP Port Unreachable

Enable Sending an ICMP Port Unreachable
POST http://<mgmt0_IP>/api/mo/sys/icmpv4/inst.json
{
  "icmpv4Inst": {
    "children": [
      {
        "icmpv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "icmpv4If": {
                "attributes": {
                  "ctrl": "port-unreachable,redirect",
                  "id": "eth1/1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <icmpv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <ctrl>port-unreachable,redirect</ctrl>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </icmpv4-items>
</System>

Enables sending an ICMP port unreachable.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ip port-unreachable

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.

MODN
icmpv4Inst sys/icmpv4/inst
icmpv4Dom sys/icmpv4/inst/dom-{name}
icmpv4If sys/icmpv4/inst/dom-{name}/if-{[id]}


icmpv4Dom Properties

The following table contains information about the icmpv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


icmpv4If Properties

The following table contains information about the icmpv4If 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 NameData TypeDescriptionValues
ctrlicmp:IfControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - port-unreachable
2 - unreachable
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 IPv6 on an Interface Using only a Single Link-Local Address
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
  "ipv6Inst": {
    "children": [
      {
        "ipv6Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv6If": {
                "attributes": {
                  "autoconfig": "disabled",
                  "id": "eth1/1",
                  "useLinkLocalAddr": "enabled"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <autoconfig>disabled</autoconfig>
              <useLinkLocalAddr>enabled</useLinkLocalAddr>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Enables IPv6 on an interface using only a single link-local address.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 address use-link-local-only

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
autoconfignw:AdminSt
(scalar:Enum8)
IPv6 Stateless address autoconfigSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
useLinkLocalAddrnw:AdminSt
(scalar:Enum8)
IPv6 Address Use Link Local AddressSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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

Changing the Format of a Link-Local Address
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
  "ipv6Inst": {
    "children": [
      {
        "ipv6Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv6If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv6LLaddr": {
                      "attributes": {
                        "addr": "feb1:2::3:4"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <lladdr-items>
                <LLaddr-list>
                  <addr>feb1:2::3:4</addr>
                </LLaddr-list>
              </lladdr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Changes the format of a link-local address.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 link-local FEB1:2::3:4

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}
ipv6LLaddr sys/ipv6/inst/dom-{name}/if-{[id]}/lladdr-{[addr]}


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6LLaddr Properties

The following table contains information about the ipv6LLaddr 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue 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

Configuring IPv6 Addresses on an Interface

Configuring IPv6 Addresses on an Interface
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
  "ipv6Inst": {
    "children": [
      {
        "ipv6Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv6If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv6Addr": {
                      "attributes": {
                        "addr": "1:2::3:4/3",
                        "ctrl": "eui64",
                        "pref": "44"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <addr-items>
                <Addr-list>
                  <addr>1:2::3:4/3</addr>
                  <ctrl>eui64</ctrl>
                  <pref>44</pref>
                </Addr-list>
              </addr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Configures IPv6 addresses on an interface.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 address 1:2::3:4/3 eui64 route-preference 44

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}
ipv6Addr sys/ipv6/inst/dom-{name}/if-{[id]}/addr-{[addr]}


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6Addr Properties

The following table contains information about the ipv6Addr 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue must match ipv4 or ipv6 known format
ctrlip:AddrControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - pervasive
2 - fabric-aware
65536 - eui64
131072 - anycast
prefip:Preference
(scalar:UByte)
Preference
RANGE: [0 , 255]
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

Configuring a U6RIB Route Preference for Local or Direct Routes

Configuring a U6RIB Route Preference for Local or Direct Routes
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
  "ipv6Inst": {
    "children": [
      {
        "ipv6Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv6If": {
                "attributes": {
                  "autoconfig": "enabled",
                  "defaultRoute": "enabled",
                  "id": "eth1/1",
                  "useLinkLocalAddr": "disabled"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <autoconfig>enabled</autoconfig>
              <defaultRoute>enabled</defaultRoute>
              <useLinkLocalAddr>disabled</useLinkLocalAddr>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Configuring a U6RIB route preference for local or direct routes.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 address autoconfig default

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
autoconfignw:AdminSt
(scalar:Enum8)
IPv6 Stateless address autoconfigSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
defaultRoutenw:AdminSt
(scalar:Enum8)
Default Route Addition with Nexthop as RA Source AddressSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
useLinkLocalAddrnw:AdminSt
(scalar:Enum8)
IPv6 Address Use Link Local AddressSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled


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 IPv6 Stateless Address Autoconfig

Configuring IPv6 Stateless Address Autoconfig
POST http://<mgmt0_IP>/api/mo/sys/ipv6/inst.json
{
  "ipv6Inst": {
    "children": [
      {
        "ipv6Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv6If": {
                "attributes": {
                  "id": "eth1/1"
                },
                "children": [
                  {
                    "ipv6Neighbor": {
                      "attributes": {
                        "addr": "1:2::3:4",
                        "neighborMac": "00:05:00:05:00:05"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <nghbr-items>
                <Neighbor-list>
                  <addr>1:2::3:4</addr>
                  <neighborMac>00:05:00:05:00:05</neighborMac>
                </Neighbor-list>
              </nghbr-items>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Configures IPv6 stateless address autoconfig.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 neighbor 1:2::3:4 5.5.5

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.

MODN
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}
ipv6Neighbor sys/ipv6/inst/dom-{name}/if-{[id]}/nghbr-{[addr]}


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6Neighbor Properties

The following table contains information about the ipv6Neighbor 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 NameData TypeDescriptionValues
addraddress:Ip
AddressValue must match ipv4 or ipv6 known format
neighborMacaddress:MAC
IPv6 neighbor MAC AddressValue must match MM:MM:MM:SS:SS:SS 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

Enable Sending ICMPv6 Unreachable Messages

Enable Sending ICMPv6 Unreachable Messages
POST http://<mgmt0_IP>/api/mo/sys/icmpv6/inst.json
{
  "icmpv6Inst": {
    "children": [
      {
        "icmpv6If": {
          "attributes": {
            "ctrl": "unreachables-icmp",
            "id": "eth1/1"
}}}]}}
{
    imdata:[]
}
<System>
  <icmpv6-items>
    <inst-items>
      <if-items>
        <If-list>
          <id>eth1/1</id>
          <ctrl>unreachables-icmp</ctrl>
        </If-list>
      </if-items>
    </inst-items>
  </icmpv6-items>
</System>

Enables sending ICMPv6 unreachable messages.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 icmp unreachables

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.

MODN
icmpv6Inst sys/icmpv6/inst
icmpv6If sys/icmpv6/inst/if-{[id]}


icmpv6If Properties

The following table contains information about the icmpv6If 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 NameData TypeDescriptionValues
ctrlicmpv6:IfControl
(scalar:Bitmask64)
The control state.SELECTION:
1 - unreachables
2 - unreachables-icmp
256 - redirect
DEFAULT: redirect
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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

Specifying when Probing for an Adjacency Begins

Specifying when Probing for an Adjacency Begins
POST http://<mgmt0_IP>/api/mo/sys/icmpv6.json
{
  "icmpv6Entity": {
    "children": [
      {
        "icmpv6Inst": {
          "attributes": {
            "adjStaleTimer": "300",
            "adjStaleTimerIcmp": "disabled"
}}}]}}
{
    imdata:[]
}
<System>
  <icmpv6-items>
    <inst-items>
      <adjStaleTimer>300</adjStaleTimer>
      <adjStaleTimerIcmp>disabled</adjStaleTimerIcmp>
    </inst-items>
  </icmpv6-items>
</System>

Specifies when probing for an adjacency begins.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 adjacency-stale-timer 300

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.

MODN
icmpv6Entity sys/icmpv6
icmpv6Inst sys/icmpv6/inst


icmpv6Inst Properties

The following table contains information about the icmpv6Inst 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 NameData TypeDescriptionValues
adjStaleTimericmpv6:AdjStaleTimer
(scalar:Uint16)
Adjacency stale timer
RANGE: [30 , 65535]
DEFAULT: 1380
adjStaleTimerIcmpnw:AdminSt
(scalar:Enum8)
Ipv6 adjacency stale timer with ICMP optionSELECTION:
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

Configuring an IP Interface as Unnumbered

Configuring an IP Interface as Unnumbered
POST http://<mgmt0_IP>/api/mo/sys/nd/inst.json
{
  "ipv4Inst": {
    "children": [
      {
        "ipv4Dom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "ipv4If": {
                "attributes": {
                  "id": "eth1/1",
                  "unnumbered": "lo1"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>eth1/1</id>
              <unnumbered>lo1</unnumbered>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
</System>

Configures an IP interface as unnumbered.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet 1/1
 ip unnumbered lo1

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.

MODN
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
unnumberednw:IfId
(base:IfIndex)
IP unnumberedMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 Unnumbered VLAN Interface

Configuring an Unnumbered VLAN Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
{
"ipv4Entity": {
  "children": [
{
  "ipv4Inst": {
    "children": [
{
"ipv4Dom": {
  "attributes": {
    "name": "default"
},
"children": [
{
  "ipv4If": {
    "attributes": {
      "id": "vlan123",
      "unnumbered": "vlan321"
}}}]}}]}}]}},{
"interfaceEntity": {
  "children": [
{
  "sviIf": {
    "attributes": {
      "id": "vlan123"

}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>vlan123</id>
              <unnumbered>vlan321</unnumbered>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
      </If-list>
    </svi-items>
  </intf-items>
</System>


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.

interface vlan 123
  ip unnumbered vlan 321

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.

MODN
topSystem sys
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
unnumberednw:IfId
(base:IfIndex)
IP unnumberedMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


sviIf Properties

The following table contains information about the sviIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 an Unnumbered VLAN Interface

Deleting an Unnumbered VLAN Interface
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
{
"ipv4Entity": {
  "children": [
{
  "ipv4Inst": {
"children": [
  {
"ipv4Dom": {
  "attributes": {
    "name": "default"
},
"children": [
{
  "ipv4If": {
    "attributes": {
      "id": "vlan123",
      "unnumbered": "unspecified"
}}}]}}]}}]}},{
        "interfaceEntity": {
          "children": [
            {
              "sviIf": {
                "attributes": {
                  "id": "vlan123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <ipv4-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>vlan123</id>
              <unnumbered>unspecified</unnumbered>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv4-items>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan123</id>
      </If-list>
    </svi-items>
  </intf-items>
</System>


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.

interface vlan 123
  no ip unnumbered vlan 321

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.

MODN
topSystem sys
ipv4Entity sys/ipv4
ipv4Inst sys/ipv4/inst
ipv4Dom sys/ipv4/inst/dom-{name}
ipv4If sys/ipv4/inst/dom-{name}/if-{[id]}
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}


ipv4Dom Properties

The following table contains information about the ipv4Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv4If Properties

The following table contains information about the ipv4If 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
unnumberednw:IfId
(base:IfIndex)
IP unnumberedMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


sviIf Properties

The following table contains information about the sviIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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 VLAN Interface as IPv6 Forward

Configuring a VLAN Interface as IPv6 Forward
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
{
"interfaceEntity": {
  "children": [
{
  "sviIf": {
    "attributes": {
      "id": "vlan1"
}}}]}},{
"ipv6Entity": {
  "children": [
{
  "ipv6Inst": {
    "children": [
{
"ipv6Dom": {
  "attributes": {
    "name": "default"
},
"children": [
{
  "ipv6If": {
    "attributes": {
      "forward": "enabled",
      "id": "vlan1"
}}}]}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <intf-items>
    <svi-items>
      <If-list>
        <id>vlan2</id>
      </If-list>
    </svi-items>
  </intf-items>
  <ipv6-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>default</name>
          <if-items>
            <If-list>
              <id>vlan2</id>
              <forward>enabled</forward>
            </If-list>
          </if-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </ipv6-items>
</System>

Configures a VLAN interface as IPv6 forward.


CLI Commands

The CLI commands and options listed below are the 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 or the YANG tab to view the XML payload.

interface ethernet1/1
 ipv6 forward

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.

MODN
topSystem sys
interfaceEntity sys/intf
sviIf sys/intf/svi-{[id]}
ipv6Entity sys/ipv6
ipv6Inst sys/ipv6/inst
ipv6Dom sys/ipv6/inst/dom-{name}
ipv6If sys/ipv6/inst/dom-{name}/if-{[id]}


sviIf Properties

The following table contains information about the sviIf 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 NameData TypeDescriptionValues
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


ipv6Dom Properties

The following table contains information about the ipv6Dom 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 NameData TypeDescriptionValues
namenaming:Name256
(string:Basic)
The name of the object.
MAX SIZE: 63


ipv6If Properties

The following table contains information about the ipv6If 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 NameData TypeDescriptionValues
forwardnw:AdminSt
(scalar:Enum8)
IPv6 forwardSELECTION:
1 - enabled
2 - disabled
DEFAULT: disabled
idnw:IfId
(base:IfIndex)
An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100


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