Edit

Share via


Get-VMNetworkAdapterVlan

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

Syntax

VMName (Default)

Get-VMNetworkAdapterVlan
    [[-VMName] <String[]>]
    [-VMNetworkAdapterName <String>]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [<CommonParameters>]

VMSnapshot

Get-VMNetworkAdapterVlan
    [-VMSnapshot] <VMSnapshot>
    [<CommonParameters>]

ResourceObject

Get-VMNetworkAdapterVlan
    [-VMNetworkAdapter] <VMNetworkAdapterBase[]>
    [<CommonParameters>]

ManagementOS

Get-VMNetworkAdapterVlan
    [-ManagementOS]
    [-VMNetworkAdapterName <String>]
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [<CommonParameters>]

VMObject

Get-VMNetworkAdapterVlan
    [-VM] <VirtualMachine[]>
    [-VMNetworkAdapterName <String>]
    [<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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagementOS

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ManagementOS
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VM

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

Parameter properties

Type:

VirtualMachine[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments: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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMNetworkAdapter

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

Parameter properties

Type:

VMNetworkAdapterBase[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceObject
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMNetworkAdapterName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ManagementOS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
VMObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSnapshot

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

Parameter properties

Type:VMSnapshot
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VMCheckpoint

Parameter sets

VMSnapshot
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.HyperV.PowerShell.VMNetworkAdapterVlanSetting