MSCluster_Service class

A dynamic WMI class that represents the Cluster service.

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

Syntax

[Dynamic, Provider("MS_CLUSTER_PROVIDER"), UUID("{8F9030D0-9149-4113-9ADD-6F2101285E5D}"), AMENDMENT]
class MSCluster_Service : CIM_ClusteringService
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  string   CreationClassName;
  string   Name;
  string   StartMode;
  boolean  Started;
  string   SystemCreationClassName;
  string   SystemName;
  uint32   NodeHighestVersion;
  uint32   NodeLowestVersion;
  string   State;
};

Members

The MSCluster_Service class has these types of members:

Methods

The MSCluster_Service class has these methods.

Method Description
Start Starts the cluster service.
Stop Sends a stop request to the cluster service.

Properties

The MSCluster_Service class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description (one-line string) of the service.

This property is inherited from CIM_ManagedSystemElement.

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.

This property is inherited from CIM_Service.

Description

Data type: string

Access type: Read-only

Provides a textual description of the service.

This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime

Access type: Read-only

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

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

This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

Uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property.

This property is inherited from CIM_Service.

NodeHighestVersion

Data type: uint32

Access type: Read-only

Specifies the highest possible version of Clustering Service with which the node hosting this service can join or communicate.

NodeLowestVersion

Data type: uint32

Access type: Read-only

Specifies the lowest possible version of Clustering Service with which the node hosting this service can join or communicate.

Started

Data type: boolean

Access type: Read-only

Indicates whether the service has been started (TRUE), or stopped (FALSE).

This property is inherited from CIM_Service.

StartMode

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

A string value indicating whether the Service is automatically started by a System, Operating System, etc. or only started upon request.

This property is inherited from CIM_Service.

("Automatic")

("Manual")

State

Data type: string

Access type: Read-only

The current state of this service.

Values include the following:

"Continue Pending"

"Pause Pending"

"Paused"

"Running"

"Start Pending"

"Stop Pending"

"Stopped"

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

A string indicating the current status of the service.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

SystemCreationClassName

Data type: string

Access type: Read-only

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

The scoping System's creation class name.

This property is inherited from CIM_Service.

SystemName

Data type: string

Access type: Read-only

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

The scoping system's name.

This property is inherited from CIM_Service.

Remarks

The MSCluster_Service class is derived from the CIM_ClusteringService 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_ClusteringService

Failover Cluster Provider Reference