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.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Look for an array of Hyper-V hosts and VMs.
Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-HostsAndVMs <SwitchParameter>] [<CommonParameters>] |
- Look for an array of Hyper-V hosts.
Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-Hosts <SwitchParameter>] [<CommonParameters>] |
- Look for an array of Hyper-V hosts and volumes.
Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-HostsAndVolumes <SwitchParameter>] [<CommonParameters>] |
- Look for an array of Hyper-V VM groups.
Find-VBRHvEntity [-Name <String[]>] [-Server <CHost[]>] [-VMGroups <SwitchParameter>] [<CommonParameters>] |
- Look for 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.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Name | Specifies an array of entity names. The cmdlet will return entities with these names. | String[] | False | Named | False |
Server | Specifies an array of Hyper-V hosts. The cmdlet will return entities created on these hosts. | Accepts the CHost[] object. To get this object, run the Get-VBRServer cmdlet. | False | Named | True (ByValue, |
HostsAndVMs | Defines that the cmdlet will return an array of hosts and VMs. | SwitchParameter | False | Named | False |
Hosts | Defines that the cmdlet will return an array of hosts. | SwitchParameter | False | Named | False |
HostsAndVolumes | Defines that the cmdlet will return an array of hosts and volumes. | SwitchParameter | False | Named | False |
VMGroups | Defines that the cmdlet will return an array of VM groups. | SwitchParameter | False | Named | False |
Tags | Defines that the cmdlet will return an array of tags. Note: To specify the tag name, provide the Name parameter. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the following Hyper-V objects:
- CHvHostItem
- CHvVmItem
cmdlet returns the VBOApplicationOnlyConnectionSettings object that defines Azure AD application settings.
Examples
Example 1. Getting all Hosts and VMs Available on Hyper-V
Example 2. Getting all Hosts Available on Hyper-V
Example 3. Getting all Hosts and Volumes Available on Hyper-V
Example 3. Getting all Hosts and Volumes Available on Hyper-V
Example 4. Getting all Hyper-V Tags
Related Commands
