diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7c010bf..7661ca6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,21 +1,21 @@ --- repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.1.0 hooks: - id: check-merge-conflict - id: check-symlinks - id: debug-statements - id: end-of-file-fixer - id: no-commit-to-branch args: [--branch, main] - id: trailing-whitespace - repo: https://github.com/psf/black rev: 19.3b0 hooks: - id: black args: [-l, "79"] - repo: https://github.com/ansible-network/collection_prep - rev: 0.9.3 + rev: 0.9.4 hooks: - id: update-docs diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index 46af72d..1fc2232 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -1,684 +1,684 @@ .. _vyos.vyos.vyos_interface_module: ************************ vyos.vyos.vyos_interface ************************ **(deprecated, removed after 2022-06-01) Manage Interface on VyOS network devices** Version added: 1.0.0 .. contents:: :local: :depth: 1 DEPRECATED ---------- :Removed in collection release after 2022-06-01 :Why: Updated modules released with more functionality. :Alternative: vyos_interfaces Synopsis -------- - This module provides declarative management of Interfaces on VyOS network devices. Parameters ---------- .. raw:: html
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of Interfaces definitions.
|
|||
delay
integer
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values
up /down and neighbors. |
|||
description
string
|
Description of Interface.
|
|||
duplex
string
|
|
Interface link status.
|
||
enabled
boolean
|
|
Interface link status.
|
||
mtu
integer
|
Maximum size of transmit packet.
|
|||
name
string
/ required
|
Name of the Interface.
|
|||
neighbors
list
/ elements=dictionary
|
Check the operational state of given interface
name for LLDP neighbor.The following suboptions are available.
|
|||
host
string
|
LLDP neighbor host for given interface
name . |
|||
port
string
|
LLDP neighbor port to which given interface
name is connected. |
|||
speed
string
|
Interface link speed.
|
|||
state
string
|
|
State of the Interface configuration,
up means present and operationally up and down means present and operationally down |
||
delay
integer
|
Default: 10
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values
up /down and neighbors. |
||
description
string
|
Description of Interface.
|
|||
duplex
string
|
|
Interface link status.
|
||
enabled
boolean
|
|
Interface link status.
|
||
mtu
integer
|
Maximum size of transmit packet.
|
|||
name
string
|
Name of the Interface.
|
|||
neighbors
list
/ elements=dictionary
|
Check the operational state of given interface
name for LLDP neighbor.The following suboptions are available.
|
|||
host
string
|
LLDP neighbor host for given interface
name . |
|||
port
string
|
LLDP neighbor port to which given interface
name is connected. |
|||
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
|
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.
|
|||
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.
|
|||
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. |
|||
speed
string
|
Interface link speed.
|
|||
state
string
|
|
State of the Interface configuration,
up means present and operationally up and down means present and operationally down |
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of L3 interfaces definitions
|
||
ipv4
string
|
IPv4 of the L3 interface.
|
||
ipv6
string
|
IPv6 of the L3 interface.
|
||
name
string
/ required
|
Name of the L3 interface.
|
||
state
string
|
|
State of the L3 interface configuration.
|
|
ipv4
string
|
IPv4 of the L3 interface.
|
||
ipv6
string
|
IPv6 of the L3 interface.
|
||
name
string
|
Name of the L3 interface.
|
||
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
|
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.
|
||
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.
|
||
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 L3 interface configuration.
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of link aggregation definitions.
|
||
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
mode
string
|
|
Mode of the link aggregation group.
|
|
name
string
/ required
|
Name of the link aggregation group.
|
||
state
string
|
|
State of the link aggregation group.
|
|
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
mode
string
|
|
Mode of the link aggregation group.
|
|
name
string
|
Name of the link aggregation group.
|
||
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
|
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.
|
||
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.
|
||
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 link aggregation group.
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of interfaces LLDP should be configured on.
|
||
name
string
/ required
|
Name of the interface LLDP should be configured on.
|
||
state
string
|
|
State of the LLDP configuration.
|
|
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
|
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.
|
||
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.
|
||
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.
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
interfaces
list
/ elements=string
|
Name of the interfaces.
|
||
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
|
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.
|
||
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.
|
||
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 link aggregation group.
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
list
/ elements=dictionary
|
List of logging definitions.
|
||
dest
string
|
|
Destination of the logs.
|
|
facility
string
|
Set logging facility.
|
||
level
string
|
Set logging severity levels.
|
||
name
string
|
If value of
dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified. |
||
state
string
|
|
State of the logging configuration.
|
|
dest
string
|
|
Destination of the logs.
|
|
facility
string
|
Set logging facility.
|
||
level
string
|
Set logging severity levels.
|
||
name
string
|
If value of
dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified. |
||
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
|
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.
|
||
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.
|
||
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 logging configuration.
|
Key | Returned | Description |
---|---|---|
commands
list
|
always |
The list of configuration mode commands to send to the device
Sample:
['set system syslog global facility all level notice']
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
count
integer
|
Default: 5
|
Number of packets to send to check reachability.
|
|
dest
string
/ required
|
The IP Address or hostname (resolvable by the device) of the remote node.
|
||
interval
integer
|
Determines the interval (in seconds) between consecutive pings.
|
||
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
|
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.
|
||
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.
|
||
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. |
||
size
integer
|
Determines the size (in bytes) of the ping packet(s).
|
||
source
string
|
The source interface or IP Address to use while sending the ping packet(s).
|
||
state
string
|
|
Determines if the expected result is success or fail.
|
|
ttl
integer
|
The time-to-live value for the ICMP packet(s).
|
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
admin_distance
integer
|
Admin distance of the static route.
|
||
aggregate
list
/ elements=dictionary
|
List of static route definitions
|
||
admin_distance
integer
|
Admin distance of the static route.
|
||
mask
string
|
Network prefix mask of the static route.
|
||
next_hop
string
|
Next hop IP of the static route.
|
||
prefix
string
/ required
|
Network prefix of the static route.
mask param should be ignored if prefix is provided with mask value prefix/mask . |
||
state
string
|
|
State of the static route configuration.
|
|
mask
string
|
Network prefix mask of the static route.
|
||
next_hop
string
|
Next hop IP of the static route.
|
||
prefix
string
|
Network prefix of the static route.
mask param should be ignored if prefix is provided with mask value prefix/mask . |
||
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
|
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.
|
||
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.
|
||
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 static route configuration.
|
Key | Returned | Description |
---|---|---|
commands
list
|
always |
The list of configuration mode commands to send to the device
Sample:
['set protocols static route 192.168.2.0/16 next-hop 10.0.0.1']
|