From a45e2988263f5109a56b6dcb2c46ecbc6738cb3a Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 27 Aug 2020 14:58:25 -0400 Subject: Release 1.0.4 (#81) Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_banner_module.rst | 247 +-- docs/vyos.vyos.vyos_command_module.rst | 339 ++- docs/vyos.vyos.vyos_config_module.rst | 497 +++-- docs/vyos.vyos.vyos_facts_module.rst | 352 ++- docs/vyos.vyos.vyos_firewall_global_module.rst | 1076 ++++----- docs/vyos.vyos.vyos_firewall_interfaces_module.rst | 300 +-- docs/vyos.vyos.vyos_firewall_rules_module.rst | 1996 ++++++++--------- docs/vyos.vyos.vyos_interface_module.rst | 696 +++--- docs/vyos.vyos.vyos_interfaces_module.rst | 433 ++-- docs/vyos.vyos.vyos_l3_interface_module.rst | 366 ++- docs/vyos.vyos.vyos_l3_interfaces_module.rst | 399 ++-- docs/vyos.vyos.vyos_lag_interfaces_module.rst | 366 ++- docs/vyos.vyos.vyos_linkagg_module.rst | 416 ++-- docs/vyos.vyos.vyos_lldp_global_module.rst | 243 +- docs/vyos.vyos.vyos_lldp_interface_module.rst | 298 ++- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 498 ++--- docs/vyos.vyos.vyos_lldp_module.rst | 225 +- docs/vyos.vyos.vyos_logging_module.rst | 431 ++-- docs/vyos.vyos.vyos_ospfv2_module.rst | 2320 ++++++++++---------- docs/vyos.vyos.vyos_ospfv3_module.rst | 469 ++-- docs/vyos.vyos.vyos_ping_module.rst | 385 ++-- docs/vyos.vyos.vyos_static_route_module.rst | 404 ++-- docs/vyos.vyos.vyos_static_routes_module.rst | 467 ++-- docs/vyos.vyos.vyos_system_module.rst | 278 ++- docs/vyos.vyos.vyos_user_module.rst | 490 ++--- docs/vyos.vyos.vyos_vlan_module.rst | 513 ++--- 26 files changed, 7241 insertions(+), 7263 deletions(-) (limited to 'docs') diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index dd26e377..8e14ce3c 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -31,178 +31,179 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
banner
string - / required
- - - - - -
Specifies which banner that should be configured on the remote device.
- + / required + + + + + + +
Specifies which banner that should be configured on the remote device.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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 -
- - - - - -
Specifies whether or not the configuration is present in the current devices active running configuration.
- + + + + + + +
Specifies whether or not the configuration is present in the current devices active running configuration.
+ - - + +
text
string -
- - - - -
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
- + + + + + +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+ - +
@@ -221,7 +222,6 @@ Examples .. code-block:: yaml+jinja - - name: configure the pre-login banner vyos.vyos.vyos_banner: banner: pre-login @@ -237,7 +237,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -250,24 +249,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['banner pre-login', 'this is my pre-login banner', 'that contains a multiline', 'string']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner pre-login', 'this is my pre-login banner', 'that contains a multiline', 'string']
+ - +

@@ -279,5 +278,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index bd3d5e69..41041bc1 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -32,208 +32,211 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
commands
list - / elements=raw / required
- - - - -
The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.
-
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). Refer below examples.
- + / elements=raw + / required + + + + + +
The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.
+
If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). Refer below examples.
+ - - + +
interval
integer -
- - - Default:
1
- - -
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.
- + + + + Default:
1
+ + +
Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.
+ - - + +
match
string -
- - -
    Choices: -
  • any
    • -
  • all ←
    • -
- - -
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
- + + + +
    Choices: +
  • any
    • +
  • all ←
    • +
+ + +
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
+ - - - + + +
retries
integer -
- - - Default:
10
- - -
Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
- + + + + Default:
10
+ + +
Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
+ - - + +
wait_for
list - / elements=string
- - - - -
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
-

aliases: waitfor
- + / elements=string + + + + + +
Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
+

aliases: waitfor
+ - +
@@ -254,7 +257,6 @@ Examples .. code-block:: yaml+jinja - - name: show configuration on ethernet devices eth0 and eth1 vyos.vyos.vyos_command: commands: @@ -281,7 +283,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -294,75 +295,75 @@ Common return values are documented `here Returned Description - - + +
failed_conditions
list -
- + + failed -
The list of conditionals that have failed
-
-
Sample:
-
['...', '...']
- +
The list of conditionals that have failed
+
+
Sample:
+
['...', '...']
+ - - + +
stdout
list -
- + + always apart from low level errors (such as action plugin) -
The set of responses from the commands
-
-
Sample:
-
['...', '...']
- +
The set of responses from the commands
+
+
Sample:
+
['...', '...']
+ - - + +
stdout_lines
list -
- + + always -
The value of stdout split into a list
-
-
Sample:
-
[['...', '...'], ['...'], ['...']]
- +
The value of stdout split into a list
+
+
Sample:
+
[['...', '...'], ['...'], ['...']]
+ - - + +
warnings
list -
- + + always -
The list of warnings (if any) generated by module based on arguments
-
-
Sample:
-
['...', '...']
- +
The list of warnings (if any) generated by module based on arguments
+
+
Sample:
+
['...', '...']
+ - +

@@ -374,5 +375,3 @@ Authors ~~~~~~~ - Nathaniel Case (@Qalthos) - - diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index c3031f35..0914d8ec 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -31,291 +31,292 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
backup
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
The backup argument will backup the current devices active configuration to the Ansible control host prior to making any changes. If the backup_options value is not given, the backup file will be located in the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
The backup argument will backup the current devices active configuration to the Ansible control host prior to making any changes. If the backup_options value is not given, the backup file will be located in the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
+ - - + +
backup_options
dictionary -
- - - - -
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored.
- + + + + + +
This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored.
+ - - - + + +
dir_path
path -
- - - - -
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
- + + + + + +
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
+ - - - + + +
filename
string -
- - - - -
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
- + + + + + +
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>
+ - - - + + +
comment
string -
- - - Default:
"configured by vyos_config"
- - -
Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored.
- + + + + Default:
"configured by vyos_config"
+ + +
Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored.
+ - - + +
config
string -
- - - - -
The config argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.
- + + + + + +
The config argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.
+ - - + +
lines
list - / elements=string
- - - - -
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.
- + / elements=string + + + + + +
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.
+ - - + +
match
string -
- - -
    Choices: -
  • line ←
    • -
  • none
    • -
- - -
The match argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the match argument is set to none the active configuration is ignored and the configuration is always loaded.
- + + + +
    Choices: +
  • line ←
    • +
  • none
    • +
+ + +
The match argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the match argument is set to none the active configuration is ignored and the configuration is always loaded.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
+ - - - + + +
save
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
The save argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
The save argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to True, the active configuration is saved.
+ - - + +
src
path -
- - - - -
The src argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.
- + + + + + +
The src argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.
+ - +
@@ -334,7 +335,6 @@ Examples .. code-block:: yaml+jinja - - name: configure the remote device vyos.vyos.vyos_config: lines: @@ -366,7 +366,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -379,126 +378,126 @@ Common return values are documented `here Returned Description - - + +
backup_path
string -
- + + when backup is yes -
The full path to the backup file
-
-
Sample:
-
/playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34
- +
The full path to the backup file
+
+
Sample:
+
/playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34
+ - - + +
commands
list -
- + + always -
The list of configuration commands sent to the device
-
-
Sample:
-
['...', '...']
- +
The list of configuration commands sent to the device
+
+
Sample:
+
['...', '...']
+ - - + +
date
string -
- + + when backup is yes -
The date extracted from the backup file name
-
-
Sample:
-
2016-07-16
- +
The date extracted from the backup file name
+
+
Sample:
+
2016-07-16
+ - - + +
filename
string -
- + + when backup is yes and filename is not specified in backup options -
The name of the backup file
-
-
Sample:
-
vyos_config.2016-07-16@22:28:34
- +
The name of the backup file
+
+
Sample:
+
vyos_config.2016-07-16@22:28:34
+ - - + +
filtered
list -
- + + always -
The list of configuration commands removed to avoid a load failure
-
-
Sample:
-
['...', '...']
- +
The list of configuration commands removed to avoid a load failure
+
+
Sample:
+
['...', '...']
+ - - + +
shortname
string -
- + + when backup is yes and filename is not specified in backup options -
The full path to the backup file excluding the timestamp
-
-
Sample:
-
/playbooks/ansible/backup/vyos_config
- +
The full path to the backup file excluding the timestamp
+
+
Sample:
+
/playbooks/ansible/backup/vyos_config
+ - - + +
time
string -
- + + when backup is yes -
The time extracted from the backup file name
-
-
Sample:
-
22:28:34
- +
The time extracted from the backup file name
+
+
Sample:
+
22:28:34
+ - +

@@ -510,5 +509,3 @@ Authors ~~~~~~~ - Nathaniel Case (@Qalthos) - - diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index f609b9e8..d2858640 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -31,156 +31,158 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
gather_network_resources
list - / elements=string
- - - - -
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'.
- + / elements=string + + + + + +
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'.
+ - - + +
gather_subset
list - / elements=string
- - - Default:
"!config"
- - -
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
- + / elements=string + + + + Default:
"!config"
+ + +
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
+ - - + +
@@ -199,7 +201,6 @@ Examples .. code-block:: yaml+jinja - # Gather all facts - vyos.vyos.vyos_facts: gather_subset: all @@ -233,7 +234,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -246,172 +246,172 @@ Common return values are documented `here Returned Description - - + +
ansible_net_api
string -
- + + always -
The name of the transport
-
- +
The name of the transport
+
+ - - + +
ansible_net_commits
list -
- + + when present -
The set of available configuration revisions
-
- +
The set of available configuration revisions
+
+ - - + +
ansible_net_config
string -
- + + when config is configured -
The running-config from the device
-
- +
The running-config from the device
+
+ - - + +
ansible_net_gather_network_resources
list -
- + + always -
The list of fact resource subsets collected from the device
-
- +
The list of fact resource subsets collected from the device
+
+ - - + +
ansible_net_gather_subset
list -
- + + always -
The list of subsets gathered by the module
-
- +
The list of subsets gathered by the module
+
+ - - + +
ansible_net_hostname
string -
- + + always -
The configured system hostname
-
- +
The configured system hostname
+
+ - - + +
ansible_net_model
string -
- + + always -
The device model string
-
- +
The device model string
+
+ - - + +
ansible_net_neighbors
list -
- + + when interface is configured -
The set of LLDP neighbors
-
- +
The set of LLDP neighbors
+
+ - - + +
ansible_net_python_version
string -
- + + always -
The Python version Ansible controller is using
-
- +
The Python version Ansible controller is using
+
+ - - + +
ansible_net_serialnum
string -
- + + always -
The serial number of the device
-
- +
The serial number of the device
+
+ - - + +
ansible_net_version
string -
- + + always -
The version of the software running
-
- +
The version of the software running
+
+ - +

