Documentation

cl_interface_policy - Configure interface enforcement policy on Cumulus Linux

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

  • 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.

Parameters

Parameter
Choices/Defaults
Comments
allowed
required
List of ports to run initial run at 10G.
location
Default:
/etc/network/interfaces.d/
Directory to store interface files.

Notes

Note

  • lo must be included in the allowed list.
  • eth0 must be in allowed list if out of band management is done

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, 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 { deprecated[‘removed_in’] | default(‘’) | string | convert_symbols_to_format }@. 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.