W3cubDocs

/Ansible

dellemc.enterprise_sonic.sonic_port_breakout – Configure port breakout settings on physical interfaces

Note

This plugin is part of the dellemc.enterprise_sonic collection (version 1.1.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_port_breakout.

New in version 1.0.0: of dellemc.enterprise_sonic

Synopsis

  • This module provides configuration management of port breakout parameters on devices running Enterprise SONiC.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
config
list / elements=dictionary
Specifies the port breakout related configuration.
mode
string
    Choices:
  • 1x100G
  • 1x400G
  • 1x40G
  • 2x100G
  • 2x200G
  • 2x50G
  • 4x100G
  • 4x10G
  • 4x25G
  • 4x50G
Specifies the mode of the port breakout.
name
string / required
Specifies the name of the port breakout.
state
string
    Choices:
  • merged ←
  • deleted
Specifies the operation to be performed on the port breakout configured on the device.
In case of merged, the input mode configuration will be merged with the existing port breakout configuration on the device.
In case of deleted the existing port breakout mode configuration will be removed from the device.

Notes

Note

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

Examples

# Using deleted
#
# Before state:
# -------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   4x10G          Completed     Eth1/1/1
#                                   Eth1/1/2
#                                   Eth1/1/3
#                                   Eth1/1/4
#1/11  1x100G         Completed     Eth1/11
#

- name: Merge users configurations
  dellemc.enterprise_sonic.sonic_port_breakout:
    config:
      - name: 1/11
        mode: 1x100G
    state: deleted

# After state:
# ------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   4x10G          Completed     Eth1/1/1
#                                   Eth1/1/2
#                                   Eth1/1/3
#                                   Eth1/1/4
#1/11  Default        Completed     Ethernet40


# Using deleted
#
# Before state:
# -------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   4x10G          Completed     Eth1/1/1
#                                   Eth1/1/2
#                                   Eth1/1/3
#                                   Eth1/1/4
#1/11  1x100G         Completed     Eth1/11
#
- name: Merge users configurations
  dellemc.enterprise_sonic.sonic_port_breakout:
    config:
    state: deleted


# After state:
# ------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   Default        Completed     Ethernet0
#1/11  Default        Completed     Ethernet40


# Using merged
#
# Before state:
# -------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   4x10G          Completed     Eth1/1/1
#                                   Eth1/1/2
#                                   Eth1/1/3
#                                   Eth1/1/4
#
- name: Merge users configurations
  dellemc.enterprise_sonic.sonic_port_breakout:
    config:
      - name: 1/11
        mode: 1x100G
    state: merged


# After state:
# ------------
#
#do show interface breakout
#-----------------------------------------------
#Port  Breakout Mode  Status        Interfaces
#-----------------------------------------------
#1/1   4x10G          Completed     Eth1/1/1
#                                   Eth1/1/2
#                                   Eth1/1/3
#                                   Eth1/1/4
#1/11  1x100G         Completed     Eth1/11

Return Values

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

Key Returned Description
after
list / elements=string
when changed
The resulting configuration model invocation.

Sample:
The configuration returned will always be in the same format of the parameters above.
before
list / elements=string
always
The configuration prior to the model invocation.

Sample:
The configuration returned will always be in the same format of the parameters above.
commands
list / elements=string
always
The set of commands pushed to the remote device.

Sample:
['command 1', 'command 2', 'command 3']


Authors

  • Niraimadaiselvam M (@niraimadaiselvamm)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_port_breakout_module.html