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

Get help about specified command.

`<cmd>`: `<string>` ::

Command name

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

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