VRA MACHINES Commands


DescriptionCommand
Register machine into the vRA Inventory     vra machines unmanaged register
Perform action on a machine (Actions on snapshots i.e. Create/Revert/Delete should be executed with a gap of few minutes between two consecutive actions to allow completion of previous action)     vra machines action execute
Get the action form for machine     vra machines action form
Get the list of the actions for a specified Machine     vra machines action list
Change the reservation of a provisioned item.     vra machines change reservation
Cloud Machine Details     vra machines detail
Unregisters an existing machine from vRA management/inventory (but doesn't destroy the machine on the vSphere endpoint)     vra machines forceunregister
List Machines     vra machines list
List all Unmanaged Machines (not in the vRA Inventory)     vra machines unmanaged list
Register machine into the vRA Inventory     vra machines unmanaged register


Perform action on a machine (Actions on snapshots i.e. Create/Revert/Delete should be executed with a gap of few minutes between two consecutive actions to allow completion of previous action)

vra machines action execute

Parameter--id (Machine name or its catalog resource ID)
Mandatorytrue

Parameter--action (Action ID or name to be performed)
Mandatorytrue

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

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

Parameter--powerActionSelector (The power action that will be performed on the VM before reconfiguration. Select from [DoNotReboot, Reboot, RebootIfRequired])
Mandatoryfalse

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

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

Parameter--properties (Only Cpu and MemoryMb are supported for reconfigure. Eg: --properties "Cpu=2,MemoryMb=2048")
Mandatoryfalse


Get the action form for machine

vra machines action form

Parameter--itemid (Machine name or its catalog resource ID)
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 Machine

vra machines action list

Parameter--id (Machine name or its catalog resource ID)
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


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

Parameter--blueprintName (The name of virtual machine template)
Mandatoryfalse

Parameter--reservationName (The name of the reservation)
Mandatoryfalse

Parameter--storagePath (The name or the Id of the Storage volume. Enter the reservationName before storagePath)
Mandatoryfalse

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

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


Cloud Machine Details

vra machines detail

Parameter--id (Machine name or its catalog resource ID)
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


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


List Machines

vra machines list

Parameter--requestId (Request ID or name)
Mandatoryfalse

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

Parameter--allMachines (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


List all Unmanaged Machines (not in the vRA Inventory)

vra machines unmanaged 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 (Enter page number to display in pagination (default 1))
Mandatoryfalse

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


Register machine into the vRA Inventory

vra machines unmanaged register

Parameter--owner (Enter Machine Owner)
Mandatorytrue

Parameter--blueprintid (Provide a valid Blueprint ID or name)
Mandatorytrue

Parameter--compositeBlueprintId (Provide a valid Composite Blueprint ID or name)
Mandatorytrue

Parameter--componentId (Provide a valid Component name within the selected composite blueprint)
Mandatorytrue

Parameter--deploymentName (Provide a Deployment name)
Mandatorytrue

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

Parameter--hoststoragereservationid (Provide a valid ReservationToStorage ID, if left blank it will be dynamically found)
Mandatoryfalse

Parameter--vmid (Provide a vRA VirtualMachine ID (Guid) or name)
Mandatorytrue

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

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

Parameter--clusterName (Name of cluster machine resides on)
Mandatoryfalse


Copyright 2019 VMware, Inc. All rights reserved.