PowerCLI Reference

Remove-VDPortGroup

Synopsis

This cmdlet removes distributed port groups.

Syntax

Remove-VDPortGroup [-VDPortGroup] <VDPortgroup[]> [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
New-VDPortgroup
Get-VDPortgroup
Set-VDPortgroup
Export-VDPortgroup

Detailed Description

This cmdlet removes distributed port groups.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VDPortGroupVDPortgroup[]Specifies the distributed port group that you want to remove.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

None

Notes

Examples

-------------------------- Example 1 --------------------------

Get-VDPortGroup -Name "MyVDPortGroup" | Remove-VDPortGroup

Removes the specified distributed port group from the vSphere distributed switch that it belongs to.


Copyright © VMware, Inc. All rights reserved.