W3cubDocs

/Ansible

junipernetworks.junos.junos_linkagg – (deprecated, removed after 2022-06-01) Manage link aggregation groups on Juniper JUNOS network devices

Note

This plugin is part of the junipernetworks.junos collection (version 2.6.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install junipernetworks.junos.

To use it in a playbook, specify: junipernetworks.junos.junos_linkagg.

New in version 1.0.0: of junipernetworks.junos

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED

Removed in: major release after 2022-06-01
Why: Updated modules released with more functionality
Alternative: Use junipernetworks.junos.junos_lag_interfaces instead.

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

ncclient (>=v0.5.2)

Parameters

Parameter		Choices/Defaults	Comments
active boolean		Choices: no yes ←	Specifies whether or not the configuration is active or deactivated
aggregate list / elements=dictionary			List of link aggregation definitions.
	active boolean	Choices: no yes	Specifies whether or not the configuration is active or deactivated
	description string		Description of Interface.
	device_count integer		Number of aggregated ethernet devices that can be configured. Acceptable integer value is between 1 and 128.
	members list / elements=string		List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces.
	min_links integer		Minimum members that should be up before bringing up the link aggregation group.
	mode string	Choices: 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 string / required		Name of the link aggregation group.
	state string	Choices: present absent up down	State of the link aggregation group.
description string			Description of Interface.
device_count integer			Number of aggregated ethernet devices that can be configured. Acceptable integer value is between 1 and 128.
members list / elements=string			List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces.
min_links integer			Minimum members that should be up before bringing up the link aggregation group.
mode string		Choices: 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 string			Name of the link aggregation group.
provider dictionary			Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` or `connection: netconf`. For more information please see the Junos OS Platform Options guide. A dict object containing connection details.
	host string		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.
	password string		Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
	port integer		Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for `transport=cli`) or port 830 (for `transport=netconf`) device.
	ssh_keyfile path		Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	timeout integer		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.
	transport string	Choices: cli netconf ←	Configures the transport connection to use when connecting to the remote device.
	username string		Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
state string		Choices: present ← absent up down	State of the link aggregation group.

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.
Recommended connection is netconf. See the Junos OS Platform Options.
This module also works with local connections for legacy playbooks.
For information on using CLI and netconf see the Junos OS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.

Examples

- name: configure link aggregation
  junipernetworks.junos.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
  junipernetworks.junos.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
  junipernetworks.junos.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
  junipernetworks.junos.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
  junipernetworks.junos.junos_linkagg:
    name: ae11
    state: down

- name: Enable link aggregation
  junipernetworks.junos.junos_linkagg:
    name: ae11
    state: up

Return Values

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

Key	Returned	Description
diff string	when configuration is changed and diff option is enabled.	Configuration difference before and after applying change. Sample: [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; + } + } + }

Status

This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.

Authors

Ganesh Nalawade (@ganeshrn)

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