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

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

*pveum acldel* `<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.

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

List of users.

*pveum aclmod* `<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.

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

List of users.

*pveum groupadd* `<groupid>` `[OPTIONS]`

Create new group.

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

no description available

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

no description available

*pveum groupdel* `<groupid>`

Delete group.

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

no description available

*pveum groupmod* `<groupid>` `[OPTIONS]`

Update group data.

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

no description available

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

no description available

*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 roleadd* `<roleid>` `[OPTIONS]`

Create new role.

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

no description available

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

no description available

*pveum roledel* `<roleid>`

Delete role.

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

no description available

*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`

Create new role.

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

no description available

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

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

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

no description available

*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 useradd* `<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 accout

`--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` `<password>` ::

Initial password.

*pveum userdel* `<userid>`

Delete user.

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

User ID

*pveum usermod* `<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>` ::

Enable/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
Commit	Line	Data
1f554f76 DM	1	pveum `<COMMAND> [ARGS] [OPTIONS]`
1f554f76 DM	2
2489d6df	3	pveum acldel `<path> --roles <string>` `[OPTIONS]`
1f554f76 DM	4
	5	Update Access Control List (add or remove permissions).
	6
013dc89f	7	`<path>`: `<string>` ::
1f554f76 DM	8
	9	Access control path
	10
2489d6df	11	`--groups` `<string>` ::
1f554f76 DM	12
	13	List of groups.
	14
2489d6df	15	`--propagate` `<boolean>` ('default =' `1`)::
1f554f76 DM	16
	17	Allow to propagate (inherit) permissions.
	18
2489d6df	19	`--roles` `<string>` ::
1f554f76 DM	20
	21	List of roles.
	22
2489d6df	23	`--users` `<string>` ::
1f554f76 DM	24
	25	List of users.
	26
2489d6df	27	pveum aclmod `<path> --roles <string>` `[OPTIONS]`
1f554f76 DM	28
	29	Update Access Control List (add or remove permissions).
	30
013dc89f	31	`<path>`: `<string>` ::
1f554f76 DM	32
	33	Access control path
	34
2489d6df	35	`--groups` `<string>` ::
1f554f76 DM	36
	37	List of groups.
	38
2489d6df	39	`--propagate` `<boolean>` ('default =' `1`)::
1f554f76 DM	40
	41	Allow to propagate (inherit) permissions.
	42
2489d6df	43	`--roles` `<string>` ::
1f554f76 DM	44
	45	List of roles.
	46
2489d6df	47	`--users` `<string>` ::
1f554f76 DM	48
	49	List of users.
	50
1f554f76 DM	51	pveum groupadd `<groupid>` `[OPTIONS]`
	52
	53	Create new group.
	54
013dc89f	55	`<groupid>`: `<string>` ::
1f554f76 DM	56
	57	no description available
	58
2489d6df	59	`--comment` `<string>` ::
1f554f76 DM	60
	61	no description available
	62
1f554f76 DM	63	pveum groupdel `<groupid>`
	64
	65	Delete group.
	66
013dc89f	67	`<groupid>`: `<string>` ::
1f554f76 DM	68
	69	no description available
	70
1f554f76 DM	71	pveum groupmod `<groupid>` `[OPTIONS]`
	72
	73	Update group data.
	74
013dc89f	75	`<groupid>`: `<string>` ::
1f554f76 DM	76
	77	no description available
	78
2489d6df	79	`--comment` `<string>` ::
1f554f76 DM	80
	81	no description available
	82
35a75dd3	83	pveum help `[OPTIONS]`
1f554f76 DM	84
	85	Get help about specified command.
	86
35a75dd3	87	`--extra-args` `<array>` ::
1f554f76	88
35a75dd3	89	Shows help for a specific command
1f554f76	90
2489d6df	91	`--verbose` `<boolean>` ::
1f554f76 DM	92
	93	Verbose output format.
	94
1f554f76 DM	95	pveum passwd `<userid>`
	96
	97	Change user password.
	98
013dc89f	99	`<userid>`: `<string>` ::
1f554f76 DM	100
	101	User ID
	102
1f554f76 DM	103	pveum roleadd `<roleid>` `[OPTIONS]`
	104
	105	Create new role.
	106
013dc89f	107	`<roleid>`: `<string>` ::
1f554f76 DM	108
	109	no description available
	110
2489d6df	111	`--privs` `<string>` ::
1f554f76 DM	112
	113	no description available
	114
1f554f76 DM	115	pveum roledel `<roleid>`
	116
	117	Delete role.
	118
