X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pveum.1-synopsis.adoc;h=6f0d58b09b9278c5a446ec4d3ec9180184f0349a;hp=d9fbde635513d1572453a40d6898fbfac639111b;hb=7d6078845fa6a3bd308c7dc843273e56be33f315;hpb=013dc89ffce47b8c55412c016a508205768b4fd6 diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index d9fbde6..6f0d58b 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). @@ -8,25 +8,23 @@ Update Access Control List (add or remove permissions). Access control path -`-groups` `` :: +`--groups` `` :: List of groups. -`-propagate` `` ('default =' `1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `` :: +`--roles` `` :: List of roles. -`-users` `` :: +`--users` `` :: List of users. - - -*pveum aclmod* ` -roles ` `[OPTIONS]` +*pveum acl modify* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). @@ -34,26 +32,31 @@ Update Access Control List (add or remove permissions). Access control path -`-groups` `` :: +`--groups` `` :: List of groups. -`-propagate` `` ('default =' `1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `` :: +`--roles` `` :: List of roles. -`-users` `` :: +`--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. @@ -61,13 +64,11 @@ Create new group. no description available -`-comment` `` :: +`--comment` `` :: no description available - - -*pveum groupdel* `` +*pveum group delete* `` Delete group. @@ -75,9 +76,7 @@ Delete group. no description available - - -*pveum groupmod* `` `[OPTIONS]` +*pveum group modify* `` `[OPTIONS]` Update group data. @@ -85,27 +84,33 @@ Update group data. no description available -`-comment` `` :: +`--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* -``: `` :: +An alias for 'pveum group modify'. -Command name +*pveum help* `[OPTIONS]` -`-verbose` `` :: +Get help about specified command. -Verbose output format. +`--extra-args` `` :: +Shows help for a specific command +`--verbose` `` :: +Verbose output format. *pveum passwd* `` @@ -115,10 +120,7 @@ Change user password. User ID - - - -*pveum roleadd* `` `[OPTIONS]` +*pveum role add* `` `[OPTIONS]` Create new role. @@ -126,13 +128,11 @@ Create new role. no description available -`-privs` `` :: +`--privs` `` :: no description available - - -*pveum roledel* `` +*pveum role delete* `` Delete role. @@ -140,28 +140,35 @@ Delete role. no description available +*pveum role modify* `` `[OPTIONS]` - -*pveum rolemod* ` -privs ` `[OPTIONS]` - -Create new role. +Update an existing role. ``: `` :: no description available -`-append` `` :: +`--append` `` :: no description available + NOTE: Requires option(s): `privs` -`-privs` `` :: +`--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]` @@ -171,30 +178,27 @@ Create or verify authentication ticket. User name -`-otp` `` :: +`--otp` `` :: One-time password for Two-factor authentication. -`-path` `` :: +`--path` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `privs` -`-privs` `` :: +`--privs` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `path` -`-realm` `` :: +`--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. @@ -202,45 +206,43 @@ Create new user. User ID -`-comment` `` :: +`--comment` `` :: no description available -`-email` `` :: +`--email` `` :: no description available -`-enable` `` ('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` ` (0 - N)` :: +`--expire` ` (0 - N)` :: Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `` :: +`--firstname` `` :: no description available -`-groups` `` :: +`--groups` `` :: no description available -`-keys` `` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `` :: +`--lastname` `` :: no description available -`-password` :: +`--password` `` :: Initial password. - - -*pveum userdel* `` +*pveum user delete* `` Delete user. @@ -248,9 +250,7 @@ Delete user. User ID - - -*pveum usermod* `` `[OPTIONS]` +*pveum user modify* `` `[OPTIONS]` Update user configuration. @@ -258,44 +258,54 @@ Update user configuration. User ID -`-append` `` :: +`--append` `` :: no description available + NOTE: Requires option(s): `groups` -`-comment` `` :: +`--comment` `` :: no description available -`-email` `` :: +`--email` `` :: 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)` :: +`--expire` ` (0 - N)` :: Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `` :: +`--firstname` `` :: no description available -`-groups` `` :: +`--groups` `` :: no description available -`-keys` `` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `` :: +`--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'.