Get-VMNetworkAdapterVlan

  • Reference
Module:
Hyper-V

Gets the virtual LAN settings configured on a virtual network adapter.

Syntax

Get-VMNetworkAdapterVlan
   [[-VMName] <String[]>]
   [-VMNetworkAdapterName <String>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]
Get-VMNetworkAdapterVlan
   [-VMSnapshot] <VMSnapshot>
   [<CommonParameters>]
Get-VMNetworkAdapterVlan
   [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
   [<CommonParameters>]
Get-VMNetworkAdapterVlan
   [-ManagementOS]
   [-VMNetworkAdapterName <String>]
   [-CimSession <CimSession[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential[]>]
   [<CommonParameters>]
Get-VMNetworkAdapterVlan
   [-VMNetworkAdapterName <String>]
   [-VM] <VirtualMachine[]>
   [<CommonParameters>]

Description

The Get-VMNetworkAdapterVlan cmdlet gets the virtual LAN settings configured on a virtual network adapter.

Examples

Example 1

PS C:\> Get-VMNetworkAdapterVlan

Gets the virtual LAN settings for each virtual network adapter in all virtual machines on the system.

Parameters

-CimSession

Runs 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[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies one or more Hyper-V hosts on which the virtual LAN settings configured on a virtual network adapter are to be retrieved. 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[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagementOS

Specifies that the virtual LAN settings are to be retrieved from the management (i.e. parent, or host) operating system.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VM

Specifies the virtual machine in which the virtual LAN settings configured on a virtual network adapter are to be retrieved.

Type:VirtualMachine[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMName

Specifies the name of the virtual machine in which the virtual LAN settings configured on a virtual network adapter are to be retrieved.

Friendly name of the virtual machine

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMNetworkAdapter

Specifies the virtual network adapter for which the virtual LAN settings are to be retrieved.

Type:VMNetworkAdapterBase[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VMNetworkAdapterName

Specifies the name of the virtual network adapter for which the virtual LAN settings are to be retrieved.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMSnapshot

Specifies the snapshot in which the virtual LAN settings are to be retrieved.

Type:VMSnapshot
Aliases:VMCheckpoint
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Microsoft.HyperV.PowerShell.VMNetworkAdapterVlanSetting