@@ -425,5 +425,3 @@ Authors - Nathaniel Case (@qalthos) - Nilashish Chakraborty (@Nilashishc) - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index f7e64628..30f7ecf1 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -31,731 +31,743 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A dictionary of Firewall global configuration options.
- + + + + + +
A dictionary of Firewall global configuration options.
+ - - - + + +
config_trap
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
SNMP trap generation on firewall configuration changes.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
SNMP trap generation on firewall configuration changes.
+ - - - + + +
group
dictionary -
- - - - -
Defines a group of objects for referencing in firewall rules.
- + + + + + +
Defines a group of objects for referencing in firewall rules.
+ - - - - + + + +
address_group
list - / elements=dictionary
- - - - -
Defines a group of IP addresses for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of IP addresses for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the address group.
- + + + + + +
Allows you to specify a brief description for the address group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Address-group members.
-
IPv4 address to match.
-
IPv4 range to match.
- + / elements=dictionary + + + + + +
Address-group members.
+
IPv4 address to match.
+
IPv4 range to match.
+ - - - - - - + + + + + +
address
string -
- - - - -
IP address.
- + + + + + +
IP address.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall address group.
- + / required + + + + + +
Name of the firewall address group.
+ - - - - - + + + + +
network_group
list - / elements=dictionary
- - - - -
Defines a group of networks for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of networks for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the network group.
- + + + + + +
Allows you to specify a brief description for the network group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Adds an IPv4 network to the specified network group.
-
The format is ip-address/prefix.
- + / elements=dictionary + + + + + +
Adds an IPv4 network to the specified network group.
+
The format is ip-address/prefix.
+ - - - - - - + + + + + +
address
string -
- - - - -
IP address.
- + + + + + +
IP address.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall network group.
- + / required + + + + + +
Name of the firewall network group.
+ - - - - - + + + + +
port_group
list - / elements=dictionary
- - - - -
Defines a group of ports for referencing in firewall rules.
- + / elements=dictionary + + + + + +
Defines a group of ports for referencing in firewall rules.
+ - - - - - + + + + +
description
string -
- - - - -
Allows you to specify a brief description for the port group.
- + + + + + +
Allows you to specify a brief description for the port group.
+ - - - - - + + + + +
members
list - / elements=dictionary
- - - - -
Port-group member.
- + / elements=dictionary + + + + + +
Port-group member.
+ - - - - - - + + + + + +
port
string -
- - - - -
Defines the number.
- + + + + + +
Defines the number.
+ - - - - - - + + + + + +
name
string - / required
- - - - -
Name of the firewall port group.
- + / required + + + + + +
Name of the firewall port group.
+ - - - - - + + + + +
log_martians
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Specifies whether or not to record packets with invalid addresses in the log.
-
(True) Logs packets with invalid addresses.
-
(False) Does not log packets with invalid addresses.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Specifies whether or not to record packets with invalid addresses in the log.
+
(True) Logs packets with invalid addresses.
+
(False) Does not log packets with invalid addresses.
+ - - - + + +
ping
dictionary -
- - - - -
Policy for handling of all IPv4 ICMP echo requests.
- + + + + + +
Policy for handling of all IPv4 ICMP echo requests.
+ - - - - + + + +
all
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enables or disables response to all IPv4 ICMP Echo Request (ping) messages.
-
The system responds to IPv4 ICMP Echo Request messages.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enables or disables response to all IPv4 ICMP Echo Request (ping) messages.
+
The system responds to IPv4 ICMP Echo Request messages.
+ - - - - + + + +
broadcast
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enables or disables response to broadcast IPv4 ICMP Echo Request and Timestamp Request messages.
-
IPv4 ICMP Echo and Timestamp Request messages are not processed.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enables or disables response to broadcast IPv4 ICMP Echo Request and Timestamp Request messages.
+
IPv4 ICMP Echo and Timestamp Request messages are not processed.
+ - - - - + + + +
route_redirects
list - / elements=dictionary
- - - - -
-A dictionary of Firewall icmp redirect and source route global configuration options.
- + / elements=dictionary + + + + + +
-A dictionary of Firewall icmp redirect and source route global configuration options.
+ - - - - + + + +
afi
string - / required
- - -
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- - -
Specifies IP address type
- + / required + + + +
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ + +
Specifies IP address type
+ - - - - + + + +
icmp_redirects
dictionary -
- - - - -
Specifies whether to allow sending/receiving of IPv4/v6 ICMP redirect messages.
- + + + + + +
Specifies whether to allow sending/receiving of IPv4/v6 ICMP redirect messages.
+ - - - - - + + + + +
receive
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Permits or denies receiving packets ICMP redirect messages.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Permits or denies receiving packets ICMP redirect messages.
+ - - - - - + + + + +
send
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Permits or denies transmitting packets ICMP redirect messages.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Permits or denies transmitting packets ICMP redirect messages.
+ - - - - - + + + + +
ip_src_route
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Specifies whether or not to process source route IP options.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Specifies whether or not to process source route IP options.
+ - - - - + + + +
state_policy
list - / elements=dictionary
- - - - -
Specifies global firewall state-policy.
- + / elements=dictionary + + + + + +
Specifies global firewall state-policy.
+ - - - - + + + +
action
string -
- - -
    Choices: -
  • accept
    • -
  • drop
    • -
  • reject
    • -
- - -
Action for packets part of an established connection.
- + + + +
    Choices: +
  • accept
    • +
  • drop
    • +
  • reject
    • +
+ + +
Action for packets part of an established connection.
+ - - - - + + + +
connection_type
string -
- - -
    Choices: -
  • established
    • -
  • invalid
    • -
  • related
    • -
- - -
Specifies connection type.
- + + + +
    Choices: +
  • established
    • +
  • invalid
    • +
  • related
    • +
+ + +
Specifies connection type.
+ - - - - + + + +
log
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enable logging of packets part of an established connection.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enable logging of packets part of an established connection.
+ - - - - + + + +
syn_cookies
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Specifies policy for using TCP SYN cookies with IPv4.
-
(True) Enables TCP SYN cookies with IPv4.
-
(False) Disables TCP SYN cookies with IPv4.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Specifies policy for using TCP SYN cookies with IPv4.
+
(True) Enables TCP SYN cookies with IPv4.
+
(False) Disables TCP SYN cookies with IPv4.
+ - - - + + +
twa_hazards_protection
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
RFC1337 TCP TIME-WAIT assasination hazards protection.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
RFC1337 TCP TIME-WAIT assasination hazards protection.
+ - - - + + +
validation
string -
- - -
    Choices: -
  • strict
    • -
  • loose
    • -
  • disable
    • -
- - -
Specifies a policy for source validation by reversed path, as defined in RFC 3704.
-
(disable) No source validation is performed.
-
(loose) Enable Loose Reverse Path Forwarding as defined in RFC3704.
-
(strict) Enable Strict Reverse Path Forwarding as defined in RFC3704.
- + + + +
    Choices: +
  • strict
    • +
  • loose
    • +
  • disable
    • +
+ + +
Specifies a policy for source validation by reversed path, as defined in RFC 3704.
+
(disable) No source validation is performed.
+
(loose) Enable Loose Reverse Path Forwarding as defined in RFC3704.
+
(strict) Enable Strict Reverse Path Forwarding as defined in RFC3704.
+ - - - + + +
running_config
string -
- - - - -
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command show configuration commands | grep 'firewall'
- + + + + + +
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command show configuration commands | grep 'firewall'
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- - -
The state the configuration should be left in.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ + +
The state the configuration should be left in.
+ - +
@@ -773,7 +785,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -1659,7 +1670,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1672,60 +1682,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set firewall group address-group ENG-HOSTS', 'set firewall group address-group ENG-HOSTS address 192.0.3.1']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set firewall group address-group ENG-HOSTS', 'set firewall group address-group ENG-HOSTS address 192.0.3.1']
+ - +

@@ -1737,5 +1747,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst index 9e37a423..7c55b045 100644 --- a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst @@ -31,177 +31,183 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A list of firewall rules options for interfaces.
- + / elements=dictionary + + + + + +
A list of firewall rules options for interfaces.
+ - - - + + +
access_rules
list - / elements=dictionary
- - - - -
Specifies firewall rules attached to the interfaces.
- + / elements=dictionary + + + + + +
Specifies firewall rules attached to the interfaces.
+ - - - - + + + +
afi
string - / required
- - -
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- - -
Specifies the AFI for the Firewall rules to be configured on this interface.
- + / required + + + +
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ + +
Specifies the AFI for the Firewall rules to be configured on this interface.
+ - - - - + + + +
rules
list - / elements=dictionary
- - - - -
Specifies the firewall rules for the provided AFI.
- + / elements=dictionary + + + + + +
Specifies the firewall rules for the provided AFI.
+ - - - - - + + + + +
direction
string - / required
- - -
    Choices: -
  • in
    • -
  • local
    • -
  • out
    • -
- - -
Specifies the direction of packets that the firewall rule will be applied on.
- + / required + + + +
    Choices: +
  • in
    • +
  • local
    • +
  • out
    • +
