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_config_module.rst | 497 +++++++++++++++++----------------- 1 file changed, 247 insertions(+), 250 deletions(-) (limited to 'docs/vyos.vyos.vyos_config_module.rst') diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index c3031f3..0914d8e 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 -
- - - - - -
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.
- + + + + + + +
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 -
- - - - - -
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.
- + + + + + + +
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 -
- - - - - -
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.
- + + + + + + +
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) - - -- cgit v1.2.3