Revision d937cc33 share/man/onevnet.1

View differences:

share/man/onevnet.1
1 1
.\" generated with Ronn/v0.7.3
2 2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3 3
.
4
.TH "ONEVNET" "1" "January 2013" "" "onevnet(1) -- manages OpenNebula networks"
4
.TH "ONEVNET" "1" "March 2013" "" "onevnet(1) -- manages OpenNebula networks"
5 5
.
6 6
.SH "NAME"
7 7
\fBonevnet\fR
......
34 34
.SH "COMMANDS"
35 35
.
36 36
.IP "\(bu" 4
37
create \fIfile\fR
38
.
39
.IP "" 4
40
.
41
.nf
42

  
43
Creates a new Virtual Network from the given template file
44
valid options: cluster
45
.
46
.fi
47
.
48
.IP "" 0
49

  
37
create \fIfile\fR Creates a new Virtual Network from the given template file valid options: cluster
50 38
.
51 39
.IP "\(bu" 4
52
delete \fIrange|vnetid_list\fR
53
.
54
.IP "" 4
55
.
56
.nf
57

  
58
Deletes the given Virtual Network
59
.
60
.fi
61
.
62
.IP "" 0
63

  
40
delete \fIrange|vnetid_list\fR Deletes the given Virtual Network
64 41
.
65 42
.IP "\(bu" 4
66
addleases \fIvnetid\fR \fIip\fR [\fImac\fR]
67
.
68
.IP "" 4
69
.
70
.nf
71

  
72
Adds a lease to the Virtual Network
73
.
74
.fi
75
.
76
.IP "" 0
77

  
43
addleases \fIvnetid\fR \fIip\fR [\fImac\fR] Adds a lease to the Virtual Network
78 44
.
79 45
.IP "\(bu" 4
80
rmleases \fIvnetid\fR \fIip\fR
81
.
82
.IP "" 4
83
.
84
.nf
85

  
86
Removes a lease from the Virtual Network
87
.
88
.fi
89
.
90
.IP "" 0
91

  
46
rmleases \fIvnetid\fR \fIip\fR Removes a lease from the Virtual Network
92 47
.
93 48
.IP "\(bu" 4
94
hold \fIvnetid\fR \fIip\fR
95
.
96
.IP "" 4
97
.
98
.nf
99

  
100
Holds a Virtual Network lease, marking it as used
101
.
102
.fi
103
.
104
.IP "" 0
105

  
49
hold \fIvnetid\fR \fIip\fR Holds a Virtual Network lease, marking it as used
106 50
.
107 51
.IP "\(bu" 4
108
release \fIvnetid\fR \fIip\fR
109
.
110
.IP "" 4
111
.
112
.nf
113

  
114
Releases a Virtual Network lease on hold
115
.
116
.fi
117
.
118
.IP "" 0
119

  
52
release \fIvnetid\fR \fIip\fR Releases a Virtual Network lease on hold
120 53
.
121 54
.IP "\(bu" 4
122
publish \fIrange|vnetid_list\fR
123
.
124
.IP "" 4
125
.
126
.nf
127

  
128
DEPRECATED, use chmod instead\. Publishes the given Virtual Network\.
129
A public Virtual Network can be seen and used by other users in the
130
Virtual Network\'s group\.
131
.
132
.fi
133
.
134
.IP "" 0
135

  
55
publish \fIrange|vnetid_list\fR DEPRECATED, use chmod instead\. Publishes the given Virtual Network\. A public Virtual Network can be seen and used by other users in the Virtual Network\'s group\.
136 56
.
137 57
.IP "\(bu" 4
138
unpublish \fIrange|vnetid_list\fR
139
.
140
.IP "" 4
141
.
142
.nf
143

  
144
DEPRECATED, use chmod instead\. Unpublishes the given Virtual Network\. A
145
private Virtual Network can\'t be used by any other user\.
146
.
147
.fi
148
.
149
.IP "" 0
150

  
58
unpublish \fIrange|vnetid_list\fR DEPRECATED, use chmod instead\. Unpublishes the given Virtual Network\. A private Virtual Network can\'t be used by any other user\.
151 59
.
152 60
.IP "\(bu" 4
153
chgrp \fIrange|vnetid_list\fR \fIgroupid\fR
154
.
155
.IP "" 4
156
.
157
.nf
158

  
159
Changes the Virtual Network group
160
.
161
.fi
162
.
163
.IP "" 0
164

  
61
chgrp \fIrange|vnetid_list\fR \fIgroupid\fR Changes the Virtual Network group
165 62
.
166 63
.IP "\(bu" 4
167
chown \fIrange|vnetid_list\fR \fIuserid\fR [\fIgroupid\fR]
168
.
169
.IP "" 4
170
.
171
.nf
172

  
173
Changes the Virtual Network owner and group
174
.
175
.fi
176
.
177
.IP "" 0
178

  
64
chown \fIrange|vnetid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Network owner and group
179 65
.
180 66
.IP "\(bu" 4
181
chmod \fIrange|vnetid_list\fR \fIoctet\fR
182
.
183
.IP "" 4
184
.
185
.nf
186

  
187
Changes the Virtual Network permissions
188
.
189
.fi
190
.
191
.IP "" 0
192

  
67
chmod \fIrange|vnetid_list\fR \fIoctet\fR Changes the Virtual Network permissions
193 68
.
194 69
.IP "\(bu" 4
195
list [\fIfilterflag\fR]
196
.
197
.IP "" 4
198
.
199
.nf
200

  
201
Lists Virtual Networks in the pool
202
valid options: list, delay, filter, xml, numeric, kilobytes, describe
203
.
204
.fi
205
.
206
.IP "" 0
207

  
70
list [\fIfilterflag\fR] Lists Virtual Networks in the pool valid options: list, delay, filter, xml, numeric, kilobytes, describe
208 71
.
209 72
.IP "\(bu" 4
210
show \fIvnetid\fR
211
.
212
.IP "" 4
213
.
214
.nf
215

  
216
Shows information for the given Virtual Network
217
valid options: xml
218
.
219
.fi
220
.
221
.IP "" 0
222

  
73
show \fIvnetid\fR Shows information for the given Virtual Network valid options: xml
223 74
.
224 75
.IP "\(bu" 4
225
update \fIvnetid\fR [\fIfile\fR]
226
.
227
.IP "" 4
228
.
229
.nf
230

  
231
Update the template contents\. If a path is not provided the editor will
232
be launched to modify the current content\.
233
.
234
.fi
235
.
236
.IP "" 0
237

  
76
update \fIvnetid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\.
238 77
.
239 78
.IP "\(bu" 4
240
rename \fIvnetid\fR \fIname\fR
241
.
242
.IP "" 4
243
.
244
.nf
245

  
246
Renames the Virtual Network
247
.
248
.fi
249
.
250
.IP "" 0
251

  
79
rename \fIvnetid\fR \fIname\fR Renames the Virtual Network
252 80
.
253 81
.IP "" 0
254 82
.
255 83
.SH "ARGUMENT FORMATS"
256 84
.
257 85
.IP "\(bu" 4
258
file
259
.
260
.IP "" 4
261
.
262
.nf
263

  
264
Path to a file
265
.
266
.fi
267
.
268
.IP "" 0
269

  
86
file Path to a file
270 87
.
271 88
.IP "\(bu" 4
272
range
273
.
274
.IP "" 4
275
.
276
.nf
277

  
278
List of id\'s in the form 1,8\.\.15
279
.
280
.fi
281
.
282
.IP "" 0
283

  
89
range List of id\'s in the form 1,8\.\.15
284 90
.
285 91
.IP "\(bu" 4
286
text
287
.
288
.IP "" 4
289
.
290
.nf
291

  
292
String
293
.
294
.fi
295
.
296
.IP "" 0
297

  
92
text String
298 93
.
299 94
.IP "\(bu" 4
300
groupid
301
.
302
.IP "" 4
303
.
304
.nf
305

  
306
OpenNebula GROUP name or id
307
.
308
.fi
309
.
310
.IP "" 0
311

  
95
groupid OpenNebula GROUP name or id
312 96
.
313 97
.IP "\(bu" 4
314
userid
315
.
316
.IP "" 4
317
.
318
.nf
319

  
320
OpenNebula USER name or id
321
.
322
.fi
323
.
324
.IP "" 0
325

  
98
userid OpenNebula USER name or id
326 99
.
327 100
.IP "\(bu" 4
328
vnetid
329
.
330
.IP "" 4
331
.
332
.nf
333

  
334
OpenNebula VNET name or id
335
.
336
.fi
337
.
338
.IP "" 0
339

  
101
vnetid OpenNebula VNET name or id
340 102
.
341 103
.IP "\(bu" 4
342
vnetid_list
343
.
344
.IP "" 4
345
.
346
.nf
347

  
348
Comma\-separated list of OpenNebula VNET names or ids
349
.
350
.fi
351
.
352
.IP "" 0
353

  
104
vnetid_list Comma\-separated list of OpenNebula VNET names or ids
354 105
.
355 106
.IP "\(bu" 4
356
filterflag
357
.
358
.IP "" 4
359
.
360
.nf
361

  
362
a, all       all the known VNETs
363
m, mine      the VNET belonging to the user in ONE_AUTH
364
g, group     \'mine\' plus the VNET belonging to the groups
365
             the user is member of
366
uid          VNET of the user identified by this uid
367
user         VNET of the user identified by the username
368
.
369
.fi
370
.
371
.IP "" 0
372

  
107
filterflag a, all all the known VNETs m, mine the VNET belonging to the user in ONE_AUTH g, group \'mine\' plus the VNET belonging to the groups the user is member of uid VNET of the user identified by this uid user VNET of the user identified by the username
373 108
.
374 109
.IP "" 0
375 110
.
376 111
.SH "LICENSE"
377
OpenNebula 3\.9\.0 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
112
OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
378 113
.
379 114
.P
380 115
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