X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveum.1-synopsis.adoc;h=5278b395d8e2483b1dbad306f64de867f0db11bf;hb=0a1739bd15ba88b0a384366994f1b8afe5073676;hp=dd3e988806520730a67cb651ad45b97a89a70382;hpb=35a75dd36c05f79e9dda81147867878a55d839c1;p=pve-docs.git diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index dd3e988..5278b39 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -1,6 +1,6 @@ *pveum* ` [ARGS] [OPTIONS]` -*pveum acldel* ` --roles ` `[OPTIONS]` +*pveum acl delete* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). @@ -20,11 +20,19 @@ Allow to propagate (inherit) permissions. List of roles. +`--tokens` `` :: + +List of API tokens. + `--users` `` :: List of users. -*pveum aclmod* ` --roles ` `[OPTIONS]` +*pveum acl list* `[FORMAT_OPTIONS]` + +Get Access Control List (ACLs). + +*pveum acl modify* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). @@ -44,11 +52,23 @@ Allow to propagate (inherit) permissions. List of roles. +`--tokens` `` :: + +List of API tokens. + `--users` `` :: List of users. -*pveum groupadd* `` `[OPTIONS]` +*pveum acldel* + +An alias for 'pveum acl delete'. + +*pveum aclmod* + +An alias for 'pveum acl modify'. + +*pveum group add* `` `[OPTIONS]` Create new group. @@ -60,7 +80,7 @@ no description available no description available -*pveum groupdel* `` +*pveum group delete* `` Delete group. @@ -68,7 +88,11 @@ Delete group. no description available -*pveum groupmod* `` `[OPTIONS]` +*pveum group list* `[FORMAT_OPTIONS]` + +Group index. + +*pveum group modify* `` `[OPTIONS]` Update group data. @@ -80,6 +104,18 @@ no description available no description available +*pveum groupadd* + +An alias for 'pveum group add'. + +*pveum groupdel* + +An alias for 'pveum group delete'. + +*pveum groupmod* + +An alias for 'pveum group modify'. + *pveum help* `[OPTIONS]` Get help about specified command. @@ -100,7 +136,7 @@ Change user password. User ID -*pveum roleadd* `` `[OPTIONS]` +*pveum role add* `` `[OPTIONS]` Create new role. @@ -112,7 +148,7 @@ no description available no description available -*pveum roledel* `` +*pveum role delete* `` Delete role. @@ -120,9 +156,13 @@ Delete role. no description available -*pveum rolemod* ` --privs ` `[OPTIONS]` +*pveum role list* `[FORMAT_OPTIONS]` -Create new role. +Role index. + +*pveum role modify* `` `[OPTIONS]` + +Update an existing role. ``: `` :: @@ -138,6 +178,18 @@ NOTE: Requires option(s): `privs` no description available +*pveum roleadd* + +An alias for 'pveum role add'. + +*pveum roledel* + +An alias for 'pveum role delete'. + +*pveum rolemod* + +An alias for 'pveum role modify'. + *pveum ticket* `` `[OPTIONS]` Create or verify authentication ticket. @@ -166,7 +218,7 @@ NOTE: Requires option(s): `path` You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. -*pveum useradd* `` `[OPTIONS]` +*pveum user add* `` `[OPTIONS]` Create new user. @@ -184,7 +236,7 @@ no description available `--enable` `` ('default =' `1`):: -Enable the account (default). You can set this to '0' to disable the accout +Enable the account (default). You can set this to '0' to disable the account `--expire` ` (0 - N)` :: @@ -206,11 +258,11 @@ Keys for two factor auth (yubico). no description available -`--password` :: +`--password` `` :: Initial password. -*pveum userdel* `` +*pveum user delete* `` Delete user. @@ -218,7 +270,19 @@ Delete user. User ID -*pveum usermod* `` `[OPTIONS]` +*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]` + +User index. + +`--enabled` `` :: + +Optional filter for enable property. + +`--full` `` ('default =' `0`):: + +Include group and token information. + +*pveum user modify* `` `[OPTIONS]` Update user configuration. @@ -240,9 +304,9 @@ no description available no description available -`--enable` `` :: +`--enable` `` ('default =' `1`):: -Enable/disable the account. +Enable the account (default). You can set this to '0' to disable the account `--expire` ` (0 - N)` :: @@ -264,4 +328,113 @@ Keys for two factor auth (yubico). no description available +*pveum user permissions* `[]` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Retrieve effective permissions of given user/token. + +``: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` :: + +User ID or full API token ID + +`--path` `` :: + +Only dump this specific path, not the whole tree. + +*pveum user token add* ` ` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Generate a new API token for a specific user. NOTE: returns API token +value, which needs to be stored as it cannot be retrieved afterwards! + +``: `` :: + +User ID + +``: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: + +User-specific token identifier. + +`--comment` `` :: + +no description available + +`--expire` ` (0 - N)` ('default =' `same as user`):: + +API token expiration date (seconds since epoch). '0' means no expiration date. + +`--privsep` `` ('default =' `1`):: + +Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. + +*pveum user token list* `` `[FORMAT_OPTIONS]` + +Get user API tokens. + +``: `` :: + +User ID + +*pveum user token modify* ` ` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Update API token for a specific user. + +``: `` :: + +User ID + +``: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: + +User-specific token identifier. + +`--comment` `` :: + +no description available + +`--expire` ` (0 - N)` ('default =' `same as user`):: + +API token expiration date (seconds since epoch). '0' means no expiration date. + +`--privsep` `` ('default =' `1`):: + +Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. + +*pveum user token permissions* ` ` `[OPTIONS]` `[FORMAT_OPTIONS]` + +Retrieve effective permissions of given token. + +``: `` :: + +User ID + +``: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: + +User-specific token identifier. + +`--path` `` :: + +Only dump this specific path, not the whole tree. + +*pveum user token remove* ` ` `[FORMAT_OPTIONS]` + +Remove API token for a specific user. + +``: `` :: + +User ID + +``: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: + +User-specific token identifier. + +*pveum useradd* + +An alias for 'pveum user add'. + +*pveum userdel* + +An alias for 'pveum user delete'. + +*pveum usermod* + +An alias for 'pveum user modify'. +