From 9e159990f949652ec1b22f9a9a6e72828bdd1e80 Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Thu, 2 Jan 2025 14:06:58 -0500 Subject: T6988: fix: remove role/level, fix tests (#371) * T6988: fix: remove role/level, fix tests * feature: add support for SSH keys * tests: add integration tests for public_keys * feat: add encrypted password support * tests: add unit for encrypted * tests: fix wrapping in YAML * tests: fix smoke tests --- docs/vyos.vyos.vyos_user_module.rst | 191 ++++++++++++++++++++++++++++++++---- 1 file changed, 172 insertions(+), 19 deletions(-) (limited to 'docs') diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 5f0ad83..f95200b 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + - -
ParameterParameter Choices/Defaults Comments
+
aggregate @@ -52,7 +52,7 @@ Parameters
+
configured_password @@ -68,7 +68,23 @@ Parameters
+ +
+ encrypted_password + +
+ string +
+ 		+ +
The encrypted password of the user account on the remote device. Note that unlike the configured_password argument, this argument ignores the update_password and updates if the value is different from the one in the device running config.
+
full_name @@ -84,23 +100,59 @@ Parameters
+
+ 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.
+
+
+ public_keys + +
+ list + / elements=dictionary +
+ 		+ +
Public keys for authentiction over SSH.
+
- level + key
string + / required
-
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
-

aliases: role
+
Public key string (base64 encoded)
name @@ -113,12 +165,39 @@ Parameters 		-
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
+
Name of the key (usually in the form of user@hostname)
+
+ type + +
+ string + / required +
+ 		+
    Choices: +
  • ssh-dss
    • +
  • ssh-rsa
    • +
  • ecdsa-sha2-nistp256
    • +
  • ecdsa-sha2-nistp384
    • +
  • ssh-ed25519
    • +
  • ecdsa-sha2-nistp521
    • +
+ 		+
Type of the key
+
state @@ -138,7 +217,7 @@ Parameters
+
update_password @@ -158,7 +237,7 @@ Parameters
+
configured_password @@ -173,7 +252,22 @@ Parameters
+ +
+ encrypted_password + +
+ string +
+ 		+ +
The encrypted password of the user account on the remote device. Note that unlike the configured_password argument, this argument ignores the update_password and updates if the value is different from the one in the device running config.
+
full_name @@ -188,38 +282,98 @@ Parameters
+
+ 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.
+
+
+ public_keys + +
+ list + / elements=dictionary +
+ 		+ +
Public keys for authentiction over SSH.
+
- level + key
string + / required
-
The level argument configures the level of the user when logged into the system. This argument accepts string values admin or operator.
-

aliases: role
+
Public key string (base64 encoded)
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.
+
Name of the key (usually in the form of user@hostname)
+
+ type + +
+ string + / required +
+ 		+
    Choices: +
  • ssh-dss
    • +
  • ssh-rsa
    • +
  • ecdsa-sha2-nistp256
    • +
  • ecdsa-sha2-nistp384
    • +
  • ssh-ed25519
    • +
  • ecdsa-sha2-nistp521
    • +
+ 		+
Type of the key
+
purge @@ -238,7 +392,7 @@ Parameters
+
state @@ -257,7 +411,7 @@ Parameters
+
update_password @@ -307,7 +461,6 @@ Examples aggregate: - name: netop - name: netend - level: operator state: present - name: Change Password for User netop vyos.vyos.vyos_user: @@ -344,7 +497,7 @@ Common return values are documented `here 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']
+
['set system login user authentication plaintext-password password']
-- cgit v1.2.3