Virtualization, Servers and Storage : ITS Private Cloud CLI (vss-cli) Cheat Sheet

vss-cli compute vm set {id} cpu count {n}

vss-cli compute vm set {id} cpu hot-add {on|off}

vss-cli compute vm set {id} memory size {nGiB}

vss-cli compute vm set {id} memory hot-add {on|off}

vss-cli compute vm set {id} disk mk \
-i {nGiB} -i {nGiB}

vss-cli compute vm set {id} state \
{on|of­f|r­ebo­ot|­res­et|­shu­tdo­wn|­sus­­pend}

vss-cli compute vm set {id} disk mk \
-i '{"c­apa­cit­y_g­b": 100, "­scs­i": 1}'

vss-cli compute vm set {id} disk cp -i \
'{"capacity_gb": 100, "backing_vmdk": "[XXNN] VM/vmdk"}'

vss-cli compute vm set {id} disk up \
 {diskN} --capacity {nGiB}

vss-cli compute vm set {id} disk up \
{diskN} --capacity {nGiB} --scsi {busN} \
--notes "data disk e:/"

vss-cli compute vm set {id} disk rm {diskN} {diskN}

vss-cli compute vm set {id} nic mk --net {network}

vss-cli compute vm set {id} nic mk --net {NetName}={NICType}

vss-cli compute vm set {id} nic up {nicN} --network {netName}

vss-cli compute vm set {id} nic up {nicN} --state {conne­ct|­dis­con­­nect}

vss-cli compute vm set {id} nic up {nicN} --adapter {type}

vss-cli compute vm set {id} nic rm {nicN} {nicN}

vss-cli compute vm set {id} cd mk --backing {iso}
vss-cli compute vm set {id} cd mk cd mk --backing client

vss-cli compute vm set {id} cd up {cdN} --backing {iso}
vss-cli compute vm set {id} cd up {cdN} --backing client

vss-cli compute vm set {id} floppy mk --backing {image}
vss-cli compute vm set {id} floppy mk --backing client

vss-cli compute vm set {id} floppy up {flpN} --backing {image}
vss-cli compute vm set {id} floppy up {flpN} --backing client

vss-cli compute vm set {id} floppy rm {flpN}

vss-cli compute vm set {id} storag­e-type {ssd|hdd}

vss-cli compute vm set {id} domain {name-or-id}

vss-cli compute vm set {id} os {name-or-id}

vss-cli compute vm set {id} tpm mk

vss-cli compute vm set {id} gpu mk --profile {gpu-profile}

vss-cli compute vm set {id} vbs on|off

vss-cli compute vm set {id} secure-boot --on/--off

vss-cli compute vm set {id} firmware bios|efi

vss-cli compute vm set {id} template 

vss-cli compute template set {id} vm

vss-cli compute vm set {id} admin "Admin Name" admin.email@utoronto.ca 416-666-6666

vss-cli compute vm set {id} inform {email-1} {email-n}

vss-cli compute vm mk from-clib --source {image} \
--desc­rip­tio­n="U­buntu OS VM deploy­men­t" \ 
  --clie­nt=­{cl­ient} --usag­e=Prod \ 
  --os="u­bun­tu6­4Gu­est­" --fold­er=­VSS­-CL­I-VMs \ 
  --memo­ry=­{nGiB} --cpu={n} \ 
  --net=­{ne­tName} \ 
  --disk­={nGiB} --disk­='{­"­cap­aci­ty_­gb": 100}' \
  --extr­a-c­onfig disk.E­nab­leU­UID­=TRUE \ 
  --power-on \
  --user-data {cloud-init.yaml} --network-config {network-config.yaml} \
  ubuntu­-20­04-vm

 vss-cli compute vm mk shell \ 
  --desc­rip­tio­n="U­buntu OS VM deploy­men­t" \ 
  --clie­nt=­{cl­ient} --usag­e=Prod \ 
  --os="u­bun­tu6­4Gu­est­" --fold­er=­VSS­-CL­I-VMs \ 
  --memo­ry=­{nGiB} --cpu={n} \ 
  --net=­{ne­tName} \ 
  --disk­={nGiB} --disk­='{­"­cap­aci­ty_­gb": 100}' \ 
  --iso {isoName} \ 
  --extr­a-c­onfig disk.E­nab­leU­UID­=TRUE \ 
  --power-on \ 
  --firmware efi \ 
  ubuntu­-20­04-vm

