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

Creating Port Channels

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/1"
                }
              }
            },
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po10",
                  "isExplicit": "yes",
                  "pcMode": "active"
                },
                "children": [
                  {
                    "pcRsMbrIfs": {
                      "attributes": {
                        "tDn": "sys/intf/phys-[eth1/1]"
                      }
                    }
                  }
                ]
              }
            },
            {
              "pcAggrIf": {
                "attributes": {
                  "accessVlan": "vlan-20",
                  "adminSt": "down",
                  "bw": "20000",
                  "delay": "20",
                  "descr": "test port-channel",
                  "duplex": "full",
                  "id": "po1",
                  "layer": "Layer2",
                  "linkLog": "enable",
                  "minLinks": "5",
                  "mode": "trunk",
                  "mtu": "1750",
                  "snmpTrapSt": "disable",
                  "speed": "40G",
                  "trunkLog": "enable",
                  "trunkVlans": "2-20",
                  "userCfgdFlags": "admin_layer,admin_mtu,admin_state"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy

  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/1</id>
      </PhysIf-list>
    </phys-items>
    <aggr-items>
      <AggrIf-list>
        <id>po10</id>
        <isExplicit>true</isExplicit>
        <pcMode>active</pcMode>
        <rsmbrIfs-items>
          <RsMbrIfs-list>
            <tDn>/System/intf-items/phys-items/PhysIf-list[id='eth1/1']</tDn>
          </RsMbrIfs-list>
        </rsmbrIfs-items>
      </AggrIf-list>
      <AggrIf-list>
        <id>po1</id>
        <accessVlan>vlan-20</accessVlan>
        <adminSt>down</adminSt>
        <bw>20000</bw>
        <delay>20</delay>
        <descr>test port-channel</descr>
        <duplex>full</duplex>
        <layer>Layer2</layer>
        <linkLog>enable</linkLog>
        <minLinks>5</minLinks>
        <mode>trunk</mode>
        <mtu>1750</mtu>
        <snmpTrapSt>disable</snmpTrapSt>
        <speed>40G</speed>
        <trunkLog>enable</trunkLog>
        <trunkVlans>2-20</trunkVlans>
        <userCfgdFlags>admin_layer,admin_mtu,admin_state</userCfgdFlags>
      </AggrIf-list>
    </aggr-items>
  </intf-items>

Configuring a Port-Channel Interface

A port channel is a logical interface that is an aggregation of multiple physical interfaces. You can bundle up to 32 individual links to physical ports into a port channel to improve bandwidth and redundancy. You can also use port channeling to load balance traffic across these channeled physical interfaces.

For more information about port-channel interfaces, see the “Configuring Port Channels” section.

See also Configuring Virtual Port Channels#!configuring-virtual-port-channels).

Creating Port Channels

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.

int port-channel 1 shutdown
description “test port-channel”
mtu 1750
duplex full
no snmp trap link-status
speed 40000
switchport
switchport mode trunk
switchport access vlan 20
switchport trunk allowed vlan 2-20
bandwidth 20000
delay 20
logging event port link-status
logging event port trunk-status
lacp min-links 5
int eth1/1
channel-group 10 mode active

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-[eth1/1]
pcAggrIf	sys/intf/aggr-{[id]}
pcAggrIf	sys/intf/aggr-{[id]}
pcRsMbrIfs	sys/intf/aggr-{[id]}/rsmbrIfs-[sys/intf/phys-[eth1/1]}
pcAggrIf	sys/intf/aggr-{[id]}
pcAggrIf	sys/intf/aggr-{[id]}

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

pcAggrIf Properties

The following table contains information about the pcAggrIf 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
isExplicit	scalar:Bool	PC Created Explicitly	SELECTION: true or false DEFAULT: true
pcMode	pc:Mode (scalar:Enum8)	The aggregated interface protocol channel mode.	SELECTION: 0 - on 1 - static 2 - active 3 - passive 4 - mac-pin DEFAULT: on

pcRsMbrIfs Properties

The following table contains information about the pcRsMbrIfs 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
tDn	reln:Dn reference:BinRef	null

pcAggrIf 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
isExplicit	scalar:Bool	PC Created Explicitly	SELECTION: true or false DEFAULT: true
pcMode	pc:Mode (scalar:Enum8)	The aggregated interface protocol channel mode.	SELECTION: 0 - on 1 - static 2 - active 3 - passive 4 - mac-pin DEFAULT: on

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

Creating Port-Channel Members

CLI Commands

interface ethernet 1/1
channel-group 10 force

MO	DN
topSystem	sys
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
pcRsMbrIfs	sys/intf/aggr-{[id]}/rsmbrIfs-{[tDn]}
l1PhysIf	sys/intf/phys-{[id]}

pcAggrIf 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
isExplicit	scalar:Bool	PC Created Explicitly	SELECTION: true or false DEFAULT: true
pcMode	pc:Mode (scalar:Enum8)	The aggregated interface protocol channel mode.	SELECTION: 0 - on 1 - static 2 - active 3 - passive 4 - mac-pin DEFAULT: on

pcRsMbrIfs Properties

Property Name	Data Type	Description	Values
isMbrForce	pc:ChnlGrpForce (scalar:Bool)	Channel group force	SELECTION: true or false
tDn	reln:Dn reference:BinRef	null

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

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 Fabric-Facing Port on a Port-Channel Interface

CLI Commands

interface port-channel 123
port-type fabric

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]
pcAggrIfExtended	sys/intf/aggr-[po123]/aggrExtd
pcAggrIfExtended	sys/intf/aggr-[po123]/aggrExtd

pcAggrIf 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

pcAggrIfExtended Properties

The following table contains information about the pcAggrIfExtended 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

pcAggrIfExtended 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

Deleting a Fabric-Facing Port Configured on a Port-Channel Interface

CLI Commands

interface port-channel 123
no port-type fabric

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-{[id]}
pcAggrIfExtended	sys/intf/aggr-{[id]}/aggrExtd
pcAggrIfExtended	sys/intf/aggr-{[id]}/aggrExtd

pcAggrIf 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

pcAggrIfExtended 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

pcAggrIfExtended 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 port-channel 123
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
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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

Deleting a Description

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

CLI Commands

interface port-channel 123
no description SampleString_123

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

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

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

CLI Commands

interface port-channel 123
buffer-boost

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]
pcAggrIfExtended

pcAggrIf 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

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 port-channel 123
no buffer-boost

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]
pcAggrIfExtended