+ + +
Specifies the direction of packets that the firewall rule will be applied on.
+ - - - - - + + + + +
name
string -
- - - - -
Specifies the name of the IPv4/IPv6 Firewall rule for the interface.
- + + + + + +
Specifies the name of the IPv4/IPv6 Firewall rule for the interface.
+ - - - - - + + + + +
name
string - / required
- - - - -
Name/Identifier for the interface.
- + / required + + + + + +
Name/Identifier for the interface.
+ - - - + + +
running_config
string -
- - - - -
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command C(show configuration commands | grep 'firewall'
- + + + + + +
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for comparison. This value of this option should be the output received from device by executing command C(show configuration commands | grep 'firewall'
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • rendered
    • -
  • gathered
    • -
- - -
The state the configuration should be left in.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • rendered
    • +
  • gathered
    • +
+ + +
The state the configuration should be left in.
+ - +
@@ -212,7 +218,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -1329,9 +1334,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1344,60 +1346,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
["set interfaces ethernet eth1 firewall local ipv6-name 'V6-LOCAL'", "set interfaces ethernet eth3 firewall in name 'INBOUND'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set interfaces ethernet eth1 firewall local ipv6-name 'V6-LOCAL'", "set interfaces ethernet eth3 firewall in name 'INBOUND'"]
+ - +

@@ -1409,5 +1411,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index 647f8353..15073b1e 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -31,1281 +31,1287 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A dictionary of Firewall rule-set options.
- - - - - + / elements=dictionary + + + + + +
A dictionary of Firewall rule-set options.
+ + + + +
afi
string - / required
- - -
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- - -
Specifies the type of rule-set.
- + / required + + + +
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ + +
Specifies the type of rule-set.
+ - - - + + +
rule_sets
list - / elements=dictionary
- - - - -
The Firewall rule-set list.
- - - - - - + / elements=dictionary + + + + + +
The Firewall rule-set list.
+ + + + + +
default_action
string -
- - -
    Choices: -
  • drop
    • -
  • reject
    • -
  • accept
    • -
- - -
Default action for rule-set.
-
drop (Drop if no prior rules are hit (default))
-
reject (Drop and notify source if no prior rules are hit)
-
accept (Accept if no prior rules are hit)
- - - - - - + + + +
    Choices: +
  • drop
    • +
  • reject
    • +
  • accept
    • +
+ + +
Default action for rule-set.
+
drop (Drop if no prior rules are hit (default))
+
reject (Drop and notify source if no prior rules are hit)
+
accept (Accept if no prior rules are hit)
+ + + + + +
description
string -
- - - - -
Rule set description.
- + + + + + +
Rule set description.
+ - - - - + + + +
enable_default_log
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Option to log packets hitting default-action.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Option to log packets hitting default-action.
+ - - - - + + + +
name
string -
- - - - -
Firewall rule set name.
- + + + + + +
Firewall rule set name.
+ - - - - + + + +
rules
list - / elements=dictionary
- - - - -
A ditionary that specifies the rule-set configurations.
- - - - - - - + / elements=dictionary + + + + + +
A ditionary that specifies the rule-set configurations.
+ + + + + + +
action
string -
- - -
    Choices: -
  • drop
    • -
  • reject
    • -
  • accept
    • -
  • inspect
    • -
- - -
Specifying the action.
- - - - - - - + + + +
    Choices: +
  • drop
    • +
  • reject
    • +
  • accept
    • +
  • inspect
    • +
+ + +
Specifying the action.
+ + + + + + +
description
string -
- - - - -
Description of this rule.
- - - - - - - + + + + + +
Description of this rule.
+ + + + + + +
destination
dictionary -
- - - - -
Specifying the destination parameters.
- - - - - - - - + + + + + +
Specifying the destination parameters.
+ + + + + + + +
address
string -
- - - - -
Destination ip address subnet or range.
-
IPv4/6 address, subnet or range to match.
-
Match everything except the specified address, subnet or range.
-
Destination ip address subnet or range.
- - - - - - - - + + + + + +
Destination ip address subnet or range.
+
IPv4/6 address, subnet or range to match.
+
Match everything except the specified address, subnet or range.
+
Destination ip address subnet or range.
+ + + + + + + +
group
dictionary -
- - - - -
Destination group.
- - - - - - - - - + + + + + +
Destination group.
+ + + + + + + + +
address_group
string -
- - - - -
Group of addresses.
- - - - - - - - - + + + + + +
Group of addresses.
+ + + + + + + + +
network_group
string -
- - - - -
Group of networks.
- - - - - - - - - + + + + + +
Group of networks.
+ + + + + + + + +
port_group
string -
- - - - -
Group of ports.
- - - - - - - - - + + + + + +
Group of ports.
+ + + + + + + + +
port
string -
- - - - -
Multiple destination ports can be specified as a comma-separated list.
-
The whole list can also be "negated" using '!'.
-
For example:'!22,telnet,http,123,1001-1005'.
- - - - - - - - + + + + + +
Multiple destination ports can be specified as a comma-separated list.
+
The whole list can also be "negated" using '!'.
+
For example:'!22,telnet,http,123,1001-1005'.
+ + + + + + + +
disabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Option to disable firewall rule.
- - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Option to disable firewall rule.
+ + + + + + +
fragment
string -
- - -
    Choices: -
  • match-frag
    • -
  • match-non-frag
    • -
- - -
IP fragment match.
- - - - - - - + + + +
    Choices: +
  • match-frag
    • +
  • match-non-frag
    • +
+ + +
IP fragment match.
+ + + + + + +
icmp
dictionary -
- - - - -
ICMP type and code information.
- - - - - - - - + + + + + +
ICMP type and code information.
+ + + + + + + +
code
integer -
- - - - -
ICMP code.
- - - - - - - - + + + + + +
ICMP code.
+ + + + + + + +
type
integer -
- - - - -
ICMP type.
- - - - - - - - + + + + + +
ICMP type.
+ + + + + + + +
type_name
string -
- - -
    Choices: -
  • any
    • -
  • echo-reply
    • -
  • destination-unreachable
    • -
  • network-unreachable
    • -
  • host-unreachable
    • -
  • protocol-unreachable
    • -
  • port-unreachable
    • -
  • fragmentation-needed
    • -
  • source-route-failed
    • -
  • network-unknown
    • -
  • host-unknown
    • -
  • network-prohibited
    • -
  • host-prohibited
    • -
  • TOS-network-unreachable
    • -
  • TOS-host-unreachable
    • -
  • communication-prohibited
    • -
  • host-precedence-violation
    • -
  • precedence-cutoff
    • -
  • source-quench
    • -
  • redirect
    • -
  • network-redirect
    • -
  • host-redirect
    • -
  • TOS-network-redirect
    • -
  • TOS-host-redirect
    • -
  • echo-request
    • -
  • router-advertisement
    • -
  • router-solicitation
    • -
  • time-exceeded
    • -
  • ttl-zero-during-transit
    • -
  • ttl-zero-during-reassembly
    • -
  • parameter-problem
    • -
  • ip-header-bad
    • -
  • required-option-missing
    • -
  • timestamp-request
    • -
  • timestamp-reply
    • -
  • address-mask-request
    • -
  • address-mask-reply
    • -
  • ping
    • -
  • pong
    • -
  • ttl-exceeded
    • -
- - -
ICMP type-name.
- - - - - - - - + + + +
    Choices: +
  • any
    • +
  • echo-reply
    • +
  • destination-unreachable
    • +
  • network-unreachable
    • +
  • host-unreachable
    • +
  • protocol-unreachable
    • +
  • port-unreachable
    • +
  • fragmentation-needed
    • +
  • source-route-failed
    • +
  • network-unknown
    • +
  • host-unknown
    • +
  • network-prohibited
    • +
  • host-prohibited
    • +
  • TOS-network-unreachable
    • +
  • TOS-host-unreachable
    • +
  • communication-prohibited
    • +
  • host-precedence-violation
    • +
  • precedence-cutoff
    • +
  • source-quench
    • +
  • redirect
    • +
  • network-redirect
    • +
  • host-redirect
    • +
  • TOS-network-redirect
    • +
  • TOS-host-redirect
    • +
  • echo-request
    • +
  • router-advertisement
    • +
  • router-solicitation
    • +
  • time-exceeded
    • +
  • ttl-zero-during-transit
    • +
  • ttl-zero-during-reassembly
    • +
  • parameter-problem
    • +
  • ip-header-bad
    • +
  • required-option-missing
    • +
  • timestamp-request
    • +
  • timestamp-reply
    • +
  • address-mask-request
    • +
  • address-mask-reply
    • +
  • ping
    • +
  • pong
    • +
  • ttl-exceeded
    • +
+ + +
ICMP type-name.
+ + + + + + + +
ipsec
string -
- - -
    Choices: -
  • match-ipsec
    • -
  • match-none
    • -
- - -
Inboud ip sec packets.
- - - - - - - + + + +
    Choices: +
  • match-ipsec
    • +
  • match-none
    • +
+ + +
Inboud ip sec packets.
+ + + + + + +
limit
dictionary -
- - - - -
Rate limit using a token bucket filter.
- - - - - - - - + + + + + +
Rate limit using a token bucket filter.
+ + + + + + + +
burst
integer -
- - - - -
Maximum number of packets to allow in excess of rate.
- - - - - - - - + + + + + +
Maximum number of packets to allow in excess of rate.
+ + + + + + + +
rate
dictionary -
- - - - -
format for rate (integer/time unit).
-
any one of second, minute, hour or day may be used to specify time unit.
-
eg. 1/second implies rule to be matched at an average of once per second.
- - - - - - - - - + + + + + +
format for rate (integer/time unit).
+
any one of second, minute, hour or day may be used to specify time unit.
+
eg. 1/second implies rule to be matched at an average of once per second.
+ + + + + + + + +
number
integer -
- - - - -
This is the integer value.
- - - - - - - - - + + + + + +
This is the integer value.
+ + + + + + + + +
unit
string -
- - - - -
This is the time unit.
- - - - - - - - - + + + + + +
This is the time unit.
+ + + + + + + + +
number
integer - / required
- - - - -
Rule number.
- - - - - - - + / required + + + + + +
Rule number.
+ + + + + + +
p2p
list - / elements=dictionary
- - - - -
P2P application packets.
- - - - - - - - + / elements=dictionary + + + + + +
P2P application packets.
+ + + + + + + +
application
string -
- - -
    Choices: -
  • all
    • -
  • applejuice
    • -
  • bittorrent
    • -
  • directconnect
    • -
  • edonkey
    • -
  • gnutella
    • -
  • kazaa
    • -
- - -
Name of the application.
- - - - - - - - + + + +
    Choices: +
  • all
    • +
  • applejuice
    • +
  • bittorrent
    • +
  • directconnect
    • +
  • edonkey
    • +
  • gnutella
    • +
  • kazaa
    • +
+ + +
Name of the application.
+ + + + + + + +
protocol
string -
- - - - -
Protocol to match (protocol name in /etc/protocols or protocol number or all).
-
<text> IP protocol name from /etc/protocols (e.g. "tcp" or "udp").
-
<0-255> IP protocol number.
-
tcp_udp Both TCP and UDP.
-
all All IP protocols.
-
(!)All IP protocols except for the specified name or number.
- - - - - - - + + + + + +
Protocol to match (protocol name in /etc/protocols or protocol number or all).
+
<text> IP protocol name from /etc/protocols (e.g. "tcp" or "udp").
+
<0-255> IP protocol number.
+
tcp_udp Both TCP and UDP.
+
all All IP protocols.
+
(!)All IP protocols except for the specified name or number.
+ + + + + + +
recent
dictionary -
- - - - -
Parameters for matching recently seen sources.
- - - - - - - - + + + + + +
Parameters for matching recently seen sources.
+ + + + + + + +
count
integer -
- - - - -
Source addresses seen more than N times.
- - - - - - - - + + + + + +
Source addresses seen more than N times.
+ + + + + + + +
time
integer -
- - - - -
Source addresses seen in the last N seconds.
- - - - - - - - + + + + + +
Source addresses seen in the last N seconds.
+ + + + + + + +
source
dictionary -
- - - - -
Source parameters.
- - - - - - - - + + + + + +
Source parameters.
+ + + + + + + +
address
string -
- - - - -
Source ip address subnet or range.
-
IPv4/6 address, subnet or range to match.
-
Match everything except the specified address, subnet or range.
-
Source ip address subnet or range.
- - - - - - - - + + + + + +
Source ip address subnet or range.
+
IPv4/6 address, subnet or range to match.
+
Match everything except the specified address, subnet or range.
+
Source ip address subnet or range.
+ + + + + + + +
group
dictionary -
- - - - -
Source group.
- - - - - - - - - + + + + + +
Source group.
+ + + + + + + + +
address_group
string -
- - - - -
Group of addresses.
- - - - - - - - - + + + + + +
Group of addresses.
+ + + + + + + + +
network_group
string -
- - - - -
Group of networks.
- - - - - - - - - + + + + + +
Group of networks.
+ + + + + + + + +
port_group
string -
- - - - -
Group of ports.
- - - - - - - - - + + + + + +
Group of ports.
+ + + + + + + + +
mac_address
string -
- - - - -
<MAC address> MAC address to match.
-
<!MAC address> Match everything except the specified MAC address.
- - - - - - - - + + + + + +
<MAC address> MAC address to match.
+
<!MAC address> Match everything except the specified MAC address.
+ + + + + + + +
port
string -
- - - - -
Multiple source ports can be specified as a comma-separated list.
-
The whole list can also be "negated" using '!'.
-
For example:'!22,telnet,http,123,1001-1005'.
- - - - - - - - + + + + + +
Multiple source ports can be specified as a comma-separated list.
+
The whole list can also be "negated" using '!'.
+
For example:'!22,telnet,http,123,1001-1005'.
+ + + + + + + +
state
dictionary -
- - - - -
Session state.
- - - - - - - - + + + + + +
Session state.
+ + + + + + + +
established
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Established state.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Established state.
+ + + + + + + +
invalid
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Invalid state.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Invalid state.
+ + + + + + + +
new
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
New state.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
New state.
+ + + + + + + +
related
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Related state.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Related state.
+ + + + + + + +
tcp
dictionary -
- - - - -
TCP flags to match.
- - - - - - - - + + + + + +
TCP flags to match.
+ + + + + + + +
flags
string -
- - - - -
TCP flags to be matched.
- - - - - - - - + + + + + +
TCP flags to be matched.
+ + + + + + + +
time
dictionary -
- - - - -
Time to match rule.
- - - - - - - - + + + + + +
Time to match rule.
+ + + + + + + +
monthdays
string -
- - - - -
Monthdays to match rule on.
- - - - - - - - + + + + + +
Monthdays to match rule on.
+ + + + + + + +
startdate
string -
- - - - -
Date to start matching rule.
- - - - - - - - + + + + + +
Date to start matching rule.
+ + + + + + + +
starttime
string -
- - - - -
Time of day to start matching rule.
- - - - - - - - + + + + + +
Time of day to start matching rule.
+ + + + + + + +
stopdate
string -
- - - - -
Date to stop matching rule.
- - - - - - - - + + + + + +
Date to stop matching rule.
+ + + + + + + +
stoptime
string -
- - - - -
Time of day to stop matching rule.
- - - - - - - - + + + + + +
Time of day to stop matching rule.
+ + + + + + + +
utc
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Interpret times for startdate, stopdate, starttime and stoptime to be UTC.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Interpret times for startdate, stopdate, starttime and stoptime to be UTC.
+ + + + + + + +
weekdays
string -
- - - - -
Weekdays to match rule on.
- - - - - - - - + + + + + +
Weekdays to match rule on.
+ + + + + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep firewall.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep firewall.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- - -
The state the configuration should be left in
- - - + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ + +
The state the configuration should be left in
+ + +
@@ -1323,7 +1329,6 @@ Examples .. code-block:: yaml+jinja - # Using deleted to delete firewall rules based on rule-set name # # Before state @@ -2356,9 +2361,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -2371,60 +2373,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
["set firewall name Downlink default-action 'accept'", "set firewall name Downlink description 'IPv4 INBOUND rule set'", "set firewall name Downlink rule 501 action 'accept'", "set firewall name Downlink rule 502 description 'Rule 502 is configured by Ansible'", "set firewall name Downlink rule 502 ipsec 'match-ipsec'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set firewall name Downlink default-action 'accept'", "set firewall name Downlink description 'IPv4 INBOUND rule set'", "set firewall name Downlink rule 501 action 'accept'", "set firewall name Downlink rule 502 description 'Rule 502 is configured by Ansible'", "set firewall name Downlink rule 502 ipsec 'match-ipsec'"]
+ - +

@@ -2436,5 +2438,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index c00b430f..111ff311 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -38,521 +38,525 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of Interfaces definitions.
- + / 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.
- + + + + + +
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.
- + + + + + +
Description of Interface.
+ - - - + + +
duplex
string -
- - -
    Choices: -
  • full
    • -
  • half
    • -
  • auto
    • -
- - -
Interface link status.
- + + + +
    Choices: +
  • full
    • +
  • half
    • +
  • auto
    • +
+ + +
Interface link status.
+ - - - + + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Interface link status.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Interface link status.
+ - - - + + +
mtu
integer -
- - - - -
Maximum size of transmit packet.
- + + + + + +
Maximum size of transmit packet.
+ - - - + + +
name
string - / required
- - - - -
Name of the Interface.
- + / 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.
- + / 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.
- + + + + + +
LLDP neighbor host for given interface name.
+ - - - - + + + +
port
string -
- - - - -
LLDP neighbor port to which given interface name is connected.
- + + + + + +
LLDP neighbor port to which given interface name is connected.
+ - - - - + + + +
speed
string -
- - - - -
Interface link speed.
- + + + + + +
Interface link speed.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- - -
State of the Interface configuration, up means present and operationally up and down means present and operationally down
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ + +
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.
- + + + + 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.
- + + + + + +
Description of Interface.
+ - - + +
duplex
string -
- - -
    Choices: -
  • full
    • -
  • half
    • -
  • auto
    • -
- - -
Interface link status.
- + + + +
    Choices: +
  • full
    • +
  • half
    • +
  • auto
    • +
+ + +
Interface link status.
+ - - + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Interface link status.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Interface link status.
+ - - + +
mtu
integer -
- - - - -
Maximum size of transmit packet.
- + + + + + +
Maximum size of transmit packet.
+ - - + +
name
string -
- - - - -
Name of the Interface.
- + + + + + +
Name of the Interface.
+ - - + +
neighbors
list - / elements=dictionary
- - - - -
Check the operational state of given interface name for LLDP neighbor.
-
The following suboptions are available.
- + / 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.
- + + + + + +
LLDP neighbor host for given interface name.
+ - - - + + +
port
string -
- - - - -
LLDP neighbor port to which given interface name is connected.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
Interface link speed.
+ - - + +
state
string -
- - -
    Choices: -
  • present ←
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- - -
State of the Interface configuration, up means present and operationally up and down means present and operationally down
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ + +
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+ - +
@@ -570,7 +574,6 @@ Examples .. code-block:: yaml+jinja - - name: configure interface vyos.vyos.vyos_interface: name: eth0 @@ -634,7 +637,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -647,24 +649,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']
+ - +

@@ -680,5 +682,3 @@ Authors ~~~~~~~ - Ganesh Nalawade (@ganeshrn) - - diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 67c71de7..5bf5d231 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -32,275 +32,278 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
The provided interfaces configuration.
- + / elements=dictionary + + + + + +
The provided interfaces configuration.
+ - - - + + +
description
string -
- - - - -
Interface description.
- + + + + + +
Interface description.
+ - - - + + +
duplex
string -
- - -
    Choices: -
  • full
    • -
  • half
    • -
  • auto
    • -
- - -
Interface duplex mode.
-
Applicable for Ethernet interfaces only.
- + + + +
    Choices: +
  • full
    • +
  • half
    • +
  • auto
    • +
+ + +
Interface duplex mode.
+
Applicable for Ethernet interfaces only.
+ - - - + + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Administrative state of the interface.
-
Set the value to true to administratively enable the interface or false to disable it.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Administrative state of the interface.
+
Set the value to true to administratively enable the interface or false to disable it.
+ - - - + + +
mtu
integer -
- - - - -
MTU for a specific interface. Refer to vendor documentation for valid values.
-
Applicable for Ethernet, Bonding, VXLAN and Virtual Tunnel interfaces.
- + + + + + +
MTU for a specific interface. Refer to vendor documentation for valid values.
+
Applicable for Ethernet, Bonding, VXLAN and Virtual Tunnel interfaces.
+ - - - + + +
name
string - / required
- - - - -
Full name of the interface, e.g. eth0, eth1, bond0, vti1, vxlan2.
- + / required + + + + + +
Full name of the interface, e.g. eth0, eth1, bond0, vti1, vxlan2.
+ - - - + + +
speed
string -
- - -
    Choices: -
  • auto
    • -
  • 10
    • -
  • 100
    • -
  • 1000
    • -
  • 2500
    • -
  • 10000
    • -
- - -
Interface link speed.
-
Applicable for Ethernet interfaces only.
- + + + +
    Choices: +
  • auto
    • +
  • 10
    • +
  • 100
    • +
  • 1000
    • +
  • 2500
    • +
  • 10000
    • +
+ + +
Interface link speed.
+
Applicable for Ethernet interfaces only.
+ - - - + + +
vifs
list - / elements=dictionary
- - - - -
Virtual sub-interfaces related configuration.
-
802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS.
- + / elements=dictionary + + + + + +
Virtual sub-interfaces related configuration.
+
802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS.
+ - - - - + + + +
description
string -
- - - - -
Virtual sub-interface description.
- + + + + + +
Virtual sub-interface description.
+ - - - - + + + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
Administrative state of the virtual sub-interface.
-
Set the value to true to administratively enable the interface or false to disable it.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
Administrative state of the virtual sub-interface.
+
Set the value to true to administratively enable the interface or false to disable it.
+ - - - - + + + +
mtu
integer -
- - - - -
MTU for the virtual sub-interface.
-
Refer to vendor documentation for valid values.
- + + + + + +
MTU for the virtual sub-interface.
+
Refer to vendor documentation for valid values.
+ - - - - + + + +
vlan_id
integer -
- - - - -
Identifier for the virtual sub-interface.
- + + + + + +
Identifier for the virtual sub-interface.
+ - - - - + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep interfaces.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep interfaces.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • rendered
    • -
  • gathered
    • -
  • parsed
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • rendered
    • +
  • gathered
    • +
  • parsed
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -318,7 +321,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # ------------- @@ -1246,9 +1248,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1261,60 +1260,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set interfaces ethernet eth1 mtu 1200', 'set interfaces ethernet eth2 vif 100 description VIF 100']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set interfaces ethernet eth1 mtu 1200', 'set interfaces ethernet eth2 vif 100 description VIF 100']
+ - +

@@ -1327,5 +1326,3 @@ Authors - Nilashish Chakraborty (@nilashishc) - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index 8745ffda..a8fe6040 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -38,273 +38,275 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of L3 interfaces definitions
- + / elements=dictionary + + + + + +
List of L3 interfaces definitions
+ - - - + + +
ipv4
string -
- - - - -
IPv4 of the L3 interface.
- + + + + + +
IPv4 of the L3 interface.
+ - - - + + +
ipv6
string -
- - - - -
IPv6 of the L3 interface.
- + + + + + +
IPv6 of the L3 interface.
+ - - - + + +
name
string - / required
- - - - -
Name of the L3 interface.
- + / required + + + + + +
Name of the L3 interface.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
- - -
State of the L3 interface configuration.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
+ + +
State of the L3 interface configuration.
+ - - - + + +
ipv4
string -
- - - - -
IPv4 of the L3 interface.
- + + + + + +
IPv4 of the L3 interface.
+ - - + +
ipv6
string -
- - - - -
IPv6 of the L3 interface.
- + + + + + +
IPv6 of the L3 interface.
+ - - + +
name
string -
- - - - -
Name of the L3 interface.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
- - -
State of the L3 interface configuration.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
State of the L3 interface configuration.
+ - +
@@ -322,7 +324,6 @@ Examples .. code-block:: yaml+jinja - - name: Set eth0 IPv4 address vyos.vyos.vyos_l3_interface: name: eth0 @@ -348,7 +349,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -361,24 +361,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
["set interfaces ethernet eth0 address '192.168.0.1/24'"]
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
["set interfaces ethernet eth0 address '192.168.0.1/24'"]
+ - +

@@ -394,5 +394,3 @@ Authors ~~~~~~~ - Ricardo Carrillo Cruz (@rcarrillocruz) - - diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst index 106c90d3..38dd3e91 100644 --- a/docs/vyos.vyos.vyos_l3_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_l3_interfaces_module.rst @@ -31,256 +31,263 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
The provided L3 interfaces configuration.
- + / elements=dictionary + + + + + +
The provided L3 interfaces configuration.
+ - - - + + +
ipv4
list - / elements=dictionary
- - - - -
List of IPv4 addresses of the interface.
- + / elements=dictionary + + + + + +
List of IPv4 addresses of the interface.
+ - - - - + + + +
address
string -
- - - - -
IPv4 address of the interface.
- + + + + + +
IPv4 address of the interface.
+ - - - - + + + +
ipv6
list - / elements=dictionary
- - - - -
List of IPv6 addresses of the interface.
- + / elements=dictionary + + + + + +
List of IPv6 addresses of the interface.
+ - - - - + + + +
address
string -
- - - - -
IPv6 address of the interface.
- + + + + + +
IPv6 address of the interface.
+ - - - - + + + +
name
string - / required
- - - - -
Full name of the interface, e.g. eth0, eth1.
- + / required + + + + + +
Full name of the interface, e.g. eth0, eth1.
+ - - - + + +
vifs
list - / elements=dictionary
- - - - -
Virtual sub-interfaces L3 configurations.
- + / elements=dictionary + + + + + +
Virtual sub-interfaces L3 configurations.
+ - - - - + + + +
ipv4
list - / elements=dictionary
- - - - -
List of IPv4 addresses of the virtual interface.
- + / elements=dictionary + + + + + +
List of IPv4 addresses of the virtual interface.
+ - - - - - + + + + +
address
string -
- - - - -
IPv4 address of the virtual interface.
- + + + + + +
IPv4 address of the virtual interface.
+ - - - - - + + + + +
ipv6
list - / elements=dictionary
- - - - -
List of IPv6 addresses of the virtual interface.
- + / elements=dictionary + + + + + +
List of IPv6 addresses of the virtual interface.
+ - - - - - + + + + +
address
string -
- - - - -
IPv6 address of the virtual interface.
- + + + + + +
IPv6 address of the virtual interface.
+ - - - - - + + + + +
vlan_id
integer -
- - - - -
Identifier for the virtual sub-interface.
- + + + + + +
Identifier for the virtual sub-interface.
+ - - - - + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep -e eth[2,3].
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep -e eth[2,3].
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -298,7 +305,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -685,9 +691,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -700,60 +703,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set interfaces ethernet eth1 192.0.2.14/2', 'set interfaces ethernet eth3 vif 101 address 198.51.100.130/25']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set interfaces ethernet eth1 192.0.2.14/2', 'set interfaces ethernet eth3 vif 101 address 198.51.100.130/25']
+ - +

@@ -766,5 +769,3 @@ Authors - Nilashish Chakraborty (@NilashishC) - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index b09a846c..153e20e2 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -31,229 +31,233 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A list of link aggregation group configurations.
- + / elements=dictionary + + + + + +
A list of link aggregation group configurations.
+ - - - + + +
arp_monitor
dictionary -
- - - - -
ARP Link monitoring parameters.
- + + + + + +
ARP Link monitoring parameters.
+ - - - - + + + +
interval
integer -
- - - - -
ARP link monitoring frequency in milliseconds.
- + + + + + +
ARP link monitoring frequency in milliseconds.
+ - - - - + + + +
target
list - / elements=string
- - - - -
IP address to use for ARP monitoring.
- + / elements=string + + + + + +
IP address to use for ARP monitoring.
+ - - - - + + + +
hash_policy
string -
- - -
    Choices: -
  • layer2
    • -
  • layer2+3
    • -
  • layer3+4
    • -
- - -
LAG or bonding transmit hash policy.
- + + + +
    Choices: +
  • layer2
    • +
  • layer2+3
    • +
  • layer3+4
    • +
+ + +
LAG or bonding transmit hash policy.
+ - - - + + +
members
list - / elements=dictionary
- - - - -
List of member interfaces for the LAG (bond).
- + / elements=dictionary + + + + + +
List of member interfaces for the LAG (bond).
+ - - - - + + + +
member
string -
- - - - -
Name of the member interface.
- + + + + + +
Name of the member interface.
+ - - - - + + + +
mode
string -
- - -
    Choices: -
  • 802.3ad
    • -
  • active-backup
    • -
  • broadcast
    • -
  • round-robin
    • -
  • transmit-load-balance
    • -
  • adaptive-load-balance
    • -
  • xor-hash
    • -
- - -
LAG or bond mode.
- + + + +
    Choices: +
  • 802.3ad
    • +
  • active-backup
    • +
  • broadcast
    • +
  • round-robin
    • +
  • transmit-load-balance
    • +
  • adaptive-load-balance
    • +
  • xor-hash
    • +
+ + +
LAG or bond mode.
+ - - - + + +
name
string - / required
- - - - -
Name of the link aggregation group (LAG) or bond.
- + / required + + + + + +
Name of the link aggregation group (LAG) or bond.
+ - - - + + +
primary
string -
- - - - -
Primary device interfaces for the LAG (bond).
- + + + + + +
Primary device interfaces for the LAG (bond).
+ - - - + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep bond.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep bond.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -271,7 +275,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -865,9 +868,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -880,60 +880,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set interfaces bonding bond2', 'set interfaces bonding bond2 hash-policy layer2']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set interfaces bonding bond2', 'set interfaces bonding bond2 hash-policy layer2']
+ - +

