Disable-VBRCloudGatewayPool

In this article

    Short Description

    Disables cloud gateway pools.

    Applies to

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

    Syntax

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

    Detailed Description

    This cmdlet disables selected cloud gateway pools. Disabling a cloud gateway pool temporarily suspends all operations on it. Run Enable-VBRCloudGatewayPool to enable the disabled cloud gateway pools.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CloudGatewayPool

    Specifies an array of cloud gateway pools that you want to disable.

    Accepts the VBRCloudGatewayPool type.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    Force

    indicates that the cmdlet won`t show the notification about the active sessions of tenants.

    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

    Example

    This example shows how to disable a cloud gateway pool.

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

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

    Disable-VBRCloudGatewayPool -CloudGatewayPool $pool

    Related Commands

    Get-VBRCloudGatewayPool