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

Find-VBRViEntity

Short Description

Looks for VMware entities created on a selected host.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Find-VBRViEntity [-Server <CHost[]>] [-HostsAndClusters] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Server <CHost[]>] [-VMsAndTemplates] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Server <CHost[]>] [-DatastoresAndVMs] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Server <CHost[]>] [-HostsAndDatastores] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Server <CHost[]>] [-ResourcePools] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Server <CHost[]>] [-Servers] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Find-VBRViEntity [-Name <String[]>] [-Server <CHost[]>] [-Tags] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns VMware objects connected to a specified ESX(i) host.

You can get the list of all VMware entities registered in your virtual VMware environment or narrow down the search results to specific objects, or look for instances directly by name.

Run Get-VBRServer to get the list of the VMware hosts.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

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

False

Named

True

True

Server

Specifies the array of ESX(i) hosts. The cmdlet will return entities created on these hosts.

False

Named

True (ByValue,
ByProperty
Name)

False

HostsAnd
Clusters

Indicates that the cmdlet will return only hosts and clusters.

False

Named

False

False

VMsAnd
Templates

Indicates that the cmdlet will return only VMs and templates.

False

Named

False

False

Datastores
AndVMs

Indicates that the cmdlet will return only datastores and VMs.

False

Named

False

False

HostsAnd
Datastores

Indicates that the cmdlet will return only hosts and datastores.

False

Named

False

False

ResourcePools

Indicates that the cmdlet will return only resource pools.

False

Named

False

False

Servers

Indicates that the cmdlet will return only VMware hosts.

False

Named

False

False

Tags

Indicates that the cmdlet will return only tags.

Use the Name parameter to specify the tag name.

False

Named

False

False

<CommonParameters>

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

Return Type

CVcItem

CViFolderItem

CViDatacenterItem

CEsxItem

CViClusterItem

CViResourcePoolItem

CViVmItem

CViVirtualAppItem

CViFolderItem

CViDatacenterItem

Example 1

This command looks for the list of hosts and clusters connected to the ESXi hosts named "ESXiHost 01" and "ESXiHost 02". The servers are obtained with Get-VBRServer and piped down.

PS C:\PS> Get-VBRServer -Name "ESXiHost 01", "ESXiHost 02" | Find-VBRViEntity -HostsAndClusters

Example 2

This command returns an ESXi cluster named "vSAN" located on the ESXiHost.

PS C:\PS> Find-VBRViEntity -Server ESXiHost -HostsAndClusters -Name vSAN

Example 3

This command looks for the list of resource pools connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down. The list of resource pools is narrowed down to the resource pools with names starting with "Veeam".

PS C:\PS> Get-VBRServer -Name "ESXiHost" | Find-VBRViEntity -ResourcePools -Name Veeam*

Example 4

This command looks for the list of VMs having a VMware tag named "Mac OS" within a particular host. The host is obtained with Get-VBRServer and assigned to the '$server' variable beforehand.

PS C:\PS> Find-VBRViEntity -Server $server -Tags -Name "Mac OS"

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 Endpoint Backup Documentation

Veeam Management Pack Documentation