Revision d937cc33 share/man/oneuser.1

View differences:

share/man/oneuser.1
1 1
.\" generated with Ronn/v0.7.3
2 2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3 3
.
4
.TH "ONEUSER" "1" "January 2013" "" "oneuser(1) -- manages OpenNebula users"
4
.TH "ONEUSER" "1" "March 2013" "" "oneuser(1) -- manages OpenNebula users"
5 5
.
6 6
.SH "NAME"
7 7
\fBoneuser\fR
......
43 43
.SH "COMMANDS"
44 44
.
45 45
.IP "\(bu" 4
46
create \fIusername\fR [\fIpassword\fR]
47
.
48
.IP "" 4
49
.
50
.nf
51

  
52
Creates a new User
53
Examples:
54
  oneuser create my_user my_password
55
  oneuser create my_user \-r /tmp/mypass
56
  oneuser create my_user \-\-ssh \-\-key /tmp/id_rsa
57
  oneuser create my_user \-\-ssh \-r /tmp/public_key
58
  oneuser create my_user \-\-x509 \-\-cert /tmp/my_cert\.pem
59
valid options: read_file, sha1, ssh, x509, key, cert, driver
60
.
61
.fi
62
.
63
.IP "" 0
64

  
46
create \fIusername\fR [\fIpassword\fR] Creates a new User Examples: oneuser create my_user my_password oneuser create my_user \-r /tmp/mypass oneuser create my_user \-\-ssh \-\-key /tmp/id_rsa oneuser create my_user \-\-ssh \-r /tmp/public_key oneuser create my_user \-\-x509 \-\-cert /tmp/my_cert\.pem valid options: read_file, sha1, ssh, x509, key, cert, driver
65 47
.
66 48
.IP "\(bu" 4
67
update \fIuserid\fR [\fIfile\fR]
68
.
69
.IP "" 4
70
.
71
.nf
72

  
73
Update the template contents\. If a path is not provided the editor will
74
be launched to modify the current content\.
75
.
76
.fi
77
.
78
.IP "" 0
79

  
49
update \fIuserid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\.
80 50
.
81 51
.IP "\(bu" 4
82
quota \fIuserid\fR [\fIfile\fR]
83
.
84
.IP "" 4
85
.
86
.nf
87

  
88
Set the quota limits for the user\. If a path is not provided the editor
89
will be launched to modify the current quotas\.
90
.
91
.fi
92
.
93
.IP "" 0
94

  
52
quota \fIuserid\fR [\fIfile\fR] Set the quota limits for the user\. If a path is not provided the editor will be launched to modify the current quotas\.
95 53
.
96 54
.IP "\(bu" 4
97
batchquota \fIrange|userid_list\fR [\fIfile\fR]
98
.
99
.IP "" 4
100
.
101
.nf
102

  
103
Sets the quota limits in batch for various users\. If a path is not
104
provided the editor will be launched to create new quotas\.
105
.
106
.fi
107
.
108
.IP "" 0
109

  
55
batchquota \fIrange|userid_list\fR [\fIfile\fR] Sets the quota limits in batch for various users\. If a path is not provided the editor will be launched to create new quotas\.
110 56
.
111 57
.IP "\(bu" 4
112
defaultquota [\fIfile\fR]
113
.
114
.IP "" 4
115
.
116
.nf
117

  
118
Sets the default quota limits for the users\. If a path is not provided
119
the editor will be launched to modify the current default quotas\.
120
.
121
.fi
122
.
123
.IP "" 0
124

  
58
defaultquota [\fIfile\fR] Sets the default quota limits for the users\. If a path is not provided the editor will be launched to modify the current default quotas\.
125 59
.
126 60
.IP "\(bu" 4
127
umask \fIrange|userid_list\fR [\fImask\fR]
61
umask \fIrange|userid_list\fR [\fImask\fR] Changes the umask used to create the default permissions\. In a similar way to the Unix umask command, the expected value is a three\-digit base\-8 number\. Each digit is a mask that disables permissions for the owner, group and other, respectively\.
128 62
.
129 63
.IP "" 4
130 64
.
131 65
.nf
132 66

  
133
Changes the umask used to create the default permissions\. In a similar
134
way to the Unix umask command, the expected value is a three\-digit
135
base\-8 number\. Each digit is a mask that disables permissions for the
136
owner, group and other, respectively\.
137

  
138 67
If mask is not given, or if it is an empty string, the umask will
139 68
be unset
140 69
.
......
144 73

  
145 74
.
146 75
.IP "\(bu" 4
147
login \fIusername\fR
148
.
149
.IP "" 4
150
.
151
.nf
152

  
153
Creates the Login token for authentication
154
Examples:
155
  oneuser login my_user \-\-ssh \-\-key /tmp/id_rsa \-\-time 72000
