| Description | Command |
|---|---|
| Check VCO authentication | vco login isauthenticated |
| Login to VCO with Username and Keyfile | vco login keyfile |
| Login to VCO with Username and Password | vco login userpass |
| Logout from vCO and optionally delete the persistent session if being used currently. | vco logout |
| Get details about a workflow | vco workflow detail |
| VCO Http GET Request | vco workflow http get |
| List all workflows | vco workflow list |
| Start a Workflow | vco workflow request |
Check VCO authentication |
| vco login isauthenticated |
| Parameter | --export (Export to File) |
| Mandatory | false |
| Parameter | --format (Format the response in either Tabular format (default), JSON or CSV) |
| Mandatory | false |
Login to VCO with Username and Keyfile |
| vco login keyfile |
| Parameter | --server (Server Name) |
| Mandatory | true |
| Parameter | --user (User) |
| Mandatory | false |
| Parameter | --keyfile (Encrypted Keyfile) |
| Mandatory | true |
| Parameter | --export (Export to File) |
| Mandatory | false |
| Parameter | --format (Format the response in either Tabular format (default), JSON or CSV) |
| Mandatory | false |
Login to VCO with Username and Password |
| vco login userpass |
| Parameter | --server (vCO Server (IP or hostname)) |
| Mandatory | false |
| Parameter | --user (vCO Username) |
| Mandatory | false |
| Parameter | --password (vCO Password. If left unspecified, you will be prompted to enter it securely) |
| Mandatory | false |
| Parameter | --export (Export to File) |
| Mandatory | false |
| Parameter | --format (Format the response in either Tabular format (default), JSON or CSV) |
| Mandatory | false |
Logout from vCO and optionally delete the persistent session if being used currently. |
| vco logout |
| Parameter | --retainSessionFile (To retain the session file or not [Yes or No]) |
| Mandatory | false |
Get details about a workflow |
| vco workflow detail |
| Parameter | --id (Workflow Id) |
| Mandatory | true |
| Parameter | --requestfile (Export corectly formatted JSON data to a file so that it can be used to request) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
VCO Http GET Request |
| vco workflow http get |
| Parameter | --url (Workflow Id) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
List all workflows |
| vco workflow list |
| Parameter | --name (If provided, this value filters (case-insensitive) the results to only include workflows matching on the 'name' field) |
| Mandatory | false |
| Parameter | --page (Enter page number to display in pagination (default 1)) |
| Mandatory | false |
| Parameter | --pageSize (Enter page size to display in pagination (default 25, maximum 5000)) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
Start a Workflow |
| vco workflow request |
| Parameter | --id (Workflow Id) |
| Mandatory | true |
| Parameter | --inputs (Semicolon seperated workflow inputs, requires requestfile property. Example: Name=User1;Age=30) |
| Mandatory | false |
| Parameter | --requestfile (Provide corectly formatted JSON data so that it can be used to create the request) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Copyright 2019 VMware, Inc. All rights reserved.