This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRCloudProvider
Short Description
Adds cloud service providers.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Add-VBRCloudProvider -Address <string> -Credentials <VBRCloudProviderCredentials> [-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 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 Add-VBRCloudProviderCredentials to specify the cloud provider credentials records. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
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. Accepts the VBRCloudProviderCredentials type. | 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 the VBRHvCloudProviderNetworkAppliance.type. | False | Named | False | False |
Verify | Indicates 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. | False | Named | False | False |
Certificate | Specifies the thumbprint that will be compared to the TLS certificate thumbprint. | False | Named | False | False |
Install | 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 on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
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.
- Run Get-VBRCloudProviderCredentials to get credentials to access the service provider. Save the result to the $credentials variable.
- Run Add-VBRCloudProvider to add the service provider. Use the $credentials variable.
$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1" 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 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.
To add the service provider:
- Run Get-VBRCloudProviderCredentials to get credentials to access the service provider. Save the result to the $credentials variable.
- Run Add-VBRCloudProvider to add the service provider using the data above.
$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1" 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.
- Create a network extension appliance. See New-VBRCloudProviderNetworkAppliance for instructions. Save the result to the $viAppl variable.
- Run Get-VBRCloudProviderCredentials to get credentials to access the service provider. Save the result to the $credentials variable.
- Run Add-VBRCloudProvider to create the cloud provider. Use the $credentials variable.
$credentials = Get-VBRCloudProviderCredentials -Name "Tenant1" Add-VBRCloudProvider -Address "104.45.95.227" -Credentials $credentials -Appliance $viAppl |
Related Commands
