HA: refine docs for migrate shutdown policy

[pve-docs.git] / pveum.1-synopsis.adoc

diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc
index 6755db35f69f0e89460215577fc15d8c973b060a..c9845dea8797d271be09cb33a354cf9a5373b088 100644 (file)
--- a/pveum.1-synopsis.adoc
+++ b/pveum.1-synopsis.adoc
@@ -1,6 +1,6 @@
 *pveum* `<COMMAND> [ARGS] [OPTIONS]`
 
-*pveum acldel* `<path> --roles <string>` `[OPTIONS]`
+*pveum acl delete* `<path> --roles <string>` `[OPTIONS]`
 
 Update Access Control List (add or remove permissions).
 
@@ -24,9 +24,11 @@ List of roles.
 
 List of users.
 
+*pveum acl list* `[FORMAT_OPTIONS]`
 
+Get Access Control List (ACLs).
 
-*pveum aclmod* `<path> --roles <string>` `[OPTIONS]`
+*pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
 
 Update Access Control List (add or remove permissions).
 
@@ -50,10 +52,15 @@ List of roles.
 
 List of users.
 
+*pveum acldel*
 
+An alias for 'pveum acl delete'.
 
+*pveum aclmod*
 
-*pveum groupadd* `<groupid>` `[OPTIONS]`
+An alias for 'pveum acl modify'.
+
+*pveum group add* `<groupid>` `[OPTIONS]`
 
 Create new group.
 
@@ -65,9 +72,7 @@ no description available
 
 no description available
 
-
-
-*pveum groupdel* `<groupid>`
+*pveum group delete* `<groupid>`
 
 Delete group.
 
@@ -75,9 +80,11 @@ Delete group.
 
 no description available
 
+*pveum group list* `[FORMAT_OPTIONS]`
 
+Group index.
 
-*pveum groupmod* `<groupid>` `[OPTIONS]`
+*pveum group modify* `<groupid>` `[OPTIONS]`
 
 Update group data.
 
@@ -89,23 +96,29 @@ no description available
 
 no description available
 
+*pveum groupadd*
 
+An alias for 'pveum group add'.
 
+*pveum groupdel*
 
-*pveum help* `[<cmd>]` `[OPTIONS]`
+An alias for 'pveum group delete'.
 
-Get help about specified command.
+*pveum groupmod*
 
-`<cmd>`: `<string>` ::
+An alias for 'pveum group modify'.
 
-Command name
+*pveum help* `[OPTIONS]`
 
-`--verbose` `<boolean>` ::
+Get help about specified command.
 
-Verbose output format.
+`--extra-args` `<array>` ::
 
+Shows help for a specific command
 
+`--verbose` `<boolean>` ::
 
+Verbose output format.
 
 *pveum passwd* `<userid>`
 
@@ -115,10 +128,7 @@ Change user password.
 
 User ID
 
-
-
-
-*pveum roleadd* `<roleid>` `[OPTIONS]`
+*pveum role add* `<roleid>` `[OPTIONS]`
 
 Create new role.
 
@@ -130,9 +140,7 @@ no description available
 
 no description available
 
-
-
-*pveum roledel* `<roleid>`
+*pveum role delete* `<roleid>`
 
 Delete role.
 
@@ -140,11 +148,13 @@ Delete role.
 
 no description available
 
+*pveum role list* `[FORMAT_OPTIONS]`
 
+Role index.
 
-*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`
+*pveum role modify* `<roleid>` `[OPTIONS]`
 
-Create new role.
+Update an existing role.
 
 `<roleid>`: `<string>` ::
 
@@ -160,8 +170,17 @@ 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* `<username>` `[OPTIONS]`
 
@@ -191,10 +210,7 @@ NOTE: Requires option(s): `path`
 
 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
 
-
-
-
-*pveum useradd* `<userid>` `[OPTIONS]`
+*pveum user add* `<userid>` `[OPTIONS]`
 
 Create new user.
 
@@ -212,7 +228,7 @@ no description available
 
 `--enable` `<boolean>` ('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)` ::
 
@@ -234,13 +250,11 @@ Keys for two factor auth (yubico).
 
 no description available
 
-`--password` ::
+`--password` `<string>` ::
 
 Initial password.
 
-
-
-*pveum userdel* `<userid>`
+*pveum user delete* `<userid>`
 
 Delete user.
 
@@ -248,9 +262,15 @@ Delete user.
 
 User ID
 
+*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
 
+User index.
 
-*pveum usermod* `<userid>` `[OPTIONS]`
+`--enabled` `<boolean>` ::
+
+Optional filter for enable property.
+
+*pveum user modify* `<userid>` `[OPTIONS]`
 
 Update user configuration.
 
@@ -272,9 +292,9 @@ no description available
 
 no description available
 
-`--enable` `<boolean>` ::
+`--enable` `<boolean>` ('default =' `1`)::
 
-Enable/disable the account.
+Enable the account (default). You can set this to '0' to disable the account
 
 `--expire` `<integer> (0 - N)` ::
 
@@ -296,6 +316,16 @@ Keys for two factor auth (yubico).
 
 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'.