Get-NetAdapterSriov

Gets the SR-IOV properties of the network adapter.

Syntax

Get-NetAdapterSriov
   -InterfaceDescription <String[]>
   [-IncludeHidden]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetAdapterSriov
   [[-Name] <String[]>]
   [-IncludeHidden]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NetAdapterSriov cmdlet gets the Single-Root I/O Virtualization (SR-IOV) properties of network adapters that support SR-IOV. SR-IOV enables network traffic to by-pass the software switch layer of the Hyper-V virtualization stack. As a result, the I/O overhead in the software emulation layer is diminished and can achieve network performance that is nearly the same performance as in non-virtualized environments. Run this cmdlet to display how the hardware is set to support SR-IOV. This cmdlet will display the properties of the network adapter that relate to SR-IOV, such as the number of ports, and virtual functions (VFs). The property SriovSupport indicates potential reasons for SR-IOV not functioning properly.

The possible values for SriovSupport include the following:

Examples

Example 1: Display SR-IOV properties for all SR-IOV-capable network adapters

PS C:\> Get-NetAdapterSriov -Name "*"

This command displays the SR-IOV properties for all SR-IOV-capable network adapters.

Example 2: Display SR-IOV properties for the specified network adapter

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

This command displays the SR-IOV properties for network adapter named Ethernet 2.

Example 3: Display SR-IOV properties for the network adapter with the specified interface description

PS C:\> Get-NetAdapterSriov -InterfaceDescription "Contoso 12345 Gigabit Network Device"

This command displays the SR-IOV properties for the network adapter with the interface description named Contoso 12345 Gigabit Network Device.

Example 4: Get all SR-IOV properties for all network adapters with SR-IOV enabled

PS C:\> Get-NetAdapterSriov -Name "*" | Where-Object -FilterScript { $_.Enabled -Eq $true }

This command gets the SR-IOV properties for the network adapter with SR-IOV enabled.

Required Parameters

-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[]
Aliases:ifDesc, InstanceID
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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
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[]
Aliases:Session
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. If a wildcard character is used to identify a network adapter, then the wildcard character is matched against both hidden and visible adapters.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies an array network adapter names. The name of the network adapter from which this cmdlet gets the SR-IOV properties.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
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

Inputs

None

Outputs

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

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.