Get-NetAdapterVPort

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

Syntax

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

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 (VF) settings, if the function ID is provided.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

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

Required Parameters

-InterfaceDescription

Specifies the network adapter interface description. 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[]
Aliases:ifDesc
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True

Optional Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FunctionID

Specifies the ID of the SR-IOV VF settings to display.

Type:UInt16[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludeHidden

Specifies both visible and hidden network adapters should be included. 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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:True
-PhysicalFunction

Specifies the physical function (PF) as the network adapter for the VPort.

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

Specifies the virtual switch port number that will be 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[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

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.