pcAggrIf 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

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 port-channel 123
switchport
switchport dot1q ethertype 0x8100

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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 Default EtherType for 802.1q Frames

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

CLI Commands

interface port-channel 123
switchport
no switchport dot1q ethertype 0x8100

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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

Enabling LACP Convergence For VPC Port Channels

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

CLI Commands

interface port-channel 123
switchport
lacp vpc-convergence

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
lacpVpcConvergence	scalar:Enum8	LACP vpc convergence	DEFAULT: disable
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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

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

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

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

Disabling LACP Convergence For VPC Port Channels

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

CLI Commands

interface port-channel 123
switchport
no LACP vpc-convergence

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
lacpVpcConvergence	scalar:Enum8	LACP vpc convergence	DEFAULT: disable
layer	l1:Layer (scalar:Enum8)	Administrative port layer	SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: pltfmDfltLayer
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

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

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

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

Configuring Disabling Loop-Free Detection

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

CLI Commands

interface port-channel 123
switchport
switchport isolated

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]
pcAggrIfExtended	sys/intf/aggr-[po123]/aggrExtd

pcAggrIf 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: pltfmDfltLayer
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

pcAggrIfExtended 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

Deleting Disabling Loop-Free Detection

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

CLI Commands

interface port-channel 123
switchport
no switchport isolated

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]
pcAggrIfExtended	sys/intf/aggr-[po123]/aggrExtd

pcAggrIf 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: pltfmDfltLayer
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

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

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

CLI Commands

interface port-channel 123
delay 16138833

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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 port-channel 123
no delay 7936140

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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

Configuring UPDOWN and CHANGE Messages

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

CLI Commands

interface port-channel 123
logging event port link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Administrative link logging enable	SELECTION: 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

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

CLI Commands

interface port-channel 123
no logging event port link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Administrative link logging enable	SELECTION: 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)

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

CLI Commands

interface port-channel 123
logging event port link-status default

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Administrative link logging enable	SELECTION: 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)

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

CLI Commands

interface port-channel 123
no logging event port link-status default

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
linkLog	l1:LinkLog (scalar:Enum8)	Administrative link logging enable	SELECTION: 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

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

CLI Commands

interface port-channel 123
snmp trap link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
snmpTrapSt	l1:SnmpTrapSt (scalar:Enum8)	Administrative port snmp trap state	SELECTION: 1 - enable 2 - disable 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 SNMP LINKUP and LINKDOWN Traps

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

CLI Commands

interface port-channel 123
no snmp trap link-status

Verifying a DME Configuration

MO	DN
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

pcAggrIf 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
snmpTrapSt	l1:SnmpTrapSt (scalar:Enum8)	Administrative port snmp trap state	SELECTION: 1 - enable 2 - disable 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

Enabling Port-Channel Fast Convergence

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

CLI Commands

port-channel fast-convergence

