Get-VBRViVM

Short Description

Returns VMs available on a vCenter Server.

Platform: VMware

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

Syntax

This cmdlet provides the following parameter sets:

Name (Default)

Get-VBRViVM -Server <CHost> [-Name <String[]>] [<CommonParameters>]
Reference

Get-VBRViVM -Server <CHost> [-Reference <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns VMs available on a vCenter Server. Use this cmdlet to get VMs that will be used for mapping in a universal CDP policy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Name	Specifies an array of VM names. The cmdlet will return VMs with these names.	`String[]`	False	Named	False
Reference	Specifies an array of references (MoRefs) for VMs. The cmdlet will return VMs with these references.	`String[]`	False	Named	False
Server	Specifies a vCenter Server. The cmdlet will return VMs available on this server. Accepts the `CHost` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	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 an array of VBRViVM objects that contain VMware VMs available on the specified vCenter Server.

Examples

Get-VBRViVM Example 1. Getting All VMs Available on vCenter Server

This example shows how to get all VMs available on the vcenter01.tech.local vCenter Server.

$server = Get-VBRServer -Name "vcenter01.tech.local"

Get-VBRViVM -Server $server

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViVM cmdlet. Set the $server variable as the Server parameter value.

Get-VBRViVM Example 2. Getting VMs Available on vCenter Server by Names

This example shows how to get the WebSrv01 and WebSrv02 VMs available on the vcenter01.tech.local vCenter Server.

$server = Get-VBRServer -Name "vcenter01.tech.local"

Get-VBRViVM -Server $server -Name "WebSrv01", "WebSrv02"

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViVM cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter values.

Get-VBRViVM Example 3. Getting VMs Available on vCenter Server by References

This example shows how to get VMs with the vm-1024 and vm-1025 references available on the vcenter01.tech.local vCenter Server.

$server = Get-VBRServer -Name "vcenter01.tech.local"

Get-VBRViVM -Server $server -Reference "vm-1024", "vm-1025"

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViVM cmdlet. Set the $server variable as the Server parameter value. Specify the Reference parameter values.