Set-VBRCloudGatewayPool

In this article

    Short Description

    Modifies cloud gateway pools.

    Applies to

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

    Syntax

    Set-VBRCloudGatewayPool -CloudGatewayPool <VBRCloudGatewayPool> [-Name <String>] [-Description <String>][-CloudGateway <VBRCloudGateway[]>] [-Force [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies cloud gateway pools. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudGatewayPool

    Specifies the cloud gateway pool that you want to modify. Accepts the VBRCloudGatewayPool type.

    True

    Named

    True (ByValue)

    False

    Name

    Specifies the name that you want to assign to the existing cloud gateway pool. The cmdlet will change the name of the selected cloud gateway pool.

    False

    Named

    False

    False

    Description

    Specifies the description that you want to add to the existing cloud gateway pool. The cmdlet will change the description of the selected cloud gateway pool.

    False

    Named

    False

    False

    CloudGateway

    Specifies cloud gateways. The cmdlet will add these cloud gateways to the cloud gateway pool.

    NOTE: The cmdlet will overwrite the existing cloud gateway pools with the new ones.

    Accepts the VBRCloudGateway type.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will add all available gateways to cloud gateway pools without warning.

    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

    This example shows how to modify the name of a cloud gateway pool.

    1. Run Get-VBRCloudGatewayPool to get the gateway pool that you want to modify. Save the result to the $pool variable.
    2. Run Set-VBRCloudGatewayPool with the $pool variable.

    $pool = Get-VBRCloudGatewayPool -Name "New Cloud Pool"

    Set-VBRCloudGatewayPool -CloudGatewayPool $pool -Name "Silver Cloud Pool"

    Related Commands

    Get-VBRCloudGatewayPool