Documentation

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

New in version 2.1.

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

          Example playbook entries using the cl_ports module to manage the switch
attributes defined in the ports.conf file on Cumulus Linux

## Unganged port config using simple args
   - name: configure ports.conf setup
     cl_ports: speed_4_by_10g="swp1, swp32" speed_40g="swp2-31"
     notify: restart switchd

## Unganged port configuration on certain ports using complex args

    - name: configure ports.conf setup
      cl_ports:
          speed_4_by_10g: ['swp1-3', 'swp6']
          speed_40g: ['swp4-5', 'swp7-32']
      notify: restart switchd

          Return Values

          Common return values are documented here Common 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


          This is a Core Module

          For more information on what this means please read Core Modules

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