Add Approval Policy |
| vra approvalpolicy add |
| Parameter | --name (Enter an Approval Policy Name) |
| Mandatory | true |
| Parameter | --inputfile (Provide input file containing policy, this can be exported from one already created and modified) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Get Approval Policy Details |
| vra approvalpolicy detail |
| Parameter | --id (Provide Approval Policy ID to fetch details) |
| Mandatory | false |
| Parameter | --name (Provide Approval Policy ID or name to fetch details) |
| 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 |
List Approval Policies |
| vra approvalpolicy list |
| 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 |
| 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 |
Remove Approval Policy |
| vra approvalpolicy remove |
| Parameter | --id (Provide Approval Policy ID to be deleted) |
| Mandatory | false |
| Parameter | --name (Provide Approval Policy ID or name to be deleted) |
| Mandatory | false |
| Parameter | --force (Delete approval policy even if it is associated with an active entitlement [Yes or No].) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Import Advanced Service Items from a zip file |
| vra asd import |
| Parameter | --importFile (Provide a file to import ASD content) |
| Mandatory | true |
Validate Advanced Service Items from a zip file |
| vra asd validate |
| Parameter | --importFile (Provide a file to validate ASD content and display its results) |
| Mandatory | true |
Add VSphere Infrastucture Blueprint & Catalog Item |
| vra blueprint add vsphere |
| Parameter | --name (Enter a vSphere Blueprint Name) |
| Mandatory | true |
| Parameter | --id (Enter id for the Blueprint. If not specified, it will be auto-generated.) |
| Mandatory | false |
| Parameter | --cpu (Enter CPU Count) |
| Mandatory | false |
| Parameter | --memory (Enter memory MB) |
| Mandatory | false |
| Parameter | --clonefrom (Override CloneFrom template value) |
| Mandatory | false |
| Parameter | --servicename (Enter Service Name to assign to new CatalogItem) |
| Mandatory | false |
| Parameter | --serviceid (Enter service Id to assign to new CatalogItem) |
| Mandatory | false |
| Parameter | --description (Enter description) |
| Mandatory | false |
| Parameter | --publish (Publish the blueprint - yes or no) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --inputfile (Provide input file, this is a YAML formatted file which you can get by running the command [vcac iaas blueprints detail]) |
| Mandatory | true |
Get vSphere Blueprint |
| vra blueprint detail |
| Parameter | --name (Provide a valid Blueprint name) |
| Mandatory | false |
| Parameter | --id (Provide a valid Blueprint ID) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
List Blueprints |
| vra blueprint list |
| 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 |
| 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 |
Delete vSphere Blueprint |
| vra blueprint remove |
| Parameter | --name (Provide a Blueprint name to be removed) |
| Mandatory | false |
| Parameter | --id (Provide a Blueprint ID to be removed) |
| Mandatory | false |
Import All vSphere templates into Blueprints |
| vra blueprint vsphere importalltemplates |
| Parameter | --servicename (Enter Service Name to assign to new CatalogItem) |
| Mandatory | false |
| Parameter | --serviceid (Enter service Id to assign to new CatalogItem) |
| Mandatory | false |
| Parameter | --image (Enter path for Image file) |
| Mandatory | false |
| Parameter | --media (Enter Media Type of image file [gif, jpeg, png]) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --inputfile (Template blueprint YAML file to use when importing templates. NOTE: CPU, Memory and Storage minimums for all imported blueprints will come from the machine template. All other blueprint details come from this 'inputfile') |
| Mandatory | true |
Add Business Groups |
| vra businessgroup add |
| Parameter | --name (Enter GroupName) |
| Mandatory | true |
| Parameter | --description (Enter description for the business group) |
| Mandatory | false |
| Parameter | --email (Enter Administrator Email) |
| Mandatory | true |
| Parameter | --machinePrefixId (Provide a valid Machine Prefix ID or prefix name) |
| Mandatory | true |
| Parameter | --adContainer (Enter Active Directory Container) |
| Mandatory | true |
| Parameter | --admins (Enter comma separated list of users for Group Manager Role) |
| Mandatory | true |
| Parameter | --support (Enter comma separated list of users for Support Role) |
| Mandatory | false |
| Parameter | --sharedAccessUsers (Enter comma separated list of users for users with shared access Role) |
| Mandatory | false |
| Parameter | --users (Enter comma separated list of users for User Role) |
| Mandatory | false |
Get Business Group Detail |
| vra businessgroup detail |
| Parameter | --id (Provide Business Group ID or name to fetch details) |
| 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 Business Groups |
| vra businessgroup list |
| 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 |
| 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 |
Remove Business Group |
| vra businessgroup remove |
| Parameter | --id (Provide an ID or name of a Group to be removed) |
| Mandatory | true |
Update Business Group |
| vra businessgroup update |
| Parameter | --id (Provide an ID or name of a Group to be updated) |
| Mandatory | true |
| Parameter | --description (Enter description for the business group) |
| Mandatory | false |
| Parameter | --adContainer (Enter a new value for Active Directory Container) |
| Mandatory | false |
| Parameter | --email (Enter a new value for Administrator Email) |
| Mandatory | false |
| Parameter | --machinePrefixId (Enter a new value for Machine Prefix ID or prefix name) |
| Mandatory | false |
| Parameter | --addadmins (Enter comma separated list of users to be added for Group Manager Role) |
| Mandatory | false |
| Parameter | --addsupport (Enter comma separated list of users to be added for Support Role) |
| Mandatory | false |
| Parameter | --addsharedaccessusers (Enter comma separated list of users to be added for shared access user Role) |
| Mandatory | false |
| Parameter | --addusers (Enter comma separated list of users to be added for User Role) |
| Mandatory | false |
| Parameter | --removeadmins (Enter comma separated list of users to be removed from Group Manager Role) |
| Mandatory | false |
| Parameter | --removesharedaccessusers (Enter comma separated list of users to be removed from shared access user Role) |
| Mandatory | false |
| Parameter | --removesupport (Enter comma separated list of users to be removed from Support Role) |
| Mandatory | false |
| Parameter | --removeusers (Enter comma separated list of users to be removed from User Role) |
| Mandatory | false |
CatalogItem Details |
| vra catalog detail |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| 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 CatalogItems optionally filtered by type. |
| vra catalog list |
| Parameter | --businessGroupId (Provide a valid business group ID or name.) |
| Mandatory | false |
| Parameter | --type (Type of CatalogItem to display [COMPOSITE_BLUEPRINT, XAAS or ALL]. If option is not provided displays all CatalogItems) |
| 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 |
Generate a catalog request template in the form of a JSON file |
| vra catalog request generate template |
| Parameter | --groupid (Provide a valid business group ID or name.) |
| Mandatory | true |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| Mandatory | true |
| Parameter | --reason (Enter a reason for this request) |
| Mandatory | true |
| Parameter | --description (Enter a Description) |
| Mandatory | false |
| Parameter | --requestedFor (Enter the user for whom the machine will be provisioned.) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | true |
Make a new Request from a given CatalogItem |
| vra catalog request submit |
| Parameter | --groupid (Provide a valid business group ID or name.) |
| Mandatory | false |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| Mandatory | false |
| Parameter | --cpu (Enter the number of Cpu's) |
| Mandatory | false |
| Parameter | --memory (Enter the amount of memory in MB) |
| Mandatory | false |
| Parameter | --leasedays (Enter a positive numeric value for lease days. If unspecified or specified 0, default value for leasedays from Blueprint will be used) |
| Mandatory | false |
| Parameter | --reason (Enter a reason for this request) |
| Mandatory | false |
| Parameter | --description (Enter a Description) |
| Mandatory | false |
| Parameter | --properties (Enter comma separated list of properties. To escape special characters, enclose them in single quotes. Eg: "foo.bar='foo bar,bar:55'") |
| Mandatory | false |
| Parameter | --requestedFor (Enter the user for whom the machine will be provisioned.) |
| Mandatory | false |
| Parameter | --inputfile (The catalog request template to use. WARNING: This will override all other parameters.) |
| Mandatory | false |
Assign Icon to CatalogItem |
| vra catalogitem icon assign |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| Mandatory | true |
| Parameter | --image (Enter Image File to be set as Icon) |
| Mandatory | true |
| Parameter | --media (Enter media type of file [gif, jpeg, png]) |
| Mandatory | true |
Assign Service to CatalogItem |
| vra catalogitem service assign |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| Mandatory | true |
| Parameter | --serviceid (Enter a valid Service id or name to be assigned to Catalog Item) |
| Mandatory | true |
Remove service assigned to CatalogItem |
| vra catalogitem service unassign |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| Mandatory | true |
Unassigned catalogitem details |
| vra catalogitem unassigned detail |
| Parameter | --id (Provide a valid catalog item ID or name.) |
| 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 unassigned catalog items |
| vra catalogitem unassigned list |
| 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 |
List Component Registry Endpoints |
| vra componentregistry endpoint list |
| 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 |
| 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 |
Update Component Registry Endpoint Url |
| vra componentregistry endpoint update |
| Parameter | --id (Provide a valid Endpoint ID to be updated) |
| Mandatory | true |
| Parameter | --url (Enter new Endpoint Url) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List of available services from the component registry |
| vra componentregistry service list |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| 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 | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
Start datacollection on the specified cluster |
| vra computeresource datacollection start |
| Parameter | --name (Provide a valid ID or name of a Cluster or Host) |
| Mandatory | false |
| Parameter | --id (Provide a valid ID of a Cluster or Host) |
| Mandatory | false |
| Parameter | --waitforcompletion (Wait till datacollection is complete? [Yes or No]) |
| Mandatory | true |
| Parameter | --type (Only run this type of data collection (inventory, state, performance)) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Stop datacollection on the specified cluster |
| vra computeresource datacollection stop |
| Parameter | --name (Provide a valid ID or name of a Cluster or Host) |
| Mandatory | false |
| Parameter | --id (Provide a valid Id of a Cluster or Host) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Lists all compute resources (aka: hosts) that have no active reservations against them |
| vra computeresource inactive list |
Removes compute resources (aka: hosts) that have no active reservations against them |
| vra computeresource inactive remove |
List Compute Resources |
| vra computeresource list |
| 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 |
| 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 |
Content details |
| vra content detail |
| Parameter | --id (The internal content identifier - the id field) |
| 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 |
Exports content as a zip file using an internal identifier or a combination of public content id and type |
| vra content export |
| Parameter | --path (Absolute path to the folder where the zip is to be generated. If the supplied path is a file then the zip is created with the that name else a zip with name contentId-contentTypeId.zip is generated. If a file with name contentId-contentTypeId.zip already exists at the path then a zip with name contentId-contentTypeId-***.zip is generated where * represent randomly generated numeric digits.) |
| Mandatory | true |
| Parameter | --id (The internal content identifier - the id field) |
| Mandatory | false |
| Parameter | --content-id (The public human readable content id - the contentId field) |
| Mandatory | false |
| Parameter | --type (Content type. Choose from [composite-blueprint, property-definition, property-group, software-component, xaas-blueprint, xaas-bundle-content, xaas-resource-action, xaas-resource-mapping, xaas-resource-type]. Please note that global property-definition and property-group won't be listed) |
| Mandatory | false |
| Parameter | --secure (A flag to exclude or include secure data such as passwords. true - Exclude secure data from the exported content. false - Include secure data in the exported plain text content. Including secure data in plain text poses a security risk. If you choose to include passwords in the exported content, you agree to accept that risk.) |
| Mandatory | false |
| Parameter | --verbose (Show detailed output for the export. [Yes or No]) |
| Mandatory | false |
| Parameter | --precheck (OFF = no precheck ,ON = stop on first warning encountered and WARN = proceed in case of warnings and stop on first failure.) |
| Mandatory | false |
Import content(s) from a zip file |
| vra content import |
| Parameter | --path (Absolute path to the zip file) |
| Mandatory | true |
| Parameter | --resolution (Conflict resolution method to be used when a match is found for the content. This method applies to all the components during import. Options are: 1) OVERWRITE: Overwrite the existing content with the new content. You may choose to run with --precheck WARN to proceed with import even when there is warning. 2) SKIP: Skip importing the new content and reuse the existing content.) |
| Mandatory | true |
| Parameter | --dry-run (Validate package contents [Yes or No]) |
| Mandatory | false |
| Parameter | --verbose (Show detailed output for the export. [Yes or No]) |
| Mandatory | false |
| Parameter | --precheck (OFF = no precheck ,ON = stop on first warning encountered and WARN = proceed in case of warnings and stop on first failure.) |
| Mandatory | false |
List all content |
| vra content list |
| Parameter | --type (Content type. Choose from [composite-blueprint, property-definition, property-group, software-component, xaas-blueprint, xaas-bundle-content, xaas-resource-action, xaas-resource-mapping, xaas-resource-type]. Please note that global property-definition and property-group won't be listed) |
| Mandatory | false |
| Parameter | --page (page number) |
| Mandatory | false |
| Parameter | --pageSize (Page size) |
| 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 |
Export content without dependencies using an internal identifier or a combination of public content id and type |
| vra content simple export |
| Parameter | --path (Absolute path to the folder where the file is to be generated. If the supplied path is a file then the file is created with the that name else a file with name |
| Mandatory | true |
| Parameter | --id (The internal content identifier - the id field) |
| Mandatory | false |
| Parameter | --content-id (The public human readable content id - the contentId field) |
| Mandatory | false |
| Parameter | --type (Content type. Choose from [composite-blueprint, property-definition, property-group, software-component, xaas-blueprint, xaas-bundle-content, xaas-resource-action, xaas-resource-mapping, xaas-resource-type]. Please note that global property-definition and property-group won't be listed) |
| Mandatory | false |
| Parameter | --secure (A flag to exclude or include secure data such as passwords. true - Exclude secure data from the exported content. false - Include secure data in the exported plain text content. Including secure data in plain text poses a security risk. If you choose to include passwords in the exported content, you agree to accept that risk.) |
| Mandatory | false |
| Parameter | --verbose (Show detailed output for the export. [Yes or No]) |
| Mandatory | false |
Import single content file. NOTE: This only supports non zip files like *.yaml |
| vra content simple import |
| Parameter | --type (Content type. Choose from [composite-blueprint, property-definition, property-group, software-component, xaas-blueprint, xaas-bundle-content, xaas-resource-action, xaas-resource-mapping, xaas-resource-type]. Please note that global property-definition and property-group won't be listed) |
| Mandatory | true |
| Parameter | --path (Absolute path to the content file) |
| Mandatory | true |
| Parameter | --verbose (Show detailed output for the export. [Yes or No]) |
| Mandatory | false |
Create a new set of credentials |
| vra credential add |
| Parameter | --name (Enter a Name for credentials) |
| Mandatory | true |
| Parameter | --username (Enter Username) |
| Mandatory | true |
| Parameter | --password (The password for the credentials being created.If left unspecified you will be prompted to enter it securely) |
| Mandatory | false |
| Parameter | --description (Enter Description) |
| Mandatory | false |
Delete IaaS credentials |
| vra credential delete |
| Parameter | --id (Enter a valid credential ID or name to be deleted) |
| Mandatory | true |
List credentials |
| vra credential list |
| 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 |
| 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 |
Update IaaS credentials |
| vra credential update |
| Parameter | --id (Provide a valid credential ID or name to be updated) |
| Mandatory | true |
| Parameter | --name (Enter new Credential name) |
| Mandatory | false |
| Parameter | --username (Enter new Username) |
| Mandatory | false |
| Parameter | --password (Enter new Password) |
| Mandatory | false |
| Parameter | --description (Enter new Description) |
| Mandatory | false |
Perform action on a Deployment |
| vra deployment action execute |
| Parameter | --id (The deployment ID or name) |
| Mandatory | true |
| Parameter | --action (Name or ID of action to be performed, action "Change Security" is not supported) |
| Mandatory | true |
| Parameter | --description (A short description about action being performed) |
| Mandatory | false |
| Parameter | --reason (Reason for action being performed) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --properties (Provide appropriate comma-separated key=value properties for action. Eg: --properties "provider-NewOwner=user@domain" for --action "Change Owner", "vmId=2 (vmId is the name of the VM in Catalog)" or "nested_blueprintId~vmId=2" for --action "Scale Out") |
| Mandatory | false |
Get the action form for deployment |
| vra deployment action form |
| Parameter | --itemid (The deployment ID or name) |
| Mandatory | true |
| Parameter | --actionid (Action ID or name) |
| 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 |
Get the list of the actions for a specified Deployment |
| vra deployment action list |
| Parameter | --id (The deployment ID or name) |
| 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 |
| 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 |
Lists the components of a deployment. |
| vra deployment component list |
| Parameter | --id (The deployment ID or name.) |
| 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 |
| 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 |
Deployment Details |
| vra deployment detail |
| Parameter | --id (The deployment ID or name) |
| 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 Deployments |
| vra deployment list |
| Parameter | --requestId (Request ID or name) |
| Mandatory | false |
| Parameter | --businessGroupId (Business Group ID or name) |
| Mandatory | false |
| Parameter | --allDeployments (Select All VMs within Business group [Yes or No]) |
| 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 |
| 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 |
Add new Inbound Email Provider |
| vra emailserver inbound add |
| Parameter | --name (Enter name of the email provider to add) |
| Mandatory | true |
| Parameter | --emailaddress (Enter Email Address) |
| Mandatory | true |
| Parameter | --servername (Enter a valid Server Name) |
| Mandatory | true |
| Parameter | --protocol (Enter a valid email protocol [IMAP, POP, SMTP, SMTPSSL, SMTPTLS]) |
| Mandatory | true |
| Parameter | --authentication (Specify if Authentication is Required. [Yes or No]) |
| Mandatory | true |
| Parameter | --username (Enter Username) |
| Mandatory | true |
| Parameter | --password (Enter Password) |
| Mandatory | true |
| Parameter | --port (Enter Port) |
| Mandatory | true |
| Parameter | --deletemessages (Should Delete Messages? [Yes or No]) |
| Mandatory | false |
| Parameter | --acceptselfsignedcerts (Accept Self Signed Certificates? [Yes or No]) |
| Mandatory | true |
| Parameter | --description (Enter Description) |
| Mandatory | false |
| Parameter | --folder (Enter Default Folder for this email server. Eg - INBOX) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Add new Inbound list |
| vra emailserver list |
| 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 |
| 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 |
Add new Outbound Email Provider |
| vra emailserver outbound add |
| Parameter | --name (Enter name of the email provider to add) |
| Mandatory | true |
| Parameter | --emailaddress (Enter Email Address) |
| Mandatory | true |
| Parameter | --servername (Enter a valid Server Name) |
| Mandatory | true |
| Parameter | --protocol (Enter a valid email protocol [IMAP, POP, SMTP, SMTPSSL, SMTPTLS]) |
| Mandatory | true |
| Parameter | --authentication (Specify if Authentication is Required. [Yes or No]) |
| Mandatory | true |
| Parameter | --username (Enter Username) |
| Mandatory | true |
| Parameter | --password (Enter Password) |
| Mandatory | true |
| Parameter | --port (Enter Port) |
| Mandatory | true |
| Parameter | --acceptselfsignedcerts (Accept Self Signed Certificates? [Yes or No]) |
| Mandatory | true |
| Parameter | --description (Enter Description) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Remove Email Provider |
| vra emailserver remove |
| Parameter | --id (Provide a valid Email Server ID or name to be deleted) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List endpoint association types |
| vra endpoint associations list |
| 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 |
| 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 |
List endpoint category types |
| vra endpoint categories list |
| 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 |
| 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 |
Start datacollection on the specified endpoint |
| vra endpoint datacollection start |
| Parameter | --endpointname (Provide a valid name of a Cluster or Host) |
| Mandatory | true |
| Parameter | --waitforcompletion (Wait till datacollection is complete? [Yes or No]) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Export endpoint configurations |
| vra endpoint export |
| Parameter | --filename (The endpoint configuration file to export to.) |
| Mandatory | true |
Import endpoint configurations |
| vra endpoint import |
| Parameter | --filename (The endpoint configuration file to import.) |
| Mandatory | true |
List endpoint configurations |
| vra endpoint list |
| 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 |
| 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 |
Remove endpoint configuration |
| vra endpoint remove |
| Parameter | --id (Provide a valid endpoint id to be removed.) |
| Mandatory | true |
List endpoint types |
| vra endpoint types list |
| 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 |
| 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 |
Add Entitlement Action |
| vra entitlement action assign |
Add All Operation to Entitlement |
| vra entitlement action assignall |
Add All Operation to Entitlement |
| vra entitlement action assignall |
| Parameter | --id (Provide a valid ID or name of the Entitlement) |
| Mandatory | true |
List Entitlement Actions |
| vra entitlement action list |
| 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 |
| 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 |
Add new Entitlement |
| vra entitlement add |
| Parameter | --name (Enter name of the Entitlement) |
| Mandatory | true |
| Parameter | --businessgroupid (Enter a valid Business Group ID or name) |
| Mandatory | true |
| Parameter | --state (Enter state [ACTIVE, DRAFT, INACTIVE]) |
| Mandatory | true |
| Parameter | --description (Enter description) |
| Mandatory | false |
Assign Catalog Item |
| vra entitlement catalogitem assign |
| Parameter | --id (Provide a valid ID or name of the Entitlement) |
| Mandatory | true |
| Parameter | --catalogitemid (Provide a valid ID or name of the Catalog Item) |
| Mandatory | true |
| Parameter | --approvalpolicyid (Enter a valid Approval Policy ID or name) |
| Mandatory | false |
| Parameter | --action (Enter Action [ADD, REMOVE]) |
| Mandatory | true |
Entitlement Details |
| vra entitlement detail |
| Parameter | --id (Provide a valid ID or name of the Entitlement) |
| 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 Entitlements |
| vra entitlement list |
| 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 |
| 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 |
Add Entitlement Principal |
| vra entitlement principal assign |
| Parameter | --id (Select Id or name of the entitlement) |
| Mandatory | true |
| Parameter | --users (Add Users to the entitlement. Include an action parameter.) |
| Mandatory | false |
| Parameter | --groups (Add Groups to the entitlement. Include an action parameter.) |
| Mandatory | false |
| Parameter | --action (Enter Action [ADD, REMOVE]) |
| Mandatory | false |
| Parameter | --allUsers (Assign AllUsers for the entitlement. If YES, individual users and groups will be removed [YES/NO]) |
| Mandatory | false |
Delete Entitlement |
| vra entitlement remove |
| Parameter | --id (Provide the valid ID or name of an inactive or draft entitlement) |
| Mandatory | true |
Assign Entitlement Service |
| vra entitlement service assign |
| Parameter | --id (Provide a valid ID or name of the Entitlement) |
| Mandatory | true |
| Parameter | --serviceid (Provide a valid ID or name of the service) |
| Mandatory | true |
| Parameter | --approvalpolicyid (Enter a valid Approval Policy ID or name) |
| Mandatory | false |
| Parameter | --action (Enter Action [ADD, REMOVE]) |
| Mandatory | true |
Update Entitlement |
| vra entitlement update |
| Parameter | --id (Provide a valid ID or name of the Entitlement to be updated) |
| Mandatory | true |
| Parameter | --name (Enter new name) |
| Mandatory | false |
| Parameter | --state (Enter new state [ACTIVE, DRAFT, INACTIVE]) |
| Mandatory | false |
| Parameter | --description (Enter new description) |
| Mandatory | false |
Add Fabric Groups |
| vra fabricgroup add |
| Parameter | --name (Enter Group Name) |
| Mandatory | true |
| Parameter | --admins (Enter comma separated list of users for group manager role) |
| Mandatory | true |
| Parameter | --description (Enter Description) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --computeresourceids (Enter comma separated list of compute resource IDs) |
| Mandatory | false |
Get Fabric Group Detail |
| vra fabricgroup detail |
| Parameter | --id (Provide a valid ID or name of the fabric group to fetch details) |
| 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 Fabric Groups |
| vra fabricgroup list |
| 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 |
Remove Fabric Group |
| vra fabricgroup remove |
| Parameter | --id (Provide a valid fabric group ID or name to be deleted) |
| Mandatory | true |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
Update Fabric Group |
| vra fabricgroup update |
| Parameter | --id (Provide a valid fabric group ID or name to be updated) |
| Mandatory | true |
| Parameter | --description (Enter new description) |
| Mandatory | false |
| Parameter | --addadmins (Enter comma separated list of users for manager role to be added) |
| Mandatory | false |
| Parameter | --addcomputeresource (Enter comma separated list of compute resource IDs to be added) |
| Mandatory | false |
| Parameter | --removeadmins (Enter comma separated list of Users to be removed) |
| Mandatory | false |
| Parameter | --removecomputeresource (Enter comma separated list of compute resource IDs to be removed) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
List Machine Templates |
| vra iaas machinetemplate list |
| 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 |
| 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 |
Gets the Network Profile detail. |
| vra iaas networkprofile detail |
| Parameter | --id (Provide a valid Network Profile ID or name) |
| 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 |
Lists all the Network Profiles |
| vra iaas networkprofile list |
| 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 |
| 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 |
Add an icon |
| vra icon add |
| Parameter | --image (Provide a valid image file) |
| Mandatory | true |
| Parameter | --media (Enter media type of file [gif, jpeg, png]) |
| Mandatory | true |
| Parameter | --tenantId (Provide a valid tenant ID) |
| Mandatory | false |
| Parameter | --businessGroupId (Provide a valid Business Group ID or name) |
| Mandatory | false |
Delete/Revert an icon |
| vra icon remove |
| Parameter | --id (Provide a valid Icon ID) |
| Mandatory | true |
Update an icon |
| vra icon update |
| Parameter | --id (Provide a valid Icon ID) |
| Mandatory | true |
| Parameter | --image (Provide a valid image file) |
| Mandatory | true |
| Parameter | --media (Enter media type of file [gif, jpeg, png]) |
| Mandatory | true |
| Parameter | --tenantId (Provide a valid tenant ID) |
| Mandatory | false |
| Parameter | --businessGroupId (Provide a valid Business Group ID or name) |
| Mandatory | false |
Login to the vRA Server via OAuth2 Authorization Code flow |
| vra login authzcode |
| Parameter | --server (Server Name. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --tenant (Tenant (Organisation Name) default is vsphere.local) |
| Mandatory | false |
| Parameter | --oauth2clientid (OAuth2 Client identifier. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --oauth2clientsecret (OAuth2 Client secret. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --port (Redirect url port number. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --iaasUser (vRA IaaS User) |
| Mandatory | false |
| Parameter | --iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely) |
| Mandatory | false |
| Parameter | --promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.) |
| Mandatory | false |
| Parameter | --iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Login to ODATA IaaS Service with NTLM credentials |
| vra login iaas |
| Parameter | --server (Enter IaaS Server Name) |
| Mandatory | true |
| Parameter | --domain (Enter Windows Domain, default is local server name) |
| Mandatory | false |
| Parameter | --user (Enter User Name) |
| Mandatory | false |
| Parameter | --password (Enter Password) |
| Mandatory | false |
| Parameter | --keyfile (Provide the encrypted keyfile for iaas password) |
| Mandatory | false |
Displays detailed information about current login and persistent session (if being used). |
| vra login isauthenticated all |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
Check to see if vRA Catalog Services have been authenticated |
| vra login isauthenticated catalog |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Check to see if vRA IaaS Services have been authenticated |
| vra login isauthenticated iaas |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Login to the vRA Server with username and keyfile |
| vra login keyfile |
| Parameter | --server (Server Name) |
| Mandatory | false |
| Parameter | --tenant (Tenant (Organisation Name) default is vsphere.local) |
| Mandatory | false |
| Parameter | --user (User) |
| Mandatory | false |
| Parameter | --keyfile (Provide the encrypted keyfile for password) |
| Mandatory | true |
| Parameter | --iaasServer (vRA IaaS Server, if left empty dynamically will find it from vCAC) |
| Mandatory | false |
| Parameter | --iaasUser (vRA IaaS User) |
| Mandatory | false |
| Parameter | --iaasKeyfile (Provide the encrypted keyfile for iaas password) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Login to the vRA Server using a refresh token |
| vra login refreshtoken |
| Parameter | --server (Server Name. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --tenant (Tenant (Organisation Name) default is vsphere.local) |
| Mandatory | false |
| Parameter | --oauth2clientid (OAuth2 Client identifier. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --oauth2clientsecret (OAuth2 Client secret. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --refreshtoken (OAuth2 refresh token. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --iaasUser (vRA IaaS User) |
| Mandatory | false |
| Parameter | --iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely) |
| Mandatory | false |
| Parameter | --promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.) |
| Mandatory | false |
| Parameter | --iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Login to the vRA Server with username and password |
| vra login userpass |
| Parameter | --server (Server Name. If unspecified, you will be prompted to enter it.) |
| Mandatory | false |
| Parameter | --tenant (Tenant (Organisation Name) default is vsphere.local) |
| Mandatory | false |
| Parameter | --user (Username, including the full domain (user@org.company.com). Using domain aliases are not currently supported. If left unspecified, you will be prompted to enter it securely) |
| Mandatory | false |
| Parameter | --password (Cleartext CAFE password. If left unspecified, you will be prompted to enter it securely) |
| Mandatory | false |
| Parameter | --iaasUser (vRA IaaS User) |
| Mandatory | false |
| Parameter | --iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely) |
| Mandatory | false |
| Parameter | --promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.) |
| Mandatory | false |
| Parameter | --iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Logout and optionally delete the persistent session if being used currently. |
| vra logout |
| Parameter | --retainSessionFile (To retain the session file or not [Yes or No]) |
| Mandatory | false |
List IaaS User Logs |
| vra logs recentevents |
| 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 |
| 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 |
Create Machine Prefix |
| vra machineprefix add |
| Parameter | --prefix (Enter prefix) |
| Mandatory | true |
| Parameter | --numberOfDigits (Enter number of machine digits) |
| Mandatory | true |
| Parameter | --nextNumber (Enter next number) |
| Mandatory | true |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
List Machine Prefixes |
| vra machineprefix list |
| 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 |
| 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 |
Remove Machine Prefix |
| vra machineprefix remove |
| Parameter | --id (Enter Prefix ID or name to be removed) |
| Mandatory | true |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
Update Machine Prefix |
| vra machineprefix update |
| Parameter | --id (Enter Prefix ID or name to be updated) |
| Mandatory | true |
| Parameter | --prefix (Enter new prefix value) |
| Mandatory | false |
| Parameter | --numberOfDigits (Enter new number of machine digits) |
| Mandatory | false |
| Parameter | --nextNumber (Enter new next number) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --id (Machine name or its catalog resource ID) |
| Mandatory | true |
| Parameter | --action (Action ID or name to be performed) |
| Mandatory | true |
| Parameter | --description (A short description about action being performed) |
| Mandatory | false |
| Parameter | --reason (Reason for action being performed) |
| Mandatory | false |
| Parameter | --powerActionSelector (The power action that will be performed on the VM before reconfiguration. Select from [DoNotReboot, Reboot, RebootIfRequired]) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --properties (Only Cpu and MemoryMb are supported for reconfigure. Eg: --properties "Cpu=2,MemoryMb=2048") |
| Mandatory | false |
Get the action form for machine |
| vra machines action form |
| Parameter | --itemid (Machine name or its catalog resource ID) |
| Mandatory | true |
| Parameter | --actionid (Action ID or name) |
| 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 |
Get the list of the actions for a specified Machine |
| vra machines action list |
| Parameter | --id (Machine name or its catalog resource 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 |
| 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 |
Change the reservation of a provisioned item. |
| vra machines change reservation |
| Parameter | --ids (A single or a comma-separated list of machine names or its catalog resource IDs.) |
| Mandatory | true |
| Parameter | --blueprintName (The name of virtual machine template) |
| Mandatory | false |
| Parameter | --reservationName (The name of the reservation) |
| Mandatory | false |
| Parameter | --storagePath (The name or the Id of the Storage volume. Enter the reservationName before storagePath) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Cloud Machine Details |
| vra machines detail |
| Parameter | --id (Machine name or its catalog resource 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 |
Unregisters an existing machine from vRA management/inventory (but doesn't destroy the machine on the vSphere endpoint) |
| vra machines forceunregister |
| Parameter | --name (The *name or catalogResource.id* of the machine to unregister) |
| Mandatory | true |
List Machines |
| vra machines list |
| Parameter | --requestId (Request ID or name) |
| Mandatory | false |
| Parameter | --businessGroupId (Business Group ID or name) |
| Mandatory | false |
| Parameter | --allMachines (Select All VMs within Business group [Yes or No]) |
| 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 |
| 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 |
List all Unmanaged Machines (not in the vRA Inventory) |
| vra machines unmanaged list |
| 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 |
| 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 |
Register machine into the vRA Inventory |
| vra machines unmanaged register |
| Parameter | --owner (Enter Machine Owner) |
| Mandatory | true |
| Parameter | --blueprintid (Provide a valid Blueprint ID or name) |
| Mandatory | true |
| Parameter | --compositeBlueprintId (Provide a valid Composite Blueprint ID or name) |
| Mandatory | true |
| Parameter | --componentId (Provide a valid Component name within the selected composite blueprint) |
| Mandatory | true |
| Parameter | --deploymentName (Provide a Deployment name) |
| Mandatory | true |
| Parameter | --reservationid (Provide a valid Reservation ID or name) |
| Mandatory | true |
| Parameter | --hoststoragereservationid (Provide a valid ReservationToStorage ID, if left blank it will be dynamically found) |
| Mandatory | false |
| Parameter | --vmid (Provide a vRA VirtualMachine ID (Guid) or name) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
| Parameter | --clusterName (Name of cluster machine resides on) |
| Mandatory | false |
Create authz client on vRA to allow two factor authentication |
| vra oauth2client create |
| Parameter | --server (The vRA server) |
| Mandatory | true |
| Parameter | --tenant (Tenant Id) |
| Mandatory | true |
| Parameter | --newoauth2clientid (New OAuth2 client id) |
| Mandatory | false |
| Parameter | --newoauth2clientsecret (New OAuth2 client secret) |
| Mandatory | false |
| Parameter | --existingoauth2clientid (Existing OAuth2 client id) |
| Mandatory | false |
| Parameter | --existingoauth2clientsecret (Existing OAuth2 client secret) |
| Mandatory | false |
| Parameter | --accesstokenttl (Access Token TTL) |
| Mandatory | false |
| Parameter | --refreshtokenttl (Refresh Token TTL) |
| Mandatory | false |
| Parameter | --port (The callback redirect uri port number) |
| Mandatory | true |
Add content to package |
| vra package content add |
| Parameter | --pkgId (Package id) |
| Mandatory | true |
| Parameter | --ids (Comma separated list of content ids (the id field) to be added to package) |
| Mandatory | true |
List content for a given package |
| vra package content list |
| Parameter | --pkgId (Package id) |
| Mandatory | true |
| Parameter | --type (Content type. Press tab key for options.) |
| Mandatory | false |
| Parameter | --page (Page number) |
| Mandatory | false |
| Parameter | --pageSize (Page size) |
| 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 |
Remove content from a package |
| vra package content remove |
| Parameter | --pkgId (Package id) |
| Mandatory | true |
| Parameter | --ids (Comma separated list of content ids (the id field) to be removed from the package) |
| Mandatory | true |
Create a new package |
| vra package create |
| Parameter | --name (Package name) |
| Mandatory | true |
| Parameter | --description (Package description) |
| Mandatory | false |
| Parameter | --ids (Comma separated list of content ids (the id field)) |
| Mandatory | true |
Delete existing package |
| vra package delete |
| Parameter | --pkgId (Package id) |
| Mandatory | true |
Package details |
| vra package detail |
| Parameter | --pkgId (Package 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 |
Export an existing package of contents |
| vra package export |
| Parameter | --pkgId (The package id) |
| Mandatory | true |
| Parameter | --path (Absolute path to the folder where the zip is to be generated. If the supplied path is a file then the zip is created with the file name else a zip with name packageId.zip is generated. If a file with name packageId already exists at the path then a zip with name packageId-***.zip is generated where * represent randomly generated numeric digits.) |
| Mandatory | true |
| Parameter | --secure (A flag to exclude or include secure data such as passwords. true - Exclude secure data from the exported content. false - Include secure data in the exported plain text content. Including secure data in plain text poses a security risk. If you choose to include passwords in the exported content, you agree to accept that risk.) |
| Mandatory | false |
| Parameter | --verbose (Show detailed output for the import. [Yes or No]) |
| Mandatory | false |
| Parameter | --precheck (OFF = no precheck ,ON = stop on first warning encountered and WARN = proceed in case of warnings and stop on first failure.) |
| Mandatory | false |
List all package |
| vra package list |
| Parameter | --page (Page number) |
| Mandatory | false |
| Parameter | --pageSize (Page size) |
| 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 |
Update an existing package |
| vra package update |
| Parameter | --pkgId (Package id) |
| Mandatory | true |
| Parameter | --name (Package name) |
| Mandatory | false |
| Parameter | --description (Package description) |
| Mandatory | false |
| Parameter | --ids (Comma separated list of content ids (the id field)) |
| Mandatory | false |
List Blueprint Provisioning Workflows |
| vra provisioningworkflows list |
| 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 |
| 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 |
Approve Requests |
| vra request approve |
| Parameter | --ids (Select Request IDs or request numbers (comma separated) to approve) |
| Mandatory | true |
| Parameter | --message (Approval Message) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Cancel a request |
| vra request cancel |
| Parameter | --force (Indicates if a request has to be force cancelled.Force cancel just cancels request but does not clean up any resources related to the request. So this should be last resort solution used by admin to get rid of stuck requests) |
| Mandatory | false |
| Parameter | --id (Provide the valid ID of request) |
| Mandatory | true |
Request Details |
| vra request detail |
| Parameter | --id (Provide a valid Request ID or request number) |
| 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 |
| Parameter | --processJson (Process embedded flat string json. Works only with JSON output format, Select [Yes or No]) |
| Mandatory | false |
List Requests |
| vra request list |
| Parameter | --state (Select partial State Name. States could be [UNSUBMITTED, SUBMITTED, DELETED, PENDING_PRE_APPROVAL, PRE_APPROVAL_SEND_ERROR, PRE_APPROVED, PRE_REJECTED, PROVIDER_DELETION_ERROR, IN_PROGRESS, PROVIDER_SEND_ERROR, PROVIDER_COMPLETED, PROVIDER_FAILED, PENDING_POST_APPROVAL, POST_APPROVAL_SEND_ERROR, POST_APPROVED, POST_REJECTION_RECEIVED, ROLLBACK_ERROR, POST_REJECTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED]) |
| Mandatory | false |
| Parameter | --from (From Date, format: dd:mm:yyyy) |
| Mandatory | false |
| Parameter | --to (To Date, format: dd:mm:yyyy) |
| 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 |
| 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 | --processJson (Process embedded flat string json. Works only with JSON output format, Select [Yes or No]) |
| Mandatory | false |
Reject Requests |
| vra request reject |
| Parameter | --ids (Select Request IDs or request numbers (comma separated) to reject) |
| Mandatory | true |
| Parameter | --message (Rejection Message) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Add a new reservation. |
| vra reservation add |
| Parameter | --type (Provide a Reservation type [VCLOUD, VSPHERE]) |
| Mandatory | true |
| Parameter | --name (Reservation name. If left unspecified, takes the value from input file.) |
| Mandatory | false |
| Parameter | --tenant (Tenant ID or name. If left unspecified, takes the value from input file.) |
| Mandatory | false |
| Parameter | --businessGroupId (Business group ID or name to associate the reservation with. If left unspecified, takes the values from input file.) |
| Mandatory | false |
| Parameter | --reservationPolicyId (Reservation Policy ID or name. If left unspecified, takes the values from input file.) |
| Mandatory | false |
| Parameter | --priority (Reservation priority. If left unspecified, takes the value from input file.) |
| Mandatory | false |
| Parameter | --enable (Enable / Disable the reservation during creation. If left unspecified, takes the value from input file. Select [Yes or No]) |
| Mandatory | false |
| Parameter | --inputfile (Input file that is JSON formatted which you can get by running the command vra reservation generate template) |
| Mandatory | true |
Reservation details |
| vra reservation detail |
| Parameter | --id (Provide a valid Reservation ID or name) |
| Mandatory | true |
| Parameter | --info (Display machines/memory/storage allocated. If true, the output cannot be used to update/create reservation. Select [true/fasle]) |
| 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 |
Get the permissible values for a reservation schema field |
| vra reservation field values |
| Parameter | --type (Provide a Reservation type [VCLOUD, VSPHERE]) |
| Mandatory | true |
| Parameter | --fieldId (Field ID. For complex fields, specify the field ids in the format: parentFieldId.childFieldId.grandChildFieldId) |
| Mandatory | true |
| Parameter | --dependencyValues (Comma separated values for dependency fields in key=value format. Example: computeResource=abc123,machineQuota=10) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Create a reservation request template with all permissible values for the requested reservation type |
| vra reservation generate template |
| Parameter | --type (Provide a Reservation type [VCLOUD, VSPHERE]) |
| Mandatory | true |
| Parameter | --name (Name of the reservation) |
| Mandatory | true |
| Parameter | --computeResourceId (ComputeResource ID related to the Reservation type. Endpoint for the computeResourceId should match with the reservation type. If left unspecified, list of computeResourceIds are displayed and you will be prompted to enter one.) |
| Mandatory | false |
| Parameter | --tenant (Tenant ID or name. If left unspecified, defaulted to tenant from current login session.) |
| Mandatory | false |
| Parameter | --businessGroupId (Business group ID or name to associate the reservation with. If left unspecified, list of businessGroupIds are displayed and you will be prompted to enter one.) |
| Mandatory | false |
| Parameter | --reservationPolicyId (Reservation Policy ID or name.) |
| Mandatory | false |
| Parameter | --priority (Reservation priority. If left unspecified, defaults to 1.) |
| Mandatory | false |
| Parameter | --enable (Enable / Disable the reservation during creation. If left unspecified, defaults to true. Select [Yes or No]) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | true |
List all reservations |
| vra reservation list |
| 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 |
| Parameter | --name (name filter) |
| Mandatory | false |
| Parameter | --type (Provide a Reservation type [VCLOUD, VSPHERE]) |
| Mandatory | false |
| Parameter | --subTenantId (Sub Tenant ID or name filter) |
| Mandatory | false |
| Parameter | --reservationPolicyId (Reservation Policy ID or name filter) |
| Mandatory | false |
Add a new reservation policy |
| vra reservation policy add |
| Parameter | --type (Reservation policy type) |
| Mandatory | true |
| Parameter | --name (Reservation policy name) |
| Mandatory | true |
| Parameter | --description (Reservation policy description) |
| Mandatory | false |
Reservation policy details |
| vra reservation policy detail |
| Parameter | --id (Provide a Reservation policy ID or name) |
| 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 reservation policies |
| vra reservation policy list |
| 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 |
| Parameter | --page (page number) |
| Mandatory | false |
| Parameter | --pageSize (page size) |
| Mandatory | false |
Remove an existing reservation policy |
| vra reservation policy remove |
| Parameter | --id (Provide a valid Reservation policy ID or name) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Update an existing reservation policy |
| vra reservation policy update |
| Parameter | --id (Provide a valid Reservation policy ID or name) |
| Mandatory | true |
| Parameter | --name (Enter new Reservation policy name) |
| Mandatory | false |
| Parameter | --description (Enter new Reservation policy description) |
| Mandatory | false |
Remove an existing reservation. |
| vra reservation remove |
| Parameter | --id (Reservation ID or name) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Get the reservation schema for the requested reservation type and save it to a file in json format. |
| vra reservation schema |
| Parameter | --type (Provide a Reservation type [VCLOUD, VSPHERE]) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | true |
Update an existing reservation |
| vra reservation update |
| Parameter | --id (Reservation ID or name. If different from input file, this value will be considered as the reservation id to be updated.) |
| Mandatory | true |
| Parameter | --name (Reservation name. If left unspecified, takes the value from input file.) |
| Mandatory | false |
| Parameter | --reservationPolicyId (Reservation Policy ID or name. If left unspecified, takes the values from input file.) |
| Mandatory | false |
| Parameter | --priority (Reservation priority. If left unspecified, takes the value from input file.) |
| Mandatory | false |
| Parameter | --enable (Enable / Disable the reservation during creation. If left unspecified, takes the value from input file. Select [Yes or No]) |
| Mandatory | false |
| Parameter | --inputfile (Input file that is JSON formatted which you can get by running the command vra reservation detail) |
| Mandatory | true |
Invoke a DELETE http request |
| vra rest delete |
| Parameter | --** default ** |
| Parameter | --service (Name of the Service hosting the URI. e.g. catalog-service) |
| Mandatory | true |
| Parameter | --uri (URI of resource. e.g. consumer/requests/{id}) |
| Mandatory | true |
| Parameter | --headers (Show request and response headers) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Invoke a GET http request |
| vra rest get |
| Parameter | --** default ** |
| Parameter | --service (Name of the Service hosting the URI. e.g. catalog-service) |
| Mandatory | true |
| Parameter | --uri (URI of resource. e.g. consumer/catalogItems) |
| Mandatory | true |
| Parameter | --headers (Show request and response headers) |
| 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 |
Invoke a POST http request |
| vra rest post |
| Parameter | --** default ** |
| Parameter | --service (Name of the Service hosting the URI. e.g. catalog-service) |
| Mandatory | true |
| Parameter | --uri (URI of resource. e.g. consumer/catalogItems) |
| Mandatory | true |
| Parameter | --headers (Show request and response headers) |
| Mandatory | false |
| Parameter | --data (json data string or @filename) |
| 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 |
Invoke a PUT http request |
| vra rest put |
| Parameter | --** default ** |
| Parameter | --service (Name of the Service hosting the URI. e.g. catalog-service) |
| Mandatory | true |
| Parameter | --uri (URI of resource. e.g. consumer/catalogItems) |
| Mandatory | true |
| Parameter | --headers (Show request and response headers) |
| Mandatory | false |
| Parameter | --data (json data string or @filename) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Add new Service |
| vra service add |
| Parameter | --name (Enter name of the service to add) |
| Mandatory | true |
| Parameter | --state (State of the service [ACTIVE, DELETED, RETIRED]) |
| Mandatory | true |
| Parameter | --description (Enter Description) |
| Mandatory | false |
| Parameter | --owner (Enter email of the owner of the service to add) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List Services |
| vra service list |
| 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 |
| 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 |
Remove Service |
| vra service remove |
| Parameter | --name (Enter Name of the Service to remove) |
| Mandatory | false |
| Parameter | --id (Enter ID of the Service to remove) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Update Service |
| vra service update |
| Parameter | --id (Enter id of the service to be updated) |
| Mandatory | true |
| Parameter | --name (Enter new name for the service) |
| Mandatory | false |
| Parameter | --state (Enter new state for the service [ACTIVE, DELETED, RETIRED]) |
| Mandatory | false |
| Parameter | --description (Enter new description for the service) |
| Mandatory | false |
| Parameter | --owner (Enter email of the owner of the service to add) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Add New Tenant |
| vra tenant add |
| Parameter | --name (Enter Name of the Tenant to add) |
| Mandatory | true |
| Parameter | --url (Enter Tenant Url) |
| Mandatory | true |
| Parameter | --description (Enter Description) |
| Mandatory | false |
| Parameter | --email (Enter Email Address) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List Tenant/Infrastructure Admins |
| vra tenant admin list |
| Parameter | --tenantname (Enter a valid Tenant Name) |
| Mandatory | false |
| Parameter | --role (Enter a valid Admin Role. Select from [ALL, APPROVAL_ADMIN, IAAS_ADMIN, SERVICE_ARCHITECT, TENANT_ADMIN]. If unspecified, default will be considered ALL) |
| Mandatory | false |
| Parameter | --columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Update Tenant/Infrastructure Admins |
| vra tenant admin update |
| Parameter | --tenantname (Provide a valid Tenant Name to be updated) |
| Mandatory | true |
| Parameter | --role (Provide a valid role. Select from [ALL, APPROVAL_ADMIN, IAAS_ADMIN, SERVICE_ARCHITECT, TENANT_ADMIN]) |
| Mandatory | true |
| Parameter | --action (Action to be performed - ADD / REMOVE) |
| Mandatory | true |
| Parameter | --users (Comma separated list of users) |
| Mandatory | true |
Add New Tenant Identity store. Requires vRA system administrator login and supports only Active Directory (AD). |
| vra tenant identitystore add |
| Parameter | --tenantname (Enter Tenant Name) |
| Mandatory | false |
| Parameter | --name (Enter Identity store Name) |
| Mandatory | true |
| Parameter | --url (Enter AD or LDAP Server Url and port number) |
| Mandatory | true |
| Parameter | --groupbasedn (Enter a Group Search Base DN) |
| Mandatory | true |
| Parameter | --domain (Enter Domain) |
| Mandatory | true |
| Parameter | --userdn (Enter User DN) |
| Mandatory | true |
| Parameter | --password (Enter Password) |
| Mandatory | true |
| Parameter | --type (Enter IdentityStoreType LDAP/AD. Only AD is suported.) |
| Mandatory | true |
| Parameter | --userbasedn (Enter User Search Base DN) |
| Mandatory | false |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List Tenant Identity store |
| vra tenant identitystore list |
| Parameter | --tenantname (Provide a valid Tenant Name) |
| 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 |
| 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 |
Remove Tenant Identity store |
| vra tenant identitystore remove |
| Parameter | --tenantname (Enter a valid Tenant Name to be deleted) |
| Mandatory | true |
| Parameter | --identitystore (Enter a valid relevant Identity Store Name) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
List Tenants |
| vra tenant list |
| 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 |
| 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 |
Vra tenant remove |
| vra tenant remove |
| Parameter | --tenantname (Provide a valid Tenant urlName or id to be removed) |
| Mandatory | true |
| Parameter | --export (Provide a file to export all results) |
| Mandatory | false |
| Parameter | --format (Supported formats include: TABLE, JSON, CSV) |
| Mandatory | false |
Returns version of vRA |
| vra version |
Copyright 2019 VMware, Inc. All rights reserved.