Get-VBRViCloudVM

Short Description

Returns VMs available in cloud hosts allocated by cloud resources.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRViCloudVM -Server <VBRCloudServer> [<CommonParameters>]
Name

Get-VBRViCloudVM -Server <VBRCloudServer> -Name <String[]> [<CommonParameters>]
Id

Get-VBRViCloudVM -Server <VBRCloudServer> -Id <String[]> [<CommonParameters>]

Detailed Description

Returns VMs available in cloud hosts that are allocated to you by your cloud resources.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an array of IDs for VMs. The cmdlet will return VMs with these IDs.	`String[]`	True	Named	False
Name	Specifies an array of VM names. The cmdlet will return VMs with these names.	`String[]`	True	Named	False
Server	Specifies cloud hosts. The cmdlet will return VMs available in these hosts. Accepts the `VBRCloudServer` object. To create this object, run the `Get-VBRCloudServer` cmdlet.	`VBRCloudServer`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRViCloudVM object that contains VMs available in cloud hosts that are allocated to you by your cloud resources.

Examples

Get-VBRViCloudVM Example 1. Getting all VMs Available in Cloud Host

This example shows how to get all VMs available in the cloud host.

$cloudserver = Get-VBRCloudServer

Get-VBRViCloudVM -Server $cloudserver

Perform the following steps:

Run the Get-VBRCloudServer cmdlet. Save the result to the $cloudserver variable.
Run the Get-VBRViCloudVM cmdlet. Set the $cloudserver variable as the Server parameter value.

Get-VBRViCloudVM Example 2. Getting VMs Available in Cloud Host by Names

This example shows how to get the srv50, srv59, srv45 VMs available in cloud hosts.

$cloudserver = Get-VBRCloudServer

Get-VBRViCloudVM -Server $cloudserver -Name "srv50", "srv59", "srv45"

Perform the following steps:

Run the Get-VBRCloudServer cmdlet. Save the result to the $cloudserver variable.
Run the Get-VBRViCloudVM cmdlet. Set the $cloudserver variable as the Server parameter value. Specify the Name parameter values.

Get-VBRViCloudVM Example 3. Getting VMs Available in Cloud Host by ID

This example shows how to get the "4ddb76ea-c11f-4c93-9147-06facf7c2186","d3cff5ea-58f0-4fbd-8f58-87896e755dc5 VMs available in cloud hosts.

$cloudserver = Get-VBRCloudServer

Get-VBRViCloudVM -Server $cloudserver -Id "4ddb76ea-c11f-4c93-9147-06facf7c2186", "d3cff5ea-58f0-4fbd-8f58-87896e755dc5"

Perform the following steps:

Run the Get-VBRCloudServer cmdlet. Save the result to the $cloudserver variable.
Run the Get-VBRViCloudVM cmdlet. Set the $cloudserver variable as the Server parameter value. Specify the Id parameter values.