@@ -945,5 +945,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index 471de9b1..ae7eea7b 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -38,297 +38,301 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of link aggregation definitions.
- + / elements=dictionary + + + + + +
List of link aggregation definitions.
+ - - - + + +
members
list - / elements=string
- - - - -
List of members of the link aggregation group.
- + / elements=string + + + + + +
List of members of the link aggregation group.
+ - - - + + +
mode
string -
- - -
    Choices: -
  • 802.3ad
    • -
  • active-backup
    • -
  • broadcast
    • -
  • round-robin
    • -
  • transmit-load-balance
    • -
  • adaptive-load-balance
    • -
  • xor-hash
    • -
  • on
    • -
- - -
Mode of the link aggregation group.
- + + + +
    Choices: +
  • 802.3ad
    • +
  • active-backup
    • +
  • broadcast
    • +
  • round-robin
    • +
  • transmit-load-balance
    • +
  • adaptive-load-balance
    • +
  • xor-hash
    • +
  • on
    • +
+ + +
Mode of the link aggregation group.
+ - - - + + +
name
string - / required
- - - - -
Name of the link aggregation group.
- + / required + + + + + +
Name of the link aggregation group.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- - -
State of the link aggregation group.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ + +
State of the link aggregation group.
+ - - - + + +
members
list - / elements=string
- - - - -
List of members of the link aggregation group.
- + / elements=string + + + + + +
List of members of the link aggregation group.
+ - - + +
mode
string -
- - -
    Choices: -
  • 802.3ad ←
    • -
  • active-backup
    • -
  • broadcast
    • -
  • round-robin
    • -
  • transmit-load-balance
    • -
  • adaptive-load-balance
    • -
  • xor-hash
    • -
  • on
    • -
