VRA REQUEST Commands


DescriptionCommand
Approve Requests     vra request approve
Cancel a request     vra request cancel
Request Details     vra request detail
List Requests     vra request list
Reject Requests     vra request reject


Approve Requests

vra request approve

Parameter--ids (Select Request IDs or request numbers (comma separated) to approve)
Mandatorytrue

Parameter--message (Approval Message)
Mandatorytrue

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

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


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

Parameter--id (Provide the valid ID of request)
Mandatorytrue


Request Details

vra request detail

Parameter--id (Provide a valid Request ID or request number)
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--processJson (Process embedded flat string json. Works only with JSON output format, Select [Yes or No])
Mandatoryfalse


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

Parameter--from (From Date, format: dd:mm:yyyy)
Mandatoryfalse

Parameter--to (To Date, format: dd:mm:yyyy)
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

Parameter--processJson (Process embedded flat string json. Works only with JSON output format, Select [Yes or No])
Mandatoryfalse


Reject Requests

vra request reject

Parameter--ids (Select Request IDs or request numbers (comma separated) to reject)
Mandatorytrue

Parameter--message (Rejection Message)
Mandatorytrue

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

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


Copyright 2019 VMware, Inc. All rights reserved.