Add-VBRHvCluster

In this article

    Short Description

    Adds a Hyper-V cluster to the backup infrastructure.

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Add a Hyper-V cluster using the account user name and password

    Add-VBRHvCluster -Name <String> -User <String> -Password <String> [-Description <String>] [<CommonParameters>]

    • Add a Hyper-V cluster using credentials managed by Veeam Backup & Replication.

    Add-VBRHvCluster -Name <String> -Credentials <CCredentials> [-Description <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds Hyper-V clusters to the backup infrastructure.

    Run the Add-VBRHvHost cmdlet to add a standalone Hyper-V host to the backup infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

    Specifies the DNS name of the Hyper-V cluster.

    String

    True

    Named

    False

    User

    Specifies the user name you want to use for authenticating with the Hyper-V cluster.

    String

    True

    Named

    False

    Password

    Specifies the password you want to use for authenticating with the Hyper-V cluster.

    String

    True

    Named

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the Hyper-V cluster.

     

    True

    Named

    False

    Description

    Specifies the description of the Hyper-V cluster.

    String

    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 CHost object that contains settings of the Hyper-V clusters added to the backup infrastructure.

    Examples

    Add-VBRHvClusterExample 1. Adding Hyper-V Сluster Using Account User Name and Password

    This command adds the HYPCLUSTER01 Hyper-V сluster server with the Administrator user name and the Password password of the account.

    Add-VBRHvCluster -Name "HYPCLUSTER01" -User Administrator -Password Password -Description "Hyper-V Cluster 01"

    Add-VBRHvClusterExample 2. Adding Hyper-V Сluster Using Credentials Managed by Veeam Backup & Replication

    This example shows how to add the HYPCLUSTER01 Hyper-V server using the credentials managed by Veeam Backup & Replication.

    $SCVMMAdministrator = Get-VBRCredentials

    Add-VBRHvCluster -Name "HYPCLUSTER01" -Description "Hyper-V Cluster 01" -Credentials $Administrator

    Perform the following steps:

    1. Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
    2. Run the Add-VBRHvCluster cmdlet. Specify the Name parameter value. Specify the Description parameter value. Set the $SCVMMAdministrator variable as the Credentials parameter value.

    Related Commands