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

Enabling LACP

DME

YANG

Copy
POST http://<IP_Address>/api/mo/sys/fm.json
{
"fmEntity": {
  "children": [
    {
      "fmLacp": {
        "attributes": {
          "adminSt": "enabled"
}}}]}}      
Response
{
    imdata": []
}

Copy
<System>
  <fm-items>
    <lacp-items>
      <adminSt>enabled</adminSt>
    </lacp-items>
  </fm-items>
</System>

Configuring LACP

This section contains payload examples to demonstrate how to use the NX-API REST API to configure LACP on the Cisco Nexus 3000 and 9000 Series switches.

Enabling LACP

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

feature lacp

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
fmEntity	sys/fm
fmLacp	sys/fm/lacp

fmLacp Properties

The following table contains information about the fmLacp 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
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 LACP

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

no feature lacp

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

MO	DN
fmEntity	sys/fm
fmLacp	sys/fm/lacp

fmLacp Properties

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

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 LACP Rate Fast

The LACP rate fast feature is used to set the rate (once every second) at which the LACP control packets are sent to an LACP-supported interface.

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 1/2
lacp rate fast

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

MO	DN
lacpEntity	sys/lacp
lacpInst	sys/lacp/inst
lacpIf	sys/lacp/inst/if-{[id]}

lacpIf Properties

The following table contains information about the lacpIf 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
txRate	lacp:TxRate (scalar:Enum8)	Specifies the rate at which the LACP packets are transmitted.	SELECTION: 1 - normal 2 - fast DEFAULT: normal

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 LACP Rate Normal

Specifies that LACP control packets are ingressed at the normal rate, every 30 seconds after the link is bundled.

CLI Command

The CLI command below is the equivalent to the payload example displayed in the pane on the right.

interface ethernet 1/2
lacp rate normal

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

MO	DN
lacpEntity	sys/lacp
lacpInst	sys/lacp/inst
lacpIf	sys/lacp/inst/if-{[id]}

lacpIf 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
txRate	lacp:TxRate (scalar:Enum8)	Specifies the rate at which the LACP packets are transmitted.	SELECTION: 1 - normal 2 - fast DEFAULT: normal

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 the MAC Address to be Used for the LACP Protocol Exchanges (Role: Primary)

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.

lacp system-mac 1234.1234.1234 role primary

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

MO	DN
lacpEntity	sys/lacp
lacpInst	sys/lacp/inst

lacpInst Properties

The following table contains information about the lacpInst 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
adminRole	lacp:SysRole (scalar:Enum8)	System Role	SELECTION: 1 - primary 2 - secondary DEFAULT: primary
adminSysMac	lacp:SysMac (address:MAC)	System MAC	Value must match MM:MM:MM:SS:SS:SS format

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 the MAC Address to be Used for the LACP Protocol Exchanges (Role: Secondary)

CLI Commands

lacp system-mac 1234.1234.1234 role secondary

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

MO	DN
lacpEntity	sys/lacp
lacpInst	sys/lacp/inst

lacpInst Properties

Property Name	Data Type	Description	Values
adminRole	lacp:SysRole (scalar:Enum8)	System Role	SELECTION: 1 - primary 2 - secondary DEFAULT: primary
adminSysMac	lacp:SysMac (address:MAC)	System MAC	Value must match MM:MM:MM:SS:SS:SS format

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

Resetting to Use the Default VDC MAC Address

CLI Commands

no lacp system-mac

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

MO	DN
lacpEntity	sys/lacp
lacpInst	sys/lacp/inst

lacpInst Properties

Property Name	Data Type	Description	Values
adminRole	lacp:SysRole (scalar:Enum8)	System Role	SELECTION: 1 - primary 2 - secondary DEFAULT: primary
adminSysMac	lacp:SysMac (address:MAC)	System MAC	Value must match MM:MM:MM:SS:SS:SS format

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

Querying the LACP Configuration

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

MO	DN
lacpInst	sys/lacp/inst

lacpInst Properties

Property Name	Data Type	Description	Values
adminPrio	lacp:SysPrio (scalar:Uint16)	Specifies the LACP instance administrative system priority.	RANGE: [1 , 65535] DEFAULT: 32768
adminSt	nw:AdminSt scalar:Enum8	The administrative state of the object or policy.	SELECTION: 1 - enabled 2 - disabled DEFAULT: enabled(1)
childAction	mo:ModificationChildAction scalar:Bitmask32	Delete or ignore. For internal use only.	SELECTION: 16384u - deleteAll 4096u - ignore 8192u - deleteNonPresent DEFAULT: 0
ctrl	nw:InstCtrl scalar:Bitmask64	The control state.	SELECTION: 1ull - stateful-ha DEFAULT: 0
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
lacpctrl	lacp:LACPInstCtrl (scalar:Bitmask32)	Instance Control	SELECTION: 1 - rapid-transition
modTs	mo:TStamp (scalar:Date)	The time when this object was last modified.	SELECTION: 0 - never DEFAULT: never
monPolDn	reference:BinRef	The monitoring policy attached to this observable object.
name	naming:Name256 string:Basic	The name of the object.	RANGE: Min: "0" Max: "128"
operErr	nw:OperErrQual (scalar:Bitmask64)	Operational Errors Qualifier	SELECTION: 1 - init-err 2 - mem-err 4 - ipc-err 8 - int-err 16 - sock-err 32 - proto-err
operPrio	lacp:SysPrio (scalar:Uint16)	Specifies the LACP instance operational system priority.	RANGE: [1 , 65535] DEFAULT: 32768
persistentOnReload	mo:Persistent scalar:Enum8	NO COMMENTS	SELECTION: 0 - false 1 - true DEFAULT: true(1)
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced
sysMac	lacp:SysMac (address:MAC)	Specifies the instance System MAC.	Value must match MM:MM:MM:SS:SS:SS format
uid	scalar:Uint16	A unique identifier for this object.

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 Delayed LACP on the Port Channel

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

CLI Commands

interface port-channel 123
lacp mode delay

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

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
lacpDelayMode	scalar:Enum8	Configuring LACP delay mode	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 Delayed LACP on the Port Channel

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

CLI Commands

interface port-channel 123
no lacp mode delay

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
lacpDelayMode	scalar:Enum8	Configuring LACP delay mode	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 Delayed LACP on the Port Channel

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

CLI Commands

interface port-channel 123
switchport
lacp mode delay

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
lacpDelayMode	scalar:Enum8	Configuring LACP delay mode	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

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 Delayed LACP on the Port Channel

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

CLI Commands

interface port-channel 123
switchport
no lacp mode delay

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
lacpDelayMode	scalar:Enum8	Configuring LACP delay mode	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

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