Remove-VBRCloudGatewayPool

In this article

    Short Description

    Removes cloud gateway pools.

    Applies to

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

    Syntax

    Remove-VBRCloudGatewayPool -CloudGatewayPool <VBRCloudGatewayPool[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet removes selected cloud gateway pools from the Veeam Backup & Replication console.

    When you remove the cloud gateway pool, the cloud gateways are not removed from your cloud infrastructure. They will show up as the cloud gateways.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudGatewayPool

    Specifies an array of cloud gateways pools that you want to remove.

    Accepts the VBRCloudGatewayPool type.

    True

    Named

    True (ByValue,
    ByPropertyName)

    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

    Force

    Indicates that the cmdlet will remove cloud gateway pools without warning even if there are tenants assigned to that cloud gateway pool.

    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 remove a cloud gateway pool.

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

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

    Remove-VBRCloudGatewayPool -CloudGatewayPool $pool

    Related Commands

    Get-VBRCloudGatewayPool