]>
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 | ||
e2d681b3 | 27 | *pveum acl modify* `<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 | ||
e2d681b3 TL |
51 | *pveum acldel* |
52 | ||
53 | An alias for 'pveum acl delete'. | |
54 | ||
55 | *pveum aclmod* | |
56 | ||
57 | An alias for 'pveum acl modify'. | |
58 | ||
59 | *pveum group add* `<groupid>` `[OPTIONS]` | |
1f554f76 DM |
60 | |
61 | Create new group. | |
62 | ||
013dc89f | 63 | `<groupid>`: `<string>` :: |
1f554f76 DM |
64 | |
65 | no description available | |
66 | ||
2489d6df | 67 | `--comment` `<string>` :: |
1f554f76 DM |
68 | |
69 | no description available | |
70 | ||
e2d681b3 | 71 | *pveum group delete* `<groupid>` |
1f554f76 DM |
72 | |
73 | Delete group. | |
74 | ||
013dc89f | 75 | `<groupid>`: `<string>` :: |
1f554f76 DM |
76 | |
77 | no description available | |
78 | ||
e2d681b3 | 79 | *pveum group modify* `<groupid>` `[OPTIONS]` |
1f554f76 DM |
80 | |
81 | Update group data. | |
82 | ||
013dc89f | 83 | `<groupid>`: `<string>` :: |
1f554f76 DM |
84 | |
85 | no description available | |
86 | ||
2489d6df | 87 | `--comment` `<string>` :: |
1f554f76 DM |
88 | |
89 | no description available | |
90 | ||
e2d681b3 TL |
91 | *pveum groupadd* |
92 | ||
93 | An alias for 'pveum group add'. | |
94 | ||
95 | *pveum groupdel* | |
96 | ||
97 | An alias for 'pveum group delete'. | |
98 | ||
99 | *pveum groupmod* | |
100 | ||
101 | An alias for 'pveum group modify'. | |
102 | ||
35a75dd3 | 103 | *pveum help* `[OPTIONS]` |
1f554f76 DM |
104 | |
105 | Get help about specified command. | |
106 | ||
35a75dd3 | 107 | `--extra-args` `<array>` :: |
1f554f76 | 108 | |
35a75dd3 | 109 | Shows help for a specific command |
1f554f76 | 110 | |
2489d6df | 111 | `--verbose` `<boolean>` :: |
1f554f76 DM |
112 | |
113 | Verbose output format. | |
114 | ||
1f554f76 DM |
115 | *pveum passwd* `<userid>` |
116 | ||
117 | Change user password. | |
118 | ||
013dc89f | 119 | `<userid>`: `<string>` :: |
1f554f76 DM |
120 | |
121 | User ID | |
122 | ||
e2d681b3 | 123 | *pveum role add* `<roleid>` `[OPTIONS]` |
1f554f76 DM |
124 | |
125 | Create new role. | |
126 | ||
013dc89f | 127 | `<roleid>`: `<string>` :: |
1f554f76 DM |
128 | |
129 | no description available | |
130 | ||
2489d6df | 131 | `--privs` `<string>` :: |
1f554f76 DM |
132 | |
133 | no description available | |
134 | ||
e2d681b3 | 135 | *pveum role delete* `<roleid>` |
1f554f76 DM |
136 | |
137 | Delete role. | |
138 | ||
013dc89f | 139 | `<roleid>`: `<string>` :: |
1f554f76 DM |
140 | |
141 | no description available | |
142 | ||
e2d681b3 | 143 | *pveum role modify* `<roleid>` `[OPTIONS]` |
1f554f76 | 144 | |
e2d681b3 | 145 | Update an existing role. |
1f554f76 | 146 | |
013dc89f | 147 | `<roleid>`: `<string>` :: |
1f554f76 DM |
148 | |
149 | no description available | |
150 | ||
2489d6df | 151 | `--append` `<boolean>` :: |
1f554f76 DM |
152 | |
153 | no description available | |
154 | + | |
155 | NOTE: Requires option(s): `privs` | |
156 | ||
2489d6df | 157 | `--privs` `<string>` :: |
1f554f76 DM |
158 | |
159 | no description available | |
160 | ||
e2d681b3 TL |
161 | *pveum roleadd* |
162 | ||
163 | An alias for 'pveum role add'. | |
164 | ||
165 | *pveum roledel* | |
166 | ||
167 | An alias for 'pveum role delete'. | |
168 | ||
169 | *pveum rolemod* | |
170 | ||
171 | An alias for 'pveum role modify'. | |
172 | ||
1f554f76 DM |
173 | *pveum ticket* `<username>` `[OPTIONS]` |
174 | ||
175 | Create or verify authentication ticket. | |
176 | ||
013dc89f | 177 | `<username>`: `<string>` :: |
1f554f76 DM |
178 | |
179 | User name | |
180 | ||
2489d6df | 181 | `--otp` `<string>` :: |
1f554f76 DM |
182 | |
183 | One-time password for Two-factor authentication. | |
184 | ||
2489d6df | 185 | `--path` `<string>` :: |
1f554f76 DM |
186 | |
187 | Verify ticket, and check if user have access 'privs' on 'path' | |
188 | + | |
189 | NOTE: Requires option(s): `privs` | |
190 | ||
2489d6df | 191 | `--privs` `<string>` :: |
1f554f76 DM |
192 | |
193 | Verify ticket, and check if user have access 'privs' on 'path' | |
194 | + | |
195 | NOTE: Requires option(s): `path` | |
196 | ||
2489d6df | 197 | `--realm` `<string>` :: |
1f554f76 | 198 | |
c2993fe5 | 199 | You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>. |
1f554f76 | 200 | |
e2d681b3 | 201 | *pveum user add* `<userid>` `[OPTIONS]` |
1f554f76 DM |
202 | |
203 | Create new user. | |
204 | ||
013dc89f | 205 | `<userid>`: `<string>` :: |
1f554f76 DM |
206 | |
207 | User ID | |
208 | ||
2489d6df | 209 | `--comment` `<string>` :: |
1f554f76 DM |
210 | |
211 | no description available | |
212 | ||
2489d6df | 213 | `--email` `<string>` :: |
1f554f76 DM |
214 | |
215 | no description available | |
216 | ||
2489d6df | 217 | `--enable` `<boolean>` ('default =' `1`):: |
1f554f76 | 218 | |
e2d681b3 | 219 | Enable the account (default). You can set this to '0' to disable the account |
1f554f76 | 220 | |
2489d6df | 221 | `--expire` `<integer> (0 - N)` :: |
1f554f76 | 222 | |
c2993fe5 | 223 | Account expiration date (seconds since epoch). '0' means no expiration date. |
1f554f76 | 224 | |
2489d6df | 225 | `--firstname` `<string>` :: |
1f554f76 DM |
226 | |
227 | no description available | |
228 | ||
2489d6df | 229 | `--groups` `<string>` :: |
1f554f76 DM |
230 | |
231 | no description available | |
232 | ||
2489d6df | 233 | `--keys` `<string>` :: |
1f554f76 DM |
234 | |
235 | Keys for two factor auth (yubico). | |
236 | ||
2489d6df | 237 | `--lastname` `<string>` :: |
1f554f76 DM |
238 | |
239 | no description available | |
240 | ||
e2d681b3 | 241 | `--password` `<string>` :: |
1f554f76 DM |
242 | |
243 | Initial password. | |
244 | ||
e2d681b3 | 245 | *pveum user delete* `<userid>` |
1f554f76 DM |
246 | |
247 | Delete user. | |
248 | ||
013dc89f | 249 | `<userid>`: `<string>` :: |
1f554f76 DM |
250 | |
251 | User ID | |
252 | ||
e2d681b3 | 253 | *pveum user modify* `<userid>` `[OPTIONS]` |
1f554f76 DM |
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 | ||
e2d681b3 | 275 | `--enable` `<boolean>` ('default =' `1`):: |
1f554f76 | 276 | |
e2d681b3 | 277 | Enable the account (default). You can set this to '0' to disable the account |
1f554f76 | 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 | ||
e2d681b3 TL |
299 | *pveum useradd* |
300 | ||
301 | An alias for 'pveum user add'. | |
302 | ||
303 | *pveum userdel* | |
304 | ||
305 | An alias for 'pveum user delete'. | |
306 | ||
307 | *pveum usermod* | |
308 | ||
309 | An alias for 'pveum user modify'. | |
310 | ||
1f554f76 | 311 |