Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRvCloud

Short Description

Adds a vCloud Director server to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

-OR-

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.

When adding a new vCloud Director server you will need to provide either username/password or credentials. This cmdlet provides syntax for both scenarios accordingly.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

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

True

0

False

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.

True

1

False

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.

True

2

False

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.

True

Named

False

False

Url

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

False

Named

False

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.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command creates a new server named "vCloudDirectorServer" having the https://vclouddirectorserver:443 URL address. The username is "Administrator" and the password is "password".

PS C:\PS> Add-VBRvCloud -Name "vCloudDirectorServer" -User Administrator -Password password -Url https://vclouddirectorserver:443 -Description "vCloud Director Server"

Example 2

This command creates a new server named "vCloudDirectorServer" having the https://vclouddirectorserver:443 URL address. The credentials are obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The -Description parameter is not set to get the default description created.

PS C:\PS> Add-VBRvCloud -Name "vCloudDirectorServer" -Credentials $Administrator -Url https://vclouddirectorserver:443

Related Commands

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation