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

Add-VBRCloudProvider

Short Description

Adds cloud service providers.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Add-VBRCloudProvider -Address <string> -Credentials <CCredentials> [-Description <string>] [-Port <int>] [-Appliance <VBRCloudProviderNetworkAppliance[]>] [-VerifyCertificate] [-CertificateThumbprint <string>] [-InstallManagementAgent] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet adds a new service provider to Veeam Backup & Replication.

You can add several providers using one cloud gateway to your Veeam backup console. The providers' credentials must have different user names.

You must set a network extension appliance if you plan to replicate your VMs to the cloud. Pre-configure the network extension appliance in advance. For details, see Network Appliance.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Address

Specifies a full DNS name or IP address of the cloud gateway configured on the service provider side.

True

Named

False

False

Description

Specifies the description of the service provider.

False

Named

False

False

Port

Specifies the port over which user’s Veeam backup server will communicate with the cloud gateway.

Permitted values: 1 to 65535.

Default: 6180.

False

Named

False

False

Credentials

Specifies credentials for the user account registered on the service provider Veeam backup server.

True

Named

False

False

Appliance

Specifies the network extension appliance on the user side.

You must configure a network extension appliance if you want to replicate to the cloud.

Accepts VBRHvCloudProviderNetworkAppliance.

False

Named

False

False

Verify
Certificate

Indicates if the SSL certificate must be verified by the thumbprints.

Use the CertificateThumbprint parameter to set the thumbprint that will be compared to the SSL certificate thumbprint.

False

Named

False

False

Certificate
Thumbprint

Specifies the thumbprint that will be compared to the SSL certificate thumbprint.

False

Named

False

False

Install
Management
Agent

Indicates that the service provider must manage the Veeam backup server under the Backup as a Service agreement.

The cmdlet will install the Veeam Managed Backup Portal agent on the Veeam backup server.

False

Named

False

False

Force

If set, the command will skip the certificate verification if the verification fails.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

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.

Return Type

VBRCloudProvider

Example 1

This example shows how to add a cloud service provider to Veeam Backup & Replication using default settings. The service provider IP address is 104.45.95.227.

  1. Run Get-VBRCredentials to get the credentials to access the service provider. Save the result to the $credentials variable.
  2. Run Add-VBRCloudProvider to add the service provider. Use the saved variable.

PS C:\PS> $credentials = Get-VBRCredentials -Name "Cloud Provider Administrator"

PS C:\PS> Add-VBRCloudProvider -Address "104.45.95.227" -Credentials $credentials

Example 2

This example shows how to add a cloud service provider with the following settings:

  • The service provider IP address is 104.45.95.227.
  • The service provider uses port 6252 for connection.
  • The SSL certificate thumbprint verification is enabled. The thumbprint is ‎e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8.

To add the service provider:

  1. Run Get-VBRCredentials to get the credentials to access the service provider. Save the result to the $credentials variable.
  2. Run Add-VBRCloudProvider to add the service provider using the data above.

PS C:\PS> $credentials = Get-VBRCredentials -Name "Cloud Provider Administrator"

PS C:\PS> Add-VBRCloudProvider -Address "104.45.95.227" -Description "Cloud gateway for SP" -Port 6252 -Credentials $credentials -VerifyCertificate -CertificateThumbprint "‎e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8"

Example 3

This example shows how to add a service provider and configure a network extension appliance. The service provider IP address is 104.45.95.227.

  1. Create a network extension appliance. See New-VBRCloudProviderNetworkAppliance for instructions. Save the result to the $viAppl variable.
  2. Run Get-VBRCredentials to get the credentials withto access the service provider. Save the result to the $credentials variable.
  3. Run Add-VBRCloudProvider to create the cloud provider. Use the saved variables.

PS C:\PS> $credentials = Get-VBRCredentials -Name "Cloud Provider Administrator"

PS C:\PS> Add-VBRCloudProvider -Address "104.45.95.227" -Credentials $credentials -Appliance $viAppl

Related Commands

Get-VBRCredentials

Get-VBRCloudProviderNetworkAppliance

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation