Add-VBRvCloud

Short Description

Adds a vCloud Director server to Veeam Backup & Replication.

Applies to

Platform: VMware

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add a vCloud Director server using the user name/password scenario.

Add-VBRvCloud [-Name] <string> [-User] <string> [-Password] <string> [-Url <string>] [-Description <string>][<CommonParameters>]

  • Add a vCloud Director server using the credentials scenario.

Add-VBRvCloud [-Name] <string> -Credentials <CCredentials> [-Url <string>] [-Description <string>][<CommonParameters>]

Detailed Description

This cmdlet adds a new vCloud Director server to Veeam Backup & Replication infrastructure.

Add-VBRvCloud Note:

Run the Add-VBRvCloudVC cmdlet to add a vCenter Server managed by vCloud Director to Veeam Backup & Replication infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies the full DNS name or IP address of the vCloud Director server or any cell in the vCloud Director infrastructure.

String

True

0

False

User

Specifies the user name you want to use for authenticating with the vCloud Director server.

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

String

True

1

False

Password

Specifies the password you want to use for authenticating with the vCloud Director server.

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

String

True

2

False

Credentials

Specifies the credentials you want to use for authenticating with the vCloud Director server.

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

Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet

True

Named

False

Url

Specifies the URL you want to connect to the vCloud Director Web API with.

String

False

Named

False

Description

Specifies the description of the new vCloud Director server. If not set, the user name who created the server and the date and time of creation will be added by default.

String

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

CHost

Examples

Add-VBRvCloudExample 1. Creating Cloud Director Server with User Name and Password

This command creates a new vCloudDirectorServer server with the following settings:

Add-VBRvCloud -Name "vCloudDirectorServer.domain.com" -User Administrator -Password password -Url "https://vclouddirectorserver:443" -Description "vCloud Director Server"

Add-VBRvCloudExample 2. Creating Cloud Director Server with Saved Credentials

This example shows how to create a new vCloudDirectorServer server with the following settings:

$administrator = Get-VBRCredentials -Name "Administrator"

Add-VBRvCloud -Name "vCloudDirectorServer.domain.com" -Credentials $administrator -Url "https://vclouddirectorserver:443"

Perform the following steps:

  1. Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $administrator variable.
  2. Run the Add-VBRvCloud cmdlet. Specify the Name parameter value. Set the $administrator variable as the Credentials parameter value. Specify the Url parameter value.

Related Commands

Get-VBRCredentials