1. onevm(1)
  2. onevm(1) -- manages OpenNebula virtual machines
  3. onevm(1)

NAME

onevm - manages OpenNebula virtual machines

SYNOPSIS

onevm command [args] [options]

OPTIONS

 --adjust x,y,z            Adjust size to not truncate selected columns
 --admin                   lock admin actions
 -a, --alias alias         Attach the NIC as an ALIAS
 --all                     Show all template data
 -a, --append              Append new attributes to the current template
 --arch arch               Architecture of the VM, e.g.: i386 or x86_64
 --as_gid gid              The Group ID to instantiate the VM
 --as_uid uid              The User ID to instantiate the VM
 --boot device_list        Set boot device list e.g. disk0,disk2,nic0
 --cache cache_mode        Hypervisor cache mode: default, none,
                           writethrough, writeback, directsync or unsafe.
                           (Only KVM driver)
 --cmd cmd                 CMD to run when SSH
 --context line1,line2,line3 Lines to add to the context section
 --cpu cpu                 CPU percentage reserved for the VM (1=100% one
                           CPU)
 --csv                     Write table in csv format
 --csv-del del             Set delimiter for csv output
 -d, --datastore id|name   Selects the datastore
 --decrypt                 Get decrypted attributes
 -d, --delay x             Sets the delay in seconds for top command
 --delete                  No recover action possible, delete the VM
 --delete-db               No recover action possible, delete the VM from
                           the DB. It does not trigger any action on the
                           hypervisor
 --describe                Describe list columns
 --discard discard_mode    Hypervisor discard mode: ignore or unmap. (Only
                           KVM driver)
 --disk image0,image1      Disks to attach. To use an image owned by other
                           user use user[disk]. Add any additional
                           attributes separated by ':' and in the shape of
                           KEY=VALUE. For example, if the disk must be
                           resized, use image0:size=1000 . Or
                           image0:size=1000:target=vda,image1:target=vdb
 --dry                     Just print the template
 --end number|TIME         ----
 --endpoint endpoint       URL of OpenNebula xmlrpc frontend
 -e, --enforce             Enforce that the host capacity is not exceeded
 --expand [x=prop,y=prop]  Expands the columns size to fill the terminal.
                           For example: $onevm list --expand
                           name=0.4,group=0.6 will expand name 40% and
                           group 60%. $onevm list --expand name,group will
                           expand name and group based on its size.$onevm
                           list --expand will expand all columns.
 --extended                Show info extended (it only works with xml
                           output)
 --failure                 Recover a VM by failing the pending action
 -f, --file file           Selects the template file
 --files_ds file1,file2    Add files to the contextualization CD from
                           thefiles datastore
 -f, --filter x,y,z        Filter data. An array is specified with
                           column=value pairs. Valid operators
                           =,!=,<,<=,>,>=,~ e.g. NAME=test (match name with
                           test) NAME~test (match test, te, tes..)
 --hard                    Does not communicate with the guest OS
 -h, --help                Show this message
 --hold                    Creates the new VM on hold state instead of
                           pending
 --hourly hour             Repeats the schedule action each hours
                           specified,it can be a number between 0,168
                           separated with commas.For example: onevm resume
                           0 --schedule "09/23 14:15" --hourly 1,5
 -i, --image id|name       Selects the image
 --init script1,script2    Script or scripts to start in context
 --interactive             Enables interactive recovery. Only works
                           alongside the --retry option.
 -i, --ip ip               IP address for the new NIC
 -j, --json                Show the resource in JSON format
 --keep-backup             Keep previous backup when creating a new one
 -k, --kilobytes           Show units in kilobytes
 -l, --list x,y,z          Selects columns to display with list command
 -c, --listconf conf       Selects a predefined column list
 --live                    Do the action with the VM running
 --logger logger           Set logger to STDOUT or FILE
 --manage                  lock manage actions
 --market market_id        Market to save oneshot
 --memory memory           Memory amount given to the VM. By default the
                           unit is megabytes. To use gigabytes add a 'g',
                           floats can be used: 8g=8192, 0.5g=512
 --monthly days            Repeats the schedule action the days of the month
                           specified, it can be a number between 0,31
                           separated with commas.For example: onevm resume
                           0 --schedule "09/23 14:15" --monthly 0,14
 -m, --multiple x          Instance multiple VMs
 --name name               Name for the new VM
 --net_context             Add network contextualization parameters
 -n, --network id|name     Selects the virtual network
 --nic network0,network1   Networks to attach. To use a network owned by
                           other user use user[network]. Additional
                           attributes are supported like with the --disk
                           option. Also you can use auto if you want that
                           OpenNebula select automatically the network
 --nic-id nic_id           NIC to use when SSH
 --nic_name name           Name of the NIC
 --no-expand               Disable expand
 --no-header               Hides the header of the table
 --no-pager                Disable pagination
 -n, --numeric             Do not translate user and group IDs
 --oneshot                 Take an snapshot of the VM without saving backup
                           info
 --operator operator       Logical operator used on filters: AND, OR.
                           Default: AND.
 --password password       Password to authenticate with OpenNebula
 --persistent              Make the new images persistent
 --poff                    Do the migrate by poweringoff the vm
 --poff-hard               Do the migrate by poweringoff hard the vm
 --prefix prefix           Overrides the DEV_PREFIX of the image
 --raw string              Raw string to add to the template. Not to be
                           confused with the RAW attribute
 --recreate                No recover action possible, delete and recreate
                           the VM
 --report_ready            Sends READY=YES to OneGate, useful for OneFlow
 --retry                   Recover a VM by retrying the last failed action
 --schedule TIME           Schedules this action to be executed afterthe
                           given time. For example: onevm resume 0
                           --schedule "09/23 14:15"
 --search search           query in KEY=VALUE format
 -s, --size x=size,y=size  Change the size of selected columns. For example:
                           $ onevm list --size "name=20" will make column
                           name size 20.
 -s, --snapshot snapshot   ID of the Snapshot to save.
 --spice                   Add spice server to the VM
 --spice-keymap keymap     spice keyboard layout
 --spice-listen ip         spice IP where to listen for connections. By
                           default is 0.0.0.0 (all interfaces).
 --spice-password password spice password
 --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.
 --ssh-options options     SSH options to use
 --startscript [file]      Start script to be executed
 --success                 Recover a VM by succeeding the pending action
 -t, --target target       Device where the image will be attached
 -t, --type type           Type of the new Image
 --use                     lock use actions
 --user name               User name used to connect to OpenNebula
 --user-inputs ui1,ui2,ui3 Specify the user inputs values when instantiating
 --vcenter_vm_folder path  In a vCenter environment sets the the VMs and
                           Template folder where the VM will be placed in.
                           The path uses slashes to separate folders. For
                           example: --vcenter_vm_folder "/Management/VMs"
 --vcpu vcpu               Number of virtualized CPUs
 -v, --verbose             Verbose mode
 -V, --version             Show version and copyright information
 --vnc                     Add VNC server to the VM
 --vnc-keymap keymap       VNC keyboard layout
 --vnc-listen ip           VNC IP where to listen for connections. By
                           default is 0.0.0.0 (all interfaces).
 --vnc-password password   VNC password
 --weekly days             Repeats the schedule action the days of the week
                           specified, it can be a number between 0,6
                           separated with commas.For example: onevm resume
                           0 --schedule "09/23 14:15" --weekly 0,2,4
 -x, --xml                 Show the resource in xml format
 -y, --yaml                Show the resource in YAML format
 --yearly days             Repeats the schedule action the days of the year
                           specified, it can be a number between 0,365
                           separated with commas.For example: onevm resume
                           0 --schedule "09/23 14:15" --yearly 30,60

COMMANDS

ARGUMENT FORMATS

VERSION

OpenNebula 6.0.0.3 Copyright 2002-2021, OpenNebula Project, OpenNebula Systems

  1. November 2021
  2. onevm(1)