junipernetworks.junos.junos_lldp – (deprecated, removed after 2022-06-01) Manage LLDP configuration on Juniper JUNOS network devices¶
Note
This plugin is part of the junipernetworks.junos collection (version 1.3.0).
To install it use: ansible-galaxy collection install junipernetworks.junos
.
To use it in a playbook, specify: junipernetworks.junos.junos_lldp
.
New in version 1.0.0: of junipernetworks.junos
DEPRECATED¶
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use junipernetworks.junos.junos_lldp_global instead.
Synopsis¶
This module provides declarative management of LLDP service 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
|
|
Specifies whether or not the configuration is active or deactivated
|
|
hold_multiplier
integer
|
Specify the number of seconds that LLDP information is held before it is discarded. The multiplier value is used in combination with the
interval value. |
||
interval
integer
|
Frequency at which LLDP advertisements are sent (in seconds).
|
||
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
|
|
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
|
|
Value of
present ensures given LLDP configuration is present on device and LLDP is enabled, for value of absent LLDP configuration is deleted and LLDP is in disabled state. Value enabled ensures LLDP protocol is enabled and LLDP configuration if any is configured on remote device, for value of disabled it ensures LLDP protocol is disabled any LLDP configuration if any is still present. |
|
transmit_delay
integer
|
Specify the number of seconds the device waits before sending advertisements to neighbors after a change is made in local system.
|
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: Enable LLDP service
junipernetworks.junos.junos_lldp:
state: enabled
- name: Disable LLDP service
junipernetworks.junos.junos_lldp:
state: disabled
- name: Set LLDP parameters
junipernetworks.junos.junos_lldp:
interval: 10
hold_multiplier: 5
transmit_delay: 30
state: present
- name: Delete LLDP parameters
junipernetworks.junos.junos_lldp:
interval: 10
hold_multiplier: 5
transmit_delay: 30
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors¶
Ganesh Nalawade (@ganeshrn)