vyos_lldp_interface – Manage LLDP interfaces configuration on VyOS network devices¶
New in version 2.4.
DEPRECATED¶
- Removed in Ansible
version: 2.13
- Why
Updated modules released with more functionality.
- Alternative
vyos_lldp_interfaces
Synopsis¶
This module provides declarative management of LLDP interfaces configuration on VyOS network devices.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
list
|
List of interfaces LLDP should be configured on.
|
||
name
string
|
Name of the interface LLDP should be configured on.
|
||
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .For more information please see the Network Guide.
A dict object containing connection details.
|
||
host
string
/ required
|
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
|
Default: 22
|
Specifies the port to use when building the connection to the remote 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
|
Default: 10
|
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.
|
|
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
|
|
State of the LLDP configuration.
|
Notes¶
Note
Tested against VYOS 1.1.7
For more information on using Ansible to manage network devices see the Ansible Network Guide
Examples¶
- name: Enable LLDP on eth1
net_lldp_interface:
state: present
- name: Enable LLDP on specific interfaces
net_lldp_interface:
interfaces:
- eth1
- eth2
state: present
- name: Disable LLDP globally
net_lldp_interface:
state: disabled
- name: Create aggregate of LLDP interface configurations
vyos_lldp_interface:
aggregate:
- name: eth1
- name: eth2
state: present
- name: Delete aggregate of LLDP interface configurations
vyos_lldp_interface:
aggregate:
- name: eth1
- name: eth2
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 version 2.13. [deprecated]
For more information see DEPRECATED.
Authors¶
Ricardo Carrillo Cruz (@rcarrillocruz)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.