Set-VBRCloudProvider

Short Description

Modifies service providers.

Platform: VMware, Hyper-V

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

Syntax

Set-VBRCloudProvider -CloudProvider <VBRCloudProvider> [-Address <String>] [-Description <String>]

[-Port <Int32>] [-Credentials <VBRCloudProviderCredentials>] [-PassThru]

[-Appliance <VBRCloudProviderNetworkAppliance[]>] [-VerifyCertificate] [-CertificateThumbprint <String>]

[-InstallManagementAgent] [-Force] [-RestoreAccessLevel <VBRVccRestoreAccessLevel>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of service provider added to Veeam Backup & Replication.

Important

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

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Address	Specifies a full DNS name or an IP address of the cloud gateway configured on the service provider side.	`String`	False	Named	False
Appliance	Specifies the appliance on the user side that will be used for the partial failover. Accepts the `VBRHvCloudProviderNetworkAppliance[]` object. To get this object, run the `Set-VBRCloudProviderNetworkAppliance` cmdlet.	`VBRCloudProviderNetworkAppliance[]`	False	Named	False
CertificateThumbprint	Specifies the thumbprint that will be compared to the TLS certificate thumbprint.	`String`	False	Named	False
CloudProvider	Specifies the service provider you want to modify. Accepts the `VBRCloudProvider` object. To get this object, run the `Get-VBRCloudProvider` cmdlet.	`VBRCloudProvider`	True	Named	True (ByPropertyName, ByValue)
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`	False	Named	False
Description	Specifies the description of the service provider.	`String`	False	Named	False
Force	Defines that the command 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
PassThru	Defines that the command will return the output object to the Windows PowerShell console.	`SwitchParameter`	False	Named	False
Port	Specifies the port over which the Veeam backup server of the user 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: You cannot decrease the access level given to the service provider. 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

Set-VBRCloudProvider Example 1. Enabling TLS Certificate Verification for Service Provider [Using Variable]

This example shows how to enable the TLS certificate verification for a service provider.

$CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

Set-VBRCloudProvider -CloudProvider $CloudProvider -VerifyCertificate -CertificateThumbprint "‎e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8"

Perform the following steps:

Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter value. Save the result to the $CloudProvider variable.
Run the Set-VBRCloudProvider cmdlet. Set the $CloudProvider variable as the CloudProvider parameter value. Provide the VerifyCertificate parameter. Specify the CertificateThumbprint parameter value.

Set-VBRCloudProvider Example 2. Setting Cloud Gateway Port [Using Pipeline]

This example shows how to set the cloud gateway port to the default value.

Get-VBRCloudProvider -Name "104.45.95.227" | Set-VBRCloudProvider -Port 6180

Perform the following steps:

Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VBRCloudProvider cmdlet. Specify the Port parameter value.

Set-VBRCloudProvider Example 3. Configuring Network Extension Appliance of Service Provider [Using Variable]

This example shows how to edit configuration of the network extension appliance configured for the service provider.

$provider = Get-VBRCloudProvider -Name "104.45.95.227"

$viAppl = Get-VBRCloudProviderNetworkAppliance -CloudProvider $provider

$newFolder = "C:\Users\admin"

$newAppliance = Set-VBRCloudProviderNetworkAppliance -NetworkAppliance $hvAppl -Folder $newFolder

$CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

Set-VBRCloudProvider -CloudProvider $CloudProvider -Appliance $newAppliance

Perform the following steps:

Modify the network extension appliance:
- Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter values. Save the result to the $provider variable.
- Run the Get-VBRCloudProviderNetworkAppliance cmdlet. Set the $provider variable as the CloudProvider parameter value. Save the result to the $viAppl variable.
- Assign the $newFolder variable the C:\Users\admin value.
- Run the Set-VBRCloudProviderNetworkAppliance cmdlet for instructions. Specify the NetworkAppliance and Folder parameter values. Save the result to the $newAppliance variable.
Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter value. Save the result to the $CloudProvider variable.
Run the Set-VBRCloudProvider cmdlet. Set the $CloudProvider variable as the CloudProvider parameter value. Set the $newAppliance variable as the Appliance parameter value.