Export (0) Print
Expand All

MSCluster_ResourceGroup class

[This documentation is preliminary and is subject to change.]

The MSCluster_ResourceGroup class is a dynamic WMI class that represents a cluster group.

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

Syntax

[Dynamic, Provider ("MS_CLUSTER_PROVIDER"), UUID ("{DDE3A30E-55F7-4c31-B6CF-E360D12C5253}")]class MSCluster_ResourceGroup : MSCluster_LogicalElement
{
  string             Caption;
  string             Description;
  datetime           InstallDate;
  string             Name = NULL;
  string             Status;
  uint32             Flags;
  uint32             Characteristics;
  uint32             State;
  uint32             AutoFailbackType;
  sint32             FailbackWindowEnd;
  sint32             FailbackWindowStart;
  uint32             FailoverPeriod;
  uint32             FailoverThreshold;
  string             Id;
  boolean            PersistentState;
  string             AntiAffinityClassNames[];
  MSCluster_Property PrivateProperties;
  string             InternalState;
  uint32             Priority;
  uint32             DefaultOwner;
  uint64             CCFEpoch;
  uint32             ResiliencyPeriod;
  uint32             GroupType;
  string             OwnerNode;
  boolean            IsCore;
  uint64             StatusInformation;
};

Members

The MSCluster_ResourceGroup class has these types of members:

Methods

The MSCluster_ResourceGroup class has these methods.

MethodDescription
BringOnline

Brings a group online.

CancelOperation

Cancels any pending operations on the resource group.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not available before Windows Server 2012.

CreateGroup

Creates a group.

DeleteGroup

Deletes a group.

Windows Server 2003:  

This property has a Static qualifier.

DestroyGroup

Destroys the cluster group and any resources in this group.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

ExecuteGroupControl

Executes a control code on the group.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

GetGroupType

Gets the group type for this resource group.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

GetPreferredOwners

Get the list of preferred owners for this resource group.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not available before Windows Server 2012.

MoveToNewNode

Moves the group to a different node.

MoveToNewNodeEx

Move the resource group to a different node.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not available before Windows Server 2012.

MoveToNewNodeParams

Move the resource group to different node with the parameters specified as a raw buffer.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not available before Windows Server 2012.

Rename

Renames a group.

SetGroupType

Sets the group type for this resource group.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not supported before Windows Server 2008.

This method is obsolete beginning in Windows Server 2012.

SetPreferredOwners

Sets the preferred owner list for this resource group.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

TakeOffline

Takes a group offline.

TakeOfflineParams

Take the resource group offline with the parameters specified as a raw buffer.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not available before Windows Server 2012.

 

Properties

The MSCluster_ResourceGroup class has these properties.

AntiAffinityClassNames
Data type: string array
Access type: Read/write

Provides access to the group's AntiAffinityClassNames property.

The AntiAffinityClassNames property identifies groups that should not be hosted on the same cluster node.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

AutoFailbackType
Data type: uint32
Access type: Read/write

Provides access to the group's AutoFailbackType property.

The AutoFailbackType property specifies whether the group should automatically be failed back to the node identified as its preferred owner when that node comes back online following a failover.

Caption
Data type: string
Access type: Read-only

Provides a short textual description of the group.

Inherited from MSCluster_LogicalElement.

CCFEpoch
Data type: uint64
Access type: Read/write

The current CCF of the resource group.

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

This property is not supported before Windows Server Technical Preview.

Characteristics
Data type: uint32
Access type: Read-only

Provides access to the characteristics set for the group. For a list of possible characteristics, see CLUSCTL_GROUP_GET_CHARACTERISTICS.

Inherited from MSCluster_LogicalElement.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is read/write before Windows Server 2012.

DefaultOwner
Data type: uint32
Access type: Read/write
Qualifiers: Min (-1) , Max (512)

Number of the last node the resource group was activated on or explicitly moved to.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

Description
Data type: string
Access type: Read/write

Provides comments about the group.

Inherited from MSCluster_LogicalElement.

FailbackWindowEnd
Data type: sint32
Access type: Read/write
Qualifiers: Min (-1) , Max (23) , Units ("hours")

Provides access to the group's FailbackWindowEnd property.

The FailbackWindowEnd property provides the latest time that the group can be moved back to the node identified as its preferred node.

