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

New in version 2.1.

DEPRECATED

Removed in Ansible:
version: 2.5
Why: The nclu module is designed to be easier to use for individuals who are new to Cumulus Linux by exposing the NCLU interface in an automatable way.
Alternative: 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.

Parameters

Parameter Choices/Defaults Comments
speed_10g
List of ports to run initial run at 10G.
speed_40g
List of ports to run initial run at 40G.
speed_40g_div_4
List of 10G ports that will be ganged to form a 40G port.
speed_4_by_10g
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, the following are the fields unique to this module:

Key Returned Description
changed
bool
 changed
whether the interface was changed

Sample:
True
msg
string
 always
human-readable report of success or failure

Sample:
interface bond0 config updated


Status

This module is flagged as deprecated and will be removed in version 2.5. For more information see DEPRECATED.

Author

  • Cumulus Networks (@CumulusNetworks)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/cl_ports_module.html