Set-VBRCloudProvider

In this article

    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 <int>][-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. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Important

    Mind the following:

    • This cmdlet is not available for the Veeam Backup Starter license.
    • 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
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudProvider

    Specifies the service provider you want to modify.

    Accepts the VBRCloudProvider type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Address

    Specifies a full DNS name or an 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 the Veeam backup server of the user 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 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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    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'.

    $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"

    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' value.

    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.

    $CloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

    Set-VBRCloudProvider -CloudProvider $CloudProvider -Appliance $newAppliance

    Related Commands

    Set-VBRCloudProviderNetworkAppliance

    Get-VBRCloudProvider

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.