VSS Command Line Interface v0.5.0

VSSCLI v0.5.0 is available for download via PyPI or GitLab. Latest version includes the following improvements and bug fixes:

• Improvements

  • New command to execute OS commands through the API: vss compute vm set guest-cmd 

    Usage: vss compute vm set guest-cmd [OPTIONS] CMD CMD_ARGS
    
      Execute a command in the Guest Operating system.
    
      vss compute vm set <uuid> guest-cmd "/bin/echo" "Hello > /tmp/hello.txt"
    
      Note: VMware Tools must be installed and running.
    
    Options:
      -u, --username TEXT  Guest Operating System username or via environment
                           variable VSS_CMD_USER
      -p, --password TEXT  Guest Operating System username password or via
                           environment variable VSS_CMD_USER_PASS
      -e, --env TEXT       Environment variables in KEY=value format.
      --help               Show this message and exit.

  • New command to get virtual machine controllers vss compute vm get controller

    vss compute vm get <uuid> controller
    Uuid                : <uuid>
    Scsi Count          : 1

  • New command to get virtual machine SCSI controllers: vss compute vm get controller scsi

    vss compute vm get <uuid> controller scsi
    Uuid                : <uuid>
    Label               : SCSI controller 0
    Bus Number          : 0
    Type                : VirtualLsiLogicController

  • New option in command vss compute vm set --user-meta to store metadata in a given change request.

    Usage: vss compute vm set [OPTIONS] UUID COMMAND [ARGS]...
    
      Set given virtual machine attribute such as cpu, memory, disk, network
      backing, cd, etc.
    
    Options:
      -s, --schedule TEXT   Schedule change in a given point in time based
                            on format YYYY-MM-DD HH:MM.
      -u, --user-meta TEXT  User metadata in key=value format. These tags are
                            stored in the request.
      --help                Show this message and exit.
    
    
    ...

  • New option in command vss compute vm mk --user-meta to store metadata in given new vm deployment. 

    Usage: vss compute vm mk [OPTIONS] COMMAND [ARGS]...
    
      Create virtual machine from different methods. i.e.
    
      vss compute vm mk from-file vm_spec.json
    
    Options:
      -u, --user-meta TEXT  User metadata in key=value format. These tags are
                            stored in the request.
      --help                Show this message and exit.
    
    ...

Upgrade or install PyVSS as follows:

# using vsscli
vss upgrade

# upgrade with pip
pip install vsscli --upgrade

# install
pip install vsscli

Docker images available: uofteis/vsscli:py2 and uofteis/vsscli:py3:

docker run -it -v /tmp:/data \
-e VSS_API_USER=user_here -e VSS_API_USER_PASS=user_pass_here \
-e VSS_DEFAULT_OUTPUT=json \
uofteis/vsscli bash

For more information, please refer to the official documentation site.