- - -
Mode of the link aggregation group.
- + + + +
    Choices: +
  • 802.3ad ←
    • +
  • active-backup
    • +
  • broadcast
    • +
  • round-robin
    • +
  • transmit-load-balance
    • +
  • adaptive-load-balance
    • +
  • xor-hash
    • +
  • on
    • +
+ + +
Mode of the link aggregation group.
+ - - + +
name
string -
- - - - -
Name of the link aggregation group.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
  • up
    • +
  • down
    • +
+ + +
State of the link aggregation group.
+ - +
@@ -346,7 +350,6 @@ Examples .. code-block:: yaml+jinja - - name: configure link aggregation group vyos.vyos.vyos_linkagg: name: bond0 @@ -374,7 +377,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -387,24 +389,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces bonding bond0', "set interfaces ethernet eth0 bond-group 'bond0'", "set interfaces ethernet eth1 bond-group 'bond0'"]
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set interfaces bonding bond0', "set interfaces ethernet eth0 bond-group 'bond0'", "set interfaces ethernet eth1 bond-group 'bond0'"]
+ - +

@@ -420,5 +422,3 @@ Authors ~~~~~~~ - Ricardo Carrillo Cruz (@rcarrillocruz) - - diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index bf803ff6..92244211 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -31,139 +31,140 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
The provided link layer discovery protocol (LLDP) configuration.
- + + + + + +
The provided link layer discovery protocol (LLDP) configuration.
+ - - - + + +
address
string -
- - - - -
This argument defines management-address.
- + + + + + +
This argument defines management-address.
+ - - - + + +
enable
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
This argument is a boolean value to enable or disable LLDP.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
This argument is a boolean value to enable or disable LLDP.
+ - - - + + +
legacy_protocols
list - / elements=string
- - -
    Choices: -
  • cdp
    • -
  • edp
    • -
  • fdp
    • -
  • sonmp
    • -
- - -
List of the supported legacy protocols.
- + / elements=string + + + +
    Choices: +
  • cdp
    • +
  • edp
    • +
  • fdp
    • +
  • sonmp
    • +
+ + +
List of the supported legacy protocols.
+ - - - + + +
snmp
string -
- - - - -
This argument enable the SNMP queries to LLDP database.
- + + + + + +
This argument enable the SNMP queries to LLDP database.
+ - - - + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -181,7 +182,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -530,9 +530,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -545,60 +542,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set service lldp legacy-protocols sonmp', "set service lldp management-address '192.0.2.14'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set service lldp legacy-protocols sonmp', "set service lldp management-address '192.0.2.14'"]
+ - +

@@ -610,5 +607,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 98d5c704..1c860e7d 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -38,215 +38,217 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of interfaces LLDP should be configured on.
- + / elements=dictionary + + + + + +
List of interfaces LLDP should be configured on.
+ - - - + + +
name
string - / required
- - - - -
Name of the interface LLDP should be configured on.
- + / required + + + + + +
Name of the interface LLDP should be configured on.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
  • enabled
    • -
  • disabled
    • -
- - -
State of the LLDP configuration.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
  • enabled
    • +
  • disabled
    • +
+ + +
State of the LLDP configuration.
+ - - - + + +
name
string -
- - - - -
Name of the interface LLDP should be configured on.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
  • enabled
    • -
  • disabled
    • -
- - -
State of the LLDP configuration.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
  • enabled
    • +
  • disabled
    • +
+ + +
State of the LLDP configuration.
+ - +
@@ -264,7 +266,6 @@ Examples .. code-block:: yaml+jinja - - name: Enable LLDP on eth1 net_lldp_interface: state: present @@ -296,7 +297,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -309,24 +309,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set service lldp eth1', 'set service lldp eth2 disable']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set service lldp eth1', 'set service lldp eth2 disable']
+ - +

@@ -342,5 +342,3 @@ Authors ~~~~~~~ - Ricardo Carrillo Cruz (@rcarrillocruz) - - diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index d64b20c7..c5ea47bc 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -31,324 +31,330 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A list of lldp interfaces configurations.
- + / elements=dictionary + + + + + +
A list of lldp interfaces configurations.
+ - - - + + +
enable
boolean -
- - -
    Choices: -
  • no
    • -
  • yes ←
    • -
- - -
to disable lldp on the interface.
- + + + +
    Choices: +
  • no
    • +
  • yes ←
    • +
+ + +
to disable lldp on the interface.
+ - - - + + +
location
dictionary -
- - - - -
LLDP-MED location data.
- + + + + + +
LLDP-MED location data.
+ - - - - + + + +
civic_based
dictionary -
- - - - -
Civic-based location data.
- + + + + + +
Civic-based location data.
+ - - - - - + + + + +
ca_info
list - / elements=dictionary
- - - - -
LLDP-MED address info
- + / elements=dictionary + + + + + +
LLDP-MED address info
+ - - - - - - + + + + + +
ca_type
integer -
- - - - -
LLDP-MED Civic Address type.
- + + + + + +
LLDP-MED Civic Address type.
+ - - - - - - + + + + + +
ca_value
string -
- - - - -
LLDP-MED Civic Address value.
- + + + + + +
LLDP-MED Civic Address value.
+ - - - - - - + + + + + +
country_code
string - / required
- - - - -
Country Code
- + / required + + + + + +
Country Code
+ - - - - - + + + + +
coordinate_based
dictionary -
- - - - -
Coordinate-based location.
- + + + + + +
Coordinate-based location.
+ - - - - - + + + + +
altitude
integer -
- - - - -
Altitude in meters.
- + + + + + +
Altitude in meters.
+ - - - - - + + + + +
datum
string -
- - -
    Choices: -
  • WGS84
    • -
  • NAD83
    • -
  • MLLW
    • -
- - -
Coordinate datum type.
- + + + +
    Choices: +
  • WGS84
    • +
  • NAD83
    • +
  • MLLW
    • +
