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 Preemption Delay

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "flexlinkFlexlink": {
          "children": [
            {
              "flexlinkInterface": {
                "attributes": {
                  "backupIntf": "eth1/2",
                  "id": "po123",
                  "preemptionDelay": "68"
                }
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "pcAggrIf": {
                "attributes": {
                  "id": "po123",
                  "layer": "Layer2",
                  "userCfgdFlags": "admin_layer"
                }
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
  <flexlink-items>
    <if-items>
      <Interface-list>
        <id>po123</id>
        <backupIntf>eth1/2</backupIntf>
        <preemptionDelay>68</preemptionDelay>
      </Interface-list>
    </if-items>
  </flexlink-items>
  <intf-items>
    <aggr-items>
      <AggrIf-list>
        <id>po123</id>
        <layer>Layer2</layer>
        <userCfgdFlags>admin_layer</userCfgdFlags>
      </AggrIf-list>
    </aggr-items>
  </intf-items>
</System>

Configuring Switchport Backup for a Port-Channel Interface

Configuring Preemption Delay

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 port-channel 123
switchport
switchport backup interface ethernet 1/2 preemption delay 68

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
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

The following table contains information about the flexlinkInterface 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
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
preemptionDelay	flexlink:Delay (scalar:Uint32)	switchport backup interface preemption delay configuration for flexlink	RANGE: [1 , 300] DEFAULT: 35

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
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 - 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 Preemption Delay

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

CLI Commands

interface port-channel 123
switchport
no switchport backup interface Ethernet1/2 preemption delay 68

Verifying a DME Configuration

MO	DN
topSystem	sys
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

Property Name	Data Type	Description	Values
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
preemptionDelay	flexlink:Delay (scalar:Uint32)	switchport backup interface preemption delay configuration for flexlink	RANGE: [1 , 300] DEFAULT: 35

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

Configuring Preemption Mode

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

CLI Commands

interface port-channel 123
switchport
switchport backup interface ethernet 1/2 preemption mode off

Verifying a DME Configuration

MO	DN
topSystem	sys
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

Property Name	Data Type	Description	Values
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
preemptionMode	flexlink:Mode (scalar:Enum8)	switchport backup interface preemption mode configuration for flexlink	SELECTION: 0 - off 1 - forced 2 - bandwidth DEFAULT: off

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 - 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 Preemption Mode

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

CLI Commands

interface port-channel 123
switchport
no switchport backup interface ethernet 1/2 preemption mode off

Verifying a DME Configuration

MO	DN
topSystem	sys
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

Property Name	Data Type	Description	Values
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
preemptionMode	flexlink:Mode (scalar:Enum8)	switchport backup interface preemption mode configuration for flexlink	SELECTION: 0 - off 1 - forced 2 - bandwidth DEFAULT: off

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

Configuring Fast Convergence on a Backup Interface

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

CLI Commands

interface port-channel 123
switchport
switchport backup interface ethernet 1/2 multicast fast-convergence

Verifying a DME Configuration

MO	DN
topSystem	sys
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

Property Name	Data Type	Description	Values
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
fastConv	scalar:Enum8	multicast fast-convergence configuration for flexlink	DEFAULT: disabled
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 - 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 Fast Convergence on a Backup Interface

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

CLI Commands

interface port-channel 123
switchport
no switchport backup interface Ethernet1/2 multicast fast-convergence

Verifying a DME Configuration

MO	DN
topSystem	sys
flexlinkFlexlink	sys/flexlink
flexlinkInterface	sys/flexlink/if-[po123]
interfaceEntity	sys/intf
pcAggrIf	sys/intf/aggr-[po123]

flexlinkInterface Properties

Property Name	Data Type	Description	Values
backupIntf	nw:IfId (base:IfIndex)	Backup Interface configuration for flexlink	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
fastConv	scalar:Enum8	multicast fast-convergence configuration for flexlink	DEFAULT: disabled
id	nw:IfId (base:IfIndex)	Interface ID	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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