vyos_user - Manage the collection of local users on VyOS device¶

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.

Parameters¶

Notes¶

Examples¶

- name: create a new user
  vyos_user:
    name: ansible
    configured_password: password
    state: present
- name: remove all users except admin
  vyos_user:
    purge: yes
- name: set multiple users to level operator
  vyos_user:
    aggregate:
      - name: netop
      - name: netend
    level: operator
    state: present
- name: Change Password for User netop
  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:

Status¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.