+ + +
Coordinate datum type.
+ - - - - - + + + + +
latitude
string - / required
- - - - -
Latitude.
- + / required + + + + + +
Latitude.
+ - - - - - + + + + +
longitude
string - / required
- - - - -
Longitude.
- + / required + + + + + +
Longitude.
+ - - - - - + + + + +
elin
string -
- - - - -
Emergency Call Service ELIN number (between 10-25 numbers).
- + + + + + +
Emergency Call Service ELIN number (between 10-25 numbers).
+ - - - - + + + +
name
string - / required
- - - - -
Name of the lldp interface.
- + / required + + + + + +
Name of the lldp interface.
+ - - - + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • rendered
    • -
  • parsed
    • -
  • gathered
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • rendered
    • +
  • parsed
    • +
  • gathered
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -366,7 +372,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -844,9 +849,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -859,60 +861,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
["set service lldp interface eth2 'disable'", 'delete service lldp interface eth1 location']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set service lldp interface eth2 'disable'", 'delete service lldp interface eth1 location']
+ - +

@@ -924,5 +926,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index 30dae36f..92aa732e 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -38,161 +38,162 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
interfaces
list - / elements=string
- - - - -
Name of the interfaces.
- + / 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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
  • enabled
    • -
  • disabled
    • -
- - -
State of the link aggregation group.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
  • enabled
    • +
  • disabled
    • +
+ + +
State of the link aggregation group.
+ - +
@@ -210,7 +211,6 @@ Examples .. code-block:: yaml+jinja - - name: Enable LLDP service vyos.vyos.vyos_lldp: state: present @@ -221,7 +221,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -234,24 +233,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set service lldp']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set service lldp']
+ - +

@@ -267,5 +266,3 @@ Authors ~~~~~~~ - Ricardo Carrillo Cruz (@rcarrillocruz) - - diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index c54f6361..f651b7a5 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -31,318 +31,319 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of logging definitions.
- + / elements=dictionary + + + + + +
List of logging definitions.
+ - - - + + +
dest
string -
- - -
    Choices: -
  • console
    • -
  • file
    • -
  • global
    • -
  • host
    • -
  • user
    • -
- - -
Destination of the logs.
- + + + +
    Choices: +
  • console
    • +
  • file
    • +
  • global
    • +
  • host
    • +
  • user
    • +
+ + +
Destination of the logs.
+ - - - + + +
facility
string -
- - - - -
Set logging facility.
- + + + + + +
Set logging facility.
+ - - - + + +
level
string -
- - - - -
Set logging severity levels.
- + + + + + +
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.
- + + + + + +
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 -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
- - -
State of the logging configuration.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
+ + +
State of the logging configuration.
+ - - - + + +
dest
string -
- - -
    Choices: -
  • console
    • -
  • file
    • -
  • global
    • -
  • host
    • -
  • user
    • -
- - -
Destination of the logs.
- + + + +
    Choices: +
  • console
    • +
  • file
    • +
  • global
    • +
  • host
    • +
  • user
    • +
+ + +
Destination of the logs.
+ - - + +
facility
string -
- - - - -
Set logging facility.
- + + + + + +
Set logging facility.
+ - - + +
level
string -
- - - - -
Set logging severity levels.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
- - -
State of the logging configuration.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
State of the logging configuration.
+ - +
@@ -361,7 +362,6 @@ Examples .. code-block:: yaml+jinja - - name: configure console logging vyos.vyos.vyos_logging: dest: console @@ -397,7 +397,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -410,24 +409,24 @@ Common return values are documented `here 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']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set system syslog global facility all level notice']
+ - +

@@ -439,5 +438,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 1d233051..50ed5d34 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -31,1598 +31,1609 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A provided OSPFv2 route configuration.
- - - - - + + + + + +
A provided OSPFv2 route configuration.
+ + + + +
areas
list - / elements=dictionary
- - - - -
OSPFv2 area.
- - - - - - + / elements=dictionary + + + + + +
OSPFv2 area.
+ + + + + +
area_id
string -
- - - - -
OSPFv2 area identity.
- + + + + + +
OSPFv2 area identity.
+ - - - - + + + +
area_type
dictionary -
- - - - -
Area type.
- - - - - - - + + + + + +
Area type.
+ + + + + + +
normal
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Normal OSPFv2 area.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Normal OSPFv2 area.
+ - - - - - + + + + +
nssa
dictionary -
- - - - -
NSSA OSPFv2 area.
- - - - - - - - + + + + + +
NSSA OSPFv2 area.
+ + + + + + + +
default_cost
integer -
- - - - -
Summary-default cost of NSSA area.
- + + + + + +
Summary-default cost of NSSA area.
+ - - - - - - + + + + + +
no_summary
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Do not inject inter-area routes into stub.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Do not inject inter-area routes into stub.
+ - - - - - - + + + + + +
set
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enabling NSSA.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enabling NSSA.
+ - - - - - - + + + + + +
translate
string -
- - -
    Choices: -
  • always
    • -
  • candidate
    • -
  • never
    • -
- - -
NSSA-ABR.
- - - - - - - - + + + +
    Choices: +
  • always
    • +
  • candidate
    • +
  • never
    • +
+ + +
NSSA-ABR.
+ + + + + + + +
stub
dictionary -
- - - - -
Stub OSPFv2 area.
- - - - - - - - + + + + + +
Stub OSPFv2 area.
+ + + + + + + +
default_cost
integer -
- - - - -
Summary-default cost of stub area.
- + + + + + +
Summary-default cost of stub area.
+ - - - - - - + + + + + +
no_summary
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Do not inject inter-area routes into stub.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Do not inject inter-area routes into stub.
+ - - - - - - + + + + + +
set
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enabling stub.
- - - - - - - - + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enabling stub.
+ + + + + + + +
authentication
string -
- - -
    Choices: -
  • plaintext-password
    • -
  • md5
    • -
- - -
OSPFv2 area authentication type.
- + + + +
    Choices: +
  • plaintext-password
    • +
  • md5
    • +
+ + +
OSPFv2 area authentication type.
+ - - - - + + + +
network
list - / elements=dictionary
- - - - -
OSPFv2 network.
- - - - - - - + / elements=dictionary + + + + + +
OSPFv2 network.
+ + + + + + +
address
string - / required
- - - - -
OSPFv2 IPv4 network address.
- - - - - - - + / required + + + + + +
OSPFv2 IPv4 network address.
+ + + + + + +
range
list - / elements=dictionary
- - - - -
Summarize routes matching prefix (border routers only).
- - - - - - - + / elements=dictionary + + + + + +
Summarize routes matching prefix (border routers only).
+ + + + + + +
address
string -
- - - - -
border router IPv4 address.
- + + + + + +
border router IPv4 address.
+ - - - - - + + + + +
cost
integer -
- - - - -
Metric for this range.
- + + + + + +
Metric for this range.
+ - - - - - + + + + +
not_advertise
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Don't advertise this range.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Don't advertise this range.
+ - - - - - + + + + +
substitute
string -
- - - - -
Announce area range (IPv4 address) as another prefix.
- - - - - - - + + + + + +
Announce area range (IPv4 address) as another prefix.
+ + + + + + +
shortcut
string -
- - -
    Choices: -
  • default
    • -
  • disable
    • -
  • enable
    • -
- - -
Area's shortcut mode.
- + + + +
    Choices: +
  • default
    • +
  • disable
    • +
  • enable
    • +
+ + +
Area's shortcut mode.
+ - - - - + + + +
virtual_link
list - / elements=dictionary
- - - - -
Virtual link address.
- - - - - - - + / elements=dictionary + + + + + +
Virtual link address.
+ + + + + + +
address
string -
- - - - -
virtual link address.
- + + + + + +
virtual link address.
+ - - - - - + + + + +
authentication
dictionary -
- - - - -
OSPFv2 area authentication type.
- - - - - - - - + + + + + +
OSPFv2 area authentication type.
+ + + + + + + +
md5
list - / elements=dictionary
- - - - -
MD5 key id based authentication.
- - - - - - - - - + / elements=dictionary + + + + + +
MD5 key id based authentication.
+ + + + + + + + +
key_id
integer -
- - - - -
MD5 key id.
- + + + + + +
MD5 key id.
+ - - - - - - - + + + + + + +
md5_key
string -
- - - - -
MD5 key.
- - - - - - - - - + + + + + +
MD5 key.
+ + + + + + + + +
plaintext_password
string -
- - - - -
Plain text password.
- - - - - - - - + + + + + +
Plain text password.
+ + + + + + + +
dead_interval
integer -
- - - - -
Interval after which a neighbor is declared dead.
- + + + + + +
Interval after which a neighbor is declared dead.
+ - - - - - + + + + +
hello_interval
integer -
- - - - -
Interval between hello packets.
- + + + + + +
Interval between hello packets.
+ - - - - - + + + + +
retransmit_interval
integer -
- - - - -
Interval between retransmitting lost link state advertisements.
- + + + + + +
Interval between retransmitting lost link state advertisements.
+ - - - - - + + + + +
transmit_delay
integer -
- - - - -
Link state transmit delay.
- - - - - - - + + + + + +
Link state transmit delay.
+ + + + + + +
auto_cost
dictionary -
- - - - -
Calculate OSPFv2 interface cost according to bandwidth.
- - - - - - + + + + + +
Calculate OSPFv2 interface cost according to bandwidth.
+ + + + + +
reference_bandwidth
integer -
- - - - -
Reference bandwidth cost in Mbits/sec.
- - - - - - + + + + + +
Reference bandwidth cost in Mbits/sec.
+ + + + + +
default_information
dictionary -
- - - - -
Control distribution of default information.
- - - - - - + + + + + +
Control distribution of default information.
+ + + + + +
originate
dictionary -
- - - - -
Distribute a default route.
- - - - - - - + + + + + +
Distribute a default route.
+ + + + + + +
always
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Always advertise default route.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Always advertise default route.
+ - - - - - + + + + +
metric
integer -
- - - - -
OSPFv2 default metric.
- + + + + + +
OSPFv2 default metric.
+ - - - - - + + + + +
metric_type
integer -
- - - - -
OSPFv2 Metric types for default routes.
- + + + + + +
OSPFv2 Metric types for default routes.
+ - - - - - + + + + +
route_map
string -
- - - - -
Route map references.
- - - - - - - + + + + + +
Route map references.
+ + + + + + +
default_metric
integer -
- - - - -
Metric of redistributed routes
- + + + + + +
Metric of redistributed routes
+ - - - + + +
distance
dictionary -
- - - - -
Administrative distance.
- - - - - - + + + + + +
Administrative distance.
+ + + + + +
global
integer -
- - - - -
Global OSPFv2 administrative distance.
- + + + + + +
Global OSPFv2 administrative distance.
+ - - - - + + + +
ospf
dictionary -
- - - - -
OSPFv2 administrative distance.
- - - - - - - + + + + + +
OSPFv2 administrative distance.
+ + + + + + +
external
integer -
- - - - -
Distance for external routes.
- + + + + + +
Distance for external routes.
+ - - - - - + + + + +
inter_area
integer -
- - - - -
Distance for inter-area routes.
- + + + + + +
Distance for inter-area routes.
+ - - - - - + + + + +
intra_area
integer -
- - - - -
Distance for intra-area routes.
- - - - - - - + + + + + +
Distance for intra-area routes.
+ + + + + + +
log_adjacency_changes
string -
- - -
    Choices: -
  • detail
    • -
- - -
Log changes in adjacency state.
- + + + +
    Choices: +
  • detail
    • +
+ + +
Log changes in adjacency state.
+ - - - + + +
max_metric
dictionary -
- - - - -
OSPFv2 maximum/infinite-distance metric.
- - - - - - + + + + + +
OSPFv2 maximum/infinite-distance metric.
+ + + + + +
router_lsa
dictionary -
- - - - -
Advertise own Router-LSA with infinite distance (stub router).
- - - - - - - + + + + + +
Advertise own Router-LSA with infinite distance (stub router).
+ + + + + + +
administrative
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Administratively apply, for an indefinite period.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Administratively apply, for an indefinite period.
+ - - - - - + + + + +
on_shutdown
integer -
- - - - -
Time to advertise self as stub-router.
- + + + + + +
Time to advertise self as stub-router.
+ - - - - - + + + + +
on_startup
integer -
- - - - -
Time to advertise self as stub-router
- - - - - - - + + + + + +
Time to advertise self as stub-router
+ + + + + + +
mpls_te
dictionary -
- - - - -
MultiProtocol Label Switching-Traffic Engineering (MPLS-TE) parameters.
- - - - - - + + + + + +
MultiProtocol Label Switching-Traffic Engineering (MPLS-TE) parameters.
+ + + + + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enable MPLS-TE functionality.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enable MPLS-TE functionality.
+ - - - - + + + +
router_address
string -
- - - - -
Stable IP address of the advertising router.
- - - - - - + + + + + +
Stable IP address of the advertising router.
+ + + + + +
neighbor
list - / elements=dictionary
- - - - -
Neighbor IP address.
- - - - - - + / elements=dictionary + + + + + +
Neighbor IP address.
+ + + + + +
neighbor_id
string -
- - - - -
Identity (number/IP address) of neighbor.
- + + + + + +
Identity (number/IP address) of neighbor.
+ - - - - + + + +
poll_interval
integer -
- - - - -
Seconds between dead neighbor polling interval.
- + + + + + +
Seconds between dead neighbor polling interval.
+ - - - - + + + +
priority
integer -
- - - - -
Neighbor priority.
- - - - - - + + + + + +
Neighbor priority.
+ + + + + +
parameters
dictionary -
- - - - -
OSPFv2 specific parameters.
- - - - - - + + + + + +
OSPFv2 specific parameters.
+ + + + + +
abr_type
string -
- - -
    Choices: -
  • cisco
    • -
  • ibm
    • -
  • shortcut
    • -
  • standard
    • -
- - -
OSPFv2 ABR Type.
- + + + +
    Choices: +
  • cisco
    • +
  • ibm
    • +
  • shortcut
    • +
  • standard
    • +
+ + +
OSPFv2 ABR Type.
+ - - - - + + + +
opaque_lsa
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enable the Opaque-LSA capability (rfc2370).
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enable the Opaque-LSA capability (rfc2370).
+ - - - - + + + +
rfc1583_compatibility
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Enable rfc1583 criteria for handling AS external routes.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Enable rfc1583 criteria for handling AS external routes.
+ - - - - + + + +
router_id
string -
- - - - -
Override the default router identifier.
- - - - - - + + + + + +
Override the default router identifier.
+ + + + + +
passive_interface
list - / elements=string
- - - - -
Suppress routing updates on an interface.
- + / elements=string + + + + + +
Suppress routing updates on an interface.
+ - - - + + +
passive_interface_exclude
list - / elements=string
- - - - -
Interface to exclude when using passive-interface default.
- + / elements=string + + + + + +
Interface to exclude when using passive-interface default.
+ - - - + + +
redistribute
list - / elements=dictionary
- - - - -
Redistribute information from another routing protocol.
- - - - - - + / elements=dictionary + + + + + +
Redistribute information from another routing protocol.
+ + + + + +
metric
integer -
- - - - -
Metric for redistribution routes.
- + + + + + +
Metric for redistribution routes.
+ - - - - + + + +
metric_type
integer -
- - - - -
OSPFv2 Metric types.
- + + + + + +
OSPFv2 Metric types.
+ - - - - + + + +
route_map
string -
- - - - -
Route map references.
- + + + + + +
Route map references.
+ - - - - + + + +
route_type
string -
- - -
    Choices: -
  • bgp
    • -
  • connected
    • -
  • kernel
    • -
  • rip
    • -
  • static
    • -
- - -
Route type to redistribute.
- - - - - - + + + +
    Choices: +
  • bgp
    • +
  • connected
    • +
  • kernel
    • +
  • rip
    • +
  • static
    • +
+ + +
Route type to redistribute.
+ + + + + +
route_map
list - / elements=string
- - - - -
Filter routes installed in local route map.
- + / elements=string + + + + + +
Filter routes installed in local route map.
+ - - - + + +
timers
dictionary -
- - - - -
Adjust routing timers.
- - - - - - + + + + + +
Adjust routing timers.
+ + + + + +
refresh
dictionary -
- - - - -
Adjust refresh parameters.
- - - - - - - + + + + + +
Adjust refresh parameters.
+ + + + + + +
timers
integer -
- - - - -
refresh timer.
- - - - - - - + + + + + +
refresh timer.
+ + + + + + +
throttle
dictionary -
- - - - -
Throttling adaptive timers.
- - - - - - - + + + + + +
Throttling adaptive timers.
+ + + + + + +
spf
dictionary -
- - - - -
OSPFv2 SPF timers.
- - - - - - - - + + + + + +
OSPFv2 SPF timers.
+ + + + + + + +
delay
integer -
- - - - -
Delay (msec) from first change received till SPF calculation.
- + + + + + +
Delay (msec) from first change received till SPF calculation.
+ - - - - - - + + + + + +
initial_holdtime
integer -
- - - - -
Initial hold time(msec) between consecutive SPF calculations.
- + + + + + +
Initial hold time(msec) between consecutive SPF calculations.
+ - - - - - - + + + + + +
max_holdtime
integer -
- - - - -
maximum hold time (sec).
- - - - - - - - + + + + + +
maximum hold time (sec).
+ + + + + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep ospf.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep ospf.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- - -
The state the configuration should be left in.
- - - + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ + +
The state the configuration should be left in.
+ + +
@@ -1640,7 +1651,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -3038,8 +3048,6 @@ Examples - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -3052,60 +3060,60 @@ Common return values are documented `here Returned Description - - + +
after
dictionary -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
dictionary -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf passive-interface 'eth1'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf passive-interface 'eth1'"]
+ - +

