dellemc.enterprise_sonic.sonic_lag_interfaces module – Manage link aggregation group (LAG) interface parameters

Note

This module is part of the dellemc.enterprise_sonic collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.enterprise_sonic.

To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_lag_interfaces.

New in dellemc.enterprise_sonic 1.0.0

Synopsis 

This module manages attributes of link aggregation group (LAG) interfaces of devices running Enterprise SONiC Distribution by Dell Technologies.

Note

This module has a corresponding action plugin.

Parameters 

Parameter	Comments
config list / elements=dictionary	A list of LAG configurations.
ethernet_segment dictionary added in dellemc.enterprise_sonic 2.5.0	Specifies Ethernet segment.
df_preference integer	The preference for Designated Forwarder election method. The range of df_preference value is from 1 to 65535.
esi string	Specifies value of Ethernet Segment Identifier. Only “AUTO” is supported for auto_lacp and auto_system_mac.
esi_type string / required	Specifies type of Ethernet Segment Identifier. esi_type and esi can not be deleted separately. If both esi and df_preference are not present, deleted state will delete whole ethernet segment. Choices: `"auto_lacp"` `"auto_system_mac"` `"ethernet_segment_id"`
members dictionary	The list of interfaces that are part of the group.
interfaces list / elements=dictionary	The list of interfaces that are part of the group.
member string	The interface name.
mode string	Specifies mode of the port-channel while creation. Choices: `"static"` `"lacp"`
name string / required	ID of the LAG.
state string	The state that the configuration should be left in. Choices: `"merged"` ← (default) `"replaced"` `"overridden"` `"deleted"`

Notes 

Note

Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports check_mode.

Examples 

# Using merged
#
# Before state:
# -------------
#
# interface Eth1/10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface PortChannel10
#  no shutdown
#
- name: Merges provided configuration with device configuration
  dellemc.enterprise_sonic.sonic_lag_interfaces:
    config:
     - name: PortChannel10
       members:
         interfaces:
           - member: Eth1/10
       ethernet_segment:
         esi_type: auto_lacp
         df_preference: 2222
     - name: PortChannel12
       members:
         interfaces:
           - member: Eth1/15
    state: merged
#
# After state:
# ------------
#
# interface Eth1/10
#  channel-group 10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface Eth1/15
#  channel-group 12
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface PortChannel10
#  no shutdown
#  !
#  evpn ethernet-segment auto-lacp
#  df-preference 2222
# !
# interface PortChannel12
#  no shutdown
#
#
# Using replaced
#
# Before state:
# -------------
#
# interface Eth1/5
#   channel-group 10
#   mtu 9100
#   speed 100000
#   no shutdown
# !
# interface Eth1/7
#   no channel-group
#   mtu 9100
#   speed 100000
#   no shutdown
# !
# interface PortChannel10
#  no shutdown
#  !
#  evpn ethernet-segment auto-lacp
#   df-preference 2222
#
- name: Replace device configuration of specified LAG attributes
  dellemc.enterprise_sonic.sonic_lag_interfaces:
    config:
      - name: PortChannel20
        members:
          interfaces:
            - member: Eth1/6
        ethernet_segment:
          esi_type: auto_system_mac
          df_preference: 6666
      - name: PortChannel10
        members:
          interfaces:
            - member: Eth1/7
        ethernet_segment:
          esi_type: auto_system_mac
          df_preference: 3333
    state: replaced
#
# After state:
# ------------
#
# interface Eth1/5
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface Eth1/6
#   channel-group 20
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface Eth1/7
#   channel-group 10
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface PortChannel10
#  no shutdown
#  !
#  evpn ethernet-segment auto-system-mac
#   df-preference 3333
#
# interface PortChanne20
#  no shutdown
#  !
#  evpn ethernet-segment auto-system-mac
#   df-preference 6666
#
# Using overridden
#
# Before state:
# -------------
#
# interface Eth1/5
#   channel-group 10
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface Eth1/6
#   no channel-group
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface PortChannel10
#   no shutdown
#   !
#   evpn ethernet-segment auto-system-mac
#    df-preference 2222
#
- name: Override device configuration of all LAG attributes
  dellemc.enterprise_sonic.sonic_lag_interfaces:
    config:
      - name: PortChannel20
        members:
          interfaces:
            - member: Eth1/6
        ethernet_segment:
          esi_type: auto_lacp
          df_preference: 3333
    state: overridden
#
# After state:
# ------------
#
# interface Eth1/5
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface Eth1/6
#   channel-group 20
#   mtu 9100
#   speed 100000
#   no shutdown
#
# interface PortChannel20
#  no shutdown
#  !
#  evpn ethernet-segment auto-lacp
#   df-preference 3333
#
# Using deleted
#
# Before state:
# -------------
# interface PortChannel 10
#  no shutdown
#  !
#  evpn ethernet-segment auto-lacp
#   df-preference 2222
# !
# interface PortChannel 12
# !
# interface Eth1/10
#  channel-group 10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface Eth1/15
#  channel-group 12
#  mtu 9100
#  speed 100000
#  no shutdown
#
- name: Deletes all LAGs and LAG attributes of all interfaces
  dellemc.enterprise_sonic.sonic_lag_interfaces:
    config:
    state: deleted
#
# After state:
# -------------
#
# interface Eth1/10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface Eth1/15
#  mtu 9100
#  speed 100000
#  no shutdown
#
# Using deleted
#
# Before state:
# -------------
# interface Eth1/10
#  channel-group 10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface PortChannel10
#  no shutdown
#  !
#  evpn ethernet-segment auto-lacp
#   df-preference 2222
#
- name: Deletes some LAGs and LAG attributes.
  sonic_lag_interfaces:
    config:
      - name: PortChannel10
        members:
          interfaces:
            - member: Eth1/10
        ethernet_segment:
          esi_type: auto_lacp
    state: deleted
#
# After state:
# -------------
#
# interface Eth1/10
#  mtu 9100
#  speed 100000
#  no shutdown
# !
# interface PortChannel10
#  no shutdown
#  !
#

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
after list / elements=string	The resulting configuration module invocation. Returned: when changed Sample: `["The configuration returned is always in the same format as the parameters above.\n"]`
before list / elements=string	The configuration prior to the module invocation. Returned: always Sample: `["The configuration that is returned is always in the same format as the parameters above.\n"]`
commands list / elements=string	The set of commands pushed to the remote device. Returned: always Sample: `["command 1", "command 2", "command 3"]`

Authors

Abirami N (@abirami-n)

dellemc.enterprise_sonic.sonic_lag_interfaces module – Manage link aggregation group (LAG) interface parameters

Synopsis

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Parameters 

Notes 

Examples 

Return Values 