ansible.builtin._net_linkagg (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

This module provides declarative management of link aggregation groups on network devices.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure link aggregation group
  net_linkagg:
    name: bond0
    members:
      - eth0
      - eth1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: remove configuration
  net_linkagg:
    name: bond0
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create aggregate of linkagg definitions
  net_linkagg:
    aggregate:
        - { name: bond0, members: [eth1] }
        - { name: bond1, members: [eth2] }

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove aggregate of linkagg definitions
  net_linkagg:
    aggregate:
      - name: bond0
      - name: bond1
    state: absent

Inputs

    
mode:
    choices:
    - 'on'
    - active
    - passive
    default: true
    description:
    - Mode of the link aggregation group. A value of C(on) will enable LACP. C(active)
      configures the link to actively information about the state of the link, or it can
      be configured in C(passive) mode ie. send link state information only when received
      them from another link.

name:
    description:
    - Name of the link aggregation group.
    required: true

purge:
    default: false
    description:
    - Purge link aggregation groups not defined in the I(aggregate) parameter.

state:
    choices:
    - present
    - absent
    - up
    - down
    default: present
    description:
    - State of the link aggregation group.

members:
    description:
    - List of members interfaces of the link aggregation group. The value can be single
      interface or list of interfaces.
    required: true

aggregate:
    description: List of link aggregation definitions.

min_links:
    description:
    - Minimum members that should be up before bringing up the link aggregation group.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always, except for the platforms that use Netconf transport to manage
    the device.
  sample:
  - set interfaces bonding bond0
  - set interfaces ethernet eth0 bond-group 'bond0'
  - set interfaces ethernet eth1 bond-group 'bond0'
  type: list