Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetAdapterSriov

Set-NetAdapterSriov

msft_netadaptersriov.cdxml

Synopsis

Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts.

Syntax

Set-NetAdapterSriov [-Name] [-AsJob] [-CimSession] [-Enabled] [-IncludeHidden] [-NoRestart] [-NumVFs] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterSriov [-AsJob] [-CimSession] [-Enabled] [-NoRestart] [-NumVFs] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterSriov [-AsJob] [-CimSession] [-Enabled] [-IncludeHidden] [-NoRestart] [-NumVFs] [-PassThru] [-ThrottleLimit] [-InterfaceDescription] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetAdapterSriov cmdlet sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter. The properties include the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts. The enabled state of SR-IOV can also be set with the cmdlet.

The network adapter for these actions can be specified with the adapter name, interface description, or piped as an input object.

Parameters

-AsJob <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Enabled <Boolean>

Sets the enabled state of SR-IOV on the network adapter. If set to True, then SR-IOV is Enabled. If set to False, then SR-IOV is Disabled.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IncludeHidden <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-InterfaceDescription <String[]>

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. The network adapter can be selected using the Name parameter, this parameter, or piped in using the InputObject parameter.

Aliases

ifDesc

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-Name <String[]>

Specifies the name of the network adapter. The network adapter can be selected using this parameter, the InterfaceDescription parameter, or piped in using the InputObject parameter.

Aliases

ifAlias, InterfaceAlias

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-NoRestart <SwitchParameter>

Specifies that the network adapter is not restarted as part of running this cmdlet. Note: Many advanced properties require restarting the network adapter before the new settings take effect.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NumVFs <UInt32>

Specifies the number of VFs that the network adapter exposes for SR-IOV. This is the maximum number of VFs that Windows Server 2012 and later will allocate on this network adapter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

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

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example sets the number of VFs available to 31 on the network adapter named Ethernet 2.

PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31

EXAMPLE 2

This example sets the number of VFs to 31 and the total number of VPorts to 64. This will result in 31 VF and 32 virtual machine queue (VMQ), plus 1 used by the physical function (PF). Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used will be 128.

PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2

Online Version
Disable-NetAdapterSriov
Enable-NetAdapterSriov
Get-NetAdapterSriov
Get-NetAdapterSriovVf