Set-VBRCloudProvider

Short Description

Modifies service providers.

Applies to

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]  [<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 parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

CloudProvider

Specifies the service provider you want to modify.

Accepts the VBRCloudProvider object. To get this object, run the Get-VBRCloudProvider cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Address

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

String

True

Named

False

Description

Specifies the description of the service provider.

String

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

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.

True

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.

False

Named

False

Verify
Certificate

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

Certificate
Thumbprint

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

String

False

Named

False

Install
Management
Agent

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

Force

Defines that the command will skip the certificate verification if the verification fails.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

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-VBRCloudProviderExample 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:

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

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

This command sets the cloud gateway port to the default value.

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

Perform the following steps:

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

Set-VBRCloudProviderExample 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.

$CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

Set-VBRCloudProvider -CloudProvider $CloudProvider -Appliance $newAppliance

Perform the following steps:

  1. Modify the network extension appliance. See the Set-VBRCloudProviderNetworkAppliance cmdlet for instructions. Save the result to the $newAppliance variable.
  2. Run the Get-VBRCloudProvider cmdlet. Specify the Name parameter value. Save the result to the $CloudProvider variable.
  3. Run the Set-VBRCloudProvider cmdlet. Set the $CloudProvider variable as the CloudProvider parameter value. Set the $newAppliance variable as the Appliance parameter value.

Related Commands