Set-VMNetworkAdapterVlan

Set-VMNetworkAdapterVlan

Configures the virtual LAN settings for the traffic through a virtual network adapter.

Syntax

Parameter Set: VMName
Set-VMNetworkAdapterVlan [-VMName] <String[]> [-Access] [-AllowedVlanIdList <String> ] [-Community] [-ComputerName <String[]> ] [-Isolated] [-NativeVlanId <Int32> ] [-Passthru] [-PrimaryVlanId <Int32> ] [-Promiscuous] [-SecondaryVlanId <Int32> ] [-SecondaryVlanIdList <String> ] [-Trunk] [-Untagged] [-VlanId <Int32> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ManagementOS
Set-VMNetworkAdapterVlan -ManagementOS [-Access] [-AllowedVlanIdList <String> ] [-Community] [-ComputerName <String[]> ] [-Isolated] [-NativeVlanId <Int32> ] [-Passthru] [-PrimaryVlanId <Int32> ] [-Promiscuous] [-SecondaryVlanId <Int32> ] [-SecondaryVlanIdList <String> ] [-Trunk] [-Untagged] [-VlanId <Int32> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ResourceObject
Set-VMNetworkAdapterVlan [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Access] [-AllowedVlanIdList <String> ] [-Community] [-Isolated] [-NativeVlanId <Int32> ] [-Passthru] [-PrimaryVlanId <Int32> ] [-Promiscuous] [-SecondaryVlanId <Int32> ] [-SecondaryVlanIdList <String> ] [-Trunk] [-Untagged] [-VlanId <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMNetworkAdapterVlan [-VM] <VirtualMachine[]> [-Access] [-AllowedVlanIdList <String> ] [-Community] [-Isolated] [-NativeVlanId <Int32> ] [-Passthru] [-PrimaryVlanId <Int32> ] [-Promiscuous] [-SecondaryVlanId <Int32> ] [-SecondaryVlanIdList <String> ] [-Trunk] [-Untagged] [-VlanId <Int32> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-VMNetworkAdapterVlan cmdlet configures virtual LAN settings for the traffic through a virtual network adapter. Access, Trunk, Private VLAN (isolated, community, or promiscuous), and untagged are mutually exclusive.

Parameters

-Access

Specifies Access mode for the virtual machine network adapter. This parameter must be specified in conjunction with parameter VlanId.

Aliases	a
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AllowedVlanIdList<String>

Specifies a list of virtual LANs allowed on a virtual machine network adapter. This parameter must be specified in conjunction with the switch parameter Trunk.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Community

Specifies Community mode for the virtual machine network adapter to be configured. This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanId.

Aliases	c
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the virtual LAN settings on a virtual machine network adapter are to be configured. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Isolated

Specifies Isolated mode for the virtual machine network adapter to be configured. This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanId.

Aliases	i
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ManagementOS

Specifies the management (e.g. parent OS, or host) operating system.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NativeVlanId<Int32>

Specifies the native virtual LAN identifier for a virtual machine network adapter. This parameter must be specified in conjunction with the switch parameter Trunk.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Passthru

Specifies that a Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting object is to be passed through to the pipeline representing the virtual machine network adapter virtual LAN settings to be configured.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PrimaryVlanId<Int32>

Specifies the primary virtual LAN identifier for a virtual network adapter in Community, Isolated, or Promiscuous mode.

This parameter must be specified in conjunction with parameter SecondaryVlanId if the virtual machine network adapter is in Community or Isolated mode. It must be used in conjunction with parameter SecondaryVlanIdList if the virtual machine network adapter is in Promiscuous mode.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Promiscuous

Specifies Promiscuous mode for the virtual machine network adapter.

This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanIdList.

Aliases	p
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SecondaryVlanId<Int32>

Specifies the secondary virtual LAN identifier for a virtual network adapter in Community or Isolated mode.

This parameter must be specified in conjunction with parameter PrimaryVlanId, along with switch parameter Community or Isolated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SecondaryVlanIdList<String>

Specifies a list of private virtual LAN secondary virtual LANs on a virtual machine network adapter.This parameter must be specified in conjunction with parameter PrimaryVlanId and switch parameter Promiscuous.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Trunk

Specifies Trunk mode for the virtual machine network adapter. This parameter must be used in conjunction with parameters AllowedVlanIdList and NativeVlanId.

Aliases	t
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Untagged

Specifies Untagged mode for the virtual machine network adapter.

Aliases	u
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

Specifies the name of the virtual machine.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMNetworkAdapter<VMNetworkAdapterBase[]>

Specifies the virtual machine network adapter.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMNetworkAdapterName<String>

Specifies the name of the virtual machine network adapter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VlanId<Int32>

Specifies the virtual LAN identifier of a virtual machine network adapter. This parameter must be specified in conjunction with switch parameter Access.

Aliases	AccessVlanId
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None by default; Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting if –PassThru is specified.

Examples

Example 1

Sets the virtual network adapter(s) in virtual machine Redmond to the Access mode. Traffic sent by this virtual machine is tagged with VLAN ID 121.

PS C:\> Set-VMNetworkAdapterVlan –VMName Redmond –Access –VlanId 121

Example 2

Sets the virtual network adapter(s) in virtual machine Redmond to the Trunk mode. Any traffic tagged with one of the VLAN IDs in the allowed VLAN list will be permitted to be sent or received by the VLAN. If traffic is untagged, it will be treated as if it were on VLAN 10.

PS C:\> Set-VMNetworkAdapterVlan -VMName Redmond -Trunk -AllowedVlanIdList 1-100 -NativeVlanId 10

Example 3

Gets the virtual network adapters from virtual machine Redmond and sets them to the Private VLAN isolated mode, where primary VLAN is 10 and the secondary VLAN is 200.

PS C:\> Get-VMNetworkAdapter -VMName Redmond | Set-VMNetworkAdapterVlan -Isolated -PrimaryVlanId 10 -SecondaryVlanId 200

Example 4

Gets the virtual network adapters from virtual machine WA and sets them to the Private VLAN promiscuous mode, where primary VLAN is 10 and the secondary VLANs are 201 and 202.

PS C:\> Get-VMNetworkAdapter -VMName WA | Set-VMNetworkAdapterVlan -Promiscuous -PrimaryVlanId 10 -SecondaryVlanIdList 200-201

Example 5

Gets virtual machine Redmond and sets the virtual network adapters in the virtual machine to the untagged mode.

PS C:\> Get-VM Redmond | Set-VMNetworkAdapterVlan -Untagged