totp: fix copy/paste mistake

[pve-docs.git] / pveum.1-synopsis.adoc

diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc
index 086b9474139cb535f7cadeb19ba120e93dd01852..0b60d7cb9217dba41ae0acd307e08176b6daf37a 100644 (file)
--- a/pveum.1-synopsis.adoc
+++ b/pveum.1-synopsis.adoc
@@ -128,7 +128,7 @@ Shows help for a specific command
 
 Verbose output format.
 
-*pveum passwd* `<userid>`
+*pveum passwd* `<userid>` `[OPTIONS]`
 
 Change user password.
 
@@ -136,6 +136,10 @@ Change user password.
 
 Full User ID, in the `name@realm` format.
 
+`--confirmation-password` `<string>` ::
+
+The current password of the user performing the change.
+
 *pveum pool add* `<poolid>` `[OPTIONS]`
 
 Create new pool.
@@ -156,33 +160,47 @@ Delete pool.
 
 no description available
 
-*pveum pool list* `[FORMAT_OPTIONS]`
+*pveum pool list* `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+List pools or get pool configuration.
+
+`--poolid` `<string>` ::
+
+no description available
+
+`--type` `<lxc | qemu | storage>` ::
 
-Pool index.
+no description available
++
+NOTE: Requires option(s): `poolid`
 
 *pveum pool modify* `<poolid>` `[OPTIONS]`
 
-Update pool data.
+Update pool.
 
 `<poolid>`: `<string>` ::
 
 no description available
 
+`--allow-move` `<boolean>` ('default =' `0`)::
+
+Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.
+
 `--comment` `<string>` ::
 
 no description available
 
-`--delete` `<boolean>` ::
+`--delete` `<boolean>` ('default =' `0`)::
 
-Remove vms/storage (instead of adding it).
+Remove the passed VMIDs and/or storage IDs instead of adding them.
 
 `--storage` `<string>` ::
 
-List of storage IDs.
+List of storage IDs to add or remove from this pool.
 
 `--vms` `<string>` ::
 
-List of virtual machines.
+List of guest VMIDs to add or remove from this pool.
 
 *pveum realm add* `<realm> --type <string>` `[OPTIONS]`
 
@@ -192,7 +210,7 @@ Add an authentication server.
 
 Authentication domain ID
 
-`--acr-values` `<string>` ::
+`--acr-values` `^[^\x00-\x1F\x7F <>#"]*$` ::
 
 Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.
 
@@ -200,11 +218,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
 
 Automatically create users if they do not exist.
 
-`--base_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--base_dn` `<string>` ::
 
 LDAP base domain name
 
-`--bind_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--bind_dn` `<string>` ::
 
 LDAP bind domain name
 
@@ -224,6 +242,10 @@ Path to the client certificate
 
 Path to the client certificate key
 
+`--check-connection` `<boolean>` ('default =' `0`)::
+
+Check bind connection to the server.
+
 `--client-id` `<string>` ::
 
 OpenID Client ID
@@ -252,7 +274,7 @@ LDAP filter for user sync.
 
 The objectclasses for groups.
 
-`--group_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--group_dn` `<string>` ::
 
 LDAP base domain name for group sync. If not set, the base_dn will be used.
 
@@ -356,7 +378,7 @@ Update authentication server settings.
 
 Authentication domain ID
 
-`--acr-values` `<string>` ::
+`--acr-values` `^[^\x00-\x1F\x7F <>#"]*$` ::
 
 Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.
 
@@ -364,11 +386,11 @@ Specifies the Authentication Context Class Reference values that theAuthorizatio
 
 Automatically create users if they do not exist.
 
-`--base_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--base_dn` `<string>` ::
 
 LDAP base domain name
 
-`--bind_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--bind_dn` `<string>` ::
 
 LDAP bind domain name
 
@@ -388,6 +410,10 @@ Path to the client certificate
 
 Path to the client certificate key
 
+`--check-connection` `<boolean>` ('default =' `0`)::
+
+Check bind connection to the server.
+
 `--client-id` `<string>` ::
 
 OpenID Client ID
@@ -410,7 +436,7 @@ A list of settings you want to delete.
 
 `--digest` `<string>` ::
 
-Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
 
 `--domain` `\S+` ::
 
@@ -424,7 +450,7 @@ LDAP filter for user sync.
 
 The objectclasses for groups.
 
-`--group_dn` `(?^:\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+)(,\s*\w+=("[\w ,+/<>;=]+"|[^ ,+"/<>;=]+))*)` ::
+`--group_dn` `<string>` ::
 
 LDAP base domain name for group sync. If not set, the base_dn will be used.
 
@@ -596,9 +622,9 @@ Create or verify authentication ticket.
 
 User name
 
-`--new-format` `<boolean>` ('default =' `0`)::
+`--new-format` `<boolean>` ('default =' `1`)::
 
-With webauthn the format of half-authenticated tickts changed. New clients should pass 1 here and not worry about the old format. The old format is deprecated and will be retired with PVE-8.0
+This parameter is now ignored and assumed to be 1.
 
 `--otp` `<string>` ::
 
@@ -656,7 +682,7 @@ no description available
 
 no description available
 
-`--keys` `<string>` ::
+`--keys` `[0-9a-zA-Z!=]{0,4096}` ::
 
 Keys for two factor auth (yubico).
 
@@ -726,7 +752,7 @@ no description available
 
 no description available
 
-`--keys` `<string>` ::
+`--keys` `[0-9a-zA-Z!=]{0,4096}` ::
 
 Keys for two factor auth (yubico).
 
@@ -758,6 +784,22 @@ Full User ID, in the `name@realm` format.
 
 The TFA ID, if none provided, all TFA entries will be deleted.
 
+*pveum user tfa list* `[<userid>]`
+
+List TFA entries.
+
+`<userid>`: `<string>` ::
+
+Full User ID, in the `name@realm` format.
+
+*pveum user tfa unlock* `<userid>`
+
+Unlock a user's TFA authentication.
+
+`<userid>`: `<string>` ::
+
+Full User ID, in the `name@realm` format.
+
 *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 
 Generate a new API token for a specific user. NOTE: returns API token