VSS Command Line Interface v0.2.2


VSSCLI v0.2.2 is available for download via PyPI or GitLab. Latest version includes the following improvements: 

Improvements

  • If you happen to be experiencing any errors with the VSS CLI, you can now turn debug with the -d/--debug flag or set the VSS_API_DEBUG environment variable

    vss --debug compute vm ls
    vss --debug compute vm ls
    # or
    export VSS_API_DEBUG=1
    vss compute vm ls
  • Network can be sorted and filtered by name, moref, description, subnet or any other attribute shown in the interface:

    vss compute net ls
      List available virtual networks.
    
      Filter by path or name name=<name> or moref=<moref>. For example:
    
          vss compute net ls -f name public
    
    Options:
      -f, --filter <TEXT TEXT>...  filter list by name or moref
      -s, --sort TEXT              sort by name or moref.attributes.
      -p, --page                   page results in a less-like format
      -n, --no-header              hide header
      -q, --quiet                  display only uuid
      --help                       Show this message and exit.
    
    
  • Folder can be sorted and filtered by name, moref or path or any other attribute shown in the interface:

    vss compute folder ls
    Usage: vss compute folder ls [OPTIONS]
    
      List logical folders.
    
      Filter by path or name name=<name>, moref=<moref>, parent=<parent>. For
      example:
    
          vss compute folder ls -f name Project
    
    Options:
      -f, --filter <TEXT TEXT>...  filter list by name, moref or parent
      -s, --sort TEXT              sort by name or moref.attributes.
      -p, --page                   page results in a less-like format
      -n, --no-header              hide header
      -q, --quiet                  display only morefs
      --help                       Show this message and exit.
    
    
    

New Features

  • ISO, Floppy and OVA/OVF virtual machine images have been separated in Public and Personal space. Personal space images are added by users to https://vskey-stor.eis.utoronto.ca via the web ui or directly with the VSS CLI. 

    vss compute iso
    vss compute iso
    Usage: vss compute iso [OPTIONS] COMMAND [ARGS]...
    
      Available ISO images in both the VSS central store and your personal
      VSKEY-STOR space.
    
    Options:
      --help  Show this message and exit.
    
    Commands:
      personal  Browse current user images
      public    Browse public images
    
    
    
  • List public available images by using vss compute iso public. List can be filtered and sorted by name or path.

    vss compute iso public ls
    vss compute iso public ls -f name like,Cent% -s name desc
  • However, if you have an ISO not listed in the Public datastore, it can be uploaded by logging in to https://vskey-stor.eis.utoronto.ca and then submit a sync request as follows:

    vss compute iso personal sync
    vss compute iso personal sync
  • Manage your Synchronization requests with vss request image-sync ls|get

    vss request image-sync ls
    vss request image-sync ls
      id  created_on               updated_on               status     type
    ----  -----------------------  -----------------------  ---------  ------
       4  2017-11-17 14:44:44 EST  2017-11-17 14:44:45 EST  Submitted  VM
       5  2017-11-17 14:44:50 EST  2017-11-17 14:44:51 EST  Submitted  Floppy
       6  2017-11-17 14:44:54 EST  2017-11-17 14:44:55 EST  Submitted  Iso
       7  2017-11-20 09:57:10 EST  2017-11-20 09:57:11 EST  Submitted  Iso
    
    
    
  • Once the Image Synchronization Request has been processed, you should be able to see the ISO in your personal space and ready to use:

    vss compute vm ls
    vss compute iso personal ls
    path                                                                         name
    ---------------------------------------------------------------------------  -------------------------------------------
    [vssUser-xfers] jm/isos/debian-live-8.5.0-amd64-gnome-desktop.iso            debian-live-8.5.0-amd64-gnome-desktop.iso
    
    
  • Listing public  ISOsFloppies or Images can be sorted now by name or path.

Remember, VSSCLI documentation is now available in EIS - VSS - VSSCLI

Upgrade or install PyVSS as follows:

# upgrade
pip install vsscli --upgrade

# install
pip install vsscli

Docker images available: uofteis/vsscli:py27:

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.