Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Disabling Loop-Free Detection

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/intf.json
{
  "interfaceEntity": {
    "children": [
      {
        "l1PhysIf": {
          "attributes": {
            "id": "eth1/1"
          },
          "children": [
            {
              "l1PhysIfExtended": {
                "attributes": {
                  "switchportIsolated": "enable"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/1</id>
        <physExtd-items>
          <switchportIsolated>enable</switchportIsolated>
        </physExtd-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring an Ethernet Interface (Nonmember)

Disabling Loop-Free Detection

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/1
switchport isolated

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

Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
l1PhysIfExtended	sys/intf/phys-{[id]}/physExtd

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 Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIfExtended Properties

The following table contains information about the l1PhysIfExtended properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
switchportIsolated	l1:SwitchportIsolated (scalar:Enum8)	Switchport Isolated	SELECTION: 0 - disable 1 - enable 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 Disabled Loop-Free Detection

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

CLI Commands

interface ethernet 1/1
no switchport isolated

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
l1PhysIfExtended	sys/intf/phys-{[id]}/physExtd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIfExtended Properties

Property Name	Data Type	Description	Values
switchportIsolated	l1:SwitchportIsolated (scalar:Enum8)	Switchport Isolated	SELECTION: 0 - disable 1 - enable 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

Configuring Default EtherType for 802.1q Frames

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

CLI Commands

interface ethernet 1/1
switchport dot1q ethertype 0x8100

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}

l1PhysIf Properties

Property Name	Data Type	Description	Values
dot1qEtherType	l1:DDot1qEtherType (scalar:Uint32)	The administrative port Dot1q ether-type. Dot1q Ether Type configures the TPID value in the VLAN tag field for packets received and sent by the interface.	RANGE: [1536 , 65535] DEFAULT: 0x8100
id	nw: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 Default EtherType for 802.1q Frames

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

CLI Commands

interface ethernet 1/1
no switchport dot1q ethertype 0x8100

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}

l1PhysIf Properties

Property Name	Data Type	Description	Values
dot1qEtherType	l1:DDot1qEtherType (scalar:Uint32)	The administrative port Dot1q ether-type. Dot1q Ether Type configures the TPID value in the VLAN tag field for packets received and sent by the interface.	RANGE: [1536 , 65535] DEFAULT: 0x8100
id	nw: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 Extra Buffers for this Interface

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

CLI Commands

interface ethernet 1/1
buffer-boost

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
l1PhysIfExtended	sys/intf/phys-{[id]}/physExtd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIfExtended Properties

Property Name	Data Type	Description	Values
bufferBoost	l1:BufferBoost (scalar:Enum8)	Disable/enable buffer boost on interface	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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 Extra Buffers for this Interface

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

CLI Commands

interface ethernet 1/1
no buffer-boost

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

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-{[id]}
l1PhysIfExtended	sys/intf/phys-{[id]}/physExtd

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIfExtended Properties

Property Name	Data Type	Description	Values
bufferBoost	l1:BufferBoost (scalar:Enum8)	Disable/enable buffer boost on interface	SELECTION: 0 - disable 1 - enable DEFAULT: enable

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 Interface Throughput Delay

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

CLI Commands

interface ethernet 1/1
delay 6490094

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/1]

l1PhysIf Properties

Property Name	Data Type	Description	Values
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
id	nw: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 Interface Throughput Delay

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

CLI Commands

interface ethernet 1/1
no delay 6490094

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/1]

l1PhysIf Properties

Property Name	Data Type	Description	Values
delay	l1:Delay (scalar:Uint32)	The administrative port delay time.	RANGE: [1 , 16777215] DEFAULT: 1
id	nw: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