Edit

Share via

New-NetIntentAdapterRssOverrides

Module:
NetworkATC Module

Creates a new instance of RSS overrides which can be used to supply granular values to Set-NetIntent.

Syntax

Default (Default) 

New-NetIntentAdapterRssOverrides
    [-RssEnabled <Boolean>]
    [-BaseProcessorGroup <UInt16>]
    [-BaseProcessorNumber <Byte>]
    [-MaxProcessorGroup <UInt16>]
    [-MaxProcessorNumber <Byte>]
    [-MaxProcessors <UInt32>]
    [-Profile <String>]
    [<CommonParameters>]

Description

The New-NetIntentAdapterRssOverrides cmdlet creates a new instance of Receive Side Scaling (RSS) overrides. These overrides allow you to specify detailed processor and RSS configuration settings, which can be applied using the Set-NetIntent cmdlet.

Examples

Example

$params = @{
    RssEnabled          = $true
    BaseProcessorGroup  = 0
    BaseProcessorNumber = 2
    MaxProcessorGroup   = 0
    MaxProcessorNumber  = 8
    MaxProcessors       = 4
}
New-NetIntentAdapterRssOverrides @params

This example demonstrates how to create a new RSS override instance with RSS enabled. It specifies the base processor group and number, as well as the maximum processor group and number. Additionally, it sets the total number of processors to be used for RSS to 4.

Parameters

-BaseProcessorGroup

Specifies the base processor group. This is the starting group number for the processors that will be used by RSS.

Parameter properties

Type:UInt16
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BaseProcessorNumber

Specifies the base processor number within the base processor group in bytes. This is the starting processor number within the base group for RSS.

Parameter properties

Type:Byte
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxProcessorGroup

Specifies the maximum processor group. This defines the last group number that will be used by RSS.

Parameter properties

Type:UInt16
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxProcessorNumber

Specifies the maximum processor number within the maximum processor group. This defines the last processor number within the maximum group that will be used by RSS.

Parameter properties

Type:Byte
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxProcessors

Specifies the total number of processors that RSS can use. This limits the number of processors that can handle network traffic.

Parameter properties

Type:UInt32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Profile

Specifies the profile to be used for the RSS settings. This can be a custom profile name that contains predefined RSS settings.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RssEnabled

Specifies whether RSS should be enabled. When RSS is enabled, network traffic is distributed across multiple processors to improve performance.

Parameter properties

Type:Boolean
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.