Remove-VBRCloudVLANConfiguration

Short Description

Removes pools of VLANs reserved for Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

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

Requires a VCP license.

Syntax

Remove-VBRCloudVLANConfiguration -Configuration <VBRCloudVLANConfiguration> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes a selected VLAN pool.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Configuration

Specifies the VLAN configuration you want to remove.

Accepts the VBRCloudVLANConfiguration object. To get this object, run the Get-VBRCloudVLANConfiguration 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

<CommonParameters>

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

Output Object

None.

Examples

Removing Selected Pool of VLANs

This example shows how to remove a selected pool of VLANs.

$configs = Get-VBRCloudVLANConfiguration

Remove-VBRCloudVLANConfiguration -Configuration $configs[0]

Perform the following steps:

  1. Run the Get-VBRCloudVLANConfiguration cmdlet. Save the array of pools to the $configs variable.

Mind the ordinal number of the necessary VLAN pool (in our example, it is the first VLAN pool in the array).

  1. Run the Remove-VBRCloudVLANConfiguration cmdlet. Set the $configs variable as the Configuration parameter value.

Related Commands

Get-VBRCloudVLANConfiguration

Page updated 5/7/2024

Page content applies to build 12.1.2.172