Share via

MSFT_NetAdapterRssSettingData class

  • Article

Receive Side Scale (RSS) settings for a network adapter

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("NetAdapterCim")]
class MSFT_NetAdapterRssSettingData : MSFT_NetAdapterSettingData
{
  string  Caption;
  string  Description;
  string  ElementName;
  string  InstanceID;
  string  Name;
  string  InterfaceDescription;
  uint32  Source;
  string  SystemName;
  boolean Enabled;
  boolean MsiSupported;
  boolean MsiXSupported;
  boolean MsiXEnabled;
  boolean ClassificationAtIsrSupported;
  boolean ClassificationAtDpcSupported;
  boolean TcpIPv4HashSupported;
  boolean TcpIPv6HashSupported;
  boolean TcpIPv6ExtensionHashSupported;
  boolean ToeplitzHashFunctionSupported;
  boolean RssOnPortsSupported;
  uint32  NumberOfInterruptMessages;
  uint32  NumberOfReceiveQueues;
  boolean IPv4HashEnabled;
  boolean TcpIPv4HashEnabled;
  boolean IPv6HashEnabled;
  boolean IPv6ExtensionHashEnabled;
  boolean TcpIPv6HashEnabled;
  boolean TcpIPv6ExtensionHashEnabled;
  boolean ToeplitzHashFunctionEnabled;
  uint16  IndirectionTableEntryCount;
  uint16  HashKeySize;
  string  IndirectionTable[];
  uint32  Profile;
  uint16  BaseProcessorGroup;
  uint8   BaseProcessorNumber;
  uint16  MaxProcessorGroup;
  uint8   MaxProcessorNumber;
  uint32  MaxProcessors;
  uint16  NumaNode;
  uint32  RssProcessorArraySize;
  string  RssProcessorArray[];
};

Members

The MSFT_NetAdapterRssSettingData class has these types of members:

  • Methods
  • Properties

Methods

The MSFT_NetAdapterRssSettingData class has these methods.

Method Description
Disable

Disables the Receive Side Scaling (RSS) properties on the network adapter.
Enable

Enables the Receive Side Scaling (RSS) properties on the network adapter.

 

Properties

The MSFT_NetAdapterRssSettingData class has these properties.

BaseProcessorGroup

Data type: uint16

Access type: Read/write

Specifies the processor group number for the first RSS processor.

BaseProcessorNumber

Data type: uint8

Access type: Read/write

Specifies the processor number for the first RSS processor.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 64 )

A short textual description of the object. This property inherits from CIM_ManagedElement.

ClassificationAtDpcSupported

Data type: boolean

Access type: Read-only

TBD

ClassificationAtIsrSupported

Data type: boolean

Access type: Read-only

TBD

Description

Data type: string

Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits from CIM_ManagedElement.

Enabled

Data type: boolean

Access type: Read/write

Enabled.

HashKeySize

Data type: uint16

Access type: Read-only

The hash key size.

IndirectionTable

Data type: string array

Access type: Read-only

Pointer to the indirection table.

IndirectionTableEntryCount

Data type: uint16

Access type: Read-only

The indirection table entry count.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

This property inherits from CIM_SettingData.

InterfaceDescription

Data type: string

Access type: Read-only

Interface Description, also known as "ifDesc" or display name is a unique name assigned to the network adapter during installation. This name cannot be changed and is persisted as long as the network adapter is not uninstalled. This property inherits from MSFT_NetAdapterSettingData.

IPv4HashEnabled

Data type: boolean

Access type: Read-only

IPv4 hash enabled.

IPv6ExtensionHashEnabled

Data type: boolean

Access type: Read-only

IPv6 extension hash enabled.

IPv6HashEnabled

Data type: boolean

Access type: Read-only

IPv6 hash enabled.

MaxProcessorGroup

Data type: uint16

Access type: Read/write

Specifies the processor group number for the last RSS processor.

MaxProcessorNumber

Data type: uint8

Access type: Read/write

Specifies the processor number for the last RSS processor.

MaxProcessors

Data type: uint32

Access type: Read/write

Specifies the maximum number of RSS processors for the network adapter.

MsiSupported

Data type: boolean

Access type: Read-only

MSI supported.

MsiXEnabled

Data type: boolean

Access type: Read-only

MSI-X Enabled.

MsiXSupported

Data type: boolean

Access type: Read-only

MSI-X supported.

Name

Data type: string

Access type: Read-only

Name, also known as Connection Name, "ifAlias", or InterfaceAlias, is a unique name assigned to the adapter during installation. The Name of the adapter can be changed by the administrator and is persisted across the boot or network adapter restart. This property inherits from MSFT_NetAdapterSettingData.

NumaNode

Data type: uint16

Access type: Read/write

The numa mode.

NumberOfInterruptMessages

Data type: uint32

Access type: Read-only

The number of interrupt messages.

NumberOfReceiveQueues

Data type: uint32

Access type: Read/write

The number of receive queues.

Profile

Data type: uint32

Access type: Read/write

Specifies the processor selection and load balancing profile applied.

Closest Processor (1)

Closest Processor Static (2)

NUMA Scaling (3)

NUMA Scaling Static (4)

Conservative Scaling (5)

RssOnPortsSupported

Data type: boolean

Access type: Read-only

RSS on ports supported.

RssProcessorArray

Data type: string array

Access type: Read-only

pointer to the RSS processor array.

RssProcessorArraySize

Data type: uint32

Access type: Read-only

The RSS processor array size.

Source

Data type: uint32

Access type: Read-only

The source of the setting data. This property inherits from MSFT_NetAdapterSettingData.

Unknown (0)

Other (1)

Device (2)

Persistent storage (3)

SystemName

Data type: string

Access type: Read-only

The scoping System\'s Name. This property inherits from MSFT_NetAdapterSettingData.

TcpIPv4HashEnabled

Data type: boolean

Access type: Read-only

TCP/IPv4 hash enabled.

TcpIPv4HashSupported

Data type: boolean

Access type: Read-only

TBD

TcpIPv6ExtensionHashEnabled

Data type: boolean

Access type: Read-only

TCP/IPv6 extension hash enabled.

TcpIPv6ExtensionHashSupported

Data type: boolean

Access type: Read-only

TCP/IPv6 extension hash supported.

TcpIPv6HashEnabled

Data type: boolean

Access type: Read-only

TCP/IPv6 hash enabled.

TcpIPv6HashSupported

Data type: boolean

Access type: Read-only

TCP/IPv6 hash supported.

ToeplitzHashFunctionEnabled

Data type: boolean

Access type: Read-only

TBD

ToeplitzHashFunctionSupported

Data type: boolean

Access type: Read-only

TBD

Requirements

Minimum supported client

 None supported

Minimum supported server

 Windows Server 2012

Namespace

Root\StandardCimv2

MOF

 NetAdapterCim.mof

DLL

 NetAdapterCim.dll