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