dellemc.enterprise_sonic.sonic_port_breakout module – Configure port breakout settings on physical interfaces
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_port_breakout.
New in dellemc.enterprise_sonic 1.0.0
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 |
Comments |
|---|---|
Specifies the port breakout related configuration. |
|
Specifies the mode of the port breakout. Choices:
|
|
Specifies the name of the port breakout. |
|
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. In case of replaced, on-device port breakout configuration of the specified interfaces is replaced with provided configuration. In case of overridden, all on-device port breakout configurations are overridden with the provided configuration. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode.
Examples
# Using deleted
#
# Before state:
# -------------
#
# sonic# 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/1
#
- name: Delete interface port breakout configuration
dellemc.enterprise_sonic.sonic_port_breakout:
config:
- name: 1/11
mode: 1x100G
state: deleted
# After state:
# ------------
#
# sonic# 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 Eth1/11
#
# Using deleted
#
# Before state:
# -------------
#
# sonic# 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/1
#
- name: Delete all port breakout configurations
dellemc.enterprise_sonic.sonic_port_breakout:
config:
state: deleted
# After state:
# ------------
#
# sonic# show interface breakout
# -----------------------------------------------
# Port Breakout Mode Status Interfaces
# -----------------------------------------------
# 1/1 Default Completed Eth1/1
# 1/11 Default Completed Eth1/11
# Using merged
#
# Before state:
# -------------
#
# sonic# 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 port breakout configurations
dellemc.enterprise_sonic.sonic_port_breakout:
config:
- name: 1/11
mode: 1x100G
state: merged
# After state:
# ------------
#
# sonic# 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/1
# Using replaced
#
# Before state:
# -------------
#
# sonic# show interface breakout
# -----------------------------------------------
# Port Breakout Mode Status Interfaces
# -----------------------------------------------
# 1/49 4x25G Completed Eth1/49/1
# Eth1/49/2
# Eth1/49/3
# Eth1/49/4
#
- name: Replace port breakout configurations
dellemc.enterprise_sonic.sonic_port_breakout:
config:
- name: 1/49
mode: 4x10G
state: replaced
# After state:
# ------------
#
# sonic# show interface breakout
# -----------------------------------------------
# Port Breakout Mode Status Interfaces
# -----------------------------------------------
# 1/49 4x10G Completed Eth1/49/1
# Eth1/49/2
# Eth1/49/3
# Eth1/49/4
# Using overridden
#
# Before state:
# -------------
#
# sonic# show interface breakout
# ----------------------------------------------
# Port Breakout Mode Status Interfaces
# -----------------------------------------------
# 1/49 4x10G Completed Eth1/49/1
# Eth1/49/2
# Eth1/49/3
# Eth1/49/4
# 1/50 2x50G Completed Eth1/50/1
# Eth1/50/2
# 1/51 1x100G Completed Eth1/51/1
#
- name: Override port breakout configurations
dellemc.enterprise_sonic.sonic_port_breakout:
config:
- name: 1/52
mode: 4x10G
state: overridden
# After state:
# ------------
#
# sonic# show interface breakout
# -----------------------------------------------
# Port Breakout Mode Status Interfaces
# -----------------------------------------------
# 1/49 Default Completed Eth1/49
# 1/50 Default Completed Eth1/50
# 1/51 Default Completed Eth1/51
# 1/52 4x10G Completed Eth1/52/1
# Eth1/52/2
# Eth1/52/3
# Eth1/52/4
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration module invocation. Returned: when changed Sample: |
|
The configuration prior to the module invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |