]> git.proxmox.com Git - pve-docs.git/blobdiff - pveum.1-synopsis.adoc
ceph: add more details for private/public network usage and distinction
[pve-docs.git] / pveum.1-synopsis.adoc
index 086b9474139cb535f7cadeb19ba120e93dd01852..ca2d343005e3066b4940f6236f5f7a44836795e7 100644 (file)
@@ -168,21 +168,25 @@ Update pool data.
 
 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]`
 
@@ -200,11 +204,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 +228,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 +260,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.
 
@@ -364,11 +372,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 +396,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 +422,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 +436,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 +608,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>` ::
 
@@ -758,6 +770,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