< Back
Get-NetAdapterRss
Post
NAME Get-NetAdapterRss
SYNOPSIS
Gets RSS properties of the network adapter.
SYNTAX
Get-NetAdapterRss [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetAdapterRss [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] -InterfaceDescription <String[]>
[<CommonParameters>]
DESCRIPTION
The Get-NetAdapterRss cmdlet gets receive side scaling (RSS) properties of the network adapters that support RSS. RSS is a scalability technology
that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet and using an indirection
table. Without RSS in Windows Server???? 2012 and later, network traffic is received on the first processor which can quickly reach full utilization
limiting receive network throughput. Various properties can be configured to optimize the performance of RSS.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceDescription <String[]>
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData
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.
Example 1: Get all RSS capable network adapters
PS C:\\>Get-NetAdapterRss ????????Name "*"
This example gets all RSS capable network adapters.
Example 2: Get RSS properties for the specified network adapter
PS C:\\>Get-NetAdapterRss ????????Name "MyAdapter"
This example gets the RSS properties of the network adapter named MyAdapter.
Example 3: Display all RSS properties for the specified network adapter
PS C:\\>Get-NetAdapterRss ????????Name MyAdapter | Format-List -Property "*"
This example displays all RSS properties of the network adapter named MyAdapter.
Example 4: Get all RSS capable network adapters with RSS enabled
PS C:\\>Get-NetAdapterRss ????????Name "*" | Where-Object -FilterScript { $_.Enabled }
This example gets all RSS capable network adapters with RSS enabled.
RELATED LINKS
Online Version:
Disable-NetAdapterRss
Enable-NetAdapterRss
Set-NetAdapterRss
SYNOPSIS
Gets RSS properties of the network adapter.
SYNTAX
Get-NetAdapterRss [[-Name] <String[]>] [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-NetAdapterRss [-AsJob] [-CimSession <CimSession[]>] [-IncludeHidden] [-ThrottleLimit <Int32>] -InterfaceDescription <String[]>
[<CommonParameters>]
DESCRIPTION
The Get-NetAdapterRss cmdlet gets receive side scaling (RSS) properties of the network adapters that support RSS. RSS is a scalability technology
that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet and using an indirection
table. Without RSS in Windows Server???? 2012 and later, network traffic is received on the first processor which can quickly reach full utilization
limiting receive network throughput. Various properties can be configured to optimize the performance of RSS.
PARAMETERS
-AsJob [<SwitchParameter>]
ps_cimcommon_asjob
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeHidden [<SwitchParameter>]
Indicates that the cmdlet includes both visible and hidden network adapters in the operation. 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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceDescription <String[]>
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.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-Name <String[]>
Specifies an array of network adapter names.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData
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.
Example 1: Get all RSS capable network adapters
PS C:\\>Get-NetAdapterRss ????????Name "*"
This example gets all RSS capable network adapters.
Example 2: Get RSS properties for the specified network adapter
PS C:\\>Get-NetAdapterRss ????????Name "MyAdapter"
This example gets the RSS properties of the network adapter named MyAdapter.
Example 3: Display all RSS properties for the specified network adapter
PS C:\\>Get-NetAdapterRss ????????Name MyAdapter | Format-List -Property "*"
This example displays all RSS properties of the network adapter named MyAdapter.
Example 4: Get all RSS capable network adapters with RSS enabled
PS C:\\>Get-NetAdapterRss ????????Name "*" | Where-Object -FilterScript { $_.Enabled }
This example gets all RSS capable network adapters with RSS enabled.
RELATED LINKS
Online Version:
Disable-NetAdapterRss
Enable-NetAdapterRss
Set-NetAdapterRss