This is an archive version of the document. To get the most up-to-date information, see the current version.

Remove-VBRDefaultGateway

Short Description

Removes cloud default gateways.

Applies to

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

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Gateway

Specifies the default cloud gateway you want to remove.

Accepts VBRDefaultGateway type.

True

Named

True (ByValue,
ByProperty
Name)

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

VBRDefaultGateway

Example

This example shows how to remove a default gateway.

  1. Run Get-VBRDefaultGatewayConfiguration to get the default gateway configuration you want to edit. Save it to $configuration variable.
  2. Get the default gateway using the DefaultGateway property of the $configuration variable. Pass the result to Remove-VBRDefaultGateway. Use the pipeline.

$configuration = Get-VBRDefaultGatewayConfiguration

$configuration.DefaultGateway | Remove-VBRDefaultGateway