OpenNebula

.TH "ONEVM" "1" "March 2013" "" "onevm(1) -- manages OpenNebula virtual machines"

 \-\-hold                    Creates the new VM on hold state instead of

                           pending

 \-\-disk image0,image1      Disks to attach\. To use an image owned by other

 \-\-nic network0,network1   Networks to attach\. To use a network owned by

 \-\-ssh [file]              Add an ssh public key to the context\. If the file

                           is omited then the user variable SSH_PUBLIC_KEY

                           will be used\.

 \-\-schedule TIME           Schedules this action to be executed afterthe

                           given time\. For example: onevm resume 0

                           \-\-schedule "09/23 14:15"

 \-\-recreate                Resubmits a fresh VM

 \-\-live                    Do the action with the VM running

 \-\-hard                    Does not communicate with the guest OS

 \-\-cache cache_mode        Hypervisor cache mode: default, none,

                           writethrough, writeback, directsync or unsafe\.

                           (Only KVM driver)

 \-n, \-\-network id|name     Selects the virtual network

 \-i, \-\-ip ip               IP address for the new NIC

 \-\-all                     Show all template data

create [\fIfile\fR] Creates a new VM from the given description instead of using a previously defined template (see \'onetemplate create\' and \'onetemplate instantiate\')\.

valid options: multiple, hold, name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, ssh, net_context, context, boot, dry

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\.

destroy \fIrange|vmid_list\fR Deletes the given VM\. Using \-\-recreate resubmits the VM\.

Resubmits the VM to PENDING state\. This is intended for VMs stuck in a

transient state\. To re\-deploy a fresh copy of the same VM, create a

Template and instantiate it, see \'onetemplate instantiate\'

valid options: schedule, recreate

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\'

valid options: schedule

release \fIrange|vmid_list\fR Releases a VM on hold\. See \'onevm hold\'

valid options: schedule

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\')

If \'\-\-live\' is specified, the Image will be saved immediately\.

valid options: type, live

shutdown \fIrange|vmid_list\fR Shuts down the given VM\. The VM life cycle will end\.

With \-\-hard it unplugs the VM\.

valid options: schedule, hard

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\.

valid options: schedule

reboot \fIrange|vmid_list\fR Reboots the given VM, this is equivalent to execute the reboot command from the VM console\.

The VM will be ungracefully rebooted if \-\-hard is used\.

valid options: schedule, hard

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

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\.

valid options: enforce, live

boot \fIrange|vmid_list\fR Boots the given VM\.

valid options: schedule

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

States: RUNNING

valid options: schedule

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)\.

valid options: schedule

resume \fIrange|vmid_list\fR Resumes the execution of the a saved VM

States: STOPPED, SUSPENDED

valid options: schedule

disk\-attach \fIvmid\fR Attaches a disk to a running VM

valid options: file, image, target, cache

disk\-detach \fIvmid\fR \fIdiskid\fR Detaches a disk from a running VM

States: RUNNING

nic\-attach \fIvmid\fR Attaches a NIC to a running VM

valid options: file, network, ip

nic\-detach \fIvmid\fR \fInicid\fR Detaches a NIC from a running VM

chgrp \fIrange|vmid_list\fR \fIgroupid\fR Changes the VM group

chown \fIrange|vmid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the VM owner and group

chmod \fIrange|vmid_list\fR \fIoctet\fR Changes the VM permissions

resched \fIrange|vmid_list\fR Sets the rescheduling flag for the VM\.

unresched \fIrange|vmid_list\fR Clears the rescheduling flag for the VM\.

rename \fIvmid\fR \fIname\fR Renames the VM

snapshot\-create \fIrange|vmid_list\fR [\fIname\fR] Creates a new VM snapshot valid options: schedule

snapshot\-revert \fIvmid\fR \fIsnapshot_id\fR Reverts a VM to a saved snapshot

snapshot\-delete \fIvmid\fR \fIsnapshot_id\fR Delets a snapshot of a VM

.IP "\(bu" 4

list [\fIfilterflag\fR] Lists VMs in the pool valid options: list, delay, filter, xml, numeric, kilobytes, describe

.IP "\(bu" 4

show \fIvmid\fR Shows information for the given VM valid options: xml, all

.IP "\(bu" 4

top [\fIfilterflag\fR] Lists Images continuously valid options: list, delay, filter, xml, numeric, kilobytes

.IP "\(bu" 4

resize \fIvmid\fR Resizes the capacity of a Virtual Machine (offline, the VM cannot be RUNNING) valid options: cpu, vcpu, memory, enforce, file

file Path to a file

range List of id\'s in the form 1,8\.\.15

text String

hostid OpenNebula HOST name or id

groupid OpenNebula GROUP name or id

userid OpenNebula USER name or id

vmid OpenNebula VM name or id

vmid_list Comma\-separated list of OpenNebula VM names or ids

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

diskid Integer

OpenNebula 3\.9\.80 Copyright 2002\-2013, OpenNebula Project (OpenNebula\.org), C12G Labs