Share via

MSFT_NetAdapterVmqSettingData class

  • Article

Network adapter Vritual Machine Queue (VMQ) settings

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

Syntax

[Dynamic, Provider("NetAdapterCim")]
class MSFT_NetAdapterVmqSettingData : MSFT_NetAdapterSettingData
{
  string  Caption;
  string  Description;
  string  ElementName;
  string  InstanceID;
  string  Name;
  string  InterfaceDescription;
  uint32  Source;
  string  SystemName;
  boolean Enabled;
  uint32  NumberOfReceiveQueues;
  uint32  TotalNumberOfMacAddresses;
  uint32  NumMacAddressesPerPort;
  uint32  NumVlansPerPort;
  boolean VlanFilteringSupported;
  boolean LookaheadSplitSupported;
  uint32  MinLookaheadSplitSize;
  uint32  MaxLookaheadSplitSize;
  boolean AnyVlanSupported;
  boolean DynamicProcessorAffinityChangeSupported;
  boolean InterruptVectorCoalescingSupported;
  uint16  BaseProcessorGroup;
  uint8   BaseProcessorNumber;
  uint32  MaxProcessors;
  uint8   MaxProcessorNumber;
  uint16  NumaNode;
};

Members

The MSFT_NetAdapterVmqSettingData class has these types of members:

  • Methods
  • Properties

Methods

The MSFT_NetAdapterVmqSettingData class has these methods.

Method Description
Disable

Disables the Virtual Machine Queue (VMQ) on the network adapter.
Enable

Enables the Virtual Machine Queue (VMQ) on the network adapter.

 

Properties

The MSFT_NetAdapterVmqSettingData class has these properties.

AnyVlanSupported

Data type: boolean

Access type: Read-only

Indicates that the network adapter supports filtering received packets matching a MAC address and any arbitrary VLAN ID.

BaseProcessorGroup

Data type: uint16

Access type: Read/write

Specifies the processor group number for the first VMQ processor.

BaseProcessorNumber

Data type: uint8

Access type: Read/write

Specifies the processor number for the first VMQ 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.

Description

Data type: string

Access type: Read-only

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

DynamicProcessorAffinityChangeSupported

Data type: boolean

Access type: Read-only

Indicates that the network adapter supports changing the processor affinity of a queue dynamically and without restarting the queue.

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

A boolean value that is set to TRUE if VMQ is enabled and FALSE if it is not.

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.

InterruptVectorCoalescingSupported

Data type: boolean

Access type: Read-only

Indicate that the network adapter supports using the same interrupt vector for multiple queues when all those queues are targeted to the same processor.

LookaheadSplitSupported

Data type: boolean

Access type: Read-only

Indicates that the network adapter supports splitting the received packets at a lookahead offset.

MaxLookaheadSplitSize

Data type: uint32

Access type: Read-only

The maximum size, in bytes, of the lookahead segment if lookahead split is enabled.

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 VMQ processors for the network adapter.

MinLookaheadSplitSize

Data type: uint32

Access type: Read-only

The minimum size, in bytes, of the lookahead segment if lookahead split is enabled.

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

Specifies the Numa Node for the RSS Processors.

NumberOfReceiveQueues

Data type: uint32

Access type: Read-only

Number of receive queues that the network adapter supports.

NumMacAddressesPerPort

Data type: uint32

Access type: Read-only

Number of supported MAC addresses per port.

NumVlansPerPort

Data type: uint32

Access type: Read-only

Number of VLANs supported per port.

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.

TotalNumberOfMacAddresses

Data type: uint32

Access type: Read-only

The total number of MAC addresses that the network adapter supports.

VlanFilteringSupported

Data type: boolean

Access type: Read-only

Indicates that the network adapter supports filtering received packets based on the VLAN ID.

Requirements

Minimum supported client

 None supported

Minimum supported server

 Windows Server 2012

Namespace

Root\StandardCimv2

MOF

 NetAdapterCim.mof

DLL

 NetAdapterCim.dll