Revision d937cc33 share/man/onevm.1

View differences:

share/man/onevm.1
1 1
.\" generated with Ronn/v0.7.3
2 2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3 3
.
4
.TH "ONEVM" "1" "January 2013" "" "onevm(1) -- manages OpenNebula virtual machines"
4
.TH "ONEVM" "1" "March 2013" "" "onevm(1) -- manages OpenNebula virtual machines"
5 5
.
6 6
.SH "NAME"
7 7
\fBonevm\fR
......
14 14
.nf
15 15

  
16 16
 \-m, \-\-multiple x          Instance multiple VMs
17
 \-\-hold                    Creates the new VM on hold state instead of pending
17
 \-\-hold                    Creates the new VM on hold state instead of
18
                           pending
18 19
 \-\-name name               Name for the new VM
19 20
 \-\-cpu cpu                 CPU percentage reserved for the VM (1=100% one
20 21
                           CPU)
21 22
 \-\-vcpu vcpu               Number of virtualized CPUs
22 23
 \-\-arch arch               Architecture of the VM, e\.g\.: i386 or x86_64
23 24
 \-\-memory memory           Memory ammount given to the VM
24
 \-\-disk disk0,disk1        Disks to attach\. To use a disk owned by other
25
 \-\-disk image0,image1      Disks to attach\. To use an image owned by other
25 26
                           user use user[disk]
26
 \-\-network network0,network1 Networks to attach\. To use a network owned by
27
 \-\-nic network0,network1   Networks to attach\. To use a network owned by
27 28
                           other user use user[network]
28 29
 \-\-raw string              Raw string to add to the template\. Not to be
29 30
                           confused with the RAW attribute
30 31
 \-\-vnc                     Add VNC server to the VM
31
 \-\-ssh [file]              Add an ssh public key to the context\. If the
32
                           file is omited then the user variable
33
                           SSH_PUBLIC_KEY will be used\.
32
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
33
                           is omited then the user variable SSH_PUBLIC_KEY
34
                           will be used\.
34 35
 \-\-net_context             Add network contextualization parameters
35 36
 \-\-context line1,line2,line3 Lines to add to the context section
36 37
 \-\-boot device             Select boot device (hd|fd|cdrom|network)
37 38
 \-\-dry                     Just print the template
39
 \-\-schedule TIME           Schedules this action to be executed afterthe
40
                           given time\. For example: onevm resume 0
41
                           \-\-schedule "09/23 14:15"
42
 \-\-recreate                Resubmits a fresh VM
38 43
 \-t, \-\-type type           Type of the new Image
44
 \-\-live                    Do the action with the VM running
45
 \-\-hard                    Does not communicate with the guest OS
39 46
 \-e, \-\-enforce             Enforce that the host capacity is not exceeded
40 47
 \-f, \-\-file file           Selects the template file
41 48
 \-i, \-\-image id|name       Selects the image
42 49
 \-t, \-\-target target       Device where the image will be attached
50
 \-\-cache cache_mode        Hypervisor cache mode: default, none,
51
                           writethrough, writeback, directsync or unsafe\.
52
                           (Only KVM driver)
53
 \-n, \-\-network id|name     Selects the virtual network
54
 \-i, \-\-ip ip               IP address for the new NIC
43 55
 \-l, \-\-list x,y,z          Selects columns to display with list command
44 56
 \-d, \-\-delay x             Sets the delay in seconds for top command
45 57
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
......
48 60
 \-n, \-\-numeric             Do not translate user and group IDs
49 61
 \-k, \-\-kilobytes           Show units in kilobytes
50 62
 \-\-describe                Describe list columns
63
 \-\-all                     Show all template data
51 64
 \-v, \-\-verbose             Verbose mode
52 65
 \-h, \-\-help                Show this message
53 66
 \-V, \-\-version             Show version and copyright information
