rewrite and extend pct documentation

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

*pveum* `<COMMAND> [ARGS] [OPTIONS]`

*pveum acl delete* `<path> --roles <string>` `[OPTIONS]`

Update Access Control List (add or remove permissions).

`<path>`: `<string>` ::

Access control path

`--groups` `<string>` ::

List of groups.

`--propagate` `<boolean>` ('default =' `1`)::

Allow to propagate (inherit) permissions.

`--roles` `<string>` ::

List of roles.

`--tokens` `<string>` ::

List of API tokens.

`--users` `<string>` ::

List of users.

*pveum acl list* `[FORMAT_OPTIONS]`

Get Access Control List (ACLs).

*pveum acl modify* `<path> --roles <string>` `[OPTIONS]`

Update Access Control List (add or remove permissions).

`<path>`: `<string>` ::

Access control path

`--groups` `<string>` ::

List of groups.

`--propagate` `<boolean>` ('default =' `1`)::

Allow to propagate (inherit) permissions.

`--roles` `<string>` ::

List of roles.

`--tokens` `<string>` ::

List of API tokens.

`--users` `<string>` ::

List of users.

*pveum acldel*

An alias for 'pveum acl delete'.

*pveum aclmod*

An alias for 'pveum acl modify'.

*pveum group add* `<groupid>` `[OPTIONS]`

Create new group.

`<groupid>`: `<string>` ::

no description available

`--comment` `<string>` ::

no description available

*pveum group delete* `<groupid>`

Delete group.

`<groupid>`: `<string>` ::

no description available

*pveum group list* `[FORMAT_OPTIONS]`

Group index.

*pveum group modify* `<groupid>` `[OPTIONS]`

Update group data.

`<groupid>`: `<string>` ::

no description available

`--comment` `<string>` ::

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.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pveum passwd* `<userid>`

Change user password.

`<userid>`: `<string>` ::

User ID

*pveum role add* `<roleid>` `[OPTIONS]`

Create new role.

`<roleid>`: `<string>` ::

no description available

`--privs` `<string>` ::

no description available

*pveum role delete* `<roleid>`

Delete role.

`<roleid>`: `<string>` ::

no description available

*pveum role list* `[FORMAT_OPTIONS]`

Role index.

*pveum role modify* `<roleid>` `[OPTIONS]`

Update an existing role.

`<roleid>`: `<string>` ::

no description available

`--append` `<boolean>` ::

no description available
+
NOTE: Requires option(s): `privs`

`--privs` `<string>` ::

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]`

Create or verify authentication ticket.

`<username>`: `<string>` ::

User name

`--otp` `<string>` ::

One-time password for Two-factor authentication.

`--path` `<string>` ::

Verify ticket, and check if user have access 'privs' on 'path'
+
NOTE: Requires option(s): `privs`

`--privs` `<string>` ::

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 <username>@<relam>.

*pveum user add* `<userid>` `[OPTIONS]`

Create new user.

`<userid>`: `<string>` ::

User ID

`--comment` `<string>` ::

no description available

`--email` `<string>` ::

no description available

`--enable` `<boolean>` ('default =' `1`)::

Enable the account (default). You can set this to '0' to disable the account

`--expire` `<integer> (0 - N)` ::

Account expiration date (seconds since epoch). '0' means no expiration date.

`--firstname` `<string>` ::

no description available

`--groups` `<string>` ::

no description available

`--keys` `<string>` ::

Keys for two factor auth (yubico).

`--lastname` `<string>` ::

no description available

`--password` `<string>` ::

Initial password.

*pveum user delete* `<userid>`

Delete user.

`<userid>`: `<string>` ::

User ID

*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`

User index.

`--enabled` `<boolean>` ::

Optional filter for enable property.

`--full` `<boolean>` ('default =' `0`)::

Include group and token information.

*pveum user modify* `<userid>` `[OPTIONS]`

Update user configuration.

`<userid>`: `<string>` ::

User ID

`--append` `<boolean>` ::

no description available
+
NOTE: Requires option(s): `groups`

`--comment` `<string>` ::

no description available

`--email` `<string>` ::

no description available

`--enable` `<boolean>` ('default =' `1`)::

Enable the account (default). You can set this to '0' to disable the account

`--expire` `<integer> (0 - N)` ::

Account expiration date (seconds since epoch). '0' means no expiration date.

`--firstname` `<string>` ::

no description available

`--groups` `<string>` ::

no description available

`--keys` `<string>` ::

Keys for two factor auth (yubico).

`--lastname` `<string>` ::

no description available

*pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`

Retrieve effective permissions of given user/token.

`<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` ::

User ID or full API token ID

`--path` `<string>` ::

Only dump this specific path, not the whole tree.

*pveum user token add* `<userid> <tokenid>` `[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!

`<userid>`: `<string>` ::

User ID

`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::

User-specific token identifier.

`--comment` `<string>` ::

no description available

`--expire` `<integer> (0 - N)` ('default =' `same as user`)::

API token expiration date (seconds since epoch). '0' means no expiration date.

`--privsep` `<boolean>` ('default =' `1`)::

Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.

*pveum user token list* `<userid>` `[FORMAT_OPTIONS]`

Get user API tokens.

`<userid>`: `<string>` ::

User ID

*pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`

Update API token for a specific user.

`<userid>`: `<string>` ::

User ID

`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::

User-specific token identifier.

`--comment` `<string>` ::

no description available

`--expire` `<integer> (0 - N)` ('default =' `same as user`)::

API token expiration date (seconds since epoch). '0' means no expiration date.

`--privsep` `<boolean>` ('default =' `1`)::

Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.

*pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`

Retrieve effective permissions of given token.

`<userid>`: `<string>` ::

User ID

`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::

User-specific token identifier.

`--path` `<string>` ::

Only dump this specific path, not the whole tree.

*pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`

Remove API token for a specific user.

`<userid>`: `<string>` ::

User ID

`<tokenid>`: `(?^:[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'.