ClusResource object
[The ClusResource object is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]
Enables operations on a resource, its properties, and related objects.
Members
The ClusResource object has these types of members:
Methods
The ClusResource object has these methods.
| Method | Description |
|---|---|
| AddResourceNode | Adds a new node to the list of possible nodes that can host the resource. |
| BecomeQuorumResource | Sets the quorum resource. |
| CanResourceBeDependent | Determines if the resource can be dependent on another resource. |
| ChangeResourceGroup | Moves the resource from its current group to a different group. |
| Delete | Deletes the resource from the cluster. |
| Fail | Initiates failure of the resource. |
| Offline | Takes the resource offline. |
| Online | Brings the resource online. |
| RemoveResourceNode | Removes a node from the list of possible nodes that can host the resource. |
Properties
The ClusResource object has these properties.
| Property | Access type | Description |
|---|---|---|
| ClassInfo |
Read-only |
Returns the resource class of a resource. |
| Cluster |
Read-only |
Returns the cluster that includes the resource. |
| CommonProperties |
Read-only |
Returns a ClusProperties collection containing the resource's read/write common properties. |
| CommonROProperties |
Read-only |
Returns a ClusProperties collection containing the resource's read-only common properties. |
| CoreFlag |
Read-only |
Returns any flags that identify the resource as a core resource. |
| CryptoKeys |
Read-only |
Returns a ClusCryptoKeys collection containing the resource's checkpointed crypto keys. |
| Dependencies |
Read-only |
Returns a ClusResDependencies collection providing access to the resource's dependency list. |
| Dependents |
Read-only |
Returns a ClusResDependents collection providing access to the list of the resource's dependent resources. |
| Disk |
Read-only |
For Physical Disk resources, returns a ClusDisk object providing access to information about the disk. |
| Group |
Read-only |
Returns the group to which the resource belongs. |
| MaintenanceMode |
Read/write |
Returns or sets maintenance mode for a disk resource. |
| Name |
Read/write |
Read/write property that either retrieves or modifies the name of the resource. |
| OwnerNode |
Read-only |
Returns the node that is hosting the resource. |
| PossibleOwnerNodes |
Read-only |
Returns the nodes that are members of the resource's possible owners list. |
| PrivateProperties |
Read-only |
Returns a ClusProperties collection containing the resource's read/write private properties. |
| PrivateROProperties |
Read-only |
Returns a ClusProperties collection containing the resource's read-only private properties. |
| RegistryKeys |
Read-only |
Returns a ClusRegistryKeys collection containing the resource's checkpointed registry keys. |
| State |
Read-only |
Returns information about the current state of the resource. |
| Type |
Read-only |
Returns the resource type of the resource as a ClusResType object. |
| TypeName |
Read-only |
Returns the resource type name of the resource. |
Remarks
A ClusResource object is obtained from the following collections:
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
| Header |
|
| IDL |
|
| Type library |
|
| DLL |
|
| IID |
CLSID_ClusResource is defined as f2e60709-2631-11d1-89f1-00a0c90d061e IID_ISClusResource is defined as f2e6070a-2631-11d1-89f1-00a0c90d061e |