FailbackWindowStart
Data type: sint32
Access type: Read/write
Qualifiers: Min (-1) , Max (23) , Units ("hours")

Provides access to the group's FailbackWindowStart property.

The FailbackWindowStart property provides the earliest time (that is, local time as kept by the cluster) that the group can be moved back to the node identified as its preferred node.

FailoverPeriod
Data type: uint32
Access type: Read/write
Qualifiers: Min (1) , Max (1193) , Units ("hours")

Provides access to the group's FailoverPeriod property.

The FailoverPeriod property specifies a number of hours during which a maximum number of failover attempts, specified by the FailoverThreshold property, can occur.

FailoverThreshold
Data type: uint32
Access type: Read/write

Provides access to the group's FailoverThreshold property.

The FailoverThreshold property specifies the maximum number of failover attempts.

Flags
Data type: uint32
Access type: Read-only

Provides access to the flags set for the group. For a list of possible characteristics, see CLUSCTL_GROUP_GET_FLAGS.

Inherited from MSCluster_LogicalElement.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is read/write before Windows Server 2012.

GroupType
Data type: uint32
Access type: Read-only

The Type of the resource group.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is read/write before Windows Server 2012.

The values iSCSI Target Server, Scale-Out File Server, and Hyper-V Replica Broker are not available before Windows Server 2012.

FileServer (100)
PrintServer (101)
DhcpServer (102)
Dtc (103)
Msmq (104)
Wins (105)
StandAloneDfs (106)
GenericApplication (107)
GenericService (108)
GenericScript (109)
IScsiNameService (110)
VirtualMachine (111)
TsSessionBroker (112)
iSCSI Target Server (113)
Scale-Out File Server (114)
Hyper-V Replica Broker (115)
Unknown (9999)
Id
Data type: string
Access type: Read-only

The Id of the network.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is not supported before Windows Server 2012.

InstallDate
Data type: datetime
Access type: Read-only

Indicates when the group was installed. The lack of a value does not indicate that the group is not installed.

Inherited from MSCluster_LogicalElement.

InternalState
Data type: string
Access type: Read-only

This property is not supported.

Windows Server 2008:  

Provides the current internal state of the resource group.

IsCore
Data type: boolean
Access type: Read-only

Indicates that the resource group is essential to the cluster and cannot be deleted.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is not available before Windows Server 2012.

Name
Data type: string
Access type: Read-only
Qualifiers: Key

Specifies the name of the group.

Inherited from MSCluster_LogicalElement.

OwnerNode
Data type: string
Access type: Read-only

The node hosting the resource group.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is not available before Windows Server 2012.

PersistentState
Data type: boolean
Access type: Read/write

Provides access to the group's PersistentState property.

The PersistentState property specifies whether a group should be left offline or brought online when the Cluster service starts.

Priority
Data type: uint32
Access type: Read/write
Qualifiers: Min (0) , Max (4999)

Priority value of the resource group

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property has a maximum value of "512" before Windows Server 2012.

PrivateProperties
Data type: MSCluster_Property
Access type: Read/write

Provides access to the group's MSCluster_Property class.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ResiliencyPeriod
Data type: uint32
Access type: Read/write

The resiliency period for this group, in seconds.

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

This property is not supported before Windows Server Technical Preview.

State
Data type: uint32
Access type: Read/write

The current state of the resource group.

The following are the possible values.

StateUnknown (-1)
Online (0)
Offline (1)
Failed (2)
PartialOnline (3)
Pending (4)
Status
Data type: string
Access type: Read-only

Indicates the current status of the group.

Inherited from MSCluster_LogicalElement.

The following are the possible values.

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

StatusInformation
Data type: uint64
Access type: Read-only

Status flags for the resource group that are set by the cluster service.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This property is not available before Windows Server 2012.

Remarks

The MSCluster_ResourceGroup class is derived from the MSCluster_LogicalElement class.

Examples

The Is this server part of a MS Cluster PowerShell code sample on TechNet Gallery uses MSCluster_ResourceGroup to determine if a remote server is part of a cluster.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2003 Datacenter, Windows Server 2003 Enterprise

Namespace

\\.\Root\MSCluster

MOF

ClusWmi.mof

See also

Failover Cluster Provider Reference

 

 

Show:
© 2014 Microsoft