Share via

MSCluster_NetworkInterface class

  • Article

A dynamic WMI class that represents a network interface.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Dynamic, Provider("MS_CLUSTER_PROVIDER"), UUID("{3DE393F8-8FD5-4426-901D-8EE017003A61}"), AMENDMENT]
class MSCluster_NetworkInterface : CIM_LogicalDevice
{
  string             Caption;
  string             Status;
  datetime           InstallDate;
  string             SystemCreationClassName;
  string             SystemName;
  string             CreationClassName;
  string             DeviceID;
  boolean            PowerManagementSupported;
  uint16             PowerManagementCapabilities[];
  uint16             Availability;
  uint32             ConfigManagerErrorCode;
  boolean            ConfigManagerUserConfig;
  string             PNPDeviceID;
  uint16             StatusInfo;
  uint32             LastErrorCode;
  string             ErrorDescription;
  boolean            ErrorCleared;
  string             OtherIdentifyingInfo[];
  uint64             PowerOnHours;
  uint64             TotalPowerOnHours;
  string             IdentifyingDescriptions[];
  string             Name;
  string             Description;
  string             Adapter;
  string             AdapterId;
  string             Node;
  string             Address;
  string             Network;
  uint32             State;
  uint32             Flags;
  uint32             Characteristics;
  string             IPv6Addresses[];
  string             IPv4Addresses[];
  boolean            DhcpEnabled;
  MSCluster_Property PrivateProperties;
  string             Id;
};

Members

The MSCluster_NetworkInterface class has these types of members:

Methods

The MSCluster_NetworkInterface class has these methods.

Method Description
EnableDevice Requests that the LogicalDevice be enabled ("Enabled" input parameter = TRUE) or disabled (= FALSE). If successful, the Device's StatusInfo property should also reflect the desired state (enabled/disabled). The return code should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.
This method is inherited from CIM_LogicalDevice.
ExecuteNetworkInterfaceControl Executes a control code on the network interface.
Reset Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.
This method is inherited from CIM_LogicalDevice.
SetPowerState SetPowerState defines the desired power state for a LogicalDevice and when a Device should be put into that state. The desired power state is specified by setting the PowerState parameter to one of the following integer values: 1="Full Power", 2="Power Save - Low Power Mode", 3="Power Save - Standby", 4="Power Save - Other", 5="Power Cycle" or 6="Power Off". The Time parameter (for all state changes but 5, "Power Cycle") indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). When the PowerState parameter is equal to 5, Power Cycle, the Time parameter indicates when the Device should power on again. Power Off (6) is immediate. SetPowerState should return 0 if successful, 1 if the specified PowerState and Time request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.
This method is inherited from CIM_LogicalDevice.

Properties

The MSCluster_NetworkInterface class has these properties.

Adapter

Data type: string

Access type: Read-only

Provides the name that is used to uniquely identify the network interface in the cluster.

AdapterId

Data type: string

Access type: Read-only

Provides a unique ID for the network interface.

Address

Data type: string

Access type: Read-only

Provides the primary network address that the node uses for the network interface.

Availability

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operational State|004.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5")

The availability and status of the network interface.

Inherited from CIM_LogicalDevice. The following are the possible values.

Other (1 (0x1))

The network interface availability is in another state.

Unknown (2 (0x2))

The network interface availability is unknown.

Running/Full Power (3 (0x3))

The network interface is available at full power.

Warning (4 (0x4))

The network interface is in a warning state.

In Test (5 (0x5))

The network interface is in a test state.

Not Applicable (6 (0x6))

The network interface availability is not applicable.

Power Off (7 (0x7))

The network interface is powered off.

Off Line (8 (0x8))

The network interface is offline.

Off Duty (9 (0x9))

The network interface is off duty.

Degraded (10 (0xA))

The network interface availability is degraded.

Not Installed (11 (0xB))

The network interface is not installed.

Install Error (12 (0xC))

The network interface is not installed properly.

Power Save - Unknown (13 (0xD))

The network interface availability is known to be in a power save mode, but its exact status is unknown.

Power Save - Low Power Mode (14 (0xE))

The network interface is in a power save state but still functioning, and may exhibit degraded performance.

Power Save - Standby (15 (0xF))

The network interface is not functioning but could be brought to full power quickly.

Power Cycle (16 (0x10))

The network interface is being power cycled.

Power Save - Warning (17 (0x11))

The network interface is in a warning state but also in a power save mode.

Paused (18 (0x12))

The network interface is paused.

Not Ready (19 (0x13))

The network interface is not ready.

Not Configured (20 (0x14))

The network interface is not configured.

Quiesced (21 (0x15))

The network interface is quiesced.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Provides a short textual description of the network interface.

Inherited from CIM_LogicalDevice.

Characteristics

Data type: uint32

Access type: Read/write

Provides access to the characteristics set for the network interface. For a list of possible characteristics, see CLUSCTL_NETINTERFACE_GET_CHARACTERISTICS.

ConfigManagerErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Read, Schema ("Win32")

Indicates the Win32 Configuration Manager error code.

Inherited from CIM_LogicalDevice. The following are the possible values.

0 (0x0)

The network interface is working properly.

1 (0x1)

The network interface is not configured correctly.

2 (0x2)

Windows cannot load the driver for the network interface.

3 (0x3)

The driver for the network interface might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

The network interface is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

The driver for the network interface requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the network interface conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

The driver loader for the network interface is missing.

9 (0x9)

The network interface is not working properly; the controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

The network interface cannot start.

11 (0xB)

The network interface failed.

12 (0xC)

The network interface cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the network interface's resources.

14 (0xE)

