]> 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
pve-network.adoc: vlan - remove fixe markup for numbered list, cleanups
[pve-docs.git] / pveum.1-synopsis.adoc
... / ...
CommitLineData
1*pveum* `<COMMAND> [ARGS] [OPTIONS]`
2
3*pveum acldel* `<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
28
29*pveum aclmod* `<path> --roles <string>` `[OPTIONS]`
30
31Update Access Control List (add or remove permissions).
32
33`<path>`: `<string>` ::
34
35Access control path
36
37`--groups` `<string>` ::
38
39List of groups.
40
41`--propagate` `<boolean>` ('default =' `1`)::
42
43Allow to propagate (inherit) permissions.
44
45`--roles` `<string>` ::
46
47List of roles.
48
49`--users` `<string>` ::
50
51List of users.
52
53
54
55
56*pveum groupadd* `<groupid>` `[OPTIONS]`
57
58Create new group.
59
60`<groupid>`: `<string>` ::
61
62no description available
63
64`--comment` `<string>` ::
65
66no description available
67
68
69
70*pveum groupdel* `<groupid>`
71
72Delete group.
73
74`<groupid>`: `<string>` ::
75
76no description available
77
78
79
80*pveum groupmod* `<groupid>` `[OPTIONS]`
81
82Update group data.
83
84`<groupid>`: `<string>` ::
85
86no description available
87
88`--comment` `<string>` ::
89
90no description available
91
92
93
94
95*pveum help* `[<cmd>]` `[OPTIONS]`
96
97Get help about specified command.
98
99`<cmd>`: `<string>` ::
100
101Command name
102
103`--verbose` `<boolean>` ::
104
105Verbose output format.
106
107
108
109
110*pveum passwd* `<userid>`
111
112Change user password.
113
114`<userid>`: `<string>` ::
115
116User ID
117
118
119
120
121*pveum roleadd* `<roleid>` `[OPTIONS]`
122
123Create new role.
124
125`<roleid>`: `<string>` ::
126
127no description available
128
129`--privs` `<string>` ::
130
131no description available
132
133
134
135*pveum roledel* `<roleid>`
136
137Delete role.
138
139`<roleid>`: `<string>` ::
140
141no description available
142
143
144
145*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`
146
147Create new role.
148
149`<roleid>`: `<string>` ::
150
151no description available
152
153`--append` `<boolean>` ::
154
155no description available
156+
157NOTE: Requires option(s): `privs`
158
159`--privs` `<string>` ::
160
161no description available
162
163
164
165
166*pveum ticket* `<username>` `[OPTIONS]`
167
168Create or verify authentication ticket.
169
170`<username>`: `<string>` ::
171
172User name
173
174`--otp` `<string>` ::
175
176One-time password for Two-factor authentication.
177
178`--path` `<string>` ::
179
180Verify ticket, and check if user have access 'privs' on 'path'
181+
182NOTE: Requires option(s): `privs`
183
184`--privs` `<string>` ::
185
186Verify ticket, and check if user have access 'privs' on 'path'
187+
188NOTE: Requires option(s): `path`
189
190`--realm` `<string>` ::
191
192You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
193
194
195
196
197*pveum useradd* `<userid>` `[OPTIONS]`
198
199Create new user.
200
201`<userid>`: `<string>` ::
202
203User ID
204
205`--comment` `<string>` ::
206
207no description available
208
209`--email` `<string>` ::
210
211no description available
212
213`--enable` `<boolean>` ('default =' `1`)::
214
215Enable the account (default). You can set this to '0' to disable the accout
216
217`--expire` `<integer> (0 - N)` ::
218
219Account expiration date (seconds since epoch). '0' means no expiration date.
220
221`--firstname` `<string>` ::
222
223no description available
224
225`--groups` `<string>` ::
226
227no description available
228
229`--keys` `<string>` ::
230
231Keys for two factor auth (yubico).
232
233`--lastname` `<string>` ::
234
235no description available
236
237`--password` ::
238
239Initial password.
240
241
242
243*pveum userdel* `<userid>`
244
245Delete user.
246
247`<userid>`: `<string>` ::
248
249User ID
250
251
252
253*pveum usermod* `<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>` ::
276
277Enable/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
300
301
PVE Documentation