156
  oneuser login my_user \-\-x509 \-\-cert /tmp/my_cert\.pem
157
                        \-\-key /tmp/my_key\.pk \-\-time 72000
158
  oneuser login my_user \-\-x509_proxy \-\-proxy /tmp/my_cert\.pem
159
                        \-\-time 72000
160
valid options: ssh, x509, x509_proxy, key, cert, proxy, time
161
.
162
.fi
163
.
164
.IP "" 0
165

  
76
login \fIusername\fR Creates the Login token for authentication Examples: oneuser login my_user \-\-ssh \-\-key /tmp/id_rsa \-\-time 72000 oneuser login my_user \-\-x509 \-\-cert /tmp/my_cert\.pem \-\-key /tmp/my_key\.pk \-\-time 72000 oneuser login my_user \-\-x509_proxy \-\-proxy /tmp/my_cert\.pem \-\-time 72000 valid options: ssh, x509, x509_proxy, key, cert, proxy, time
166 77
.
167 78
.IP "\(bu" 4
168
key
79
key DEPRECATED, use login to generate auth files\.
169 80
.
170 81
.IP "" 4
171 82
.
172 83
.nf
173 84

  
174
DEPRECATED, use login to generate auth files\.
175

  
176 85
Shows a public key from a private SSH key\. Use it as password
177 86
for the SSH authentication mechanism\.
178 87
valid options: key
......
183 92

  
184 93
.
185 94
.IP "\(bu" 4
186
delete \fIrange|userid_list\fR
187
.
188
.IP "" 4
189
.
190
.nf
191

  
192
Deletes the given User
193
.
194
.fi
195
.
196
.IP "" 0
197

  
95
delete \fIrange|userid_list\fR Deletes the given User
198 96
.
199 97
.IP "\(bu" 4
200
passwd \fIuserid\fR [\fIpassword\fR]
201
.
202
.IP "" 4
203
.
204
.nf
205

  
206
Changes the given User\'s password
207
valid options: read_file, sha1, ssh, x509, key, cert, driver
208
.
209
.fi
210
.
211
.IP "" 0
212

  
98
passwd \fIuserid\fR [\fIpassword\fR] Changes the given User\'s password valid options: read_file, sha1, ssh, x509, key, cert, driver
213 99
.
214 100
.IP "\(bu" 4
215
chgrp \fIrange|userid_list\fR \fIgroupid\fR
216
.
217
.IP "" 4
218
.
219
.nf
220

  
221
Changes the User\'s main group
222
.
223
.fi
224
.
225
.IP "" 0
226

  
101
chgrp \fIrange|userid_list\fR \fIgroupid\fR Changes the User\'s main group
227 102
.
228 103
.IP "\(bu" 4
229
chauth \fIuserid\fR [\fIauth\fR] [\fIpassword\fR]
230
.
231
.IP "" 4
232
.
233
.nf
234

  
235
Changes the User\'s auth driver and its password (optional)
236
Examples:
237
  oneuser chauth my_user core
238
  oneuser chauth my_user core new_password
239
  oneuser chauth my_user core \-r /tmp/mypass
240
  oneuser chauth my_user \-\-ssh \-\-key /home/oneadmin/\.ssh/id_rsa
241
  oneuser chauth my_user \-\-ssh \-r /tmp/public_key
242
  oneuser chauth my_user \-\-x509 \-\-cert /tmp/my_cert\.pem
