ITS Private Cloud CLI (vss-cli) Cheat Sheet

Global options (account)vss-cli

Username

--username

VSS_AP­I_USER env variable

Password

--password

VSS_AP­I_U­SER­_PASS env variable.

MFA TOTP Token

--totp

If MFA enabled, will be prompted.

Config­uration Path

--config

Altern­ative config­uration path.

Global options (format) vss-cli

Table format to use

--tabl­e-f­ormat

csv, fancy_­grid, github, grid, html, jira...

Custom columns

--columns

Any VM attribute: 

moref,­nam­e,c­pu_­cou­nt,­ip_­address

Truncates column values

--colu­mns­-width

0: auto, -1: disable

Don't use headers

--no-h­eaders

When printing tables

Sort output

--sort-by

Sort table by the jsonpath expres­sion.

Output

--output

json|y­aml­|ta­ble­|au­to|­ndjson

Virtual Machine (update): compute vm set {id}

CPU

cpu count {n}

Memory

memory size {nGiB}

Disk New (basic)

disk mk -i {nGiB} -i {nGiB}

Power State

Disk New (adv.)

Disk Copy (adv.)

Disk Update

Disk Update (adv.)

Disk Delete

NIC New

NIC new (adv.)

NIC Update Net

NIC Update State

NIC Update Type

NIC Delete

CD/ISO Create

CD/ISO Update

Floppy Create

Floppy Update

Storage Type

Domain

Operating System

Add vTPM

Add vGPU

Enable|Disable VBS

Enable|Disable Secure Boot

FIrmware

Convert to|from template

Administrator

Informational Contacts

Add --wait to global vss-cli and get immediate change request results.

Virtual Machine (restore) compute vm res

More information about Restore Requests available here:

Fetch VM restore Points

Fetch VM restore Points

Submit Restore

Virtual Machine (deplo­yment) compute vm mk

Shell VM

Clone VM or Template

Clone VM (from snapshot)

CLI Spec (existing)

CLI Spec (new)

From Image

Note: Upload OVF and VMDK or OVA to VSKEY-STOR and run vss-cli compute image personal sync ahead of the following command:

Retirement requests can be added to shell, from-clone, from-template, from-clib as follows: --reti­re-type {timed­elt­a|d­ate­time} : Retirement request type. --reti­re-­warning {n} : Days before retirement date to notify. --reti­re-­value {hours­},{­day­s},­{mo­nths}: Value for given retirement type.

Virtual Machine Snapshot

Create now

Create later

List

Revert

Remove

Extend snapshot lifetime

Remember that every change, new vm submission and snapshot request create a unique ID.

Virtual Machine Folders

Create

Rename

Move

Virtual Machine Inventory

Create

Download

 

Virtual Machine query: vss-cli {ls|get {id}}

Search for a vm

Search for vm by name

Get a vm attribute

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

Virtual Machine query (advanced): The power of --col­umns with vss-cli

Look for a VM by IP address

List including storage type and prefer­ences

Decommission Virtual Machine

Show VM info before decommissioning

Configure

Initialize

List

Set

Default config­uration file is available at 

Account MFA

Enable MFA

Disable MFA

Verify

Account Notifi­cations

Format

Filter

Method

Account Group Membership

Get Group membership

Get group details

Get group members

OVF/OVA parsing

Get Deployment Option parameters

Generate additi­ona­l-p­arams spec

Get Property parameters

Raw requests

For example: 

Downloadable Cheat Sheet

 

University of Toronto - Since 1827