MSFT_NetAdapterPowerManagementSettingData class

Article
08/31/2015

MSFT_NetAdapterPowerManagementSettingData represents the Power Management settings and features of 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_NetAdapterPowerManagementSettingData : MSFT_NetAdapterSettingData
{
  string Caption;
  string Description;
  string ElementName;
  string InstanceID;
  string SystemName;
  string Name;
  string InterfaceDescription;
  uint32 Source;
  uint32 AllowComputerToTurnOffDevice;
  uint32 D0PacketCoalescing;
  uint32 DeviceSleepOnDisconnect;
  uint32 ArpOffload;
  uint32 NSOffload;
  uint32 RsnRekeyOffload;
  string OffloadParameters[];
  uint32 SelectiveSuspend;
  uint32 WakeOnMagicPacket;
  uint32 WakeOnPattern;
  string WakePatterns[];
};

Members

The MSFT_NetAdapterPowerManagementSettingData class has these types of members:

Methods
Properties

Methods

The MSFT_NetAdapterPowerManagementSettingData class has these methods.

Method	Description
Disable	Provides a method to disable specific power management capabilities on the adapter.
Enable	Provides a method to enable specific power management capabilities on the adapter.

Properties

The MSFT_NetAdapterPowerManagementSettingData class has these properties.

AllowComputerToTurnOffDevice

Data type: uint32

Access type: Read-only

Supplies the setting for power management of the adapter. If the property is anything other than Enabled, the remaining property values are undefined.

Unsupported (0)

Disabled (1)

Enabled (2 )

ArpOffload

Data type: uint32

Access type: Read-only

Supplies the setting for ARP offloads on the adapter.

Unsupported (0)

Disabled (1)

Enabled (2 )

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 64 )

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

D0PacketCoalescing

Data type: uint32

Access type: Read-only

Supplies the setting for D0 Packet Coalescing on the adapter.

Unsupported (0)

Disabled (1)

Enabled (2 )

Description

Data type: string

Access type: Read-only

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

DeviceSleepOnDisconnect

Data type: uint32

Access type: Read-only

Supplies the setting for sleeping on media disconnect. If this property is Enabled, then the adapter may enter a low power state on a media disconnect event.

Unsupported (0)

Disabled (1)

Enabled (2)

Inactive (3 )

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.

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

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. Also known as the ifDescr or friendly name.

Name

Data type: string

Access type: Read-only

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. Also known as the connection name, ifAlias, or InterfaceAlias.

NSOffload

Data type: uint32

Access type: Read-only

Supplies the setting for NS offloads on the adapter.

Unsupported (0)

Disabled (1)

Enabled (2 )

OffloadParameters

Data type: string array

Access type: Read-only

Supplies the parameters for protocol offloads on the adapter.

RsnRekeyOffload

Data type: uint32

Access type: Read-only

Supplies the setting for 802.11i RSN offloading.

Unsupported (0)

Disabled (1)

Enabled (2 )

SelectiveSuspend

Data type: uint32

Access type: Read-only

Supplies the setting for selective suspend on the adapter.

Unsupported (0)

Disabled (1)

Enabled (2 )

Source

Data type: uint32

Access type: Read-only

The source of the setting data.

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.

WakeOnMagicPacket

Data type: uint32

Access type: Read-only

Supplies the setting for waking on Magic Packets. If this property is Enabled, then the adapter wakes the system on receipt of a Magic Packet.

Unsupported (0)

Disabled (1)

Enabled (2 )

WakeOnPattern

Data type: uint32

Access type: Read-only

Supplies the setting for waking on a packet pattern. If this property is Enabled, then the adapter wakes the system on receipt of a specified pattern.

Unsupported (0)

Disabled (1)

Enabled (2 )

WakePatterns

Data type: string array

Access type: Read-only

Supplies the list of packet patterns programmed to wake the system.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\StandardCimv2
MOF	NetAdapterCim.mof
DLL	NetAdapterCim.dll

MSFT_NetAdapterPowerManagementSettingData class

Syntax

Members

Methods

Properties

Requirements

Additional resources