Package: vsscli
Warning: this project has been deprecatedIf you are runningvsscliv0.5.x we strongly suggest using the newvss-cliavailable atVSS-Cli. For more information
see the followingAnnouncement.ITS Private Cloud Command Line InterfaceThis package provides a unified command line interface to the ITS Private Cloud.DocumentationPackage documentation is now available atdocs.InstallationWindows users, download and installPython Releases for Windowsprior runningpip.The fastest way to install VSS CLI is to usepip:pipinstallvsscliIf you have the VSS CLI installed and want to upgrade to the latest version
you can run:pipinstall--upgradevsscliThis will install VSS CLI as well as all dependencies. You can also justdownload the tarball.
Once you have thevssclidirectory structure on your workstation, you can just run:cd<path_to_vsscli>
pythonsetup.pyinstallCLI ReleasesThe release notes for the VSS CLI can be foundCHANGELOGin the gitlab repo.Getting StartedBefore using VSS CLI, you need setup your VSS credentials. You can do this in a couple of ways:Environment variablesConfiguration fileThe quickest way to get started is to run thevss configurecommand:vssconfigure
Username[]:
Endpoint[https://vss-api.eis.utoronto.ca]:
Passw
Repeatforconfirmation:To use environment variables, setVSS_API_USERandVSS_API_USER_PASSorVSS_API_TOKEN:exportVSS_API_USER=<vss_user>exportVSS_API_USER_PASS=<vss_user_pass># orexportVSS_API_TOKEN=<vss_api_token>To use a config file, create a configuration as follows:{"https://vss-api.eis.utoronto.ca":{"auth":"<encoded_creds>","token":"<access_token"}}Place it in~/.vss/config.json(or in%UserProfile%\.vss\config.jsonon Windows).
If you place the config file in a different location than~/.vss/config.jsonyou need to inform VSS CLI the full path. Do this by setting
the appropriate environment variable:exportVSS_CONFIG_FILE=/path/to/config_file.jsonOr use the-c/--configoption in thevsscommand as follows:vss-c~/.secret/vss-config.jsonBy default VSS CLI output is text, and this can be configured either by-o/--outputoption or theVSS_DEFAULT_OUTPUTenvironment variable as follows:$exportVSS_DEFAULT_OUTPUT=json# or$exportVSS_DEFAULT_OUTPUT=textJSON Parameter InputVSS CLI options vary from simple string, boolean or numeric values to
JSON data structures as input parameters on the command line.For example, consider the following command to deploy a new virtual
machine from a given template and provide a guest operating system
specification to reconfigure hostname, domain, dns, ip, subnet
and gateway:vsscomputevmmkfrom-template--source$TEMPLATE_UUID\--description'New virtual machine'\--custom-spec'{"hostname": "fe1", "domain": "eis.utoronto.ca", "interfaces": [{"dhcp": true}]}'Where$TEMPLATE_UUIDis an environment variable storing the UUID of
the source template.Bash completionBash completion support is provided byClickand will complete
sub commands and parameters. Subcommands are always listed whereas parameters
only if at least a dash has been provided. Example:vsscompute<TAB><TAB>
accountcomputeconfigurerequeststortoken

vss-<TAB><TAB>
--config--no-verbose--output--verbose--version-c-oActivating Bash completion can be done by executing the following command:eval"$(_VSS_COMPLETE=sourcevss)"The above activation example will always invoke your application on startup
and may slow down the shell activation. VSS-CLI ships with a Bash completion
activation script namedvss_bash_completerwhich can be either loaded manually
or added to yourbasrc:.$(dirname`whichvss`)/vss_bash_completerVSS ShellThe VSS CLI provides a REPL interactive shell with tab-completion, suggestions and
command history.Usage:vssshell[OPTIONS]REPLinteractiveshell.

Options:-i,--historyTEXTFilepathtosavehistory--helpShowthismessageandexit.To enter the shell just executevss shelland you will get the following welcome message:Getting HelpWe use GitLab issues for tracking bugs, enhancements and feature requests.
If it turns out that you may have found a bug, pleaseopen a new issue.VersioningThe API versions are tagged based onSemantic Versioning. Versions available in thetags section.ContributingRefer to theContributing Guidefor details on our code of conduct and the process of
submitting code to the repository.