]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *pveum* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
e2d681b3 | 3 | *pveum acl delete* `<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 | ||
e9cd3bd4 TL |
23 | `--tokens` `<string>` :: |
24 | ||
25 | List of API tokens. | |
26 | ||
2489d6df | 27 | `--users` `<string>` :: |
1f554f76 DM |
28 | |
29 | List of users. | |
30 | ||
5c1699e5 TL |
31 | *pveum acl list* `[FORMAT_OPTIONS]` |
32 | ||
33 | Get Access Control List (ACLs). | |
34 | ||
e2d681b3 | 35 | *pveum acl modify* `<path> --roles <string>` `[OPTIONS]` |
1f554f76 DM |
36 | |
37 | Update Access Control List (add or remove permissions). | |
38 | ||
013dc89f | 39 | `<path>`: `<string>` :: |
1f554f76 DM |
40 | |
41 | Access control path | |
42 | ||
2489d6df | 43 | `--groups` `<string>` :: |
1f554f76 DM |
44 | |
45 | List of groups. | |
46 | ||
2489d6df | 47 | `--propagate` `<boolean>` ('default =' `1`):: |
1f554f76 DM |
48 | |
49 | Allow to propagate (inherit) permissions. | |
50 | ||
2489d6df | 51 | `--roles` `<string>` :: |
1f554f76 DM |
52 | |
53 | List of roles. | |
54 | ||
e9cd3bd4 TL |
55 | `--tokens` `<string>` :: |
56 | ||
57 | List of API tokens. | |
58 | ||
2489d6df | 59 | `--users` `<string>` :: |
1f554f76 DM |
60 | |
61 | List of users. | |
62 | ||
e2d681b3 TL |
63 | *pveum acldel* |
64 | ||
65 | An alias for 'pveum acl delete'. | |
66 | ||
67 | *pveum aclmod* | |
68 | ||
69 | An alias for 'pveum acl modify'. | |
70 | ||
71 | *pveum group add* `<groupid>` `[OPTIONS]` | |
1f554f76 DM |
72 | |
73 | Create new group. | |
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 | ||
e2d681b3 | 83 | *pveum group delete* `<groupid>` |
1f554f76 DM |
84 | |
85 | Delete group. | |
86 | ||
013dc89f | 87 | `<groupid>`: `<string>` :: |
1f554f76 DM |
88 | |
89 | no description available | |
90 | ||
5c1699e5 TL |
91 | *pveum group list* `[FORMAT_OPTIONS]` |
92 | ||
93 | Group index. | |
94 | ||
e2d681b3 | 95 | *pveum group modify* `<groupid>` `[OPTIONS]` |
1f554f76 DM |
96 | |
97 | Update group data. | |
98 | ||
013dc89f | 99 | `<groupid>`: `<string>` :: |
1f554f76 DM |
100 | |
101 | no description available | |
102 | ||
2489d6df | 103 | `--comment` `<string>` :: |
1f554f76 DM |
104 | |
105 | no description available | |
106 | ||
e2d681b3 TL |
107 | *pveum groupadd* |
108 | ||
109 | An alias for 'pveum group add'. | |
110 | ||
111 | *pveum groupdel* | |
112 | ||
113 | An alias for 'pveum group delete'. | |
114 | ||
115 | *pveum groupmod* | |
116 | ||
117 | An alias for 'pveum group modify'. | |
118 | ||
35a75dd3 | 119 | *pveum help* `[OPTIONS]` |
1f554f76 DM |
120 | |
121 | Get help about specified command. | |
122 | ||
35a75dd3 | 123 | `--extra-args` `<array>` :: |
1f554f76 | 124 | |
35a75dd3 | 125 | Shows help for a specific command |
1f554f76 | 126 | |
2489d6df | 127 | `--verbose` `<boolean>` :: |
1f554f76 DM |
128 | |
129 | Verbose output format. | |
130 | ||
1f554f76 DM |
131 | *pveum passwd* `<userid>` |
132 | ||
133 | Change user password. | |
134 | ||
013dc89f | 135 | `<userid>`: `<string>` :: |
1f554f76 DM |
136 | |
137 | User ID | |
138 | ||
e2d681b3 | 139 | *pveum role add* `<roleid>` `[OPTIONS]` |
1f554f76 DM |
140 | |
141 | Create new role. | |
142 | ||
013dc89f | 143 | `<roleid>`: `<string>` :: |
1f554f76 DM |
144 | |
145 | no description available | |
146 | ||
2489d6df | 147 | `--privs` `<string>` :: |
1f554f76 DM |
148 | |
149 | no description available | |
150 | ||
e2d681b3 | 151 | *pveum role delete* `<roleid>` |
1f554f76 DM |
152 | |
153 | Delete role. | |
154 | ||
013dc89f | 155 | `<roleid>`: `<string>` :: |
1f554f76 DM |
156 | |
157 | no description available | |
158 | ||
5c1699e5 TL |
159 | *pveum role list* `[FORMAT_OPTIONS]` |
160 | ||
161 | Role index. | |
162 | ||
e2d681b3 | 163 | *pveum role modify* `<roleid>` `[OPTIONS]` |
1f554f76 | 164 | |
e2d681b3 | 165 | Update an existing role. |
1f554f76 | 166 | |
013dc89f | 167 | `<roleid>`: `<string>` :: |
1f554f76 DM |
168 | |
169 | no description available | |
170 | ||
2489d6df | 171 | `--append` `<boolean>` :: |
1f554f76 DM |
172 | |
173 | no description available | |
174 | + | |
175 | NOTE: Requires option(s): `privs` | |
176 | ||
2489d6df | 177 | `--privs` `<string>` :: |
1f554f76 DM |
178 | |
179 | no description available | |
180 | ||
e2d681b3 TL |
181 | *pveum roleadd* |
182 | ||
183 | An alias for 'pveum role add'. | |
184 | ||
185 | *pveum roledel* | |
186 | ||
187 | An alias for 'pveum role delete'. | |
188 | ||
189 | *pveum rolemod* | |
190 | ||
191 | An alias for 'pveum role modify'. | |
192 | ||
1f554f76 DM |
193 | *pveum ticket* `<username>` `[OPTIONS]` |
194 | ||
195 | Create or verify authentication ticket. | |
196 | ||
013dc89f | 197 | `<username>`: `<string>` :: |
1f554f76 DM |
198 | |
199 | User name | |
200 | ||
2489d6df | 201 | `--otp` `<string>` :: |
1f554f76 DM |
202 | |
203 | One-time password for Two-factor authentication. | |
204 | ||
2489d6df | 205 | `--path` `<string>` :: |
1f554f76 DM |
206 | |
207 | Verify ticket, and check if user have access 'privs' on 'path' | |
208 | + | |
209 | NOTE: Requires option(s): `privs` | |
210 | ||
2489d6df | 211 | `--privs` `<string>` :: |
1f554f76 DM |
212 | |
213 | Verify ticket, and check if user have access 'privs' on 'path' | |
214 | + | |
215 | NOTE: Requires option(s): `path` | |
216 | ||
2489d6df | 217 | `--realm` `<string>` :: |
1f554f76 | 218 | |
c2993fe5 | 219 | You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>. |
1f554f76 | 220 | |
e2d681b3 | 221 | *pveum user add* `<userid>` `[OPTIONS]` |
1f554f76 DM |
222 | |
223 | Create new user. | |
224 | ||
013dc89f | 225 | `<userid>`: `<string>` :: |
1f554f76 DM |
226 | |
227 | User ID | |
228 | ||
2489d6df | 229 | `--comment` `<string>` :: |
1f554f76 DM |
230 | |
231 | no description available | |
232 | ||
2489d6df | 233 | `--email` `<string>` :: |
1f554f76 DM |
234 | |
235 | no description available | |
236 | ||
2489d6df | 237 | `--enable` `<boolean>` ('default =' `1`):: |
1f554f76 | 238 | |
e2d681b3 | 239 | Enable the account (default). You can set this to '0' to disable the account |
1f554f76 | 240 | |
2489d6df | 241 | `--expire` `<integer> (0 - N)` :: |
1f554f76 | 242 | |
c2993fe5 | 243 | Account expiration date (seconds since epoch). '0' means no expiration date. |
1f554f76 | 244 | |
2489d6df | 245 | `--firstname` `<string>` :: |
1f554f76 DM |
246 | |
247 | no description available | |
248 | ||
2489d6df | 249 | `--groups` `<string>` :: |
1f554f76 DM |
250 | |
251 | no description available | |
252 | ||
2489d6df | 253 | `--keys` `<string>` :: |
1f554f76 DM |
254 | |
255 | Keys for two factor auth (yubico). | |
256 | ||
2489d6df | 257 | `--lastname` `<string>` :: |
1f554f76 DM |
258 | |
259 | no description available | |
260 | ||
e2d681b3 | 261 | `--password` `<string>` :: |
1f554f76 DM |
262 | |
263 | Initial password. | |
264 | ||
e2d681b3 | 265 | *pveum user delete* `<userid>` |
1f554f76 DM |
266 | |
267 | Delete user. | |
268 | ||
013dc89f | 269 | `<userid>`: `<string>` :: |
1f554f76 DM |
270 | |
271 | User ID | |
272 | ||
5c1699e5 TL |
273 | *pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]` |
274 | ||
275 | User index. | |
276 | ||
277 | `--enabled` `<boolean>` :: | |
278 | ||
279 | Optional filter for enable property. | |
280 | ||
e9cd3bd4 TL |
281 | `--full` `<boolean>` ('default =' `0`):: |
282 | ||
283 | Include group and token information. | |
284 | ||
e2d681b3 | 285 | *pveum user modify* `<userid>` `[OPTIONS]` |
1f554f76 DM |
286 | |
287 | Update user configuration. | |
288 | ||
013dc89f | 289 | `<userid>`: `<string>` :: |
1f554f76 DM |
290 | |
291 | User ID | |
292 | ||
2489d6df | 293 | `--append` `<boolean>` :: |
1f554f76 DM |
294 | |
295 | no description available | |
296 | + | |
297 | NOTE: Requires option(s): `groups` | |
298 | ||
2489d6df | 299 | `--comment` `<string>` :: |
1f554f76 DM |
300 | |
301 | no description available | |
302 | ||
2489d6df | 303 | `--email` `<string>` :: |
1f554f76 DM |
304 | |
305 | no description available | |
306 | ||
e2d681b3 | 307 | `--enable` `<boolean>` ('default =' `1`):: |
1f554f76 | 308 | |
e2d681b3 | 309 | Enable the account (default). You can set this to '0' to disable the account |
1f554f76 | 310 | |
2489d6df | 311 | `--expire` `<integer> (0 - N)` :: |
1f554f76 | 312 | |
c2993fe5 | 313 | Account expiration date (seconds since epoch). '0' means no expiration date. |
1f554f76 | 314 | |
2489d6df | 315 | `--firstname` `<string>` :: |
1f554f76 DM |
316 | |
317 | no description available | |
318 | ||
2489d6df | 319 | `--groups` `<string>` :: |
1f554f76 DM |
320 | |
321 | no description available | |
322 | ||
2489d6df | 323 | `--keys` `<string>` :: |
1f554f76 DM |
324 | |
325 | Keys for two factor auth (yubico). | |
326 | ||
2489d6df | 327 | `--lastname` `<string>` :: |
1f554f76 DM |
328 | |
329 | no description available | |
330 | ||
e9cd3bd4 TL |
331 | *pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]` |
332 | ||
333 | Retrieve effective permissions of given user/token. | |
334 | ||
335 | `<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` :: | |
336 | ||
337 | User ID or full API token ID | |
338 | ||
339 | `--path` `<string>` :: | |
340 | ||
341 | Only dump this specific path, not the whole tree. | |
342 | ||
343 | *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]` | |
344 | ||
345 | Generate a new API token for a specific user. NOTE: returns API token | |
346 | value, which needs to be stored as it cannot be retrieved afterwards! | |
347 | ||
348 | `<userid>`: `<string>` :: | |
349 | ||
350 | User ID | |
351 | ||
352 | `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: | |
353 | ||
354 | User-specific token identifier. | |
355 | ||
356 | `--comment` `<string>` :: | |
357 | ||
358 | no description available | |
359 | ||
360 | `--expire` `<integer> (0 - N)` ('default =' `same as user`):: | |
361 | ||
362 | API token expiration date (seconds since epoch). '0' means no expiration date. | |
363 | ||
364 | `--privsep` `<boolean>` ('default =' `1`):: | |
365 | ||
366 | Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. | |
367 | ||
368 | *pveum user token list* `<userid>` `[FORMAT_OPTIONS]` | |
369 | ||
370 | Get user API tokens. | |
371 | ||
372 | `<userid>`: `<string>` :: | |
373 | ||
374 | User ID | |
375 | ||
376 | *pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]` | |
377 | ||
378 | Update API token for a specific user. | |
379 | ||
380 | `<userid>`: `<string>` :: | |
381 | ||
382 | User ID | |
383 | ||
384 | `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: | |
385 | ||
386 | User-specific token identifier. | |
387 | ||
388 | `--comment` `<string>` :: | |
389 | ||
390 | no description available | |
391 | ||
392 | `--expire` `<integer> (0 - N)` ('default =' `same as user`):: | |
393 | ||
394 | API token expiration date (seconds since epoch). '0' means no expiration date. | |
395 | ||
396 | `--privsep` `<boolean>` ('default =' `1`):: | |
397 | ||
398 | Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. | |
399 | ||
400 | *pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]` | |
401 | ||
402 | Retrieve effective permissions of given token. | |
403 | ||
404 | `<userid>`: `<string>` :: | |
405 | ||
406 | User ID | |
407 | ||
408 | `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: | |
409 | ||
410 | User-specific token identifier. | |
411 | ||
412 | `--path` `<string>` :: | |
413 | ||
414 | Only dump this specific path, not the whole tree. | |
415 | ||
416 | *pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]` | |
417 | ||
418 | Remove API token for a specific user. | |
419 | ||
420 | `<userid>`: `<string>` :: | |
421 | ||
422 | User ID | |
423 | ||
424 | `<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` :: | |
425 | ||
426 | User-specific token identifier. | |
427 | ||
e2d681b3 TL |
428 | *pveum useradd* |
429 | ||
430 | An alias for 'pveum user add'. | |
431 | ||
432 | *pveum userdel* | |
433 | ||
434 | An alias for 'pveum user delete'. | |
435 | ||
436 | *pveum usermod* | |
437 | ||
438 | An alias for 'pveum user modify'. | |
439 | ||
1f554f76 | 440 |