Disable-VBRCloudGateway

Short Description

Disables cloud gateways.

Applies to

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

Requires a cloud provider license.

Syntax

Disable-VBRCloudGateway -CloudGateway <VBRCloudGateway[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
CloudGateway	Specifies the array of cloud gateways you want to disable.	Accepts the VBRCloudGateway[] object. To get this object, run the Get-VBRCloudGateway cmdlet.	True	Named	True (ByValue, ByProperty Name)
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. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

CloudGateway

Specifies the array of cloud gateways you want to disable.

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

True

Named

True (ByValue,
ByProperty
Name)

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.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

VBRCloudGateway

Examples

Disable-VBRCloudGateway Example 1. Disabling Cloud Gateway [Using Variable]

This example shows how to disable the selected cloud gateway.

$cloudgateway = Get-VBRCloudGateway -Name "Cloud gateway"

Disable-VBRCloudGateway -CloudGateway $cloudgateway

Perform the following steps:

Run the Get-VBRCloudGateway cmdlet. Specify the Name parameter value. Save the result to the $cloudgateway variable.
Run the Disable-VBRCloudGateway cmdlet. Set the $cloudgateway variable as the CloudGateway parameter value.

Disable-VBRCloudGateway Example 2. Disabling Cloud Gateway [Using Pipeline]

This example shows how to disable the selected cloud gateway.

Get-VBRCloudGateway -Name "Cloud gateway" | Disable-VBRCloudGateway

Perform the following steps:

Run the Get-VBRCloudGateway cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Disable-VBRCloudGateway cmdlet.

Related Commands

Get-VBRCloudGateway