Skip to content
On this page

saya vm run

Run a VM

Synopsis

Run a VM

saya vm run [options] image [COMMAND [ARG ...]]

Examples


- Run a vm with default settings (e.g. in background, screen off, etc.)
  saya vm run webserver:v1 --name=server1

- Run a VM in foreground
# you can use ctrl+c to exit the vm
  saya vm run webserver:v1 --name=server1-attached --attached  

- Run a VM with screen on
  # <<screen on>> means having a compute dependent GUI started. It can be used to access the VM. <<screen-mode>> and <<attached-mode>> are orthogonal.
  saya vm run webserver:v1 --compute-type qemu --name=server2 --platform linux/arm64 --ssh-user saya2 --ssh-password saya2 --screen on


Options

      --attached                            --attached, Run the VM in foreground and attach command output to the host parent process (shell) output
      --compute-type string                 --compute-type virtualbox (default "virtualbox")
      --cpus uint                           --cpus 2
      --creation-policy stringArray         --creation-policy 'type=cloud_init_done_by_phone_cmdb,timeout=PT15M,data='
      --disk-size string                    --mem 512mib'
      --env stringToString                  --env JAVA_HOME=/opt/java/ (default [])
      --export-ssh-key-file string          --export-ssh-key-file ./sut-rsa.pup
      --export-ssh-password-file string     --export-ssh-password-file ./passord.out
  -h, --help                                help for run
      --img-type string                     --img-type ova|vhd|vmdk|qcow2|...
      --label stringToString                --label version=1.0 (default [])
      --mem string                          --mem 512mib'
      --name string                         --name ubuntu-vm-server
      --nic stringArray                     --nic 'type=hostonly, host-nic=vboxnet1, hw=IntelPro100MTServer, mac=00:00:00:00'
      --os-variant string                   --os-variant ubuntu|alpine|debian|...
      --platform string                     --platform linux/arm/v7
      --result-dst string                   --result-dst <new-file-path-to-receive-strutured-vm-run-json-result>
      --screen string                       --screen off for headless mode, or --screen on to get a gui, defaults to off
      --ssh-address string                  --ssh-address 10.10.10.8
      --ssh-do-not-create-user              --ssh-do-not-create-user
      --ssh-key string                      --ssh-key <public-certificate>
      --ssh-key-file string                 --ssh-key-file ./sut-rsa.pub
      --ssh-password string                 --ssh-password supersecret
      --ssh-port uint16                     --ssh-port 22 (default 22)
      --ssh-user string                     --ssh-user saya (default "saya")
      --ssh-user-credential-types strings   --ssh-user-credential-type 'password'
      --vbox-optical-disk strings           --vbox-optical-disk /tmp/mycd.iso
      --vbox-uart stringArray               --vbox-uart 'nr=1,port=0x3F8 4,mode=file /tmp/uartoutput.txt'

Options inherited from parent commands

      --config string        config file (default is .saya.yaml file found in the current working directory or  $HOME/.saya or /etc/saya/.saya.yaml
      --forge string         path of the directory that holds saya runtime data(e.g. local repository, VM data, transient session data, etc)
  -l, --license-key string   license key to use saya
      --log-level string     logging level, error|warn|info|debug|trace (default "info")

SEE ALSO