X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pveum.1-synopsis.adoc;h=5278b395d8e2483b1dbad306f64de867f0db11bf;hb=69ab602f6a2fe5b328c89393fbad8ea7b34b97b7;hp=9fc272394dd46a1f8f7a3677e7351dc8ed8a713d;hpb=9b3e4991113526213b75551d302c8d73deb0b6ed;p=pve-docs.git diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index 9fc2723..5278b39 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -1,304 +1,440 @@ *pveum* ` [ARGS] [OPTIONS]` -*pveum acldel* ` -roles ` `[OPTIONS]` +*pveum acl delete* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). -`` `string` :: +``: `` :: Access control path -`-groups` `string` :: +`--groups` `` :: List of groups. -`-propagate` `boolean` (default=`1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `string` :: +`--roles` `` :: List of roles. -`-users` `string` :: +`--tokens` `` :: + +List of API tokens. + +`--users` `` :: List of users. +*pveum acl list* `[FORMAT_OPTIONS]` +Get Access Control List (ACLs). -*pveum aclmod* ` -roles ` `[OPTIONS]` +*pveum acl modify* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). -`` `string` :: +``: `` :: Access control path -`-groups` `string` :: +`--groups` `` :: List of groups. -`-propagate` `boolean` (default=`1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `string` :: +`--roles` `` :: List of roles. -`-users` `string` :: +`--tokens` `` :: + +List of API tokens. + +`--users` `` :: List of users. +*pveum acldel* + +An alias for 'pveum acl delete'. +*pveum aclmod* +An alias for 'pveum acl modify'. -*pveum groupadd* `` `[OPTIONS]` +*pveum group add* `` `[OPTIONS]` Create new group. -`` `string` :: +``: `` :: no description available -`-comment` `string` :: +`--comment` `` :: no description available - - -*pveum groupdel* `` +*pveum group delete* `` Delete group. -`` `string` :: +``: `` :: no description available +*pveum group list* `[FORMAT_OPTIONS]` +Group index. -*pveum groupmod* `` `[OPTIONS]` +*pveum group modify* `` `[OPTIONS]` Update group data. -`` `string` :: +``: `` :: no description available -`-comment` `string` :: +`--comment` `` :: no description available +*pveum groupadd* +An alias for 'pveum group add'. +*pveum groupdel* -*pveum help* `[]` `[OPTIONS]` +An alias for 'pveum group delete'. -Get help about specified command. +*pveum groupmod* -`` `string` :: +An alias for 'pveum group modify'. -Command name +*pveum help* `[OPTIONS]` -`-verbose` `boolean` :: +Get help about specified command. -Verbose output format. +`--extra-args` `` :: +Shows help for a specific command +`--verbose` `` :: +Verbose output format. *pveum passwd* `` Change user password. -`` `string` :: +``: `` :: User ID - - - -*pveum roleadd* `` `[OPTIONS]` +*pveum role add* `` `[OPTIONS]` Create new role. -`` `string` :: +``: `` :: no description available -`-privs` `string` :: +`--privs` `` :: no description available - - -*pveum roledel* `` +*pveum role delete* `` Delete role. -`` `string` :: +``: `` :: no description available +*pveum role list* `[FORMAT_OPTIONS]` +Role index. -*pveum rolemod* ` -privs ` `[OPTIONS]` +*pveum role modify* `` `[OPTIONS]` -Create new role. +Update an existing role. -`` `string` :: +``: `` :: no description available -`-append` `boolean` :: +`--append` `` :: no description available + NOTE: Requires option(s): `privs` -`-privs` `string` :: +`--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. -`` `string` :: +``: `` :: User name -`-otp` `string` :: +`--otp` `` :: One-time password for Two-factor authentication. -`-path` `string` :: +`--path` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `privs` -`-privs` `string` :: +`--privs` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `path` -`-realm` `string` :: - -You can optionally pass the realm using this parameter. Normally the realm -is simply added to the username @. - +`--realm` `` :: +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. -`` `string` :: +``: `` :: User ID -`-comment` `string` :: +`--comment` `` :: no description available -`-email` `string` :: +`--email` `` :: no description available -`-enable` `boolean` (default=`1`):: +`--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` `integer (0 - N)` :: +`--expire` ` (0 - N)` :: -Account expiration date (seconds since epoch). '0' means no expiration -date. +Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `string` :: +`--firstname` `` :: no description available -`-groups` `string` :: +`--groups` `` :: no description available -`-keys` `string` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `string` :: +`--lastname` `` :: no description available -`-password` :: +`--password` `` :: Initial password. - - -*pveum userdel* `` +*pveum user delete* `` Delete user. -`` `string` :: +``: `` :: User ID +*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]` + +User index. + +`--enabled` `` :: + +Optional filter for enable property. +`--full` `` ('default =' `0`):: -*pveum usermod* `` `[OPTIONS]` +Include group and token information. + +*pveum user modify* `` `[OPTIONS]` Update user configuration. -`` `string` :: +``: `` :: User ID -`-append` `boolean` :: +`--append` `` :: no description available + NOTE: Requires option(s): `groups` -`-comment` `string` :: +`--comment` `` :: no description available -`-email` `string` :: +`--email` `` :: no description available -`-enable` `boolean` :: +`--enable` `` ('default =' `1`):: -Enable/disable the account. +Enable the account (default). You can set this to '0' to disable the account -`-expire` `integer (0 - N)` :: +`--expire` ` (0 - N)` :: -Account expiration date (seconds since epoch). '0' means no expiration -date. +Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `string` :: +`--firstname` `` :: no description available -`-groups` `string` :: +`--groups` `` :: no description available -`-keys` `string` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `string` :: +`--lastname` `` :: + +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'.