@@ -3117,5 +3125,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index 1bfbde0a..d1ee1b18 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -31,305 +31,308 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
dictionary -
- - - - -
A provided OSPFv3 route configuration.
- + + + + + +
A provided OSPFv3 route configuration.
+ - - - + + +
areas
list - / elements=dictionary
- - - - -
OSPFv3 area.
- + / elements=dictionary + + + + + +
OSPFv3 area.
+ - - - - + + + +
area_id
string -
- - - - -
OSPFv3 Area name/identity.
- + + + + + +
OSPFv3 Area name/identity.
+ - - - - + + + +
export_list
string -
- - - - -
Name of export-list.
- + + + + + +
Name of export-list.
+ - - - - + + + +
import_list
string -
- - - - -
Name of import-list.
- + + + + + +
Name of import-list.
+ - - - - + + + +
range
list - / elements=dictionary
- - - - -
Summarize routes matching prefix (border routers only).
- + / elements=dictionary + + + + + +
Summarize routes matching prefix (border routers only).
+ - - - - - + + + + +
address
string -
- - - - -
border router IPv4 address.
- + + + + + +
border router IPv4 address.
+ - - - - - + + + + +
advertise
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Advertise this range.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Advertise this range.
+ - - - - - + + + + +
not_advertise
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Don't advertise this range.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Don't advertise this range.
+ - - - - - + + + + +
parameters
dictionary -
- - - - -
OSPFv3 specific parameters.
- + + + + + +
OSPFv3 specific parameters.
+ - - - - + + + +
router_id
string -
- - - - -
Override the default router identifier.
- + + + + + +
Override the default router identifier.
+ - - - - + + + +
redistribute
list - / elements=dictionary
- - - - -
Redistribute information from another routing protocol.
- + / elements=dictionary + + + + + +
Redistribute information from another routing protocol.
+ - - - - + + + +
route_map
string -
- - - - -
Route map references.
- + + + + + +
Route map references.
+ - - - - + + + +
route_type
string -
- - -
    Choices: -
  • bgp
    • -
  • connected
    • -
  • kernel
    • -
  • ripng
    • -
  • static
    • -
- - -
Route type to redistribute.
- + + + +
    Choices: +
  • bgp
    • +
  • connected
    • +
  • kernel
    • +
  • ripng
    • +
  • static
    • +
+ + +
Route type to redistribute.
+ - - - - + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep ospfv3.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep ospfv3.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • deleted
    • -
  • parsed
    • -
  • gathered
    • -
  • rendered
    • -
- - -
The state the configuration should be left in.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • deleted
    • +
  • parsed
    • +
  • gathered
    • +
  • rendered
    • +
+ + +
The state the configuration should be left in.
+ - +
@@ -347,7 +350,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -835,9 +837,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -850,60 +849,60 @@ Common return values are documented `here Returned Description - - + +
after
dictionary -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
dictionary -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospfv3 area 2 range '2001:db10::/32'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospfv3 area 2 range '2001:db10::/32'"]
+ - +

@@ -915,5 +914,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 69bc4181..e3377fc5 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -35,235 +35,236 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
count
integer -
- - - Default:
5
- - -
Number of packets to send to check reachability.
- + + + + 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.
- + / required + + + + + +
The IP Address or hostname (resolvable by the device) of the remote node.
+ - - + +
interval
integer -
- - - - -
Determines the interval (in seconds) between consecutive pings.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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).
- + + + + + +
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).
- + + + + + +
The source interface or IP Address to use while sending the ping packet(s).
+ - - + +
state
string -
- - -
    Choices: -
  • absent
    • -
  • present ←
    • -
- - -
Determines if the expected result is success or fail.
- + + + +
    Choices: +
  • absent
    • +
  • present ←
    • +
+ + +
Determines if the expected result is success or fail.
+ - - + +
ttl
integer -
- - - - -
The time-to-live value for the ICMP packet(s).
- + + + + + +
The time-to-live value for the ICMP packet(s).
+ - +
@@ -285,7 +286,6 @@ Examples .. code-block:: yaml+jinja - - name: Test reachability to 10.10.10.10 vyos.vyos.vyos_ping: dest: 10.10.10.10 @@ -311,7 +311,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -324,92 +323,92 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
List of commands sent.
-
-
Sample:
-
['ping 10.8.38.44 count 10 interface eth0 ttl 128']
- +
List of commands sent.
+
+
Sample:
+
['ping 10.8.38.44 count 10 interface eth0 ttl 128']
+ - - + +
packet_loss
string -
- + + always -
Percentage of packets lost.
-
-
Sample:
-
0%
- +
Percentage of packets lost.
+
+
Sample:
+
0%
+ - - + +
packets_rx
integer -
- + + always -
Packets successfully received.
-
-
Sample:
-
20
- +
Packets successfully received.
+
+
Sample:
+
20
+ - - + +
packets_tx
integer -
- + + always -
Packets successfully transmitted.
-
-
Sample:
-
20
- +
Packets successfully transmitted.
+
+
Sample:
+
20
+ - - + +
rtt
dictionary -
- + + when ping succeeds -
The round trip time (RTT) stats.
-
-
Sample:
-
{'avg': 2, 'max': 8, 'min': 1, 'mdev': 24}
- +
The round trip time (RTT) stats.
+
+
Sample:
+
AnsibleMapping([('avg', 2), ('max', 8), ('min', 1), ('mdev', 24)])
+ - +

@@ -421,5 +420,3 @@ Authors ~~~~~~~ - Nilashish Chakraborty (@NilashishC) - - diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 848d5a0d..74f296d4 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -38,304 +38,306 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
admin_distance
integer -
- - - - -
Admin distance of the static route.
- + + + + + +
Admin distance of the static route.
+ - - + +
aggregate
list - / elements=dictionary
- - - - -
List of static route definitions
- + / elements=dictionary + + + + + +
List of static route definitions
+ - - - + + +
admin_distance
integer -
- - - - -
Admin distance of the static route.
- + + + + + +
Admin distance of the static route.
+ - - - + + +
mask
string -
- - - - -
Network prefix mask of the static route.
- + + + + + +
Network prefix mask of the static route.
+ - - - + + +
next_hop
string -
- - - - -
Next hop IP of the static route.
- + + + + + +
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.
- + / required + + + + + +
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
- - -
State of the static route configuration.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
+ + +
State of the static route configuration.
+ - - - + + +
mask
string -
- - - - -
Network prefix mask of the static route.
- + + + + + +
Network prefix mask of the static route.
+ - - + +
next_hop
string -
- - - - -
Next hop IP of the static route.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
- - -
State of the static route configuration.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
State of the static route configuration.
+ - +
@@ -354,7 +356,6 @@ Examples .. code-block:: yaml+jinja - - name: configure static route vyos.vyos.vyos_static_route: prefix: 192.168.2.0 @@ -389,7 +390,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -402,24 +402,24 @@ Common return values are documented `here 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']
- +
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']
+ - +

