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