Add-VBRvCloudVC

In this article

    Short Description

    Adds vCenter Server managed by vCloud Director to Veeam Backup & Replication.

    Applies to

    Platform: VMware

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

    Syntax

    This cmdlet provides the following parameter sets:

    • To add a vCloud Director server using the user name/password scenario

    Add-VBRvCloudVC [-vCloudServer] <CHost> [-VCInfo] <CVcdVcInfo> [-User] <string> [-Password] <string> [-Name <string>] [-Port <int>] [-Description <string>] [<CommonParameters>]

    • To add a vCloud Director server using the credentials scenario

    Add-VBRvCloudVC [-vCloudServer] <CHost> [-VCInfo] <CVcdVcInfo> -Credentials <CCredentials> [-Name <string>] [-Port <int>] [-Description <string>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds a new vCenter Server to Veeam Backup & Replication infrastructure. The vCenter Server is registered as a part of vCloud Director.

    Add-VBRvCloudVC Note:

    Run Add-VBRvCloud to add a vCloud Director server to Veeam Backup & Replication infrastructure.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    vCloudServer

    Specifies the vCloud server you want to connect a vCenter to.

    True

    0

    True (ByValue,
    ByProperty
    Name)

    False

    VCInfo

    Specifies the vCenter Server you want to connect to the vCloud.

    True

    1

    False

    False

    User

    Specifies the user name you want to use for authenticating with the vCenter Server.

    If you use the Username/Password scenario, the -Credentials parameter must be omitted.

    True

    2

    False

    False

    Password

    Specifies the password you want to use for authenticating with the vCenter Server.

    If you use the Username/Password scenario, the -Credentials parameter must be omitted.

    True

    3

    False

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the vCenter Server.

    If you use the Credentials scenario, the -User and -Password parameters must be omitted.

    True

    Named

    False

    False

    Name

    Specifies the DNS name or IP address of the vCenter Server you want to connect.

    False

    Named

    False

    False

    Port

    Specifies the web-service port number. If not set, the default port number 443 will be used.

    IMPORTANT: When you customize the port number, you should make sure that you set this port on the vCenter Server/ESXi host settings first.

    False

    Named

    False

    False

    Description

    Specifies the description of the vCenter Server. If not set, the default description containing the user name of the user who created the record and date and time of creation will be used.

    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.

    Example 1

    This command adds a new vCenter Server with the following parameters:

    • The vCenter will be registered on the server with 172.16.1.13 IP address. The server object is piped to the cmdlet.
    • The new vCenter Server is obtained with Find-VBRvCloudEntity ([-Vc]) and assigned to $vc variable beforehand.
    • The user name is "Administrator" and the password is "Password".
    • The new vCenter name is "vCenter Server 1".
    • The -Port parameter is not set to enable the default 443 web-service port number.
    • The -Description parameter is not set to enable the default description.

    Get-VBRServer -Name 172.16.1.13 | Add-VBRvCloudVC -VCInfo $vc -User Administrator -Password Password -Name "vCenter Server 1"

    Example 2

    This command adds a new vCenter Server with the following parameters:

    • The server where the new vCenter will be registered is represented by $s variable.
    • The new vCenter Server is obtained with Find-VBRvCloudEntity ([-Vc]) and assigned to $vc variable beforehand.
    • The $creds variable contains the Administrator credentials record.
    • The new vCenter name is "vCenter Server 2".
    • The -Port parameter is set to 456 to set the connection through web-service port number 456 instead of default 443 port.
    • The -Description parameter is not set to enable the default description.

    Add-VBRvCloudVC -vCloudServer $s -VCInfo $vc -Credentials $creds -Name "vCenter Server 2" -Port 456

    Related Commands

    Get-VBRServer

    Find-VBRvCloudEntity ([-Vc])

    Get-VBRCredentials

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.