@@ -435,5 +435,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 18085381..53942a5c 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -31,296 +31,303 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A provided static route configuration.
- + / elements=dictionary + + + + + +
A provided static route configuration.
+ - - - + + +
address_families
list - / elements=dictionary
- - - - -
A dictionary specifying the address family to which the static route(s) belong.
- + / elements=dictionary + + + + + +
A dictionary specifying the address family to which the static route(s) belong.
+ - - - - + + + +
afi
string - / required
- - -
    Choices: -
  • ipv4
    • -
  • ipv6
    • -
- - -
Specifies the type of route.
- + / required + + + +
    Choices: +
  • ipv4
    • +
  • ipv6
    • +
+ + +
Specifies the type of route.
+ - - - - + + + +
routes
list - / elements=dictionary
- - - - -
A ditionary that specify the static route configurations.
- + / elements=dictionary + + + + + +
A ditionary that specify the static route configurations.
+ - - - - - + + + + +
blackhole_config
dictionary -
- - - - -
Configured to silently discard packets.
- + + + + + +
Configured to silently discard packets.
+ - - - - - - + + + + + +
distance
integer -
- - - - -
Distance for the route.
- + + + + + +
Distance for the route.
+ - - - - - - + + + + + +
type
string -
- - - - -
This is to configure only blackhole.
- + + + + + +
This is to configure only blackhole.
+ - - - - - - + + + + + +
dest
string - / required
- - - - -
An IPv4/v6 address in CIDR notation that specifies the destination network for the static route.
- + / required + + + + + +
An IPv4/v6 address in CIDR notation that specifies the destination network for the static route.
+ - - - - - + + + + +
next_hops
list - / elements=dictionary
- - - - -
Next hops to the specified destination.
- + / elements=dictionary + + + + + +
Next hops to the specified destination.
+ - - - - - - + + + + + +
admin_distance
integer -
- - - - -
Distance value for the route.
- + + + + + +
Distance value for the route.
+ - - - - - - + + + + + +
enabled
boolean -
- - -
    Choices: -
  • no
    • -
  • yes
    • -
- - -
Disable IPv4/v6 next-hop static route.
- + + + +
    Choices: +
  • no
    • +
  • yes
    • +
+ + +
Disable IPv4/v6 next-hop static route.
+ - - - - - - + + + + + +
forward_router_address
string - / required
- - - - -
The IP address of the next hop that can be used to reach the destination network.
- + / required + + + + + +
The IP address of the next hop that can be used to reach the destination network.
+ - - - - - - + + + + + +
interface
string -
- - - - -
Name of the outgoing interface.
- + + + + + +
Name of the outgoing interface.
+ - - - - - - + + + + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep static route.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep static route.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - -
    Choices: -
  • merged ←
    • -
  • replaced
    • -
  • overridden
    • -
  • deleted
    • -
  • gathered
    • -
  • rendered
    • -
  • parsed
    • -
- - -
The state of the configuration after module completion.
- + + + +
    Choices: +
  • merged ←
    • +
  • replaced
    • +
  • overridden
    • +
  • deleted
    • +
  • gathered
    • +
  • rendered
    • +
  • parsed
    • +
+ + +
The state of the configuration after module completion.
+ - +
@@ -338,7 +345,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -1080,9 +1086,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1095,60 +1098,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The resulting configuration model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The resulting configuration model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration prior to the model invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration prior to the model invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
["set protocols static route 192.0.2.32/28 next-hop '192.0.2.6'", "set protocols static route 192.0.2.32/28 'blackhole'"]
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set protocols static route 192.0.2.32/28 next-hop '192.0.2.6'", "set protocols static route 192.0.2.32/28 'blackhole'"]
+ - +

@@ -1160,5 +1163,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index acca3667..a71303c4 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -31,205 +31,207 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
domain_name
string -
- - - - -
The new domain name to apply to the device.
- + + + + + +
The new domain name to apply to the device.
+ - - + +
domain_search
list - / elements=string
- - - - -
A list of domain names to search. Mutually exclusive with name_server
- + / elements=string + + + + + +
A list of domain names to search. Mutually exclusive with name_server
+ - - + +
host_name
string -
- - - - -
Configure the device hostname parameter. This option takes an ASCII string value.
- + + + + + +
Configure the device hostname parameter. This option takes an ASCII string value.
+ - - + +
name_server
list - / elements=string
- - - - -
A list of name servers to use with the device. Mutually exclusive with domain_search
-

aliases: name_servers
- + / elements=string + + + + + +
A list of name servers to use with the device. Mutually exclusive with domain_search
+

aliases: name_servers
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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
    • -
- - -
Whether to apply (present) or remove (absent) the settings.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
Whether to apply (present) or remove (absent) the settings.
+ - +
@@ -248,7 +250,6 @@ Examples .. code-block:: yaml+jinja - - name: configure hostname and domain-name vyos.vyos.vyos_system: host_name: vyos01 @@ -268,7 +269,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -281,24 +281,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set system hostname vyos01', 'set system domain-name foo.example.com']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set system hostname vyos01', 'set system domain-name foo.example.com']
+ - +

@@ -310,5 +310,3 @@ Authors ~~~~~~~ - Nathaniel Case (@Qalthos) - - diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 30114480..04a7a6e2 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -31,365 +31,367 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
The set of username objects to be configured on the remote VyOS device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
-

aliases: users, collection
- + / elements=dictionary + + + + + +
The set of username objects to be configured on the remote VyOS device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.
+

aliases: users, collection
+ - - - + + +
configured_password
string -
- - - - -
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
- + + + + + +
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
+ - - - + + +
full_name
string -
- - - - -
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
- + + + + + +
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
+ - - - + + +
level
string -
- - - - -
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
-

aliases: role
- + + + + + +
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
+

aliases: role
+ - - - + + +
name
string - / required
- - - - -
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
- + / required + + + + + +
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
- - -
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
+ + +
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+ - - - + + +
update_password
string -
- - -
    Choices: -
  • on_create
    • -
  • always
    • -
- - -
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
- + + + +
    Choices: +
  • on_create
    • +
  • always
    • +
+ + +
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+ - - - + + +
configured_password
string -
- - - - -
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
- + + + + + +
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
+ - - + +
full_name
string -
- - - - -
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
- + + + + + +
The full_name argument provides the full name of the user account to be created on the remote device. This argument accepts any text string value.
+ - - + +
level
string -
- - - - -
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
-

aliases: role
- + + + + + +
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
+

aliases: role
+ - - + +
name
string -
- - - - -
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
- + + + + + +
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
+ - - - + + +
purge
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user (the current defined set of users).
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Instructs the module to consider the resource definition absolute. It will remove any previously configured usernames on the device with the exception of the `admin` user (the current defined set of users).
+ - - + +
state
string -
- - -
    Choices: -
  • present ←
    • -
  • absent
    • -
- - -
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
+ - - + +
update_password
string -
- - -
    Choices: -
  • on_create
    • -
  • always ←
    • -
- - -
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
- + + + +
    Choices: +
  • on_create
    • +
  • always ←
    • +
+ + +
Since passwords are encrypted in the device running config, this argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
+ - +
@@ -408,7 +410,6 @@ Examples .. code-block:: yaml+jinja - - name: create a new user vyos.vyos.vyos_user: name: ansible @@ -433,7 +434,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -446,24 +446,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set system login user test level operator', 'set system login user authentication plaintext-password password']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set system login user test level operator', 'set system login user authentication plaintext-password password']
+ - +

@@ -475,5 +475,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 084649fb..d00260ec 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -31,386 +31,393 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
address
string -
- - - - -
Configure Virtual interface address.
- + + + + + +
Configure Virtual interface address.
+ - - + +
aggregate
list - / elements=dictionary
- - - - -
List of VLANs definitions.
- + / elements=dictionary + + + + + +
List of VLANs definitions.
+ - - - + + +
address
string -
- - - - -
Configure Virtual interface address.
- + + + + + +
Configure Virtual interface address.
+ - - - + + +
associated_interfaces
list - / elements=string
- - - - -
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
- + / elements=string + + + + + +
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
+ - - - + + +
delay
integer -
- - - - -
Delay the play should wait to check for declarative intent params values.
- + + + + + +
Delay the play should wait to check for declarative intent params values.
+ - - - + + +
interfaces
list - / elements=string / required
- - - - -
List of interfaces that should be associated to the VLAN.
- + / elements=string + / required + + + + + +
List of interfaces that should be associated to the VLAN.
+ - - - + + +
name
string -
- - - - -
Name of the VLAN.
- + + + + + +
Name of the VLAN.
+ - - - + + +
state
string -
- - -
    Choices: -
  • present
    • -
  • absent
    • -
- - -
State of the VLAN configuration.
- + + + +
    Choices: +
  • present
    • +
  • absent
    • +
+ + +
State of the VLAN configuration.
+ - - - + + +
vlan_id
integer - / required
- - - - -
ID of the VLAN. Range 0-4094.
- + / required + + + + + +
ID of the VLAN. Range 0-4094.
+ - - - + + +
associated_interfaces
list - / elements=string
- - - - -
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
- + / elements=string + + + + + +
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
+ - - + +
delay
integer -
- - - Default:
10
- - -
Delay the play should wait to check for declarative intent params values.
- + + + + Default:
10
+ + +
Delay the play should wait to check for declarative intent params values.
+ - - + +
interfaces
list - / elements=string
- - - - -
List of interfaces that should be associated to the VLAN.
- + / elements=string + + + + + +
List of interfaces that should be associated to the VLAN.
+ - - + +
name
string -
- - - - -
Name of the VLAN.
- + + + + + +
Name of the VLAN.
+ - - + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
- + + + + + +
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.
+ - - - + + +
purge
boolean -
- - -
    Choices: -
  • no ←
    • -
  • yes
    • -
- - -
Purge VLANs not defined in the aggregate parameter.
- + + + +
    Choices: +
  • no ←
    • +
  • yes
    • +
+ + +
Purge VLANs not defined in the aggregate parameter.
+ - - + +
state
string -
- - -
    Choices: -
  • present ←
    • -
  • absent
    • -
- - -
State of the VLAN configuration.
- + + + +
    Choices: +
  • present ←
    • +
  • absent
    • +
+ + +
State of the VLAN configuration.
+ - - + +
vlan_id
integer -
- - - - -
ID of the VLAN. Range 0-4094.
- + + + + + +
ID of the VLAN. Range 0-4094.
+ - +
@@ -429,7 +436,6 @@ Examples .. code-block:: yaml+jinja - - name: Create vlan vyos.vyos.vyos_vlan: vlan_id: 100 @@ -472,7 +478,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -485,24 +490,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']
+ - +

@@ -514,5 +519,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - -- cgit v1.2.3