MSCluster_ResourceGroup class

  • Article

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}"), AMENDMENT]
class MSCluster_ResourceGroup : MSCluster_LogicalElement
{
  string             Caption;
  datetime           InstallDate;
  string             Status;
  uint32             Flags;
  uint32             Characteristics;
  string             Name;
  string             Description;
  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;
  uint32             ColdStartSetting;
  string             PreferredSite[];
};

Members

The MSCluster_ResourceGroup class has these types of members:

Methods

The MSCluster_ResourceGroup class has these methods.

Method Description
BringOnline Brings a group online.
CancelOperation Cancels any pending operations on the resource group.
Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012.
CreateGroup Creates a group.
DeleteGroup Deletes a group.
DestroyGroup Destroys the cluster group and any resources in this group.
ExecuteGroupControl Executes a control code on the group.
GetGroupType Gets the group type for this resource group.
GetPreferredOwners Get the list of preferred owners for this resource group.
Windows Server 2008 R2 and Windows Server 2008: 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 and Windows Server 2008: 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 and Windows Server 2008: 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 and Windows Server 2008: 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.
TakeOffline Takes a group offline.
TakeOfflineParams Take the resource group offline with the parameters specified as a raw buffer.
Windows Server 2008 R2 and Windows Server 2008: 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.

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

Qualifiers: MaxLen (64)

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

This property is inherited from CIM_ManagedSystemElement.

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 and Windows Server 2008: **

This property is not supported before Windows Server 2016.

Characteristics

Data type: uint32

Access type: Read-only

Provides the characteristics of the group. The cluster defines characteristics only for resources. For a description of these characteristics, see CLUSCTL_RESOURCE_GET_CHARACTERISTICS.

**Windows Server 2008 R2 and Windows Server 2008: **

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement.

ColdStartSetting

Data type: uint32

Access type: Read-only

Indicates whether a group can start after a cluster cold start.

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

This property is not available before Windows Server 2016.

The following are the possible values.

Always Start (0)

Start Disabled (1)

Start Allowed Until Next Cold Start (2)

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: **

This property is not supported before Windows Server 2008 R2.

Description

Data type: string

Access type: Read/write

Qualifiers: Override (Description)

The Description property provides comments about the group.

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. The cluster defines flags only for resources. For a description of these flags, see CLUSCTL_RESOURCE_GET_FLAGS.

**Windows Server 2008 R2 and Windows Server 2008: **

This property is read/write before Windows Server 2012.

This property is inherited from MSCluster_LogicalElement.

GroupType

Data type: uint32

Access type: Read-only

The Type of the resource group.

**Windows Server 2008: **

This property is not supported before Windows Server 2008 R2.

**Windows Server 2008 R2 and Windows Server 2008: **

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.

File Server (100)

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

This value is FileServer before Windows Server 2012 R2.

Print Server (101)

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

This value is PrintServer before Windows Server 2012 R2.

DHCP Server (102)

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

This value is DhcpServer before Windows Server 2012 R2.

DTC (103)

Message Queuing (104)

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

This value is Msmq before Windows Server 2012 R2.

WINS Server (105)

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

This value is Wins before Windows Server 2012 R2.

DFS Namespace Server (106)

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

This value is StandAloneDfs before Windows Server 2012 R2.

Generic Application (107)

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

This value is GenericApplication before Windows Server 2012 R2.

Generic Service (108)

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

This value is GenericService before Windows Server 2012 R2.

Generic Script (109)

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

This value is GenericScript before Windows Server 2012 R2.

iSNS Cluster Resource (110)

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

This value is IScsiNameService before Windows Server 2012 R2.

Virtual Machine (111)

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

This value is Virtual Machine before Windows Server 2012 R2.

TS Session Broker (112)

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

This value is TsSessionBroker before Windows Server 2012 R2.

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 and Windows Server 2008: **

This property is not supported before Windows Server 2012.

InstallDate

Data type: datetime

Access type: Read-only

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

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

This property is inherited from CIM_ManagedSystemElement.

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 and Windows Server 2008: **

This property is not available before Windows Server 2012.

Name

Data type: string

Access type: Read-only

Qualifiers: Override (Name), Key

The Name property specifies the name of the group.

OwnerNode

Data type: string

Access type: Read-only

The node hosting the resource group.

**Windows Server 2008 R2 and Windows Server 2008: **

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.

PreferredSite

Data type: string array

Access type: Read/write

The preferred site to host the group.

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

This property is not supported before Windows Server 2016.

Priority

Data type: uint32

Access type: Read/write

Qualifiers: Min (0), Max (4999)

Priority value of the resource group

**Windows Server 2008: **

This property is not supported before Windows Server 2008 R2.

**Windows Server 2008 R2: **

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.

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 and Windows Server 2008: **

This property is not supported before Windows Server 2016.

State

Data type: uint32

Access type: Read-only

The current state of the resource group.

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.

Online (0)

Offline (1)

Failed (2)

Partial Online (3)

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

This value is PartialOnline before Windows Server 2012 R2.

Pending (4)

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

A string indicating the current status of the group.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

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 and Windows Server 2008: **

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 2008
Namespace
 Root\MSCluster
MOF
ClusWmi.mof
DLL
ClusWMI.dll

See also

MSCluster_LogicalElement

Failover Cluster Provider Reference