Add-VBRCloudProvider

Short Description

Adds cloud service providers.

Platform: VMware, Hyper-V

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

Syntax

Add-VBRCloudProvider -Address <String> [-Description <String>] [-Port <Int32>]

-Credentials <VBRCloudProviderCredentials> [-Appliance <VBRCloudProviderNetworkAppliance[]>]

[-VerifyCertificate] [-CertificateThumbprint <String>] [-InstallManagementAgent] [-Force]

[-RestoreAccessLevel <VBRVccRestoreAccessLevel>] [<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 provider 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.

Important

The CCredentials type object for the Credentials parameter is not accepted any longer. Run the Add-VBRCloudProviderCredentials cmdlet to specify the cloud provider credentials records.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Address	Specifies a full DNS name or IP address of the cloud gateway configured on the service provider side.	`String`	True	Named	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 the `VBRHvCloudProviderNetworkAppliance[]` object. To get this object, run the `New-VBRCloudProviderNetworkAppliance` cmdlet.	`VBRCloudProviderNetworkAppliance[]`	False	Named	False
CertificateThumbprint	Specifies the thumbprint that will be compared to the TLS certificate thumbprint.	`String`	False	Named	False
Credentials	Specifies credentials for the user account registered on the service provider Veeam backup server. Accepts the `VBRCloudProviderCredentials` object. To get this object, run the `Get-VBRCloudProviderCredentials` cmdlet.	`VBRCloudProviderCredentials`	True	Named	False
Description	Specifies the description of the service provider.	`String`	False	Named	False
Force	Defines that the cmdlet will skip the certificate verification if the verification fails.	`SwitchParameter`	False	Named	False
InstallManagementAgent	Defines 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.	`SwitchParameter`	False	Named	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`.	`Int32`	False	Named	False
RestoreAccessLevel	Defines the access level according to which the service provider can restore backups stored on cloud repositories: `None`: the service provider cannot restore backups. `UnencryptedBackups`: the service provider can restore only backups created without encryption. `AllBackups`: the service provider can restore any backups. Default: `None`. Note: The `AllBackups` access level is permanent and cannot be revoked.	`VBRVccRestoreAccessLevel`	False	Named	False
VerifyCertificate	Defines if the TLS certificate must be verified by the thumbprints. Use the `CertificateThumbprint` parameter to set the thumbprint that will be compared to the TLS certificate thumbprint.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

VBRCloudProvider

Examples

Add-VBRCloudProvider Example 1. Adding Cloud Service Provider with Default Settings

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

$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1"

Add-VBRCloudProvider -Address "198.51.100.11" -Credentials $credentials

Perform the following steps:

Run the Get-VBRCloudProviderCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
Run the Add-VBRCloudProvider cmdlet. Specify the Address parameter value. Set the $credentials variable as the Credentials parameter value.

Add-VBRCloudProvider Example 2. Adding Cloud Service Provider with Specific Settings

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

The service provider IP address is 198.51.100.11.
The service provider uses port 6252 for connection.
The TLS 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.
The service provider can restore unencrypted backups.

$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1"

Add-VBRCloudProvider -Address "198.51.100.11" -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" -RestoreAccessLevel UnencryptedBackups

Perform the following steps:

Run the Get-VBRCloudProviderCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
Run the Add-VBRCloudProvider cmdlet. Specify the following settings:
- Specify the Address and the Description parameter values.
- Specify the Port parameter value.
- Set the $credentials variable as the Credentials parameter value.
- Provide the VerifyCertificate parameter.
- Specify the CertificateThumbprint parameter value.
- Specify the RestoreAccessLevel parameter value.

Add-VBRCloudProvider Example 3. Adding Cloud Service Provider and Configuring Network Extension Appliance

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

$server = Get-VBRServer -Type HvServer -Name "srv02.tech.local"

$folder = "C:\Datastore"

$network = Get-VBRHvServerNetworkInfo -Server $server | Where { $_.NetworkName -eq "VM Network" }

$viAppl = New-VBRCloudProviderNetworkAppliance -Server $server -Network $network -Folder $folder

$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1"

Add-VBRCloudProvider -Address "198.51.100.11" -Credentials $credentials -Appliance $viAppl

Perform the following steps:

Create a network extension appliance:
- Run the Get-VBRServer cmdlet. Set the HvServer option for the Type parameter. Specify the Name parameter value. Save the server to the $server variable.
- Assign the C:\Datastore value to the $folder variable.
- Run the Get-VBRHvServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value and use the Where-Object statement to filter the networks by the .NetworkName property. Save the network to the $network variable.
- Run the New-VBRCloudProviderNetworkAppliance cmdlet. Specify the Server, Network and Folder parameter values. Save the result to the $viAppl variable.
Run the Get-VBRCloudProviderCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
Run the Add-VBRCloudProvider cmdlet. Specify the Address parameter value. Set the $credentials variable as the Credentials parameter value. Set the $viAppl variable as the Appliance parameter value.