{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This section describes the VSS Command Line Interface in detail.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Help"},"legacyAnchorId":{"value":"Use-Help"}},"macroMetadata":{"macroId":{"value":"b4aa19bd-71fe-47e5-9eb9-978111975f62"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Help"},"legacyAnchorId":{"value":"Use-Use-Help"}},"macroMetadata":{"macroId":{"value":"a7469167-b01a-4586-8fb1-d547b0938881"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Help","type":"text"}]},{"type":"paragraph","content":[{"text":"To get help when using the VSS CLI, you can add ","type":"text"},{"text":"--help","type":"text","marks":[{"type":"code"}]},{"text":" option to the end of a command. For example:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --help","type":"text"}]},{"type":"paragraph","content":[{"text":"The following command lists the available sub commands for the ","type":"text"},{"text":"compute","type":"text","marks":[{"type":"code"}]},{"text":" command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute --help","type":"text"}]},{"type":"paragraph","content":[{"text":"Help in sub commands is divided in three main sections: Usage, where the command syntax is shown as well as a brief description; Options and sub commands available with a short help column as shown below:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Usage: vss-cli compute [OPTIONS] COMMAND [ARGS]...\n\n Compute related resources such as virtual machines, networks supported\n operating systems, logical folders, OVA/OVF images, floppy images, ISO\n images and more.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n domain List compute domains.\n floppy Manage floppy images.\n folder Manage logical folders\n image Manage personal and list public VM images.\n inventory Manage inventory reports\n iso Manage ISO images.\n net List available virtual networks\n os Supported OS.\n template List virtual machine templates\n vm Manage virtual machines","type":"text"}]},{"type":"paragraph","content":[{"text":"For instance, the ","type":"text"},{"text":"vss-cli compute vm ls","type":"text","marks":[{"type":"code"}]},{"text":" command, is used to list your virtual machines hosted in the ITS Private Cloud, has the following usage:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Usage: vss-cli compute vm ls [OPTIONS]\n\n List virtual machine instances.\n\n Filter and sort list by any attribute. For example:\n\n vss-cli compute vm ls -f name=vm-name -f version=13\n\n Simple name filtering:\n\n vss-cli compute vm ls -f name=%vm-name% -s name desc\n\nOptions:\n -f, --filter-by ... filter list by \n ,\n -a, --show-all show all results [default: False]\n -p, --page page results in a less-like format\n -s, --sort ... sort by \n -c, --count INTEGER size of results\n --help Show this message and exit.","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of how to use filters and display virtual machine summary is shown below:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm ls -f name=%VM% -s name=desc\n\nmoref name folder.path cpu_count memory_gb power_state ip_address\n------- -------------------- ------------------------------------------------ ----------- ----------- ------------- ------------\nvm-1274 1910T-TestVM1 VSS > Development 1 2 poweredOff\nvm-1270 1910T-TestVM2 VSS > Development 1 2 poweredOff\nvm-1258 1910T-TestVM3 VSS > Development 1 1 poweredOff","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Command-Structure"},"legacyAnchorId":{"value":"Use-Command-Structure"}},"macroMetadata":{"macroId":{"value":"f4c09c70-2fef-4af4-a818-f13732b3886f"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Command-Structure"},"legacyAnchorId":{"value":"Use-Use-Command-Structure"}},"macroMetadata":{"macroId":{"value":"5242491d-4084-4e4b-b491-61e7f6f0f0e7"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Command Structure","type":"text"}]},{"type":"paragraph","content":[{"text":"The VSS CLI command structure is compose by the base ","type":"text"},{"text":"vss-cli","type":"text","marks":[{"type":"code"}]},{"text":" command followed by options, subgroups, sub-commands, options and arguments.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli [OPTIONS] COMMAND [ARGS]...","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters take different types of input values such as numbers, strings, lists, tuples, and JSON data structures as strings.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Parameter-Values"},"legacyAnchorId":{"value":"Use-Parameter-Values"}},"macroMetadata":{"macroId":{"value":"6c51c01a-68ce-4e68-b6bf-cbcfa0d38d0d"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Parameter-Values"},"legacyAnchorId":{"value":"Use-Use-Parameter-Values"}},"macroMetadata":{"macroId":{"value":"bd24daa1-ab0d-4de2-95e6-3eed6ed7a5b2"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Parameter Values","type":"text"}]},{"type":"paragraph","content":[{"text":"VSS CLI options vary from simple string, boolean or numeric values to JSON data structures as input parameters on the command line.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Common"},"legacyAnchorId":{"value":"Use-Common"}},"macroMetadata":{"macroId":{"value":"ed183765-c8ee-441a-93d4-e4c58951e1ed"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Common"},"legacyAnchorId":{"value":"Use-Use-Common"}},"macroMetadata":{"macroId":{"value":"003dab04-0784-4336-bf6e-9cc4875ffd24"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Common","type":"text"}]},{"type":"paragraph","content":[{"text":"String","type":"text","marks":[{"type":"strong"}]},{"text":" parameters can contain alphanumeric characters and spaces surrounded by quotes. The following example renames a virtual machine:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm set vm-123 name 'VM-New'","type":"text"}]},{"type":"paragraph","content":[{"text":"Or this can be done by using the VM name instead as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm set TEST name VM-New","type":"text"}]},{"type":"paragraph","content":[{"text":"If there’s more than one virtual machine with “TEST” in their name, you will be prompted to select which one you want to change:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Found 5 matches. Please select one:\n\n=> (vm-1270) VSS > Development > 1910T-TestVM1\n (vm-1258) VSS > Development > 1910T-TestVM2\n (vm-1274) VSS > Development > 1910T-TestVM3","type":"text"}]},{"type":"paragraph","content":[{"text":"Once, selected the change will be processed.","type":"text"}]},{"type":"paragraph","content":[{"text":"Timestamp","type":"text","marks":[{"type":"strong"}]},{"text":" is widely used in any ","type":"text"},{"text":"vm set","type":"text","marks":[{"type":"code"}]},{"text":" command to schedule ","type":"text"},{"text":"--schedule","type":"text","marks":[{"type":"code"}]},{"text":" a change or in ","type":"text"},{"text":"vm mk snapshot","type":"text","marks":[{"type":"code"}]},{"text":" to define the start date ","type":"text"},{"text":"--from","type":"text","marks":[{"type":"code"}]},{"text":" of the snapshot. Timestamps are formatted ","type":"text"},{"text":"YYYY-MM-DD HH:MM","type":"text","marks":[{"type":"code"}]},{"text":". In the next example, a virtual machine consolidation task has been submitted to run at ","type":"text"},{"text":"2017-03-10 21:00","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm set --schedule '2017-03-10 21:00' vm-123 consolidate","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists are implemented in arguments and options. In arguments list are generally series of strings separated by spaces. The below command shows how to delete two virtual machines in a single line:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm rm vm-123 vm-234","type":"text"}]},{"type":"paragraph","content":[{"text":"Multiple options are taken as lists. For instance, in order to specify multiple disks when deploying a virtual machine, multiple occurrences of ","type":"text"},{"text":"--disk","type":"text","marks":[{"type":"code"}]},{"text":" should be specified as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm mk from-template --power-on --source TestVM1 \\\n --description 'New virtual machine' --disk 40 --disk 20 --disk 30 VM2","type":"text"}]},{"type":"paragraph","content":[{"text":"Boolean is a binary flag that turns an option on or off, such is the case of a virtual machine marked as template by using the ","type":"text"},{"text":"--on","type":"text","marks":[{"type":"code"}]},{"text":" flag or template marked as virtual machine by not specifying the flag.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm set TestVM3 template --on","type":"text"}]},{"type":"paragraph","content":[{"text":"Integers","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm set TestVM2 memory size 1","type":"text"}]},{"type":"paragraph","content":[{"text":"Binary objects are handled by passing a relative or full path to the object to process. When uploading a file to VSKEY-STOR, a path should be passed as argument as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss stor ul ~/Downloads/50123e0d-6c74-0c6f-a65a-3704dd1ec619-ud.iso -d isos","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"JSON","type":"text"}]},{"type":"paragraph","content":[{"text":"Some VSS CLI options and arguments require data to be formatted as JSON, such as reconfiguring a virtual machine guest operating system specification (hostname, domain, dns, ip, subnet and gateway) upon deployment. The option ","type":"text"},{"text":"--custom-spec","type":"text","marks":[{"type":"code"}]},{"text":" expects the following JSON data structure:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"dhcp\": false,\n \"ip\": \"192.168.1.23\",\n \"gateway\": [\"192.168.1.1\"],\n \"dns\": [\"192.168.1.1\"],\n \"hostname\": \"vm1\",\n \"domain\": \"utoronto.ca\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Passing above JSON data structure to ","type":"text"},{"text":"--custom-spec","type":"text","marks":[{"type":"code"}]},{"text":" in Linux, macOS, or Unix and Windows PowerShell use the single quote ","type":"text"},{"text":"'","type":"text","marks":[{"type":"code"}]},{"text":" to enclose it.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm mk from-template --source TestVM3 --power-on \\\n --description 'New virtual machine' \\\n --custom-spec '{\"dhcp\": false, \"ip\": \"192.168.1.23\", \"gateway\": [\"192.168.1.1\"],\n \"dns\": [\"192.168.1.1\"], \"hostname\": \"vm1\", \"domain\": \"utoronto.ca\"}' VM1","type":"text"}]},{"type":"paragraph","content":[{"text":"On the Windows command prompt, use the double quote ","type":"text"},{"text":"\"","type":"text","marks":[{"type":"code"}]},{"text":" to enclose the data structure and escape the double quotes from the data structure using the backslash ","type":"text"},{"text":"\\","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute vm mk from-template --source FrontEnd-1 \\\n --description 'New virtual machine' \\\n --custom-spec \"{\\\"dhcp\\\": false, \\\"ip\\\": \\\"192.168.1.23\\\", \\\"gateway\\\": [\\\"192.168.1.1\\\"],\n \\\"dns\\\": [\\\"192.168.1.1\\\"], \\\"hostname\\\": \\\"vm1\\\", \\\"domain\\\": \\\"utoronto.ca\\\"}\" VM1","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Command-Output"},"legacyAnchorId":{"value":"Use-Command-Output"}},"macroMetadata":{"macroId":{"value":"6dbbb6e4-2aa9-4a8d-aae0-8d1e82e14b08"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Command-Output"},"legacyAnchorId":{"value":"Use-Use-Command-Output"}},"macroMetadata":{"macroId":{"value":"30433ce6-c935-4317-b8f6-d65323700f4f"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Command Output","type":"text"}]},{"type":"paragraph","content":[{"text":"The VSS CLI supports the following formats:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Table (table)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"JSON (json)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"YAML (yaml)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NDJSON (ndjson)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"auto (table)","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"By default VSS CLI output is ","type":"text"},{"text":"table","type":"text","marks":[{"type":"code"}]},{"text":", and this can be configured either by the output option:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --output json","type":"text"}]},{"type":"paragraph","content":[{"text":"Or the ","type":"text"},{"text":"VSS_OUTPUT","type":"text","marks":[{"type":"code"}]},{"text":" environment variable:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"export VSS_OUTPUT=json","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Environment variable ","type":"text"},{"text":"VSS_OUTPUT","type":"text","marks":[{"type":"code"}]},{"text":" always overrides any value set in the ","type":"text"},{"text":"-o/--output","type":"text","marks":[{"type":"code"}]},{"text":" option.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Table"},"legacyAnchorId":{"value":"Use-Table"}},"macroMetadata":{"macroId":{"value":"61245f44-ba0d-4dc9-b429-396eca62c64b"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Table"},"legacyAnchorId":{"value":"Use-Use-Table"}},"macroMetadata":{"macroId":{"value":"7a2e39c1-f22e-42ea-8856-8b81d29befa3"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Table","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"table","type":"text","marks":[{"type":"code"}]},{"text":" format presents the VSS CLI output into tab-delimited lines, helpful when using ","type":"text"},{"text":"grep","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"sed","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"awk","type":"text","marks":[{"type":"code"}]},{"text":" on Unix or Windows PowerShell.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --table-format=rst compute vm ls -f name=%VM% -s name=desc\n\n======= ==================== ================================================ =========== =========== ============= ============\nmoref name folder.path cpu_count memory_gb power_state ip_address\n======= ==================== ================================================ =========== =========== ============= ============\nvm-1274 1910T-TestVM1 VSS > Development 1 2 poweredOff\nvm-1270 1910T-TestVM2 VSS > Development 1 2 poweredOff\nvm-1258 1910T-TestVM3 VSS > Development 1 1 poweredOff\n======= ==================== ================================================ =========== =========== ============= ============","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also control the data shown with ","type":"text"},{"text":"--columns","type":"text","marks":[{"type":"code"}]},{"text":" providing a name and a ","type":"text"},{"text":"jsonpath","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If you for example just wanted the ","type":"text"},{"text":"UUID","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"NAME","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"PROVISIONED GB","type":"text","marks":[{"type":"strong"}]},{"text":" per virtual machines, you could do:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --columns=moref,name,gb=provisioned_gb compute vm ls -f name=VM\n\nmoref name gb\n------- -------------------- -----\nvm-1270 1910T-TestVM1 22.19\nvm-1258 1910T-TestVM2 21.19\nvm-1274 1910T-TestVM3 2.19","type":"text"}]},{"type":"paragraph","content":[{"text":"The option ","type":"text"},{"text":"--columns-width","type":"text","marks":[{"type":"code"}]},{"text":" allows you to set a maximum column width for a given output:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --columns-width 0 compute vm ls -f name=VM\n\nmoref name folder.path cpu_count memory_gb power_state ip_address\n------- -------------- -------------- ----------- ----------- ------------- ------------\nvm-1270 1910T-TestVM-… VSS > Develop… 1 2 poweredOff\nvm-1258 1910T-TestVM-… VSS > Develop… 1 1 poweredOff\nvm-1274 1910T-TestVM-… VSS > Develop… 1 2 poweredOff","type":"text"}]},{"type":"paragraph","content":[{"text":"--columns-width","type":"text","marks":[{"type":"code"}]},{"text":" can be set to ","type":"text"},{"text":"0","type":"text","marks":[{"type":"em"}]},{"text":" in order to let the ","type":"text"},{"text":"vss-cli","type":"text","marks":[{"type":"code"}]},{"text":" to calculate the proper column size based on your terminal:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --columns-width 18 compute vm ls -f name=VM\n\nmoref name folder.path cpu_count memory_gb power_state ip_address\n------- ------------------ ------------------ ----------- ----------- ------------- ------------\nvm-1017 1908Q-VM-2 ITS > EIS > Data … 1 1 poweredOff\nvm-1270 1910T-TestVM1 VSS > Development 1 2 poweredOff\nvm-1258 1910T-TestVM2 VSS > Development 1 1 poweredOff\nvm-1274 1910T-TestVM3 VSS > Development 1 2 poweredOff","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"JSON","type":"text"}]},{"type":"paragraph","content":[{"text":"Many languages can easily decode JSON structures using built-in modules or open source libraries. The VSS CLI can provide the output in ","type":"text"},{"text":"json","type":"text","marks":[{"type":"code"}]},{"text":" so it can be easily processed by other scripts or JSON processors such as ","type":"text"},{"text":"jq","type":"text","marks":[{"type":"link","attrs":{"href":"https://stedolan.github.io/jq/"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss --output=json compute vm ls\n[\n {\n \"moref\": \"vm-1270\",\n \"name\": \"1910T-TestVM1\",\n \"provisioned_gb\": 2.18,\n \"tools_running_status\": \"guestToolsNotRunning\",\n \"tools_version\": \"0\",\n \"tools_version_status\": \"guestToolsNotInstalled\",\n \"uncommitted_bytes\": 2338168320,\n \"unshared_bytes\": 996,\n \"updated_on\": \"2020-04-21 Tue 02:10:03 EDT\",\n \"uuid\": \"5030f8d5-fa01-8eff-bb21-8d1ee7e6c230\",\n \"version\": \"vmx-15\"\n ...\n }\n]","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"YAML"},"legacyAnchorId":{"value":"Use-YAML"}},"macroMetadata":{"macroId":{"value":"a302880a-96b5-47e1-916a-9ee608a374ae"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-YAML"},"legacyAnchorId":{"value":"Use-Use-YAML"}},"macroMetadata":{"macroId":{"value":"561272db-ed6e-46e5-b13a-0100a265e33c"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"YAML","type":"text"}]},{"type":"paragraph","content":[{"text":"As with JSON, YAML can be easily decoded by many programming languages. The VSS CLI can provide the ","type":"text"},{"text":"yaml","type":"text","marks":[{"type":"code"}]},{"text":" output as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" vss-cli --output=yaml compute vm ls -f name=%TEST% -s name desc\n\n- moref: vm-2173\n name: 2004P-test-vm-centos\n provisioned_gb: 2.18\n tools_running_status: guestToolsNotRunning\n tools_version: '0'\n tools_version_status: guestToolsNotInstalled\n uncommitted_bytes: 2338168320\n unshared_bytes: 996\n updated_on: 2020-04-21 Tue 02:10:03 EDT\n uuid: 5030f8d5-fa01-8eff-bb21-8d1ee7e6c230\n version: vmx-15","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Auto-completion"},"legacyAnchorId":{"value":"Use-Auto-completion"}},"macroMetadata":{"macroId":{"value":"f814e92f-dc27-44d8-b46c-7c42fcaa5eb6"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Auto-completion"},"legacyAnchorId":{"value":"Use-Use-Auto-completion"}},"macroMetadata":{"macroId":{"value":"2ea4363e-e4a1-47bb-aeb2-30d3cac79dfb"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Auto-completion","type":"text"}]},{"type":"paragraph","content":[{"text":"Bash completion support is provided by [Click][Click] and will complete sub commands and parameters. Sub commands are always listed whereas parameters only if at least a dash has been provided. Example:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute \naccount compute configure request stor token\n\nvss-cli -\n--config --no-verbose --output --verbose --version -c -o","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Source-File"},"legacyAnchorId":{"value":"Use-Source-File"}},"macroMetadata":{"macroId":{"value":"6425cb7d-239f-43c2-9ada-fe0fc29a439d"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Source-File"},"legacyAnchorId":{"value":"Use-Use-Source-File"}},"macroMetadata":{"macroId":{"value":"6f56780f-e75b-427c-a425-5b0220a63e48"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Source File","type":"text"}]},{"type":"paragraph","content":[{"text":"To activate completion in ","type":"text"},{"text":"bash","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"zsh","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"fish","type":"text","marks":[{"type":"code"}]},{"text":" is recommended to use a generated script and source it to ensure responsiveness:","type":"text"}]},{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"bash","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"Save the script somewhere.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"_VSS_CLI_COMPLETE=bash_source vss-cli > ~/.vss-cli-complete.bash","type":"text"}]},{"type":"paragraph","content":[{"text":"Source the file in ","type":"text"},{"text":"~/.bashrc","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":". ~/.vss-cli-complete.bash","type":"text"}]},{"type":"paragraph","content":[{"text":"After modifying the shell config, you need to start a new shell in order for the changes to be loaded or source the file ","type":"text"},{"text":". ~/.vss-cli-complete.bash","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"zsh","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"Save the script somewhere.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"_VSS_CLI_COMPLETE=zsh_source vss-cli > ~/.vss-cli-complete.zsh","type":"text"}]},{"type":"paragraph","content":[{"text":"Source the file in ","type":"text"},{"text":"~/.zshrc","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":". ~/.vss-cli-complete.zsh","type":"text"}]},{"type":"paragraph","content":[{"text":"After modifying the shell config, you need to start a new shell in order for the changes to be loaded or source the file ","type":"text"},{"text":". ~/.vss-cli-complete.zsh","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"fish","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"Save the script to ","type":"text"},{"text":"~/.config/fish/completions/vss-cli.fish:","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"codeBlock","attrs":{"language":"none"},"content":[{"text":"_VSS_CLI_COMPLETE=fish_source vss-cli > ~/.config/fish/completions/vss-cli.fish","type":"text"}]},{"type":"paragraph","content":[{"text":"After modifying the shell config, you need to start a new shell in order for the changes to be loaded.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Source"},"legacyAnchorId":{"value":"Use-Source"}},"macroMetadata":{"macroId":{"value":"a4b721bb-fb7c-4e02-aa14-2341c9d28086"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Source"},"legacyAnchorId":{"value":"Use-Use-Source"}},"macroMetadata":{"macroId":{"value":"cbf897ed-d7e3-4bb6-b162-adeece2e9e69"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Source","type":"text"}]},{"type":"paragraph","content":[{"text":"However, there’s also a non-persistent method:","type":"text"}]},{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"bash","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"source <(vss-cli completion bash)","type":"text"}]},{"type":"paragraph","content":[{"text":"For ","type":"text"},{"text":"zsh","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"source <(vss-cli completion zsh)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Shell"},"legacyAnchorId":{"value":"Use-Shell"}},"macroMetadata":{"macroId":{"value":"7a75a74f-209a-43ce-9e53-bb05414efc71"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Use-Shell"},"legacyAnchorId":{"value":"Use-Use-Shell"}},"macroMetadata":{"macroId":{"value":"8af09a9e-fee1-4aea-9257-617ccb2ac3aa"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Shell","type":"text"}]},{"type":"paragraph","content":[{"text":"The VSS CLI provides a REPL interactive shell with tab-completion, suggestions and command history.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Usage: vss-cli shell [OPTIONS]\n\n REPL interactive shell\n\nOptions:\n -i, --history TEXT File path to save history\n --help Show this message and exit.","type":"text"}]},{"type":"paragraph","content":[{"text":"To enter the shell just execute ","type":"text"},{"text":"vss-cli shell","type":"text","marks":[{"type":"code"}]},{"text":" and you will get the following welcome message:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" __ _____ ___\n \\ \\ / / __/ __| API Endpoint: https://vss-api.eis.utoronto.ca/v2\n \\ V /\\__ \\__ \\ Tab-completion & suggestions\n \\_/ |___/___/ Prefix external commands with \"!\"\n CLI v2021.5.2 History is saved: /Users/vss/.vss-cli/history\n\n Exit shell with :exit, :q, :quit, ctrl+d\n\nvss (vss-api) >","type":"text"}]},{"type":"paragraph","content":[{"text":"Every VSS CLI command, option and argument is available in the shell context. Just exclude the ","type":"text"},{"text":"vss-cli","type":"text","marks":[{"type":"code"}]},{"text":" command, for instance:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss (vss-api) > --columns=moref,name compute vm ls -f name=VM\n\nmoref name\n------- ---------------\nvm-1270 1910T-TestVM1\nvm-1258 1910T-TestVM2\nvm-1274 1910T-TestVM3","type":"text"}]}],"version":1}

Browser not supported