Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NetAdapterVPort

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Displays the network adapter VPort settings for a SR-IOV or VMQ VPort.

SYNTAX

ByName (Default)

Get-NetAdapterVPort [[-Name] <String[]>] [-VPortID <UInt32[]>] [-SwitchID <UInt32[]>] [-FunctionID <UInt16[]>]
 [-PhysicalFunction] [-IncludeHidden] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
 [<CommonParameters>]

ByInstanceID

Get-NetAdapterVPort -InterfaceDescription <String[]> [-VPortID <UInt32[]>] [-SwitchID <UInt32[]>]
 [-FunctionID <UInt16[]>] [-PhysicalFunction] [-IncludeHidden] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-NetAdapterVPort cmdlet displays the network adapter virtual port (VPort) settings for a Single-Root I/O Virtualization (SR-IOV) or virtual machine queue (VMQ) VPort.

Without a VPort specified, this cmdlet displays all VPorts on the network adapter with the port name, number and state.

Providing a specific VPort ID will display that specific VPort in long format.

Optionally, this cmdlet displays the SR-IOV virtual function settings, if the function ID is provided.

EXAMPLES

Example 1: Display all VPorts on the specified network adapter

PS C:\> Get-NetAdapterVPort -Name "Ethernet 2"

This command displays all VPorts on network adapter named Ethernet 2.

Example 2: Display the VPort summary for the specified port number for the specified network adapter

PS C:\> Get-NetAdapterVPort -Name "Ethernet Connection 2" -VPortID 3

This command displays the VPort summary for VPort 3 on the network adapter named Ethernet Connection 2.

PARAMETERS

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-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[]
Parameter Sets: (All)
Aliases: Session

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

-FunctionID

Specifies the ID of the SR-IOV virtual function settings to display as an array.

Type: UInt16[]
Parameter Sets: (All)
Aliases: VfID

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

-IncludeHidden

Indicates that the cmdlet includes both visible and hidden network adapters in the operation. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-InterfaceDescription

Specifies an array of network adapter interface descriptions. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.

Type: String[]
Parameter Sets: ByInstanceID
Aliases: ifDesc, InstanceID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies an array of network adapter names.

Type: String[]
Parameter Sets: ByName
Aliases: ifAlias, InterfaceAlias

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PhysicalFunction

Specifies the physical function as the network adapter for the VPort.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: PF

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

-SwitchID

Specifies the virtual switch ID to identify which network adapter for one or more VPorts.

Type: UInt32[]
Parameter Sets: (All)
Aliases: 

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

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type: Int32
Parameter Sets: (All)
Aliases: 

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

-VPortID

Specifies the virtual switch port number that is displayed in long format. Without this parameter, all VPorts or the specified range are displayed. Specifying a VPort will display long format for a single VPort.

Type: UInt32[]
Parameter Sets: (All)
Aliases: Id

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

CommonParameters

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

INPUTS

None

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVPortSettingData

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

NOTES

Get-NetAdapterSriov

Get-NetAdapterVmq

© 2017 Microsoft