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