backup: clarify that CLI means FS-level and highlight retention-note

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

diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc
index e00cfdf7fccb3b3b61ab7736866d83df83916a30..85765a91d04c814b06b198579a8bb6c13e9e4a56 100644 (file)
--- a/pveum.1-synopsis.adoc
+++ b/pveum.1-synopsis.adoc
@@ -136,6 +136,54 @@ Change user password.
 
 User ID
 
+*pveum pool add* `<poolid>` `[OPTIONS]`
+
+Create new pool.
+
+`<poolid>`: `<string>` ::
+
+no description available
+
+`--comment` `<string>` ::
+
+no description available
+
+*pveum pool delete* `<poolid>`
+
+Delete pool.
+
+`<poolid>`: `<string>` ::
+
+no description available
+
+*pveum pool list* `[FORMAT_OPTIONS]`
+
+Pool index.
+
+*pveum pool modify* `<poolid>` `[OPTIONS]`
+
+Update pool data.
+
+`<poolid>`: `<string>` ::
+
+no description available
+
+`--comment` `<string>` ::
+
+no description available
+
+`--delete` `<boolean>` ::
+
+Remove vms/storage (instead of adding it).
+
+`--storage` `<string>` ::
+
+List of storage IDs.
+
+`--vms` `<string>` ::
+
+List of virtual machines.
+
 *pveum realm add* `<realm> --type <string>` `[OPTIONS]`
 
 Add an authentication server.
@@ -144,6 +192,10 @@ Add an authentication server.
 
 Authentication domain ID
 
+`--autocreate` `<boolean>` ('default =' `0`)::
+
+Automatically create users if they do not exist.
+
 `--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 
 LDAP base domain name
@@ -168,6 +220,14 @@ Path to the client certificate
 
 Path to the client certificate key
 
+`--client-id` `<string>` ::
+
+OpenID Client ID
+
+`--client-key` `<string>` ::
+
+OpenID Client Key
+
 `--comment` `<string>` ::
 
 Description.
@@ -200,6 +260,10 @@ LDAP filter for group sync.
 
 LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
 
+`--issuer-url` `<string>` ::
+
+OpenID Issuer Url
+
 `--mode` `<ldap | ldap+starttls | ldaps>` ('default =' `ldap`)::
 
 LDAP protocol mode.
@@ -240,7 +304,7 @@ Comma separated list of key=value pairs for specifying which LDAP attributes map
 
 Use Two-factor authentication.
 
-`--type` `<ad | ldap | pam | pve>` ::
+`--type` `<ad | ldap | openid | pam | pve>` ::
 
 Realm type.
 
@@ -252,6 +316,10 @@ LDAP user attribute name
 
 The objectclasses for users.
 
+`--username-claim` `<email | subject | username>` ::
+
+OpenID claim used to generate the unique username.
+
 `--verify` `<boolean>` ('default =' `0`)::
 
 Verify the server's SSL certificate
@@ -276,6 +344,10 @@ Update authentication server settings.
 
 Authentication domain ID
 
+`--autocreate` `<boolean>` ('default =' `0`)::
+
+Automatically create users if they do not exist.
+
 `--base_dn` `\w+=[^,]+(,\s*\w+=[^,]+)*` ::
 
 LDAP base domain name
@@ -300,6 +372,14 @@ Path to the client certificate
 
 Path to the client certificate key
 
+`--client-id` `<string>` ::
+
+OpenID Client ID
+
+`--client-key` `<string>` ::
+
+OpenID Client Key
+
 `--comment` `<string>` ::
 
 Description.
@@ -340,6 +420,10 @@ LDAP filter for group sync.
 
 LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.
 
+`--issuer-url` `<string>` ::
+
+OpenID Issuer Url
+
 `--mode` `<ldap | ldap+starttls | ldaps>` ('default =' `ldap`)::
 
 LDAP protocol mode.
@@ -484,6 +568,10 @@ Create or verify authentication ticket.
 
 User name
 
+`--new-format` `<boolean>` ('default =' `0`)::
+
+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
+
 `--otp` `<string>` ::
 
 One-time password for Two-factor authentication.
@@ -504,6 +592,10 @@ NOTE: Requires option(s): `path`
 
 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 
+`--tfa-challenge` `<string>` ::
+
+The signed TFA challenge string the user wants to respond to.
+
 *pveum user add* `<userid>` `[OPTIONS]`
 
 Create new user.
@@ -628,27 +720,15 @@ Only dump this specific path, not the whole tree.
 
 *pveum user tfa delete* `<userid>` `[OPTIONS]`
 
-Change user u2f authentication.
+Delete TFA entries from a user.
 
 `<userid>`: `<string>` ::
 
 User ID
 
-`--config` `type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]` ::
-
-A TFA configuration. This must currently be of type TOTP of not set at all.
-
-`--key` `<string>` ::
-
-When adding TOTP, the shared secret value.
-
-`--password` `<string>` ::
-
-The current password.
-
-`--response` `<string>` ::
+`--id` `<string>` ::
 
-Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.
+The TFA ID, if none provided, all TFA entries will be deleted.
 
 *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`