cl_ports - Configure Cumulus Switch port attributes (ports.conf)¶

New in version 2.1.

DEPRECATED
Synopsis
Options
Examples
Return Values

DEPRECATED ¶

Deprecated in 2.3. Use nclu instead.

Synopsis ¶

Set the initial port attribute defined in the Cumulus Linux ports.conf, file. This module does not do any error checking at the moment. Be careful to not include ports that do not exist on the switch. Carefully read the original ports.conf file for any exceptions or limitations. For more details go the Configure Switch Port Attribute Documentation at http://docs.cumulusnetworks.com.

Options ¶

parameter	required	default	choices	comments
speed_10g	no			List of ports to run initial run at 10G.
speed_40g	no			List of ports to run initial run at 40G.
speed_40g_div_4	no			List of 10G ports that will be ganged to form a 40G port.
speed_4_by_10g	no			List of 40G ports that will be unganged to run as 4 10G ports.

Examples ¶

# Use cl_ports module to manage the switch attributes defined in the
# ports.conf file on Cumulus Linux

## Unganged port configuration on certain ports
- name: configure ports.conf setup
  cl_ports:
    speed_4_by_10g:
      - swp1
      - swp32
    speed_40g:
      - swp2-31

## Unganged port configuration on certain ports
- name: configure ports.conf setup
  cl_ports:
    speed_4_by_10g:
      - swp1-3
      - swp6
    speed_40g:
      - swp4-5
      - swp7-32

Return Values ¶

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

name	description	returned	type	sample
msg	human-readable report of success or failure	always	string	interface bond0 config updated
changed	whether the interface was changed	changed	bool	True

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.