ansible.builtin.vyos_linkagg (v2.4.6.0-1) — module

Manage link aggregation groups on VyOS network devices

| "added in version" 2.4 of ansible.builtin"

Authors: Ricardo Carrillo Cruz (@rcarrillocruz)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure link aggregation group
  vyos_linkagg:
    name: bond0
    members:
      - eth0
      - eth1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove configuration
  vyos_linkagg:
    name: bond0
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create aggregate of linkagg definitions
  vyos_linkagg:
    aggregate:
        - { name: bond0, members: [eth1] }
        - { name: bond1, members: [eth2] }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove aggregate of linkagg definitions
  vyos_linkagg:
    aggregate:
      - name: bond0
      - name: bond1
    state: absent

Inputs

    
mode:
    choices:
    - 802.3ad
    - active-backup
    - broadcast
    - round-robin
    - transmit-load-balance
    - adaptive-load-balance
    - xor-hash
    - 'on'
    description:
    - Mode of the link aggregation group.

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

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

members:
    description:
    - List of members of the link aggregation group.

aggregate:
    description: List of link aggregation definitions.

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