VRA DEPLOYMENT Commands


DescriptionCommand
Perform action on a Deployment     vra deployment action execute
Get the action form for deployment     vra deployment action form
Get the list of the actions for a specified Deployment     vra deployment action list
Lists the components of a deployment.     vra deployment component list
Deployment Details     vra deployment detail
List Deployments     vra deployment list


Perform action on a Deployment

vra deployment action execute

Parameter--id (The deployment ID or name)
Mandatorytrue

Parameter--action (Name or ID of action to be performed, action "Change Security" is not supported)
Mandatorytrue

Parameter--description (A short description about action being performed)
Mandatoryfalse

Parameter--reason (Reason for action being performed)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

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")
Mandatoryfalse


Get the action form for deployment

vra deployment action form

Parameter--itemid (The deployment ID or name)
Mandatorytrue

Parameter--actionid (Action ID or name)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse


Get the list of the actions for a specified Deployment

vra deployment action list

Parameter--id (The deployment ID or name)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25, maximum 5000))
Mandatoryfalse


Lists the components of a deployment.

vra deployment component list

Parameter--id (The deployment ID or name.)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25, maximum 5000))
Mandatoryfalse


Deployment Details

vra deployment detail

Parameter--id (The deployment ID or name)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse


List Deployments

vra deployment list

Parameter--requestId (Request ID or name)
Mandatoryfalse

Parameter--businessGroupId (Business Group ID or name)
Mandatoryfalse

Parameter--allDeployments (Select All VMs within Business group [Yes or No])
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25, maximum 5000))
Mandatoryfalse


Copyright 2019 VMware, Inc. All rights reserved.