Deprecated

Removed in 2.13

i

Reason:Updated modules released with more functionality | Alternative:eos_lag_interfaces

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

Manage link aggregation groups on Arista EOS network devices

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

Authors: Trishna Guha (@trishnaguha)

deprecated | supported by network

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create link aggregation group
  eos_linkagg:
    group: 10
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete link aggregation group
  eos_linkagg:
    group: 10
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set link aggregation group to members
  eos_linkagg:
    group: 200
    min_links: 3
    mode: active
    members:
      - Ethernet0
      - Ethernet1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove link aggregation group from Ethernet0
  eos_linkagg:
    group: 200
    min_links: 3
    mode: active
    members:
      - Ethernet1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create aggregate of linkagg definitions
  eos_linkagg:
    aggregate:
      - { group: 3, mode: on, members: [Ethernet1] }
      - { group: 100, mode: passive, min_links: 3, members: [Ethernet2] }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove aggregate of linkagg definitions
  eos_linkagg:
    aggregate:
      - { group: 3, mode: on, members: [Ethernet1] }
      - { group: 100, mode: passive, min_links: 3, members: [Ethernet2] }
    state: absent

Inputs

    
mode:
    choices:
    - active
    - 'on'
    - passive
    description:
    - Mode of the link aggregation group.

group:
    description:
    - Channel-group number for the port-channel Link aggregation group. Range 1-2000.

purge:
    default: false
    description:
    - Purge links not defined in the I(aggregate) parameter.
    type: bool

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

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

provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
    - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.'
    - This option will be removed in a release after 2022-06-01.
    - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      auth_pass:
        description:
        - Specifies the password to use if required to enter privileged mode on the remote
          device.  If I(authorize) is false, then this argument does nothing. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
          will be used instead.
        type: str
      authorize:
        default: false
        description:
        - Instructs the module to enter privileged mode on the remote device before sending
          any commands.  If not specified, the device will attempt to execute all commands
          in non-privileged mode. If the value is not specified in the task, the value
          of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
        type: bool
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote device over
          the specified transport.  The value of host is used as the destination address
          for the transport.
        type: str
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote device.  This
          is a common argument used for either I(cli) or I(eapi) transports. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
          will be used instead.
        type: str
      port:
        default: 0
        description:
        - Specifies the port to use when building the connection to the remote device.  This
          value applies to either I(cli) or I(eapi).
        - The port value will default to the appropriate transport common port if none
          is provided in the task (cli=22, http=80, https=443).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports. If the value is not
          specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
          will be used instead.
        type: path
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - cli
        - eapi
        default: cli
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      use_proxy:
        default: true
        description:
        - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
          ignored.
        type: bool
      use_ssl:
        default: true
        description:
        - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi).  If
          the transport argument is not eapi, this value is ignored.
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device.  This value is used to authenticate either the CLI login or the eAPI
          authentication depending on which transport is used. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will
          be used instead.
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates will not be validated. This should only be used on
          personally controlled sites using self-signed certificates.  If the transport
          argument is not eapi, this value is ignored.
        type: bool
    type: dict

aggregate:
    description: List of link aggregation definitions.

min_links:
    description:
    - Minimum number of ports required 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:
  - interface port-channel 30
  - port-channel min-links 5
  - interface Ethernet3
  - channel-group 30 mode on
  - no interface port-channel 30
  type: list