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

Set-VBRCloudProvider

Short Description

Modifies service providers.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

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

Detailed Description

This cmdlet modifies settings of service provider added to Veeam Backup & Replication. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CloudProvider

Specifies the service provider you want to modify.

Accepts VBRCloudProvider type.

True

Named

True (ByValue,
ByProperty
Name)

False

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 appliance on the user side that will be used for the partial failover.

Accepts VBRHvCloudProviderNetworkAppliance type.

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 enable the SSL certificate verification for a service provider.

  1. Run Get-VBRCloudProvider to get the service provider you want to modify. Save the result to the $CloudProvider variable.
  2. Run Set-VBRCloudProvider and use the saved variable. Use the VerifyCertificate parameter to enable the SSL certificate verification with thumbprints. The thumbprint is '‎e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8'.

PS C:\PS> $CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

PS C:\PS> 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"

Example 2

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

  1. Run Get-VBRCloudProvider to get the service provider you want to modify. Use the pipeline.
  2. Run Set-VBRCloudProvider with the saved variable. Set the Port parameter to '6180'.

PS C:\PS> Get-VBRCloudProvider -Name "104.45.95.227"  | Set-VBRCloudProvider -Port 6180

Example 3

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

  1. Modify the network extension appliance. See Set-VBRCloudProviderNetworkAppliance for instructions. Save the result to the $newAppliance variable.
  2. Run Get-VBRCloudProvider to get the service provider you want to modify. Save the result to the $CloudProvider variable.
  3. Run Set-VBRCloudProvider with the saved variables.

PS C:\PS> $CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

PS C:\PS> Set-VBRCloudProvider -CloudProvider $CloudProvider -Appliance $newAppliance

Related Commands

Get-VBRCredentials

Get-VBRCloudProvider

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