## PowerCLI Reference

# Set-VDVlanConfiguration

## Synopsis

This cmdlet modifies the virtual distributed port's VLAN configuration.

Syntax

Set-VDVlanConfiguration -VDPortgroup <VDPortgroup[]> [-DisableVlan] [-VlanId <Int32>] [-VlanTrunkRange <VlanRangeList>] [-PrivateVlanId <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VDVlanConfiguration -VDSwitch <VDSwitch[]> [-DisableVlan] [-VlanId <Int32>] [-VlanTrunkRange <VlanRangeList>] [-PrivateVlanId <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VDVlanConfiguration -VDPort <VDPort[]> [-DisableVlan] [-VlanId <Int32>] [-VlanTrunkRange <VlanRangeList>] [-PrivateVlanId <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version

Detailed 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 VDSwitch

Notes

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".

Copyright © VMware, Inc. All rights reserved.