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-NetAdapterRss

Set-NetAdapterRss

msft_netadapterrss.cmdletdefinition.cdxml

Synopsis

Sets the receive side scaling (RSS) properties on the network adapter.

Syntax

Set-NetAdapterRss [-Name] [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-IncludeHidden] [-MaxProcessorGroup] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-NumberOfReceiveQueues] [-PassThru] [-Profile] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterRss [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-IncludeHidden] [-MaxProcessorGroup] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-NumberOfReceiveQueues] [-PassThru] [-Profile] [-ThrottleLimit] [-InterfaceDescription] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterRss [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-MaxProcessorGroup] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-NumberOfReceiveQueues] [-PassThru] [-Profile] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetAdapterRss cmdlet sets the receive side scaling (RSS) properties on the network adapter. RSS is a scalability technology that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet. Without RSS in Windows Server® 2008, Windows Server® 2008 R2, and Windows Server® 2012; network traffic is received on the first processor which can quickly reach full utilization limiting receive network throughput. Many properties can be configured using the parameters to optimize the performance of RSS. The selection of the processors to use for RSS is an important aspect of load balancing. Most of the parameters for this cmdlet help to determine the processors used by RSS. A thorough understanding of RSS is recommended before modifying individual parameters. Selecting the correct profile should be sufficient in most scenarios.

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

-BaseProcessorGroup <UInt16>

Sets the base processor group of a non-uniform memory access (NUMA) node. This will impact the processor array used by RSS. This parameter is the lowest group number of any processors that appear in the processor array.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BaseProcessorNumber <Byte>

Sets the base processor number of a NUMA node. This parameter is the lowest processor number of any processors from the BaseProcessorGroup parameter that appear in the processor array. This allows for partitioning processors across network adapters.

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 RSS on an interface

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.

Aliases

ifDesc

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-MaxProcessorGroup <UInt16>

Sets the maximum processor group of a NUMA node. This parameter is the highest group number of any processors that appear in the processor array for this network adapter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxProcessorNumber <Byte>

Sets the maximum processor number of a NUMA node. This parameter is the highest processor number of any processors from the MaxProcessorGroup parameter that appear in the processor array for this network adapter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxProcessors <UInt32>

Sets the maximum number of processors to be used concurrently by RSS from the processor array for load balancing network transmissions from a single network adapter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of the network adapter.

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

-NumaNode <UInt16>

Sets the NUMA node affinity for a network adapter. This will ensure that a given network transmission is load balanced by RSS within the NUMA node. This affects the memory allocation and also impacts the preference and ordering of the processors in the processor array. It does not affect the set of processors contained in the array, but it may impact the subset of the array that RSS actually uses.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NumberOfReceiveQueues <UInt32>

Specifies the number of receive queues per network adapter that is to be used by the interface

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

-Profile <Profile>

Specifies the RSS profile. The acceptable values for this parameter are:  Closest, ClosestStatic, NUMA, NUMAStatic, or Conservative. - Closest: Behavior is consistent with the behavior of Windows Server® 2008 R2. - ClosestStatic: No dynamic load balancing, such as distributing but not load balancing at runtime. - NUMA: Assigns RSS processors in a round robin basis across every NUMA node to enable applications that are running on NUMA servers to scale well. - NUMAStatic: Default behavior. RSS processor selection is the same as for NUMA scalability without dynamic load balancing. - Conservative: RSS uses as few processors as possible to sustain the load. This option helps reduce the number of interrupts.

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_NetAdapterRssSettingData[]

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example sets an RSS profile for a non-uniform memory access (NUMA) server without dynamic load balancing.

PS C:\>Set-NetAdapterRss –Name "Ethernet" -Profile NUMAStatic

Online Version
Disable-NetAdapterRss
Enable-NetAdapterRss
Get-NetAdapterRss