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_user_module.rst | 490 ++++++++++++++++++------------------ 1 file changed, 244 insertions(+), 246 deletions(-) (limited to 'docs/vyos.vyos.vyos_user_module.rst') 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 -
- - - - - -
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
- + + + + + + +
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 -
- - - - - -
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.
- + + + + + + +
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 -
- - - - - -
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).
- + + + + + + +
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 -
- - - - - -
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
- + + + + + + +
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 -
- - - - - -
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.
- + + + + + + +
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) - - -- cgit v1.2.3