Add-VBRvCloud

Short Description

Adds a Cloud Director server to Veeam Backup & Replication.

Platform: VMware

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

Syntax

This cmdlet provides the following parameter sets:

AddCredentials

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

[-WhatIf] [-Confirm] [<CommonParameters>]
Credentials

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

[-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

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

Note

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the Cloud Director server. If you use the Credentials scenario, the `User` and `Password` parameters must be omitted.	`CCredentials`	True	Named	False
Description	Specifies the description of the new Cloud 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
Name	Specifies the full DNS name or IP address of the Cloud Director server or any cell in the Cloud Director infrastructure.	`String`	True	0	False
Password	Specifies the password you want to use for authenticating with the Cloud Director server. If you use the Username/Password scenario, the `Credentials` parameter must be omitted.	`String`	True	2	False
Url	Specifies the URL you want to connect to the Cloud Director Web API with.	`String`	False	Named	False
User	Specifies the user name you want to use for authenticating with the Cloud Director server. If you use the Username/Password scenario, the `Credentials` parameter must be omitted.	`String`	True	1	False
Confirm	Defines that the cmdlet will display a prompt that asks if you want to continue running the command.	`SwitchParameter`	False	Named	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	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-VBRvCloud Example 1. Creating Cloud Director Server with User Name and Password

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

The URL address is https://vclouddirectorserver:443.
The user name is Administrator and the password is password.
The description is Cloud Director Server.

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

Add-VBRvCloud Example 2. Creating Cloud Director Server with Saved Credentials

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

The URL address is https://vclouddirectorserver:443.
The user name is Administrator and the password is password.
The description is the default one.

$administrator = Get-VBRCredentials -Name "Administrator"

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

Perform the following steps:

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

Get-VBRCredentials