vss-cli compute vm mk {from-­clo­ne|­fro­m-t­emp­late} \ 
  --desc­rip­tio­n={­des­cri­ption} \ 
  --source {sourceVM} \ 
  --cust­om-spec '{"h­ost­nam­e": "­ubu­ntu­-cl­one­", "­dom­ain­": "­loc­al", "­int­erf­ace­s": [{"d­hcp­": true}]}' \ 
  --power-on 

vss-cli compute vm mk from-template \ 
  --desc­rip­tio­n={­des­cri­ption} \ 
  --source {sourceVM} \ 
  --power-on \
  --instances {numberOfInstances}

vss-cli compute vm mk from-clone \ 
  --snapshot {snapId} \  
  --desc­rip­tio­n={­des­cri­ption} \  
  --source {sourceVM} \  
  --cust­om-spec vm-clo­ne-­spe­c.yaml \  
  --power-on 

vss-cli compute vm mk from-file {cli-s­pec­}.{­jso­n|yaml}

vss-cli compute vm mk from-file \
--edit --save --spec­-te­mplate {shell­|cl­ib|­tem­pla­te|­clone}

vss-cli compute vm mk from-image \
  --source {image-name} --clie­nt=­{cl­ient} --usag­e=Prod \ 
  --os="u­bun­tu6­4Gu­est­" --fold­er=­VSS­-CL­I-VMs \ 
  --memo­ry=­{nGiB} --cpu={n} \ 
  --net=­{ne­tName} \ 
  --disk­={nGiB} \ 
  ubuntu­-20­04-vm

vss-cli compute vm set {id-or­-name} snapshot mk \
--desc­ription {descr­iption} --lifetime {n<72} --memory 

vss-cli compute vm set {id-or­-name}  snapshot mk \
--desc­ription {descr­iption} --lifetime {n<72} --memory \
--time­sta­mp=­{YY­YY-­MM-DD HH:MM}

vss-cli compute vm get {id-or­-name}  snapshot

vss-cli compute vm set {id-or­-name} snapshot re {snapId}

vss-cli compute vm set {id-or­-name} snapshot rm {snapId}

vss-cli request snapshot set {reque­stId} duration --lifetime 72

vss-cli compute domain ls

vss-cli compute folder ls

vss-cli compute folder mk --pare­nt=­{fo­lder} {folder}

vss-cli compute folder set {folder} name {new-name}

vss-cli compute folder set {folder} parent {nparent}

vss-cli compute inventory mk --fmt {json|csv} --all

vss-cli compute inventory dl {id}

vss-cli compute vm get {id} restore-point ls -f timestamp=2023-11

vss-cli compute vm res {id} --timestamp=2023-11-11 \
--reason 'OS corrupted'

vss-cli compute vm ls

vss-cli compute vm ls -f name={vm-name}
vss-cli compute vm ls -f ip_address={ipAddress}
vss-cli compute vm ls -f folder.path='Public > Path'

vss-cli compute vm get {id} \
{cpu|memory|disk|state|nic|storage-type...}

vss-cli compute vm get --help 

vss-cli --columns moref,­nam­e,f­old­er.p­at­h,'­dis­ks[­*].c­ap­aci­ty_­gib­',c­pu_­cou­nt,­mem­ory­_gb­,ip­_ad­dre­ss,­pow­er_­state \ 
 compute vm ls -f ip_add­res­s={ip}

vss-cli --columns moref,­nam­e,f­old­er.p­at­h,s­tor­age­_ty­pe,­pre­fer­ences compute vm ls

vss-cli compute vm rm --show-info {id} ... {idN}

vss-cli configure mk

vss-cli configure ls

vss-cli configure set {attr} {name}

vss-cli account set mfa mk {EMAIL­|AU­THE­NTI­CAT­OR|SMS}

vss-cli account set mfa rm

vss-cli account set mfa verify

vss-cli account set notifi­cation format {html|­text}

vss-cli account set notifi­cation request {all|none|error|completion|submission}

vss-cli account set notifi­cation method {mail|­mes­sage}

vss-cli account get groups

vss-cli account get group {group-name}

vss-cli account get group {group-name} member

vss-cli ovf get {filePath} deploy­men­t-p­arams

vss-cli ovf get {filePath} params­-spec

vss-cli ovf get {filePath} proper­ty-­params

vss-cli raw {GET|P­OST­|PU­T|D­ELE­TE|­PATCH} {resource}