Configuring an Ethernet Subinterface

Configuring a Description

Configuring a Description

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "descr": "SampleString_123",
            "id": "eth1/8.10"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/8.10</id>
        <descr>SampleString_123</descr>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


CLI Commands

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

interface ethernet 1/8.10
 description SampleString_123

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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-{[id]}


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
descrnaming:Descr1024
(string:Basic)		Description
MAX SIZE: 254
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 a Description

Deleting a Description

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "descr": "",
            "id": "eth1/8.10"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/8.10</id>
        <descr></descr>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


CLI Commands

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

interface ethernet 1/8.10
 no description SampleString_123

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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-{[id]}


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
descrnaming:Descr1024
(string:Basic)		Description
MAX SIZE: 254
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 IEEE 802.1Q Virtual LAN

Configuring IEEE 802.1Q Virtual LAN

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l3EncRtdIf": {
                "attributes": {
                  "encap": "vlan-1",
                  "id": "eth101/1/48.1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth101/1/48.1</id>
        <encap>vlan-1</encap>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>

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


CLI Commands

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

interface Ethernet101/1/48.1
 encapsulation dot1q 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
topSystem sys
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-{[id]}


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
encapbase:Encap
The routed interface encapsulation VLAN.SELECTION: unknown, vlan-%d or vxlan-%d
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 IEEE 802.1Q Virtual LAN

Deleting IEEE 802.1Q Virtual LAN

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l3EncRtdIf": {
                "attributes": {
                  "encap": "unknown",
                  "id": "eth101/1/48.1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth101/1/48.1</id>
        <encap>unknown</encap>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>

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


CLI Commands

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

interface Ethernet101/1/48.1
 no encapsulation dot1q 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
topSystem sys
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-{[id]}


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
encapbase:Encap
The routed interface encapsulation VLAN.SELECTION: unknown, vlan-%d or vxlan-%d
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 UPDOWN and CHANGE Messages

Configuring UPDOWN and CHANGE Messages 

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "linkLog": "enable"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <linkLog>enable</linkLog>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  logging event port link-status


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
linkLogl1:LinkLog
(scalar:Enum8)		Interface Link Logging EnableSELECTION:
1 - default
2 - enable
3 - disable
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting UPDOWN and CHANGE Messages

Deleting UPDOWN and CHANGE Messages   

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "linkLog": "disable"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <linkLog>disable</linkLog>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  no logging event port link-status


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
linkLogl1:LinkLog
(scalar:Enum8)		Interface Link Logging EnableSELECTION:
1 - default
2 - enable
3 - disable
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring UPDOWN and CHANGE Messages (Using the Default Value)

Configuring UPDOWN and CHANGE Messages (Using the Default Value)  

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "linkLog": "default"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <linkLog>default</linkLog>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  logging event port link-status default


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
linkLogl1:LinkLog
(scalar:Enum8)		Interface Link Logging EnableSELECTION:
1 - default
2 - enable
3 - disable
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting UPDOWN and CHANGE Messages (Using the Default Value)

Deleting UPDOWN and CHANGE Messages (Using the Default Value)  

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "linkLog": "disable"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <linkLog>disable</linkLog>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  no logging event port link-status default


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
linkLogl1:LinkLog
(scalar:Enum8)		Interface Link Logging EnableSELECTION:
1 - default
2 - enable
3 - disable
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring SNMP LINKUP and LINKDOWN Traps

Configuring SNMP LINKUP and LINKDOWN Traps  

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "snmpTrap": "enable"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <snmpTrap>enable</snmpTrap>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  snmp trap link-status


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
snmpTrapscalar:Enum8
Administrative Port Snmp Trap State
DEFAULT: disable


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 SNMP LINKUP and LINKDOWN Traps

Deleting SNMP LINKUP and LINKDOWN Traps  

POST http://<mgmt0_IP>/api/mo/sys/intf.json

{
  "interfaceEntity": {
    "children": [
      {
        "l3EncRtdIf": {
          "attributes": {
            "id": "eth1/2.345",
            "snmpTrap": "disable"
}}}]}}

{
    imdata:[]
}

<System>
  <intf-items>
    <encrtd-items>
      <EncRtdIf-list>
        <id>eth1/2.345</id>
        <snmpTrap>disable</snmpTrap>
      </EncRtdIf-list>
    </encrtd-items>
  </intf-items>
</System>

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


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 ethernet 1/2.345
  no snmp trap link-status


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
interfaceEntity sys/intf
l3EncRtdIf sys/intf/encrtd-[eth1/2.345]


l3EncRtdIf Properties

The following table contains information about the l3EncRtdIf 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
snmpTrapscalar:Enum8
Administrative Port Snmp Trap State
DEFAULT: disable


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