Fixed some typos and slight language improvements
[pve-docs.git] / pveum.1-synopsis.adoc
1 *pveum* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *pveum acl delete* `<path> --roles <string>` `[OPTIONS]`
4
5 Update Access Control List (add or remove permissions).
6
7 `<path>`: `<string>` ::
8
9 Access control path
10
11 `--groups` `<string>` ::
12
13 List of groups.
14
15 `--propagate` `<boolean>` ('default =' `1`)::
16
17 Allow to propagate (inherit) permissions.
18
19 `--roles` `<string>` ::
20
21 List of roles.
22
23 `--users` `<string>` ::
24
25 List of users.
26
27 *pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
28
29 Update Access Control List (add or remove permissions).
30
31 `<path>`: `<string>` ::
32
33 Access control path
34
35 `--groups` `<string>` ::
36
37 List of groups.
38
39 `--propagate` `<boolean>` ('default =' `1`)::
40
41 Allow to propagate (inherit) permissions.
42
43 `--roles` `<string>` ::
44
45 List of roles.
46
47 `--users` `<string>` ::
48
49 List of users.
50
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]`
60
61 Create new group.
62
63 `<groupid>`: `<string>` ::
64
65 no description available
66
67 `--comment` `<string>` ::
68
69 no description available
70
71 *pveum group delete* `<groupid>`
72
73 Delete group.
74
75 `<groupid>`: `<string>` ::
76
77 no description available
78
79 *pveum group modify* `<groupid>` `[OPTIONS]`
80
81 Update group data.
82
83 `<groupid>`: `<string>` ::
84
85 no description available
86
87 `--comment` `<string>` ::
88
89 no description available
90
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
103 *pveum help* `[OPTIONS]`
104
105 Get help about specified command.
106
107 `--extra-args` `<array>` ::
108
109 Shows help for a specific command
110
111 `--verbose` `<boolean>` ::
112
113 Verbose output format.
114
115 *pveum passwd* `<userid>`
116
117 Change user password.
118
119 `<userid>`: `<string>` ::
120
121 User ID
122
123 *pveum role add* `<roleid>` `[OPTIONS]`
124
125 Create new role.
126
127 `<roleid>`: `<string>` ::
128
129 no description available
130
131 `--privs` `<string>` ::
132
133 no description available
134
135 *pveum role delete* `<roleid>`
136
137 Delete role.
138
139 `<roleid>`: `<string>` ::
140
141 no description available
142
143 *pveum role modify* `<roleid>` `[OPTIONS]`
144
145 Update an existing role.
146
147 `<roleid>`: `<string>` ::
148
149 no description available
150
151 `--append` `<boolean>` ::
152
153 no description available
154 +
155 NOTE: Requires option(s): `privs`
156
157 `--privs` `<string>` ::
158
159 no description available
160
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
173 *pveum ticket* `<username>` `[OPTIONS]`
174
175 Create or verify authentication ticket.
176
177 `<username>`: `<string>` ::
178
179 User name
180
181 `--otp` `<string>` ::
182
183 One-time password for Two-factor authentication.
184
185 `--path` `<string>` ::
186
187 Verify ticket, and check if user have access 'privs' on 'path'
188 +
189 NOTE: Requires option(s): `privs`
190
191 `--privs` `<string>` ::
192
193 Verify ticket, and check if user have access 'privs' on 'path'
194 +
195 NOTE: Requires option(s): `path`
196
197 `--realm` `<string>` ::
198
199 You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
200
201 *pveum user add* `<userid>` `[OPTIONS]`
202
203 Create new user.
204
205 `<userid>`: `<string>` ::
206
207 User ID
208
209 `--comment` `<string>` ::
210
211 no description available
212
213 `--email` `<string>` ::
214
215 no description available
216
217 `--enable` `<boolean>` ('default =' `1`)::
218
219 Enable the account (default). You can set this to '0' to disable the account
220
221 `--expire` `<integer> (0 - N)` ::
222
223 Account expiration date (seconds since epoch). '0' means no expiration date.
224
225 `--firstname` `<string>` ::
226
227 no description available
228
229 `--groups` `<string>` ::
230
231 no description available
232
233 `--keys` `<string>` ::
234
235 Keys for two factor auth (yubico).
236
237 `--lastname` `<string>` ::
238
239 no description available
240
241 `--password` `<string>` ::
242
243 Initial password.
244
245 *pveum user delete* `<userid>`
246
247 Delete user.
248
249 `<userid>`: `<string>` ::
250
251 User ID
252
253 *pveum user modify* `<userid>` `[OPTIONS]`
254
255 Update user configuration.
256
257 `<userid>`: `<string>` ::
258
259 User ID
260
261 `--append` `<boolean>` ::
262
263 no description available
264 +
265 NOTE: Requires option(s): `groups`
266
267 `--comment` `<string>` ::
268
269 no description available
270
271 `--email` `<string>` ::
272
273 no description available
274
275 `--enable` `<boolean>` ('default =' `1`)::
276
277 Enable the account (default). You can set this to '0' to disable the account
278
279 `--expire` `<integer> (0 - N)` ::
280
281 Account expiration date (seconds since epoch). '0' means no expiration date.
282
283 `--firstname` `<string>` ::
284
285 no description available
286
287 `--groups` `<string>` ::
288
289 no description available
290
291 `--keys` `<string>` ::
292
293 Keys for two factor auth (yubico).
294
295 `--lastname` `<string>` ::
296
297 no description available
298
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
311