VRA RESERVATION Commands


DescriptionCommand
Add a new reservation.     vra reservation add
Reservation details     vra reservation detail
Get the permissible values for a reservation schema field     vra reservation field values
Create a reservation request template with all permissible values for the requested reservation type     vra reservation generate template
List all reservations     vra reservation list
Add a new reservation policy     vra reservation policy add
Reservation policy details     vra reservation policy detail
List all reservation policies     vra reservation policy list
Remove an existing reservation policy     vra reservation policy remove
Update an existing reservation policy     vra reservation policy update
Remove an existing reservation.     vra reservation remove
Get the reservation schema for the requested reservation type and save it to a file in json format.     vra reservation schema
Update an existing reservation     vra reservation update


Add a new reservation.

vra reservation add

Parameter--type (Provide a Reservation type [VCLOUD, VSPHERE])
Mandatorytrue

Parameter--name (Reservation name. If left unspecified, takes the value from input file.)
Mandatoryfalse

Parameter--tenant (Tenant ID or name. If left unspecified, takes the value from input file.)
Mandatoryfalse

Parameter--businessGroupId (Business group ID or name to associate the reservation with. If left unspecified, takes the values from input file.)
Mandatoryfalse

Parameter--reservationPolicyId (Reservation Policy ID or name. If left unspecified, takes the values from input file.)
Mandatoryfalse

Parameter--priority (Reservation priority. If left unspecified, takes the value from input file.)
Mandatoryfalse

Parameter--enable (Enable / Disable the reservation during creation. If left unspecified, takes the value from input file. Select [Yes or No])
Mandatoryfalse

Parameter--inputfile (Input file that is JSON formatted which you can get by running the command vra reservation generate template)
Mandatorytrue


Reservation details

vra reservation detail

Parameter--id (Provide a valid Reservation ID or name)
Mandatorytrue

Parameter--info (Display machines/memory/storage allocated. If true, the output cannot be used to update/create reservation. Select [true/fasle])
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


Get the permissible values for a reservation schema field

vra reservation field values

Parameter--type (Provide a Reservation type [VCLOUD, VSPHERE])
Mandatorytrue

Parameter--fieldId (Field ID. For complex fields, specify the field ids in the format: parentFieldId.childFieldId.grandChildFieldId)
Mandatorytrue

Parameter--dependencyValues (Comma separated values for dependency fields in key=value format. Example: computeResource=abc123,machineQuota=10)
Mandatoryfalse

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

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

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


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

Parameter--name (Name of the reservation)
Mandatorytrue

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

Parameter--tenant (Tenant ID or name. If left unspecified, defaulted to tenant from current login session.)
Mandatoryfalse

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

Parameter--reservationPolicyId (Reservation Policy ID or name.)
Mandatoryfalse

Parameter--priority (Reservation priority. If left unspecified, defaults to 1.)
Mandatoryfalse

Parameter--enable (Enable / Disable the reservation during creation. If left unspecified, defaults to true. Select [Yes or No])
Mandatoryfalse

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


List all reservations

vra reservation list

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--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--name (name filter)
Mandatoryfalse

Parameter--type (Provide a Reservation type [VCLOUD, VSPHERE])
Mandatoryfalse

Parameter--subTenantId (Sub Tenant ID or name filter)
Mandatoryfalse

Parameter--reservationPolicyId (Reservation Policy ID or name filter)
Mandatoryfalse


Add a new reservation policy

vra reservation policy add

Parameter--type (Reservation policy type)
Mandatorytrue

Parameter--name (Reservation policy name)
Mandatorytrue

Parameter--description (Reservation policy description)
Mandatoryfalse


Reservation policy details

vra reservation policy detail

Parameter--id (Provide a Reservation policy 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 all reservation policies

vra reservation policy list

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 (page number)
Mandatoryfalse

Parameter--pageSize (page size)
Mandatoryfalse


Remove an existing reservation policy

vra reservation policy remove

Parameter--id (Provide a valid Reservation policy ID or name)
Mandatorytrue

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

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


Update an existing reservation policy

vra reservation policy update

Parameter--id (Provide a valid Reservation policy ID or name)
Mandatorytrue

Parameter--name (Enter new Reservation policy name)
Mandatoryfalse

Parameter--description (Enter new Reservation policy description)
Mandatoryfalse


Remove an existing reservation.

vra reservation remove

Parameter--id (Reservation ID or name)
Mandatorytrue

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

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


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

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


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.)
Mandatorytrue

Parameter--name (Reservation name. If left unspecified, takes the value from input file.)
Mandatoryfalse

Parameter--reservationPolicyId (Reservation Policy ID or name. If left unspecified, takes the values from input file.)
Mandatoryfalse

Parameter--priority (Reservation priority. If left unspecified, takes the value from input file.)
Mandatoryfalse

Parameter--enable (Enable / Disable the reservation during creation. If left unspecified, takes the value from input file. Select [Yes or No])
Mandatoryfalse

Parameter--inputfile (Input file that is JSON formatted which you can get by running the command vra reservation detail)
Mandatorytrue


Copyright 2019 VMware, Inc. All rights reserved.