Remove-VBRDefaultGateway

Short Description

Removes default cloud gateways.

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRDefaultGateway -Gateway <VBRDefaultGateway> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected cloud default gateway.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Gateway	Specifies the default cloud gateway you want to remove. Accepts the `VBRDefaultGateway` object. To get this object, run the `Get-VBRDefaultGatewayConfiguration` cmdlet.	`VBRDefaultGateway`	True	Named	True (ByPropertyName, ByValue)
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
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

<CommonParameters>

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

Output Object

Examples

Removing Default Gateway [Using Pipeline]

This example shows how to remove a default gateway.

$configuration = Get-VBRDefaultGatewayConfiguration

$configuration.DefaultGateway | Remove-VBRDefaultGateway

Perform the following steps:

Run the Get-VBRDefaultGatewayConfiguration cmdlet. Save it to $configuration variable.
Get the default gateway using the DefaultGateway property of the $configuration variable. Pipe the result to the Remove-VBRDefaultGateway cmdlet.