]> git.proxmox.com Git - pve-docs.git/blobdiff - pveum.1-synopsis.adoc
repos: mention APT repo status gui
[pve-docs.git] / pveum.1-synopsis.adoc
index 30855a1dfbd66ff0c7904c32b67fd9ad861667af..b70998c011bc9c91ab4f3030031114a3d16ae845 100644 (file)
@@ -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
@@ -156,6 +208,10 @@ LDAP bind domain name
 
 Path to the CA certificate store
 
+`--case-sensitive` `<boolean>` ('default =' `1`)::
+
+username is case-sensitive
+
 `--cert` `<string>` ::
 
 Path to the client certificate
@@ -164,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.
@@ -196,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.
@@ -236,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.
 
@@ -248,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
@@ -272,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
@@ -284,6 +360,10 @@ LDAP bind domain name
 
 Path to the CA certificate store
 
+`--case-sensitive` `<boolean>` ('default =' `1`)::
+
+username is case-sensitive
+
 `--cert` `<string>` ::
 
 Path to the client certificate
@@ -292,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.
@@ -332,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.
@@ -618,6 +710,30 @@ User ID or full API token ID
 
 Only dump this specific path, not the whole tree.
 
+*pveum user tfa delete* `<userid>` `[OPTIONS]`
+
+Change user u2f authentication.
+
+`<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>` ::
+
+Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.
+
 *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
 
 Generate a new API token for a specific user. NOTE: returns API token