Verifying a DME Configuration

MO	DN
topSystem	sys
platformEntity	sys/pltfm

platformEntity Properties

The following table contains information about the platformEntity 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
pcFastConv	platform:PcFastConv (scalar:Enum8)	Port-channel Fast Convergence	SELECTION: 1 - enable 2 - disable 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

Disabling Port-Channel Fast Convergence

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

CLI Commands

no port-channel fast-convergence

Verifying a DME Configuration

MO	DN
topSystem	sys
platformEntity	sys/pltfm

platformEntity Properties

Property Name	Data Type	Description	Values
pcFastConv	platform:PcFastConv (scalar:Enum8)	Port-channel Fast Convergence	SELECTION: 1 - enable 2 - disable 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 Symmetric Load Balancing

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

CLI Commands

port-channel load-balance src-dst ip-l4port-vlan rotate 7 concatenation fex all symmetric

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformLoadBalance	sys/pltfm/pclb

platformLoadBalance Properties

The following table contains information about the platformLoadBalance 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
concatenation	platform:Concatenation (scalar:Enum8)	Enable/Disable load-balancing concatenation parameter	SELECTION: 0 - disable 1 - enable 2 - rotateEnable DEFAULT: disable
encapsulation	platform:Encapsulation (scalar:Enum8)	load balancing encapsulation parameter	SELECTION: 0 - disable 1 - gre DEFAULT: disable
fex	scalar:Bool	fex based load balancing parameter	SELECTION: true or false
loadBalanceAlgo	platform:LoadBalanceAlgo (scalar:Enum8)	src-dst based load balancing parameters	SELECTION: 1 - dstMac 2 - srcMac 3 - srcDstMac 4 - dstIpVlan 5 - srcIpVlan 6 - srcDstIpVlan 7 - dstL4Port 8 - srcL4Port 9 - srcDstL4Port 10 - dstIpL4Port 11 - srcIpL4Port 12 - srcDstIpL4Port 13 - dstIpL4PortVlan 14 - srcIpL4PortVlan 15 - srcDstIpL4PortVlan 16 - dstIp 17 - srcIp 18 - srcDstIp 21 - srcIpGre 22 - dstIpGre 23 - srcDstIpGre 30 - srcInnerheader 31 - dstInnerheader 32 - srcDstInnerheader 33 - srcGtpu 34 - dstGtpu 35 - srcDstGtpu DEFAULT: srcDstIpL4Port
rotate	platform:Rotate (scalar:Uint16)	Hash-input of load balancing rotate parameter	RANGE: [0 , 63] DEFAULT: 0
symmetry	platform:Symmetry (scalar:Enum8)	load balancing symmetry parameter	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

Unconfiguring Symmetric Load Balancing

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

CLI Commands

no port-channel load-balance src-dst ip-l4port-vlan rotate 7 concatenation fex all symmetric

Verifying a DME Configuration

MO	DN
platformEntity	sys/pltfm
platformLoadBalance	sys/pltfm/pclb

platformLoadBalance Properties

Property Name	Data Type	Description	Values
concatenation	platform:Concatenation (scalar:Enum8)	Enable/Disable load-balancing concatenation parameter	SELECTION: 0 - disable 1 - enable 2 - rotateEnable DEFAULT: disable
encapsulation	platform:Encapsulation (scalar:Enum8)	load balancing encapsulation parameter	SELECTION: 0 - disable 1 - gre DEFAULT: disable
fex	scalar:Bool	fex based load balancing parameter	SELECTION: true or false
loadBalanceAlgo	platform:LoadBalanceAlgo (scalar:Enum8)	src-dst based load balancing parameters	SELECTION: 1 - dstMac 2 - srcMac 3 - srcDstMac 4 - dstIpVlan 5 - srcIpVlan 6 - srcDstIpVlan 7 - dstL4Port 8 - srcL4Port 9 - srcDstL4Port 10 - dstIpL4Port 11 - srcIpL4Port 12 - srcDstIpL4Port 13 - dstIpL4PortVlan 14 - srcIpL4PortVlan 15 - srcDstIpL4PortVlan 16 - dstIp 17 - srcIp 18 - srcDstIp 21 - srcIpGre 22 - dstIpGre 23 - srcDstIpGre 30 - srcInnerheader 31 - dstInnerheader 32 - srcDstInnerheader 33 - srcGtpu 34 - dstGtpu 35 - srcDstGtpu DEFAULT: srcDstIpL4Port
rotate	platform:Rotate (scalar:Uint16)	Hash-input of load balancing rotate parameter	RANGE: [0 , 63] DEFAULT: 0
symmetry	platform:Symmetry (scalar:Enum8)	load balancing symmetry parameter	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