Export (0) Print
Expand All
Expand Minimize

MSFT_NetAdapterVmqQueueSettingData class

Network adapter VMQ settings for each queue

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

Syntax

[Dynamic, Provider("NetAdapterCim")]class MSFT_NetAdapterVmqQueueSettingData : MSFT_NetAdapterSettingData
{
  string                     Caption;
  string                     Description;
  string                     ElementName;
  string                     InstanceID;
  string                     Name;
  string                     InterfaceDescription;
  uint32                     Source;
  string                     SystemName;
  CIM_ManagedElement         REF ManagedElement;
  CIM_SettingData            REF SettingData;
  uint16                     REF IsDefault;
  uint16                     REF IsCurrent;
  uint16                     REF IsNext;
  uint16                     REF IsMinimum = 0;
  uint16                     REF IsMaximum = 0;
  MSFT_NetAdapter            REF ManagedElement;
  MSFT_NetAdapterSettingData REF SettingData;
  uint32                     QueueID;
  uint32                     State;
  uint32                     NumFilters;
  uint64                     ProcessorAffinityMask;
  uint16                     ProcessorGroup;
  string                     VmID;
  string                     VmFriendlyName;
  string                     QueueName;
  string                     FilterList[];
};

Members

The MSFT_NetAdapterVmqQueueSettingData class has these types of members:

Methods

The MSFT_NetAdapterVmqQueueSettingData class has these methods.

MethodDescription
GetByInstanceID

Gets a list of VMQ queues of the network adapter.

GetByName

Gets a list of VMQ queues of the network adapter.

 

Properties

The MSFT_NetAdapterVmqQueueSettingData class has these properties.

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.

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.

FilterList
Data type: string array
Access type: Read-only

An array of MAC address and VLAN ID pair filters set on the queue.

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.

IsCurrent
Data type: uint16
Access type: Read-only

Indicates that the referenced setting is currently used in the operation of the element or that this information is unknown. For a given managed element and all instances of a setting data subclass, there shall be at most one instance of ElementSettingData which references the managed element and an instance of the SettingData subclass where there is a specified non-null, non-key property of the SettingData subclass, and the IsMaximum property on the referencing ElementSettingData instance has a value of "Is Maximum" or the IsMinimum property on the referencing ElementSettingData instance has a value of "Is Minimum" and the IsCurrent property on the referencing ElementSettingData instance has a value of "Is Current".

There shall be at most one instance of ElementSettingData which references a managed element and an instance of a SettingData subclass where the IsCurrent property has a value of "Is Current" and the IsMinimum property does not have a value of "Is Minimum" and the IsMaximum property does not have a value of "Is Maximum".

This property inherits from CIM_ElementSettingData.

Unknown (0)
Is Current (1)
Is Not Current (2)
IsDefault
Data type: uint16
Access type: Read-only

Indicates that the referenced setting is a default setting for the element or that this information is unknown. This property inherits from CIM_ElementSettingData.

Unknown (0)
Is Default (1)
Is Not Default (2)
IsMaximum
Data type: uint16
Access type: Read-only

This property affects the interpretation of all non-null, non-enumerated, non-binary, numeric, non-key properties of the associated SettingData instance. All other properties of the associated SettingData instance are not affected by this property. Note: It is assumed that the semantics of each property of this set are designed to be compared mathematically. When IsMaximum = "Is Maximum", this property indicates that the affected property values specified in the associated SettingData instance shall define maximum setting values. When IsMaximum = "Is Not Maximum", this property indicates that the affected property values specified in the associated SettingData instance shall not define maximum setting values. When IsMaximum = "Unknown", this property indicates that the affected property values specified in the associated SettingData instance may correspond to maximum setting values. When IsMaximum = "Not Applicable", this property indicates that the affected property values specified in the associated SettingData instance shall not be interpreted with respect to whether each defines a maximum.

This property inherits from CIM_ElementSettingData.

Unknown (0)
Not Applicable (1)
Is Maximum (2)
Is Not Maximum (3)
IsMinimum
Data type: uint16
Access type: Read-only

