This is an archive version of the document. To get the most up-to-date information, see the current version.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 ESXi 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 | Accept |
Name | Specifies the array of entity names. The cmdlet will return entities with these names. | False | Named | True | True |
Server | Specifies the array of ESXi hosts. The cmdlet will return entities created on these hosts. | False | Named | True (ByValue, | False |
HostsAnd | Indicates that the cmdlet will return only hosts and clusters. | False | Named | False | False |
VMsAnd | Indicates that the cmdlet will return only VMs and templates. | False | Named | False | False |
Datastores | Indicates that the cmdlet will return only datastores and VMs. | False | Named | False | False |
HostsAnd | 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 on common parameters, see the About CommonParameters section of Microsoft Docs.
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.
Get-VBRServer -Name "ESXiHost 01", "ESXiHost 02" | Find-VBRViEntity -HostsAndClusters |
Example 2
This command returns an ESXi cluster named "vSAN" located on the ESXiHost.
Find-VBRViEntity -Server $server -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".
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.
Find-VBRViEntity -Server $server -Tags -Name "Mac OS" |
Related Commands
