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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring a Fabric-Facing Port on an Ethernet Interface

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2",
                  "layer": "Layer3",
                  "medium": "p2p",
                  "userCfgdFlags": "admin_layer"
                },
                "children": [
                  {
                    "l1PhysIfExtended": {
                      "attributes": {
                        "portTypeFabric": "yes"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
        <layer>Layer3</layer>
        <medium>p2p</medium>
        <userCfgdFlags>admin_layer</userCfgdFlags>
        <physExtd-items>
          <portTypeFabric>yes</portTypeFabric>
        </physExtd-items>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Configuring an Ethernet Point-to-Point Interface

Configuring a Fabric-Facing Port on an Ethernet Interface

Note: This example was added in Release 9.2(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
no switchport
medium p2p
port-type fabric

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
topSystem	sys
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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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
portTypeFabric	l1:PortTypeFabric (scalar:Enum8)	Identifies if or not the port is a fabric-facing port	SELECTION: 0 - no 1 - yes DEFAULT: no

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 Fabric-Facing Port Configured on an Ethernet Interface

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

CLI Commands

interface ethernet 1/2
no switchport
medium p2p
no port-type fabric

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

l1PhysIfExtended Properties

Property Name	Data Type	Description	Values
portTypeFabric	l1:PortTypeFabric (scalar:Enum8)	Identifies if or not the port is a fabric-facing port	SELECTION: 0 - no 1 - yes DEFAULT: no

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 Description

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

CLI Commands

interface ethernet 1/8.10
description SampleString_123

Verifying a DME Configuration

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

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[eth1/8.10]

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 Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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 a Description

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

CLI Commands

interface ethernet 1/8.10
no description SampleString_123

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
l3EncRtdIf	sys/intf/encrtd-[eth1/8.10]

l3EncRtdIf Properties

Property Name	Data Type	Description	Values
descr	naming:Descr1024 string:Basic	Additional descriptive information about the object.	RANGE: Min: "0" Max: "254"
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 Interface Throughput Delay

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

CLI Commands

interface ethernet 1/2
no switchport
medium p2p
delay 13001985

Verifying a DME Configuration

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

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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/2
no switchport
medium p2p
no delay 13001985

Verifying a DME Configuration

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

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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
medium	l1:Medium (scalar:Enum8)	The administrative port medium type.	SELECTION: 1 - broadcast 2 - p2p DEFAULT: broadcast
userCfgdFlags	l1:userCfgdFlags (scalar:Bitmask8)	Port User Config Flags	SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none

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