This property affects the interpretation of all non-null, non-enumerated, non-binary, numeric, non-key properties of the associated SettingData instance. All other properties of the associated SettingData instance are not affected by this property. Be aware that it is assumed that the semantics of each property of this set are designed to be compared mathematically. When IsMinimum = "Is Minimum", this property indicates that the affected property values specified in the associated SettingData instance shall define minimum setting values. When IsMinimum = "Is Not Minimum", this property indicates that the affected property values specified in the associated SettingData instance shall not define minimum setting values. When IsMinimum = "Unknown", this property indicates that the affected property values specified in the associated SettingData instance may correspond to minimum setting values. When IsMinimum = "Not Applicable", this property indicates that the affected property values specified in the associated SettingData instance shall not be interpreted with respect to whether each defines a minimum.

This property inherits from CIM_ElementSettingData.

Unknown (0)
Not Applicable (1)
Is Minimum (2)
Is Not Minimum (3)
IsNext
Data type: uint16
Access type: Read-only

Indicates whether or not the referenced setting is the next setting to be applied. For example, the application could occur on a reinitialization, reset, or reconfiguration request. This could be a permanent setting, or a setting used only one time, as indicated by the flag. If it is a permanent setting then the setting is applied every time the managed element reinitializes, until this flag is manually reset. However, if it is single use, then the flag is automatically cleared after the settings are applied.

If this flag is specified (that is, set to a value other than "Unknown"), then this takes precedence over any SettingData that may have been specified as Default. For example: If the managed element is a computer system, and the value of this flag is "Is Next", then the setting will be effective next time the system resets. Unless this flag is changed, it will persist for subsequent system resets. However, if this flag is set to "Is Next For Single Use", then this setting will only be used once and the flag would be reset after that to "Is Not Next". In the preceding example, if the system restarts in a quick succession, the setting will not be used at the second restart.

This property inherits from CIM_ElementSettingData.

Unknown (0)
Is Next (1)
Is Not Next (2)
Is Next For Single Use (3)
ManagedElement
Data type: CIM_ManagedElement
Access type: Read-only
Qualifiers: Key

The managed element. This property inherits from CIM_ElementSettingData.

ManagedElement
Data type: MSFT_NetAdapter
Access type: Read-only
Qualifiers: Key, Override

The managed element. This property inherits from MSFT_NetAdapterElementSettingData.

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.

NumFilters
Data type: uint32
Access type: Read-only

The number of MAC address and VLAN ID filters set on the queue.

ProcessorAffinityMask
Data type: uint64
Access type: Read-only

A bitmap that specifies the CPU that the queue has affinity with. For example, setting bit 0 indicates CPU 0 is used, setting bit 1 indicates CPU 1 is used, and so on.

ProcessorGroup
Data type: uint16
Access type: Read-only

The group number for the processors specified in ProcessorAffinityMask property.

QueueID
Data type: uint32
Access type: Read-only

The queue identifier

QueueName
Data type: string
Access type: Read-only

A string that identifies the queue.

SettingData
Data type: CIM_SettingData
Access type: Read-only
Qualifiers: Key

The SettingData object that is associated with the element. This property inherits from CIM_ElementSettingData.

SettingData
Data type: MSFT_NetAdapterSettingData
Access type: Read-only
Qualifiers: Key, Override

The SettingData object associated with the element. This property inherits from MSFT_NetAdapterElementSettingData.

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)
State
Data type: uint32
Access type: Read-only

The operational state of the queue.

Undefined (0)
Running (1)
Paused (2)
DmaStopped (3)
SystemName
Data type: string
Access type: Read-only

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

VmFriendlyName
Data type: string
Access type: Read-only

The friendly name the Virtual Machine to which the queue is assigned.

VmID
Data type: string
Access type: Read-only

The ID of the Virtual Machine to which the queue is assigned.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

\root\StandardCimv2

MOF

NetAdapterCim.mof

DLL

NetAdapterCim.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft