X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveum.1-synopsis.adoc;h=6f0d58b09b9278c5a446ec4d3ec9180184f0349a;hp=f19195ec4c13b9860a5106150b2a0033534bdc3b;hb=856993e4166495537f42e0b9c3a51c966227feab;hpb=1f554f760e12ff7da82dd3d425d9533a71ca979f diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index f19195e..6f0d58b 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -1,304 +1,311 @@ *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` :: +`--users` `` :: List of users. - - -*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` :: +`--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 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 modify* `` `[OPTIONS]` +Update an existing role. -*pveum rolemod* ` -privs ` `[OPTIONS]` - -Create new 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 usermod* `` `[OPTIONS]` +*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 useradd* + +An alias for 'pveum user add'. + +*pveum userdel* + +An alias for 'pveum user delete'. + +*pveum usermod* +An alias for 'pveum user modify'.