CIM_ClusteringService class
CIM_ClusteringService represents the functionality provided by a cluster. For example, failover functionality may be modeled as a service of a failover cluster.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, AMENDMENT]
class CIM_ClusteringService : CIM_Service
{
string Caption;
string Description;
datetime InstallDate;
string Status;
string CreationClassName;
string Name;
string StartMode;
boolean Started;
string SystemCreationClassName;
string SystemName;
};
Members
The CIM_ClusteringService class has these types of members:
Methods
The CIM_ClusteringService class has these methods.
| Method | Description |
|---|---|
| AddNode | AddNode brings a new computer system into a cluster. The node to be added is specified as a parameter to the method. The return value should be 0 if the computer system is successfully added, 1 if the method is not supported and any other number if an error occurred. |
| EvictNode | EvictNode removes a computer system from a cluster. The node to be evicted is specified as a parameter to the method. The return value should be 0 if the computer system is successfully evicted, 1 if the method is not supported and any other number if an error occurred. |
| StartService | The StartService method places the service in the started state. It returns an integer value of 0 if the service was successfully started, 1 if the request is not supported and any other number to indicate an error. This method is inherited from CIM_Service. |
| StopService | The StopService method places the service in the stopped state. It returns an integer value of 0 if the service was successfully stopped, 1 if the request is not supported and any other number to indicate an error. This method is inherited from CIM_Service. |
Properties
The CIM_ClusteringService class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one-line string) of the object.
This property is inherited from CIM_ManagedSystemElement.
-
-
CreationClassName
-
CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
This property is inherited from CIM_Service.
-
Description
-
-
Data type: string
-
Access type: Read-only
The Description property provides a textual description of the object.
This property is inherited from CIM_ManagedSystemElement.
-
-
InstallDate
-
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
The InstallDate property is a datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
-
-
Name
-
The Name property uniquely identifies the service and provides an indication of the functionality that is managed. This functionality is described in more detail in the object's Description property.
This property is inherited from CIM_Service.
-
Started
-
-
Data type: boolean
-
Access type: Read-only
Started is a boolean indicating 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)
StartMode is a string value indicating whether the service is automatically started by a operating system, or only started upon request.
This property is inherited from CIM_Service.
-
-
("Automatic")
-
("Manual")
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (10)
The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.
This property is inherited from CIM_ManagedSystemElement.
("OK")
("Error")
("Degraded")
("Unknown")
("Pred Fail")
("Starting")
("Stopping")
("Service")
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_Key, MaxLen (256)
The scoping System's CreationClassName.
This property is inherited from CIM_Service.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Propagated ("CIM_System.Name"), Key, MaxLen (256)
The name of the system that hosts this service
This property is inherited from CIM_Service.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\MicrosoftNLB |
| MOF |
|
| DLL |
|