243
valid options: read_file, sha1, ssh, x509, key, cert, driver
244
.
245
.fi
246
.
247
.IP "" 0
248

  
104
chauth \fIuserid\fR [\fIauth\fR] [\fIpassword\fR] Changes the User\'s auth driver and its password (optional) Examples: oneuser chauth my_user core oneuser chauth my_user core new_password oneuser chauth my_user core \-r /tmp/mypass oneuser chauth my_user \-\-ssh \-\-key /home/oneadmin/\.ssh/id_rsa oneuser chauth my_user \-\-ssh \-r /tmp/public_key oneuser chauth my_user \-\-x509 \-\-cert /tmp/my_cert\.pem valid options: read_file, sha1, ssh, x509, key, cert, driver
249 105
.
250 106
.IP "\(bu" 4
251
list
252
.
253
.IP "" 4
254
.
255
.nf
256

  
257
Lists Users in the pool
258
valid options: list, delay, filter, xml, numeric, describe
259
.
260
.fi
261
.
262
.IP "" 0
263

  
107
list Lists Users in the pool valid options: list, delay, filter, xml, numeric, describe
264 108
.
265 109
.IP "\(bu" 4
266
show [\fIuserid\fR]
267
.
268
.IP "" 4
269
.
270
.nf
271

  
272
Shows information for the given User
273
valid options: xml
274
.
275
.fi
276
.
277
.IP "" 0
278

  
110
show [\fIuserid\fR] Shows information for the given User valid options: xml
279 111
.
280 112
.IP "\(bu" 4
281
encode \fIusername\fR [\fIpassword\fR]
282
.
283
.IP "" 4
284
.
285
.nf
286

  
287
Encodes user and password to use it with ldap
288
.
289
.fi
290
.
291
.IP "" 0
292

  
113
encode \fIusername\fR [\fIpassword\fR] Encodes user and password to use it with ldap
293 114
.
294 115
.IP "" 0
295 116
.
296 117
.SH "ARGUMENT FORMATS"
297 118
.
298 119
.IP "\(bu" 4
299
file
300
.
301
.IP "" 4
302
.
303
.nf
304

  
305
Path to a file
306
.
307
.fi
308
.
309
.IP "" 0
310

  
120
file Path to a file
311 121
.
312 122
.IP "\(bu" 4
313
range
314
.
315
.IP "" 4
316
.
317
.nf
318

  
319
List of id\'s in the form 1,8\.\.15
320
.
321
.fi
322
.
323
.IP "" 0
324

  
123
range List of id\'s in the form 1,8\.\.15
325 124
.
326 125
.IP "\(bu" 4
327
text
328
.
329
.IP "" 4
330
.
331
.nf
332

  
333
String
334
.
335
.fi
336
.
337
.IP "" 0
338

  
126
text String
339 127
.
340 128
.IP "\(bu" 4
341
groupid
342
.
343
.IP "" 4
344
.
345
.nf
346

  
347
OpenNebula GROUP name or id
348
.
349
.fi
350
.
351
.IP "" 0
352

  
129
groupid OpenNebula GROUP name or id
353 130
.
354 131
.IP "\(bu" 4
355
userid
356
.
357
.IP "" 4
358
.
359
.nf
360

  
361
OpenNebula USER name or id
362
.
363
.fi
364
.
365
.IP "" 0
366

  
132
userid OpenNebula USER name or id
367 133
.
368 134
.IP "\(bu" 4
369
userid_list
370
.
371
.IP "" 4
372
.
373
.nf
374

  
375
Comma\-separated list of OpenNebula USER names or ids
376
.
377
.fi
378
.
379
.IP "" 0
380

  
135
userid_list Comma\-separated list of OpenNebula USER names or ids
381 136
.
382 137
.IP "\(bu" 4
383
password
384
.
385
.IP "" 4
386
.
387
.nf
388

  
389
User password
390
.
391
.fi
392
.
393
.IP "" 0
394

  
138
password User password
395 139
.
396 140
.IP "" 0
397 141
.
398 142
.SH "LICENSE"
399
OpenNebula 3\.9\.0 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
143
OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
400 144
.
401 145
.P
402 146
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0

Also available in: Unified diff