Get-VBRHvServerConfiguration
Short Description
Returns settings of Microsoft Hyper-V hosts added to the backup infrastructure.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VBRHvServerConfiguration -Server <CHost> [<CommonParameters>] |
Detailed Description
This cmdlet returns the following settings of Microsoft Hyper-V hosts that are added to the backup infrastructure:
- EnableCBT: Specifies changed block tracking settings.
- If set to True, the changed block tracking option is enabled.
- If set to False, the changed block tracking option is disabled.
- EnableFailover: Specifies the failover option settings.
- If set to True, the failover option is enabled.
- If set to False, the failover option is disabled.
- Default: True.
- ServerId: Specifies the Microsoft Hyper-V hosts ID.
For more information on settings of Microsoft Hyper-V hosts that are added to the backup infrastructure, see the Specify Settings for Connected Volumes section in the User Guide for Microsoft Hyper-V.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Server | Specifies a Microsoft Hyper-V host added to the backup infrastructure. The cmdlet will return details about this Hyper-V host. | Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet. | True | Named | True (ByValue, ByPropertyName) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBRHvServerConfiguration object that contains settings of Microsoft Hyper-V hosts added to the backup infrastructure.
Examples
Getting Settings of Microsoft Hyper-V Host
This example shows how to get settings of the hyperv09.tech.local Microsoft Hyper-V host that is added to the backup infrastructure.
$server = Get-VBRServer -Name hyperv09.tech.local Get-VBRHvServerConfiguration -Server $server EnableCBT EnableFailover ServerId --------- -------------- -------- True True 01e9fb70-42d8-4de3-b7ef-fcf7aa10cfaa |
Perform the following steps:
- Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
- Run the Get-VBRHvServerConfiguration cmdlet. Set the $server variable as the Server parameter value.
The cmdlet output will contain the following settings: EnableCBT, EnableFailover and ServerId.
Related Commands