ITS Private Cloud CLI (vss-cli) Cheat Sheet

1 Global options (account)vss-cli
2 Global options (format) vss-cli
3 Virtual Machine (update): compute vm set {id}
4 Virtual Machine (restore) compute vm res
5 Virtual Machine (deployment) compute vm mk
6 Virtual Machine Snapshot
7 Virtual Machine Folders
8 Virtual Machine Inventory
9 Virtual Machine query: vss-cli {ls|get {id}}
10 Virtual Machine query (advanced): The power of --columns with vss-cli
11 Decommission Virtual Machine
12 Configure
13 Account MFA
14 Account Notifications
15 Account Group Membership
16 OVF/OVA parsing
17 Raw requests
18 Downloadable Cheat Sheet

Global options (account)`vss-cli`

Username	`--username`	`VSS_API_USER` env variable
Password	`--password`	`VSS_API_USER_PASS` env variable.
MFA TOTP Token	`--totp`	If MFA enabled, will be prompted.
Configuration Path	`--config`	Alternative configuration path.

Global options (format) `vss-cli`

Table format to use	`--table-format`	`csv, fancy_grid, github, grid, html, jira...`
Custom columns	`--columns`	Any VM attribute: `moref,name,cpu_count,ip_address`
Truncates column values	`--columns-width`	0: auto, -1: disable
Don't use headers	`--no-headers`	When printing tables
Sort output	`--sort-by`	Sort table by the jsonpath expression.
Output	`--output`	`json\|yaml\|table\|auto\|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: https://eis-vss.atlassian.net/wiki/spaces/VSSPublic/pages/1406042121

Fetch VM restore Points

Fetch VM restore Points
Submit Restore

Virtual Machine (deployment) `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: --retire-type {timedelta|datetime} : Retirement request type. --retire-warning {n} : Days before retirement date to notify. --retire-value {hours},{days},{months}: 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 `--columns` with `vss-cli`

Look for a VM by IP address

List including storage type and preferences

Decommission Virtual Machine

Show VM info before decommissioning

Configure

Initialize
List
Set

Default configuration file is available at

Account MFA

Enable MFA
Disable MFA
Verify

Account Notifications

Format
Filter
Method

Account Group Membership

Get Group membership
Get group details
Get group members

OVF/OVA parsing

Get Deployment Option parameters
Generate additional-params spec
Get Property parameters

Raw requests

For example:

Global options (account)vss-cli

Global options (format) vss-cli

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

Virtual Machine (restore) compute vm res

Virtual Machine (deplo­yment) compute vm mk