013dc89f	119	`<roleid>`: `<string>` ::
1f554f76 DM	120
	121	no description available
	122
2489d6df	123	pveum rolemod `<roleid> --privs <string>` `[OPTIONS]`
1f554f76 DM	124
	125	Create new role.
	126
013dc89f	127	`<roleid>`: `<string>` ::
1f554f76 DM	128
	129	no description available
	130
2489d6df	131	`--append` `<boolean>` ::
1f554f76 DM	132
	133	no description available
	134	+
	135	NOTE: Requires option(s): `privs`
	136
2489d6df	137	`--privs` `<string>` ::
1f554f76 DM	138
	139	no description available
	140
1f554f76 DM	141	pveum ticket `<username>` `[OPTIONS]`
	142
	143	Create or verify authentication ticket.
	144
013dc89f	145	`<username>`: `<string>` ::
1f554f76 DM	146
	147	User name
	148
2489d6df	149	`--otp` `<string>` ::
1f554f76 DM	150
	151	One-time password for Two-factor authentication.
	152
2489d6df	153	`--path` `<string>` ::
1f554f76 DM	154
	155	Verify ticket, and check if user have access 'privs' on 'path'
	156	+
	157	NOTE: Requires option(s): `privs`
	158
2489d6df	159	`--privs` `<string>` ::
1f554f76 DM	160
	161	Verify ticket, and check if user have access 'privs' on 'path'
	162	+
	163	NOTE: Requires option(s): `path`
	164
2489d6df	165	`--realm` `<string>` ::
1f554f76	166
c2993fe5	167	You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
1f554f76	168
1f554f76 DM	169	pveum useradd `<userid>` `[OPTIONS]`
	170
	171	Create new user.
	172
013dc89f	173	`<userid>`: `<string>` ::
1f554f76 DM	174
	175	User ID
	176
2489d6df	177	`--comment` `<string>` ::
1f554f76 DM	178
	179	no description available
	180
2489d6df	181	`--email` `<string>` ::
1f554f76 DM	182
	183	no description available
	184
2489d6df	185	`--enable` `<boolean>` ('default =' `1`)::
1f554f76 DM	186
	187	Enable the account (default). You can set this to '0' to disable the accout
	188
2489d6df	189	`--expire` `<integer> (0 - N)` ::
1f554f76	190
c2993fe5	191	Account expiration date (seconds since epoch). '0' means no expiration date.
1f554f76	192
2489d6df	193	`--firstname` `<string>` ::
1f554f76 DM	194
	195	no description available
	196
2489d6df	197	`--groups` `<string>` ::
1f554f76 DM	198
	199	no description available
	200
2489d6df	201	`--keys` `<string>` ::
1f554f76 DM	202
	203	Keys for two factor auth (yubico).
	204
2489d6df	205	`--lastname` `<string>` ::
1f554f76 DM	206
	207	no description available
	208
5da3d723	209	`--password` `<password>` ::
1f554f76 DM	210
	211	Initial password.
	212
1f554f76 DM	213	pveum userdel `<userid>`
	214
	215	Delete user.
	216
013dc89f	217	`<userid>`: `<string>` ::
1f554f76 DM	218
	219	User ID
	220
1f554f76 DM	221	pveum usermod `<userid>` `[OPTIONS]`
	222
	223	Update user configuration.
	224
013dc89f	225	`<userid>`: `<string>` ::
1f554f76 DM	226
	227	User ID
	228
2489d6df	229	`--append` `<boolean>` ::
1f554f76 DM	230
	231	no description available
	232	+
	233	NOTE: Requires option(s): `groups`
	234
2489d6df	235	`--comment` `<string>` ::
1f554f76 DM	236
	237	no description available
	238
2489d6df	239	`--email` `<string>` ::
1f554f76 DM	240
	241	no description available
	242
2489d6df	243	`--enable` `<boolean>` ::
1f554f76 DM	244
	245	Enable/disable the account.
	246
2489d6df	247	`--expire` `<integer> (0 - N)` ::
1f554f76	248
c2993fe5	249	Account expiration date (seconds since epoch). '0' means no expiration date.
1f554f76	250
2489d6df	251	`--firstname` `<string>` ::
1f554f76 DM	252
	253	no description available
	254
2489d6df	255	`--groups` `<string>` ::
1f554f76 DM	256
	257	no description available
	258
2489d6df	259	`--keys` `<string>` ::
1f554f76 DM	260
	261	Keys for two factor auth (yubico).
	262
2489d6df	263	`--lastname` `<string>` ::
1f554f76 DM	264
	265	no description available
	266
	267