Syntax
Set-VDVlanConfiguration [-DisableVlan] [-PrivateVlanId <Int32>] -VDPort <VDPort[]> [-VlanId <Int32>] [-VlanTrunkRange <VlanRangeList>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the virtual distributed port's VLAN configuration. For vSphere distributed switch and port group parameter sets, the cmdlet modifies the respective default port configuration.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Confirm | SwitchParameter | If 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. | false | False | |
DisableVlan | SwitchParameter | Sets the VLAN type to None. | false | False | |
PrivateVlanId | Int32 | Specifies the secondary VLAN ID of a vSphere distributed switch's private VLAN configuration entry. The VLAN IDs of 0 and 4095 are reserved and cannot be used. | false | False | |
VDPort | VDPort[] | Specifies the port whose VLAN configuration you want to modify. | true | True (ByValue) | |
VDPortgroup | VDPortgroup[] | Specifies the port group whose default VLAN port configuration you want to modify. | true | True (ByValue) | |
VDSwitch | VDSwitch[] | Specifies the vSphere distributed switch whose default VLAN port configuration you want to modify. | true | True (ByValue) | |
VlanId | Int32 | Specifies a new VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used. | false | False | |
VlanTrunkRange | VlanRangeList | Specifies a new VLAN trunk range. Valid values are strings representing ranges of IDs. For example, "1-4, 6, 8-9". | false | False | |
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
The updated entity - VDPort, VDPortgroup, or VDSwitchNotes
Examples
-------------------------- Example 1 --------------------------
Get-VDSwitch "MyVDSwitch" | Get-VDPort -ActiveOnly | Set-VDVlanConfiguration -PrivateVlanId 4
Assigns all active ports of a specific vSphere distributed switch named "MyVDSwitch" to a private VLAN with ID "4".
-------------------------- Example 2 --------------------------
Get-VDPortgroup "MyVDPorgroup" | Get-VDPort | Set-VDVlanConfiguration -VlanId 3
Assigns all ports of a specific distributed port group named "MyVDPorgroup" to a VLAN with ID "3".