W3cubDocs

/Ansible 2.10

vyos.vyos.vyos_user – Manage the collection of local users on VyOS device

Note

This plugin is part of the vyos.vyos collection.

To install it use: ansible-galaxy collection install vyos.vyos.

To use it in a playbook, specify: vyos.vyos.vyos_user.

New in version 1.0.0: of vyos.vyos

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Note

This module has a corresponding action plugin.

Parameters

Parameter		Choices/Defaults	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
	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`.
	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.
	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
	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`.
	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
	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.
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`.
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.
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
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`.
provider dictionary			Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. For more information please see the Network Guide. A dict object containing connection details.
	host string		Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
	password string		Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
	port integer		Specifies the port to use when building the connection to the remote device.
	ssh_keyfile path		Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	timeout integer		Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
	username string		Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
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).
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
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.

Notes

Note

Tested against VyOS 1.1.8 (helium).
This module works with connection network_cli. See the VyOS OS Platform Options.
For more information on using Ansible to manage network devices see the Ansible Network Guide

Examples

- name: create a new user
  vyos.vyos.vyos_user:
    name: ansible
    configured_password: password
    state: present
- name: remove all users except admin
  vyos.vyos.vyos_user:
    purge: yes
- name: set multiple users to level operator
  vyos.vyos.vyos_user:
    aggregate:
    - name: netop
    - name: netend
    level: operator
    state: present
- name: Change Password for User netop
  vyos.vyos.vyos_user:
    name: netop
    configured_password: '{{ new_password }}'
    update_password: always
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list / elements=string	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']

Authors

Trishna Guha (@trishnaguha)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/vyos/vyos/vyos_user_module.html