The network interface cannot work properly until the computer is restarted.

15 (0xF)

The network interface is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the network interface uses.

17 (0x11)

The network interface is requesting an unknown resource type.

18 (0x12)

The network interface device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

The registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the network interface.

22 (0x16)

The network interface is disabled.

23 (0x17)

System failure. If changing the network interface device driver is ineffective, see the hardware documentation.

24 (0x18)

The network interface is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the network interface.

26 (0x1A)

Windows is still setting up the network interface.

27 (0x1B)

The network interface does not have valid log configuration.

28 (0x1C)

The network interface device drivers are not installed.

29 (0x1D)

The network interface is disabled; the device firmware did not provide the required resources.

30 (0x1E)

The network interface is using an IRQ resource that another device is using.

31 (0x1F)

The network interface is not working properly; Windows cannot load the required device drivers.

ConfigManagerUserConfig

Data type: boolean

Access type: Read-only

Qualifiers: Read, Schema ("Win32")

If TRUE, the device is using a user-defined configuration.

Inherited from CIM_LogicalDevice.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_KEY, MaxLen (256)

Indicates the name of the class or the subclass used in the creation of an instance.

Inherited from CIM_LogicalDevice.

Description

Data type: string

Access type: Read/write

Provides comments about the network interface.

Inherited from CIM_LogicalDevice.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

Provides an address or other identifying information that uniquely identifies the network interface.

Inherited from CIM_LogicalDevice.

DhcpEnabled

Data type: boolean

Access type: Read-only

Indicates if DHCP is enabled on the network interface.

ErrorCleared

Data type: boolean

Access type: Read-only

Indicates that the error reported in the LastErrorCode property is now cleared.

Inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string

Access type: Read-only

Supplies more information about the error recorded in the LastErrorCode property and information on any corrective actions that may be taken.

Inherited from CIM_LogicalDevice.

Flags

Data type: uint32

Access type: Read/write

Provides access to the flags set for the network interface. For a list of possible flags, see CLUSCTL_NETINTERFACE_GET_FLAGS.

Id

Data type: string

Access type: Read-only

The Id of the network interface.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

Represents an array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo property array. Note that each entry of this array is related to the entry in the OtherIdentifyingInfo property that is located at the same index.

Inherited from CIM_LogicalDevice.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the network interface was installed. A lack of a value does not indicate that the network interface is not installed.

Inherited from CIM_LogicalDevice.

IPv4Addresses

Data type: string array

Access type: Read-only

Provides the IPv4 addresses currently assigned to this network interface.

IPv6Addresses

Data type: string array

Access type: Read-only

Provides the IPv6 addresses currently assigned to this network interface.

LastErrorCode

Data type: uint32

Access type: Read-only

Captures the last error code reported by the network interface.

Inherited from CIM_LogicalDevice.

Name

Data type: string

Access type: Read-only

Provides the Clustering Service generated name for the network interface.

Inherited from CIM_LogicalDevice.

Network

Data type: string

Access type: Read-only

Provides the name of the network to which the network interface is connected.

Node

Data type: string

Access type: Read-only

Provides the name of the node in which the network interface is installed.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

Captures additional data, in addition to the DeviceID property, that can be used to identify a network interface.

Inherited from CIM_LogicalDevice.

PNPDeviceID

Data type: string

Access type: Read-only

Qualifiers: Read, Schema ("Win32")

Indicates the Win32 Plug and Play device identifier of the logical device.

Example: "*PNP030b"

Inherited from CIM_LogicalDevice.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Indicates the specific power-related capabilities of the network interface.

Inherited from CIM_LogicalDevice. The following are the possible values.

Unknown (0)

TBD

Not Supported (1)

TBD

Disabled (2)

TBD

Enabled (3)

The power management features are currently enabled, but the exact feature set is unknown or the information is unavailable.

Power Saving Modes Entered Automatically (4)

The device can change its power state based on usage or other criteria.

Power State Settable (5)

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

Power Cycling Supported (6)

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

Timed Power On Supported (7)

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type: boolean

Access type: Read-only

If TRUE, the node, with its running operating system, supports power management. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array. This Boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. For more information, see the PowerManagementCapabilities array.

Inherited from CIM_LogicalDevice.

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Counter, Units ("Hours")

Indicates the number of hours since the last power cycle of the network interface.

Inherited from CIM_LogicalDevice.

PrivateProperties

Data type: MSCluster_Property

Access type: Read/write

Represents the private properties of the network interface.

State

Data type: uint32

Access type: Read-only

Indicates the current state of the network interface. The following are the possible values.

Unknown (-1)

**Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **

This value is StateUnknown before Windows Server 2012 R2 .

Unavailable (0)

Failed (1)

Unreachable (2)

Up (3)

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

Indicates the current status of the network interface.

Inherited from CIM_LogicalDevice.

Values include the following:

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operational State|004.3")

Indicates whether the network interface is in an enabled, disabled, other, or unknown state.

Inherited from CIM_LogicalDevice. The following are the possible values.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_KEY, MaxLen (256)

Indicates the scoping system's CreationClassName.

Inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.Name"), Key, MaxLen (256)

Indicates the scoping system's Name.

Inherited from CIM_LogicalDevice.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Counter, Units ("Hours")

Indicates the total number of hours that the network interface has been powered.

Inherited from CIM_LogicalDevice.

Remarks

The MSCluster_NetworkInterface class is derived from the CIM_LogicalDevice class.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
Namespace
 Root\MSCluster
MOF
ClusWmi.mof
DLL
ClusWMI.dll

See also

CIM_LogicalDevice

Failover Cluster Provider Reference