Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Find-VBRHvEntity

Short Description

Looks for Hyper-V hosts, VMs and volumes.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Find-VBRHvEntity [-Server <CHost[]>] [-HostsAndVMs] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRHvEntity [-Server <CHost[]>] [-Hosts] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRHvEntity [-Server <CHost[]>] [-HostsAndVolumes] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns Hyper-V hosts, VMs and volumes managed by Veeam Backup & Replication.

You can get the list of all Hyper-V objects in your virtual environment or look for instances directly by name.

Run Get-VBRServer to get the list of the Hyper-V hosts.

Return Type

CHvHostItem

CHvVmItem

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Server

Specifies the array of Hyper-V hosts. The cmdlet will return entities created on these hosts.

False

Named

True (ByValue,
ByProperty
Name)

False

HostsAnd
VMs

Indicates that the cmdlet will return only hosts and VMs.

False

Named

False

False

Hosts

Indicates that the cmdlet will return only hosts.

False

Named

False

False

HostsAnd
Volumes

Indicates that the cmdlet will return only hosts and volumes.

False

Named

False

False

Name

Specifies the array of entity names. The cmdlet will return entities with these names.

False

Named

False

True

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> 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.

PS C:\PS> Get-VBRServer -Name "HvHost 01", "HvHost 02" | Find-VBRHvEntity -HostsAndVMs

Example 3

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

PS C:\PS> Find-VBRHvEntity -Name "HvExchange"

Related Commands

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation