cl_bond - Configures a bond port on Cumulus Linux

• Synopsis
• Requirements (on host that executes module)
• Options
• Examples
• Return Values
• Notes
• This is a Core Module

Synopsis

Configures a bond interface on Cumulus Linux To configure a bridge port use the cl_bridge module. To configure any other type of interface use the cl_interface module. Follow the guidelines for bonding found in the Cumulus User Guide at http://docs.cumulusnetworks.com.

Requirements (on host that executes module)

• Alternate Debian network interface manager - ifupdown2 @ github.com/CumulusNetworks/ifupdown2

Options

Examples

# Options ['virtual_mac', 'virtual_ip'] are required together
# configure a bond interface with IP address
cl_bond: name=bond0  slaves="swp4-5" ipv4=10.1.1.1/24
notify: reload networking

# configure bond as a dual-connected clag bond
cl_bond: name=bond1 slaves="swp1s0 swp2s0" clag_id=1
notify: reload networking

# define cl_bond once in tasks file
# then write interface config in variables file
# with just the options you want.
cl_bond:
  name: "{{ item.key }}"
  slaves: "{{ item.value.slaves }}"
  clag_id: "{{ item.value.clag_id|default(omit) }}"
  ipv4:  "{{ item.value.ipv4|default(omit) }}"
  ipv6: "{{ item.value.ipv6|default(omit) }}"
  alias_name: "{{ item.value.alias_name|default(omit) }}"
  addr_method: "{{ item.value.addr_method|default(omit) }}"
  mtu: "{{ item.value.mtu|default(omit) }}"
  vids: "{{ item.value.vids|default(omit) }}"
  virtual_ip: "{{ item.value.virtual_ip|default(omit) }}"
  virtual_mac: "{{ item.value.virtual_mac|default(omit) }}"
  mstpctl_portnetwork: "{{ item.value.mstpctl_portnetwork|default('no') }}"
  mstpctl_portadminedge: "{{ item.value.mstpctl_portadminedge|default('no') }}"
  mstpctl_bpduguard: "{{ item.value.mstpctl_bpduguard|default('no') }}"
with_dict: cl_bonds
notify: reload networking

# In vars file
# ============
cl_bonds:
    bond0:
        alias_name: 'uplink to isp'
        slaves: ['swp1', 'swp3']
        ipv4: '10.1.1.1/24'
    bond2:
        vids: [1, 50]
        clag_id: 1

Return Values

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

Notes

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, developing_test_pr and Developing Modules.