Disable-VBRCloudGatewayPool

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 the Enable-VBRCloudGatewayPool cmdlet to enable the disabled cloud gateway pools.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

CloudGatewayPool

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

Accepts the VBRCloudGatewayPool[] object. To get this object, run the Get-VBRCloudGatewayPool cmdlet.

True

Named

True (ByValue,
ByPropertyName)

Force

Defines that the cmdlet will not show the notification about the active sessions of tenants.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Disabling Cloud Gateway Pool [Using Variable]

This example shows how to disable a cloud gateway pool.

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

Disable-VBRCloudGatewayPool -CloudGatewayPool $pool

Perform the following steps:

  1. Run the Get-VBRCloudGatewayPool cmdlet. Specify the Name parameter value. Save the result to the $pool variable.
  2. Run the Disable-VBRCloudGatewayPool cmdlet. Set the $pool variable as the CloudGatewayPool parameter value.

Related Commands

Get-VBRCloudGatewayPool