......
60 73
.SH "COMMANDS"
61 74
.
62 75
.IP "\(bu" 4
63
create [\fIfile\fR]
76
create [\fIfile\fR] Creates a new VM from the given description instead of using a previously defined template (see \'onetemplate create\' and \'onetemplate instantiate\')\.
64 77
.
65 78
.IP "" 4
66 79
.
67 80
.nf
68 81

  
69
Creates a new VM from the given description instead of using a previously
70
defined template (see \'onetemplate create\' and \'onetemplate instantiate\')\.
71

  
72 82
Examples:
73 83

  
74 84
  \- using a template description file:
......
83 93
  \- a vm with two disks
84 94

  
85 95
    onevm create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \-\-disk arch,data
86
valid options: multiple, hold, name, cpu, vcpu, arch, memory, disk, network, raw, vnc, ssh, net_context, context, boot, dry
96
valid options: multiple, hold, name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, ssh, net_context, context, boot, dry
87 97
.
88 98
.fi
89 99
.
......
91 101

  
92 102
.
93 103
.IP "\(bu" 4
94
update \fIvmid\fR [\fIfile\fR]
95
.
96
.IP "" 4
97
.
98
.nf
99

  
100
Update the user template contents\. If a path is not provided the
101
editor will be launched to modify the current content\.
102
.
103
.fi
104
.
105
.IP "" 0
106

  
104
update \fIvmid\fR [\fIfile\fR] Update the user template contents\. If a path is not provided the editor will be launched to modify the current content\.
107 105
.
108 106
.IP "\(bu" 4
109
delete \fIrange|vmid_list\fR
107
destroy \fIrange|vmid_list\fR Deletes the given VM\. Using \-\-recreate resubmits the VM\.
110 108
.
111 109
.IP "" 4
112 110
.
113 111
.nf
114 112

  
115
Deletes the given VM
113
Resubmits the VM to PENDING state\. This is intended for VMs stuck in a
114
transient state\. To re\-deploy a fresh copy of the same VM, create a
115
Template and instantiate it, see \'onetemplate instantiate\'
116 116

  
117 117
States: ANY
118
valid options: schedule, recreate
118 119
.
119 120
.fi
120 121
.
......
122 123

  
123 124
.
124 125
.IP "\(bu" 4
125
hold \fIrange|vmid_list\fR
126
hold \fIrange|vmid_list\fR Sets the given VM on hold\. A VM on hold is not scheduled until it is released\. It can be, however, deployed manually; see \'onevm deploy\'
126 127
.
127 128
.IP "" 4
128 129
.
129 130
.nf
130 131

  
131
Sets the given VM on hold\. A VM on hold is not scheduled until it is
132
released\. It can be, however, deployed manually; see \'onevm deploy\'
133

  
134 132
States: PENDING
133
valid options: schedule
135 134
.
136 135
.fi
137 136
.
......
139 138

  
140 139
.
141 140
.IP "\(bu" 4
142
release \fIrange|vmid_list\fR
141
release \fIrange|vmid_list\fR Releases a VM on hold\. See \'onevm hold\'
143 142
.
144 143
.IP "" 4
145 144
.
146 145
.nf
147 146

  
148
Releases a VM on hold\. See \'onevm hold\'
149

  
150 147
States: HOLD
148
valid options: schedule
151 149
.
152 150
.fi
153 151
.
......
155 153

  
156 154
.
157 155
.IP "\(bu" 4
158
saveas \fIvmid\fR \fIdiskid\fR \fIimg_name\fR
156
disk\-snapshot \fIvmid\fR \fIdiskid\fR \fIimg_name\fR Sets the specified VM disk to be saved in a new Image\. The Image is created immediately, but the contents are saved only if the VM is shut down gracefully (i\.e\., using \'onevm shutdown\' and not \'onevm destroy\')
159 157
.
160 158
.IP "" 4
161 159
.
162 160
.nf
163 161

  
164
Sets the specified VM disk to be saved in a new Image\. The Image is
165
created immediately, but the contents are saved only if the VM is
166
shut down gracefully (i\.e\., using \'onevm shutdown\' and not
167
\'onevm delete\')
162
If \'\-\-live\' is specified, the Image will be saved immediately\.
168 163

  
169 164
States: ANY
170
valid options: type
171
.
172
.fi
173
.
174
.IP "" 0
175

  
176
.
177
.IP "\(bu" 4
178
shutdown \fIrange|vmid_list\fR
179
.
180
.IP "" 4
181
.
182
.nf
183

  
184
Shuts down the given VM\. The VM life cycle will end\.
185

  
186
States: RUNNING
165
valid options: type, live
187 166
.
188 167
.fi
189 168
.
......
191 170

  
192 171
.
193 172
.IP "\(bu" 4
194
poweroff \fIrange|vmid_list\fR
173
shutdown \fIrange|vmid_list\fR Shuts down the given VM\. The VM life cycle will end\.
195 174
.
196 175
.IP "" 4
197 176
.
198 177
.nf
199 178

  
200
Powers off the given VM\. The VM will remain in the poweroff state, and
201
can be powered on with the \'onevm restart\' command\.
179
With \-\-hard it unplugs the VM\.
202 180

  
203 181
States: RUNNING
182
valid options: schedule, hard
204 183
.
205 184
.fi
206 185
.
......
208 187

  
209 188
.
210 189
.IP "\(bu" 4
211
reboot \fIrange|vmid_list\fR
190
poweroff \fIrange|vmid_list\fR Powers off the given VM\. The VM will remain in the poweroff state, and can be powered on with the \'onevm boot\' command\.
212 191
.
213 192
.IP "" 4
214 193
.
215 194
.nf
216 195

  
217
Reboots the given VM, this is equivalent to execute the reboot command
218
from the VM console\.
219

  
220 196
States: RUNNING
197
valid options: schedule
221 198
.
222 199
.fi
223 200
.
......
225 202

  
226 203
.
227 204
.IP "\(bu" 4
228
reset \fIrange|vmid_list\fR
205
reboot \fIrange|vmid_list\fR Reboots the given VM, this is equivalent to execute the reboot command from the VM console\.
229 206
.
230 207
.IP "" 4
231 208
.
232 209
.nf
233 210

  
234
Resets the given VM
211
The VM will be ungracefully rebooted if \-\-hard is used\.
235 212

  
236 213
States: RUNNING
214
valid options: schedule, hard
237 215
.
238 216
.fi
239 217
.
......
241 219

  
242 220
.
243 221
.IP "\(bu" 4
244
deploy \fIrange|vmid_list\fR \fIhostid\fR
222
deploy \fIrange|vmid_list\fR \fIhostid\fR Deploys the given VM in the specified Host\. This command forces the deployment, in a standard installation the Scheduler is in charge of this decision
245 223
.
246 224
.IP "" 4
247 225
.
248 226
.nf
249 227

  
250
Deploys the given VM in the specified Host\. This command forces the
251
deployment, in a standard installation the Scheduler is in charge
252
of this decision
253

  
254 228
States: PENDING
255 229
valid options: enforce
256 230
.
......
260 234

  
261 235
.
262 236
.IP "\(bu" 4
263
livemigrate \fIrange|vmid_list\fR \fIhostid\fR
264
.
265
.IP "" 4
266
.
267
.nf
268

  
269
Migrates the given running VM to another Host without downtime
270

  
271
States: RUNNING
272
valid options: enforce
273
.
274
.fi
275
.
276
.IP "" 0
277

  
278
.
279
.IP "\(bu" 4
280
migrate \fIrange|vmid_list\fR \fIhostid\fR
237
migrate \fIrange|vmid_list\fR \fIhostid\fR Migrates the given running VM to another Host\. If used with \-\-live parameter the miration is done without downtime\.
281 238
.
282 239
.IP "" 4
283 240
.
284 241
.nf
285 242

  
286
Saves the given running VM and starts it again in the specified Host
287

  
288 243
States: RUNNING
289
valid options: enforce
244
valid options: enforce, live
290 245
.
291 246
.fi
292 247
.
......
294 249

  
295 250
.
296 251
.IP "\(bu" 4
297
restart \fIrange|vmid_list\fR
252
boot \fIrange|vmid_list\fR Boots the given VM\.
298 253
.
299 254
.IP "" 4
300 255
.
301 256
.nf
302 257

  
303
Boots the given VM\.
304

  
305 258
States: UNKNOWN, BOOT, POWEROFF
259
valid options: schedule
306 260
.
307 261
.fi
308 262
.
......
310 264

  
311 265
.
312 266
.IP "\(bu" 4
313
resubmit \fIrange|vmid_list\fR
267
stop \fIrange|vmid_list\fR Stops a running VM\. The VM state is saved and transferred back to the front\-end along with the disk files
314 268
.
315 269
.IP "" 4
316 270
.
317 271
.nf
318 272

  
319
Resubmits the VM to PENDING state\. This is intended for VMs stuck in a
320
transient state\. To re\-deploy a fresh copy of the same VM, create a
321
Template and instantiate it, see \'onetemplate instantiate\'
322

  
323
States: ANY, except SUSPENDED or DONE
273
States: RUNNING
274
valid options: schedule
324 275
.
325 276
.fi
326 277
.
......
328 279

  
329 280
.
330 281
.IP "\(bu" 4
331
cancel \fIrange|vmid_list\fR
282
suspend \fIrange|vmid_list\fR Saves a running VM\. It is the same as \'onevm stop\', but the files are left in the remote machine to later restart the VM there (i\.e\. the resources are not freed and there is no need to re\-schedule the VM)\.
332 283
.
333 284
.IP "" 4
334 285
.
335 286
.nf
336 287

  
337
Cancels the given VM\. The process is checked by OpenNebula, so
338
if the process fails the VM remains in running state\. If the action
339
succeeds the VMDIR in the remote machine is not deleted
340

  
341 288
States: RUNNING
289
valid options: schedule
342 290
.
343 291
.fi
344 292
.
......
346 294

  
347 295
.
348 296
.IP "\(bu" 4
349
stop \fIrange|vmid_list\fR
297
resume \fIrange|vmid_list\fR Resumes the execution of the a saved VM
350 298
.
351 299
.IP "" 4
352 300
.
353 301
.nf
354 302

  
355
Stops a running VM\. The VM state is saved and transferred back to the
356
front\-end along with the disk files
357

  
358
States: RUNNING
303
States: STOPPED, SUSPENDED
304
valid options: schedule
359 305
.
360 306
.fi
361 307
.
......
363 309

  
364 310
.
365 311
.IP "\(bu" 4
366
suspend \fIrange|vmid_list\fR
312
disk\-attach \fIvmid\fR Attaches a disk to a running VM
367 313
.
368 314
.IP "" 4
369 315
.
370 316
.nf
371 317

  
372
Saves a running VM\. It is the same as \'onevm stop\', but the files
373
are left in the remote machine to later restart the VM there
374
(i\.e\. the resources are not freed and there is no need to
375
re\-schedule the VM)\.
376

  
377 318
States: RUNNING
319
valid options: file, image, target, cache
378 320
.
379 321
.fi
380 322
.
......
382 324

  
383 325
.
384 326
.IP "\(bu" 4
385
resume \fIrange|vmid_list\fR
327
disk\-detach \fIvmid\fR \fIdiskid\fR Detaches a disk from a running VM
386 328
.
387 329
.IP "" 4
388 330
.
389 331
.nf
390 332

  
391
Resumes the execution of the a saved VM
392

  
393
States: STOPPED, SUSPENDED
333
States: RUNNING
394 334
.
395 335
.fi
396 336
.
......
398 338

  
399 339
.
400 340
.IP "\(bu" 4
401
attachdisk \fIvmid\fR
341
nic\-attach \fIvmid\fR Attaches a NIC to a running VM
402 342
.
403 343
.IP "" 4
404 344
.
405 345
.nf
406 346

  
407
Attaches a disk to a running VM
408

  
409 347
States: RUNNING
410
valid options: file, image, target
348
valid options: file, network, ip
411 349
.
412 350
.fi
413 351
.
......
415 353

  
416 354
.
417 355
.IP "\(bu" 4
418
detachdisk \fIvmid\fR \fIdiskid\fR
356
nic\-detach \fIvmid\fR \fInicid\fR Detaches a NIC from a running VM
419 357
.
420 358
.IP "" 4
421 359
.
422 360
.nf
423 361

  
424
Detaches a disk from a running VM
425

  
426 362
States: RUNNING
427 363
.
428 364
.fi
......
431 367

  
432 368
.
433 369
.IP "\(bu" 4
434
chgrp \fIrange|vmid_list\fR \fIgroupid\fR
435
.
436
.IP "" 4
437
.
438
.nf
439

  
440
Changes the VM group
441
.
442
.fi
443
.
444
.IP "" 0
445

  
370
chgrp \fIrange|vmid_list\fR \fIgroupid\fR Changes the VM group
446 371
.
447 372
.IP "\(bu" 4
448
chown \fIrange|vmid_list\fR \fIuserid\fR [\fIgroupid\fR]
449
.
450
.IP "" 4
451
.
452
.nf
453

  
454
Changes the VM owner and group
455
.
456
.fi
457
.
458
.IP "" 0
459

  
373
chown \fIrange|vmid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the VM owner and group
460 374
.
461 375
.IP "\(bu" 4
462
chmod \fIrange|vmid_list\fR \fIoctet\fR
463
.
464
.IP "" 4
465
.
466
.nf
467

  
468
Changes the VM permissions
469
.
470
.fi
471
.
472
.IP "" 0
473

  
376
chmod \fIrange|vmid_list\fR \fIoctet\fR Changes the VM permissions
474 377
.
475 378
.IP "\(bu" 4
476
resched \fIrange|vmid_list\fR
379
resched \fIrange|vmid_list\fR Sets the rescheduling flag for the VM\.
477 380
.
478 381
.IP "" 4
479 382
.
480 383
.nf
481 384

  
482
Sets the rescheduling flag for the VM\.
483

  
484 385
States: RUNNING
485 386
.
486 387
.fi
......
489 390

  
490 391
.
491 392
.IP "\(bu" 4
492
unresched \fIrange|vmid_list\fR
393
unresched \fIrange|vmid_list\fR Clears the rescheduling flag for the VM\.
493 394
.
494 395
.IP "" 4
495 396
.
496 397
.nf
497 398

  
498
Clears the rescheduling flag for the VM\.
499

  
500 399
States: RUNNING
501 400
.
502 401
.fi
......
505 404

  
506 405
.
507 406
.IP "\(bu" 4
508
rename \fIvmid\fR \fIname\fR
509
.
510
.IP "" 4
511
.
512
.nf
513

  
514
Renames the VM
515
.
516
.fi
517
.
518
.IP "" 0
519

  
407
rename \fIvmid\fR \fIname\fR Renames the VM
520 408
.
521 409
.IP "\(bu" 4
522
list [\fIfilterflag\fR]
523
.
524
.IP "" 4
525
.
526
.nf
527

  
528
Lists VMs in the pool
529
valid options: list, delay, filter, xml, numeric, kilobytes, describe
530
.
531
.fi
532
.
533
.IP "" 0
534

  
410
snapshot\-create \fIrange|vmid_list\fR [\fIname\fR] Creates a new VM snapshot valid options: schedule
535 411
.
536 412
.IP "\(bu" 4
537
show \fIvmid\fR
538
.
539
.IP "" 4
540
.
541
.nf
542

  
543
Shows information for the given VM
544
valid options: xml
545
.
546
.fi
547
.
548
.IP "" 0
549

  
413
snapshot\-revert \fIvmid\fR \fIsnapshot_id\fR Reverts a VM to a saved snapshot
550 414
.
551 415
.IP "\(bu" 4
552
top [\fIfilterflag\fR]
416
snapshot\-delete \fIvmid\fR \fIsnapshot_id\fR Delets a snapshot of a VM
553 417
.
554
.IP "" 4
418
.IP "\(bu" 4
419
list [\fIfilterflag\fR] Lists VMs in the pool valid options: list, delay, filter, xml, numeric, kilobytes, describe
555 420
.
556
.nf
557

  
558
Lists Images continuously
559
valid options: list, delay, filter, xml, numeric, kilobytes
421
.IP "\(bu" 4
422
show \fIvmid\fR Shows information for the given VM valid options: xml, all
560 423
.
561
.fi
424
.IP "\(bu" 4
425
top [\fIfilterflag\fR] Lists Images continuously valid options: list, delay, filter, xml, numeric, kilobytes
562 426
.
563
.IP "" 0
564

  
427
.IP "\(bu" 4
428
resize \fIvmid\fR Resizes the capacity of a Virtual Machine (offline, the VM cannot be RUNNING) valid options: cpu, vcpu, memory, enforce, file
565 429
.
566 430
.IP "" 0
567 431
.
568 432
.SH "ARGUMENT FORMATS"
569 433
.
570 434
.IP "\(bu" 4
571
file
572
.
573
.IP "" 4
574
.
575
.nf
576

  
577
Path to a file
578
.
579
.fi
580
.
581
.IP "" 0
582

  
435
file Path to a file
583 436
.
584 437
.IP "\(bu" 4
585
range
586
.
587
.IP "" 4
588
.
589
.nf
590

  
591
List of id\'s in the form 1,8\.\.15
592
.
593
.fi
594
.
595
.IP "" 0
596

  
438
range List of id\'s in the form 1,8\.\.15
597 439
.
598 440
.IP "\(bu" 4
599
text
600
.
601
.IP "" 4
602
.
603
.nf
604

  
605
String
606
.
607
.fi
608
.
609
.IP "" 0
610

  
441
text String
611 442
.
612 443
.IP "\(bu" 4
613
hostid
614
.
615
.IP "" 4
616
.
617
.nf
618

  
619
OpenNebula HOST name or id
620
.
621
.fi
622
.
623
.IP "" 0
624

  
444
hostid OpenNebula HOST name or id
625 445
.
626 446
.IP "\(bu" 4
627
groupid
628
.
629
.IP "" 4
630
.
631
.nf
632

  
633
OpenNebula GROUP name or id
634
.
635
.fi
636
.
637
.IP "" 0
638

  
447
groupid OpenNebula GROUP name or id
639 448
.
640 449
.IP "\(bu" 4
641
userid
642
.
643
.IP "" 4
644
.
645
.nf
646

  
647
OpenNebula USER name or id
648
.
649
.fi
650
.
651
.IP "" 0
652

  
450
userid OpenNebula USER name or id
653 451
.
654 452
.IP "\(bu" 4
655
vmid
656
.
657
.IP "" 4
658
.
659
.nf
660

  
661
OpenNebula VM name or id
662
.
663
.fi
664
.
665
.IP "" 0
666

  
453
vmid OpenNebula VM name or id
667 454
.
668 455
.IP "\(bu" 4
669
vmid_list
670
.
671
.IP "" 4
672
.
673
.nf
674

  
675
Comma\-separated list of OpenNebula VM names or ids
676
.
677
.fi
678
.
679
.IP "" 0
680

  
456
vmid_list Comma\-separated list of OpenNebula VM names or ids
681 457
.
682 458
.IP "\(bu" 4
683
filterflag
684
.
685
.IP "" 4
686
.
687
.nf
688

  
689
a, all       all the known VMs
690
m, mine      the VM belonging to the user in ONE_AUTH
691
g, group     \'mine\' plus the VM belonging to the groups
692
             the user is member of
693
uid          VM of the user identified by this uid
694
user         VM of the user identified by the username
695
.
696
.fi
697
.
698
.IP "" 0
699

  
459
filterflag a, all all the known VMs m, mine the VM belonging to the user in ONE_AUTH g, group \'mine\' plus the VM belonging to the groups the user is member of uid VM of the user identified by this uid user VM of the user identified by the username
700 460
.
701 461
.IP "\(bu" 4
702
diskid
703
.
704
.IP "" 4
705
.
706
.nf
707

  
708
Integer
709
.
710
.fi
711
.
712
.IP "" 0
713

  
462
diskid Integer
714 463
.
715 464
.IP "" 0
716 465
.
717 466
.SH "LICENSE"
718
OpenNebula 3\.9\.0 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
467
OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs
719 468
.
720 469
.P
721 470
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