< Back
Get-NetAdapterVPort
Post
NAME Get-NetAdapterVPort
SYNOPSIS
Displays the network adapter VPort settings for a SR-IOV or VMQ VPort.
SYNTAX
Get-NetAdapterVPort [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-FunctionID <UInt16[]>] [-IncludeHidden] [-PhysicalFunction]
[-SwitchID <UInt32[]>] [-ThrottleLimit <Int32>] [-VPortID <UInt32[]>] [<CommonParameters>]
Get-NetAdapterVPort [-AsJob] [-CimSession <CimSession[]>] [-FunctionID <UInt16[]>] [-IncludeHidden] [-PhysicalFunction] [-SwitchID <UInt32[]>]
[-ThrottleLimit <Int32>] [-VPortID <UInt32[]>] -InterfaceDescription <String[]> [<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.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CimSession <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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FunctionID <UInt16[]>
Specifies the ID of the SR-IOV virtual function settings to display as an array.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceDescription <String[]>
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-PhysicalFunction [<SwitchParameter>]
Specifies the physical function as the network adapter for the VPort.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SwitchID <UInt32[]>
Specifies the virtual switch ID to identify which network adapter for one or more VPorts.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit <Int32>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPortID <UInt32[]>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Online Version:
Get-NetAdapterSriov
Get-NetAdapterVmq
SYNOPSIS
Displays the network adapter VPort settings for a SR-IOV or VMQ VPort.
SYNTAX
Get-NetAdapterVPort [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-FunctionID <UInt16[]>] [-IncludeHidden] [-PhysicalFunction]
[-SwitchID <UInt32[]>] [-ThrottleLimit <Int32>] [-VPortID <UInt32[]>] [<CommonParameters>]
Get-NetAdapterVPort [-AsJob] [-CimSession <CimSession[]>] [-FunctionID <UInt16[]>] [-IncludeHidden] [-PhysicalFunction] [-SwitchID <UInt32[]>]
[-ThrottleLimit <Int32>] [-VPortID <UInt32[]>] -InterfaceDescription <String[]> [<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.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CimSession <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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FunctionID <UInt16[]>
Specifies the ID of the SR-IOV virtual function settings to display as an array.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceDescription <String[]>
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-PhysicalFunction [<SwitchParameter>]
Specifies the physical function as the network adapter for the VPort.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SwitchID <UInt32[]>
Specifies the virtual switch ID to identify which network adapter for one or more VPorts.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ThrottleLimit <Int32>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VPortID <UInt32[]>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
RELATED LINKS
Online Version:
Get-NetAdapterSriov
Get-NetAdapterVmq