| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml |
Hyper-V |
12/20/2016 |
2.0.0 |
Set-VMNetworkAdapterVlan |
Configures the virtual LAN settings for the traffic through a virtual network adapter.
Set-VMNetworkAdapterVlan [-VMNetworkAdapterName <String>] [-CimSession <CimSession[]>]
[-ComputerName <String[]>] [-Credential <PSCredential[]>] [-VMName] <String[]> [-Untagged] [-Access]
[-VlanId <Int32>] [-Trunk] [-NativeVlanId <Int32>] [-AllowedVlanIdList <String>] [-Isolated] [-Community]
[-Promiscuous] [-PrimaryVlanId <Int32>] [-SecondaryVlanId <Int32>] [-SecondaryVlanIdList <String>] [-Passthru]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-VMNetworkAdapterVlan [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Untagged] [-Access] [-VlanId <Int32>]
[-Trunk] [-NativeVlanId <Int32>] [-AllowedVlanIdList <String>] [-Isolated] [-Community] [-Promiscuous]
[-PrimaryVlanId <Int32>] [-SecondaryVlanId <Int32>] [-SecondaryVlanIdList <String>] [-Passthru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-VMNetworkAdapterVlan [-ManagementOS] [-VMNetworkAdapterName <String>] [-CimSession <CimSession[]>]
[-ComputerName <String[]>] [-Credential <PSCredential[]>] [-Untagged] [-Access] [-VlanId <Int32>] [-Trunk]
[-NativeVlanId <Int32>] [-AllowedVlanIdList <String>] [-Isolated] [-Community] [-Promiscuous]
[-PrimaryVlanId <Int32>] [-SecondaryVlanId <Int32>] [-SecondaryVlanIdList <String>] [-Passthru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-VMNetworkAdapterVlan [-VMNetworkAdapterName <String>] [-VM] <VirtualMachine[]> [-Untagged] [-Access]
[-VlanId <Int32>] [-Trunk] [-NativeVlanId <Int32>] [-AllowedVlanIdList <String>] [-Isolated] [-Community]
[-Promiscuous] [-PrimaryVlanId <Int32>] [-SecondaryVlanId <Int32>] [-SecondaryVlanIdList <String>] [-Passthru]
[-WhatIf] [-Confirm] [<CommonParameters>]
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.
PS C:\> Set-VMNetworkAdapterVlan -VMName Redmond -Access -VlanId 121
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 -Trunk -AllowedVlanIdList 1-100 -NativeVlanId 10
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:\> Get-VMNetworkAdapter -VMName Redmond | Set-VMNetworkAdapterVlan -Isolated -PrimaryVlanId 10 -SecondaryVlanId 200
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 WA | Set-VMNetworkAdapterVlan -Promiscuous -PrimaryVlanId 10 -SecondaryVlanIdList 200-201
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-VM Redmond | Set-VMNetworkAdapterVlan -Untagged
Gets virtual machine Redmond and sets the virtual network adapters in the virtual machine to the untagged mode.
PS C:\> Set-VMNetworkAdapterVlan -ManagementOS -Access -VlanID 20
Sets the virtual switch in the management OS to the Access mode. Traffic sent by this virtual switch is tagged with VLAN ID 20.
Specifies Access mode for the virtual machine network adapter. This parameter configures an untagged virtual port with the VLANId (port based VLAN), so it must be specified together with VlanId.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: a
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a list of virtual LANs allowed on a virtual machine network adapter. This parameter must be specified in conjunction with the switch parameter Trunk.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: VMName, ManagementOS
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies Community mode for the virtual machine network adapter to be configured. This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanId.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: c
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: String[]
Parameter Sets: VMName, ManagementOS
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies one or more user accounts that have permission to perform this action. The default is the current user.
Type: PSCredential[]
Parameter Sets: VMName, ManagementOS
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies Isolated mode for the virtual machine network adapter to be configured. This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanId.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: i
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the management (e.g. parent or host) operating system.
Type: SwitchParameter
Parameter Sets: ManagementOS
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the native virtual LAN identifier for a virtual machine network adapter. This parameter must be specified in conjunction with the switch parameter Trunk.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies that a Microsoft.HyperV.PowerShell.VMNetworkAdapterVlanSetting object is to be passed through to the pipeline representing the virtual machine network adapter virtual LAN settings to be configured.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies Promiscuous mode for the virtual machine network adapter.
This parameter must be specified in conjunction with parameters PrimaryVlanId and SecondaryVlanIdList.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: p
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies Trunk mode for the virtual machine network adapter. This parameter configures a tagged virtual port that passes all allowed VLANId tags to the VM adapter. Traffic with the NativeVLANId is passed untagged to the VM adapter. This parameter must be used in conjunction with parameters AllowedVlanIdList and NativeVlanId.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: t
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies Untagged mode for the virtual machine network adapter.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: u
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the virtual machine.
Type: VirtualMachine[]
Parameter Sets: VMObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the virtual machine.
Type: String[]
Parameter Sets: VMName
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the virtual machine network adapter.
Type: VMNetworkAdapterBase[]
Parameter Sets: ResourceObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of the virtual machine network adapter.
Type: String
Parameter Sets: VMName, ManagementOS, VMObject
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the virtual LAN identifier of a virtual machine network adapter. This parameter must be specified in conjunction with switch parameter Access.
Type: Int32
Parameter Sets: (All)
Aliases: AccessVlanId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Default
If -PassThru is specified.
Configure and View VLAN Settings on Hyper-V Virtual Switch Ports