This is an archive version of the document. To get the most up-to-date information, see the current version.

Find-VBRHvEntity

Short Description

Returns Hyper-V objects added to Veeam Backup & Replication.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets.

To get an array of Hyper-V hosts and VMs added to Veeam Backup & Replication infrastructure:

Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-HostsAndVMs <SwitchParameter>] [<CommonParameters>]

To get an array of Hyper-V hosts added to Veeam Backup & Replication infrastructure:

Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-Hosts <SwitchParameter>] [<CommonParameters>]

To get an array of Hyper-V hosts and volumes added to Veeam Backup & Replication infrastructure:

Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-HostsAndVolumes <SwitchParameter>] [<CommonParameters>]

To get an array of Hyper-V VM groups added to Veeam Backup & Replication infrastructure:

Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-VMGroups <SwitchParameter>] [<CommonParameters>]

To get an array of Hyper-V tags:

Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-Tags <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet retutns an array of Hyper-V objects added to Veeam Backup & Replication. You can get the array of all Hyper-V objects or a specific type of a Hyper-V object.

Run Get-VBRServer to get an array of Hyper-V hosts.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Name	Specifies an array of entity names. The cmdlet will return entities with these names.	False	Named	False	True
Server	Specifies an array of Hyper-V hosts. The cmdlet will return entities created on these hosts.	False	Named	True (ByValue, ByProperty Name)	False
HostsAndVMs	Indicates that the cmdlet will return an array of hosts and VMs.	False	Named	False	False
Hosts	Indicates that the cmdlet will return an array of hosts.	False	Named	False	False
HostsAndVolumes	Indicates that the cmdlet will return an array of hosts and volumes.	False	Named	False	False
VMGroups	Indicates that the cmdlet will return an array of VM groups.	False	Named	False	False
Tags	Indicates that the cmdlet will return an array of tags. Use the Name parameter to specify the tag name.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

CHvHostItem

CHvVmItem

Example 1

This command looks for all Hyper-V objects registered on server named "Hyper-V Host". The server is obtained with Get-VBRServer and piped down.

Get-VBRServer -Name "HvHost" | Find-VBRHvEntity

Example 2

This command looks for Hyper-V hosts and VMs registered on Hyper-V servers named "HvHost 01" and "HvHost 02". The servers are obtained with Get-VBRServer and piped down.

Get-VBRServer -Name "HvHost 01", "HvHost 02" | Find-VBRHvEntity -HostsAndVMs

Example 3

This command directly looks for the Hyper-V server named "HvExchange".

Find-VBRHvEntity -Name "HvExchange"

Related Commands

Get-VBRServer