.. _vyos.rest.vyos_user_module: ******************* vyos.rest.vyos_user ******************* **Manage local users on VyOS via the REST API.** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - Manages local user accounts on VyOS devices using the HTTPS REST API. - Mirrors ``vyos.vyos.vyos_user`` but uses the HTTP API. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
aggregate
list / elements=dictionary
List of user definitions. Mutually exclusive with name.

aliases: users, collection
configured_password
string
Plaintext password (will be hashed on device).
encrypted_password
string
Pre-hashed password string.
full_name
string
Full name.
level
string
    Choices:
  • admin
  • operator
User privilege level.
name
string / required
Username.
public_keys
list / elements=dictionary
SSH public keys for authentication.
key
string / required
Base64-encoded public key.
name
string / required
Key identifier (e.g. user@host).
type
string / required
    Choices:
  • ssh-dss
  • ssh-rsa
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ssh-ed25519
  • ecdsa-sha2-nistp521
Key type.
state
string
    Choices:
  • present
  • absent
Present or absent.
update_password
string
    Choices:
  • always
  • on_create
When to update the password.
api_key
string / required
configured_password
string
Plaintext password.
encrypted_password
string
Pre-hashed password.
full_name
string
Full name for the single user.
hostname
string / required
level
string
    Choices:
  • admin
  • operator
name
string
Single username. Mutually exclusive with aggregate.
port
integer
Default:
443
public_keys
list / elements=dictionary
key
string / required
name
string / required
type
string / required
state
string
    Choices:
  • present ←
  • absent
Whether to create (present) or remove (absent) the user.
timeout
integer
Default:
30
update_password
string
    Choices:
  • always
  • on_create
verify_ssl
boolean
    Choices:
  • no ←
  • yes

Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
commands
list
always
set/delete commands issued.


Status ------ Authors ~~~~~~~ - VyOS Community (@vyos)