This is an archive version of the document. To get the most up-to-date information, see the current version.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[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet disables a selected cloud gateway. Disabling a gateway temporarily suspends all operations on it. Run Enable-VBRCloudGateway to enable a disabled cloud gateway.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
CloudGateway | Specifies the array of cloud gateways you want to disable. Accepts the VBRCloudGateway type. | True | Named | True (ByValue, | 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 1
This command disables a cloud gateway represented by the '$cloudgateway' variable.
The cloud gateway is obtained with Get-VBRCloudGateway and assigned to the variable beforehand.
Example 2
This command disables the selected cloud gateway.
The cloud gateway is obtained with Get-VBRCloudGateway and piped down.
Related Commands
