Docs4dev
Docs
ansible / 2.4 / junos_linkagg_module.html

junos_linkagg - Manage link aggregation groups on Juniper JUNOS network devices

Synopsis

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

Requirements (on host that executes module)

  • ncclient (>=v0.5.2)

Options

parameter required default choices comments
active
 no True
  • True
  • False
Specifies whether or not the configuration is active or deactivated
aggregate
 no
List of link aggregation definitions.
description
 no
Description of Interface.
device_count
 no
Number of aggregated ethernet devices that can be configured. Acceptable integer value is between 1 and 128.
members
 yes
List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces.
min_links
 no
Minimum members that should be up before bringing up the link aggregation group.
mode
 no
  • on
  • off
  • active
  • passive
Mode of the link aggregation group. A value of on will enable LACP in passive mode. active configures the link to actively information about the state of the link, or it can be configured in passive mode ie. send link state information only when received them from another link. A value of off will disable LACP.
name
 yes
Name of the link aggregation group.
state
 no present
  • present
  • absent
  • up
  • down
State of the link aggregation group.

Examples

- name: configure link aggregation
  junos_linkagg:
    name: ae11
    members:
      - ge-0/0/5
      - ge-0/0/6
      - ge-0/0/7
    lacp: active
    device_count: 4
    state: present

- name: delete link aggregation
  junos_linkagg:
    name: ae11
    members:
      - ge-0/0/5
      - ge-0/0/6
      - ge-0/0/7
    lacp: active
    device_count: 4
    state: delete

- name: deactivate link aggregation
  junos_linkagg:
    name: ae11
    members:
      - ge-0/0/5
      - ge-0/0/6
      - ge-0/0/7
    lacp: active
    device_count: 4
    state: present
    active: False

- name: Activate link aggregation
  junos_linkagg:
    name: ae11
    members:
      - ge-0/0/5
      - ge-0/0/6
      - ge-0/0/7
    lacp: active
    device_count: 4
    state: present
    active: True

- name: Disable link aggregation
  junos_linkagg:
    name: ae11
    state: down

- name: Enable link aggregation
  junos_linkagg:
    name: ae11
    state: up

Return Values

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

name description returned type sample
diff
Configuration difference before and after applying change.
when configuration is changed and diff option is enabled. string [edit interfaces] + ge-0/0/6 { + ether-options { + 802.3ad ae0; + } + } [edit interfaces ge-0/0/7] + ether-options { + 802.3ad ae0; + } [edit interfaces] + ae0 { + description "configured by junos_linkagg"; + aggregated-ether-options { + lacp { + active; + } + } + }

Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/junos_linkagg_module.html