Export (0) Print
Expand All
Expand Minimize

Set-NetAdapterSriov

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-NetAdapterSriov

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

Parameter Set: ByName
Set-NetAdapterSriov [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-IncludeHidden] [-NoRestart] [-NumVFs <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByInstanceID
Set-NetAdapterSriov -InterfaceDescription <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-IncludeHidden] [-NoRestart] [-NumVFs <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-NetAdapterSriov -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Enabled <Boolean> ] [-NoRestart] [-NumVFs <UInt32> ] [-PassThru] [-ThrottleLimit <Int32> ] [-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

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

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

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

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

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • 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.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • 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.
    The output object will have the updated SR-IOV settings.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft