Documentation

cl_interface_policy - Configure interface enforcement policy on Cumulus Linux

New in version 2.1.

Synopsis

This module affects the configuration files located in the interfaces folder defined by ifupdown2. Interfaces port and port ranges listed in the “allowed” parameter define what interfaces will be available on the switch. If the user runs this module and has an interface configured on the switch, but not found in the “allowed” list, this interface will be unconfigured. By default this is /etc/network/interface.d For more details go the Configuring Interfaces at http://docs.cumulusnetworks.com

Options

parameter required default choices comments
allowed
no
    list of ports to run initial run at 10G
    location
    no /etc/network/interfaces.d/
      folder to store interface files.

      Examples

      Example playbook entries using the cl_interface_policy module.
      
          - name: shows types of interface ranges supported
            cl_interface_policy:
                allowed: "lo eth0 swp1-9, swp11, swp12-13s0, swp12-30s1, swp12-30s2, bond0-12"
      

      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


      Notes

      Note

      lo must be included in the allowed list.

      Note

      eth0 must be in allowed list if out of band management is done

      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.