MSCluster_ResourceGroup, ROOT\MSCluster

Description

Superclass for cluster objects that provide the FLAGS and CHARACTERISTICS attributes

MSCluster_ResourceGroup methods

MSCluster_ResourceGroup has 16 methods (16 Local)

Name	Origin	Return
BringOnline	MSCluster_ResourceGroup
CancelOperation	MSCluster_ResourceGroup
CreateGroup	MSCluster_ResourceGroup
DeleteGroup	MSCluster_ResourceGroup
DestroyGroup	MSCluster_ResourceGroup
ExecuteGroupControl	MSCluster_ResourceGroup
GetGroupType	MSCluster_ResourceGroup	uint32 {'out':True}
GetPreferredOwners	MSCluster_ResourceGroup
MoveToNewNode	MSCluster_ResourceGroup
MoveToNewNodeEx	MSCluster_ResourceGroup
MoveToNewNodeParams	MSCluster_ResourceGroup
Rename	MSCluster_ResourceGroup
SetGroupType	MSCluster_ResourceGroup
SetPreferredOwners	MSCluster_ResourceGroup
TakeOffline	MSCluster_ResourceGroup
TakeOfflineParams	MSCluster_ResourceGroup

MSCluster_ResourceGroup properties

MSCluster_ResourceGroup has 23 properties (16 Local, 7 Derived)

Name	Origin	CIMType
AntiAffinityClassNames	MSCluster_ResourceGroup	8 [string]
AutoFailbackType	MSCluster_ResourceGroup	19 [uint32]
Caption	CIM_ManagedSystemElement	8 [string]
Characteristics	MSCluster_LogicalElement	19 [uint32]
DefaultOwner	MSCluster_ResourceGroup	19 [uint32]
Description	CIM_ManagedSystemElement	8 [string]
FailbackWindowEnd	MSCluster_ResourceGroup	3 [sint32]
FailbackWindowStart	MSCluster_ResourceGroup	3 [sint32]
FailoverPeriod	MSCluster_ResourceGroup	19 [uint32]
FailoverThreshold	MSCluster_ResourceGroup	19 [uint32]
Flags	MSCluster_LogicalElement	19 [uint32]
GroupType	MSCluster_ResourceGroup	19 [uint32]
Id	MSCluster_ResourceGroup	8 [string]
InstallDate	CIM_ManagedSystemElement	101 [datetime]
IsCore	MSCluster_ResourceGroup	11 [boolean]
key Name	CIM_ManagedSystemElement	8 [string]
OwnerNode	MSCluster_ResourceGroup	8 [string]
PersistentState	MSCluster_ResourceGroup	11 [boolean]
Priority	MSCluster_ResourceGroup	19 [uint32]
PrivateProperties	MSCluster_ResourceGroup	13 [object:MSCluster_Property]
State	MSCluster_ResourceGroup	19 [uint32]
Status	CIM_ManagedSystemElement	8 [string]
StatusInformation	MSCluster_ResourceGroup	21 [uint64]

Detailed description of MSCluster_ResourceGroup methods

Local methods (16) of MSCluster_ResourceGroup class

…

▲ BringOnline method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
TimeOut	uint32	0	✓	-	{'Description':'How long (in seconds) the method should wait for the resource group to come online.'}

Bypass_GetObject

True

Description

'Brings the resource group online.'

Implemented

True

BringOnline method is in 2 classes of ROOT\MSCluster and in 1 namespace

…

▲ CancelOperation method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Flags	uint32	0	✓	-	{'Description':'Any flags for the cancel operation.'}

Bypass_GetObject

True

Description

'Cancels any pending operations on the resource group.'

Implemented

True

CancelOperation method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ CreateGroup method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
GroupName	string	0	✓	-	{'Description':'Name of the resource group.'}
GroupType	uint32	1	✓	-	{'Description':'The resource group type.','ValueMap':['100', '101', '102', '103', '104', '105', '106', '107', '108', '109', '110', '111', '112', '113', '114', '115', '9999'],'Values':['File Server', 'Print Server', 'DHCP Server', 'DTC', 'Message Queuing', 'WINS Server', ' DFS Namespace Server', 'Generic Application', 'Generic Service', 'Generic Script', 'iSNS Cluster Resource', 'Virtual Machine', 'TS Session Broker', 'iSCSI Target Server', 'Scale-Out File Server', 'Hyper-V Replica Broker', 'Unknown']}
Id	string	2	-	✓	{'Description':'Id of the resource group.'}

Description

'Create a new resource group.'

Implemented

True

Static

True

CreateGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ DeleteGroup method
Return
Bypass_GetObject	True
Description	'Delete the resource group.'
Implemented	True
DeleteGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ DestroyGroup method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Options	uint32	0	✓	-	{'BitMap':['0', '1'],'BitValues':['None', 'PerformCleanup'],'Description':'Any options which to perform while destroying the cluster group.'}

Bypass_GetObject

True

Description

'Destroys the cluster group and any resources in this group.'

Implemented

True

DestroyGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ ExecuteGroupControl method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
ControlCode	sint32	0	✓	-	{'Description':'A control code specifying the operation to be performed.'}
InputBuffer	uint8	1	✓	-	{'Description':'An input buffer containing information needed for the operation, or NULL if no information is needed.'}
OutputBuffer	uint8	2	-	✓	{'Description':'An output buffer to receive the data resulting from the operation, or NULL if no data will be returned.'}
OutputBufferSize	sint32	3	-	✓	{'Description':'The allocated size (in bytes) of the output buffer.'}

Bypass_GetObject

True

Description

'Executes a control code on the group.'

Implemented

True

ExecuteGroupControl method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ GetGroupType method
Return	uint32 {'out':True}
Bypass_GetObject	True
Description	'Get the group type of this resource group.'
Implemented	True
ValueMap	['100', '101', '102', '103', '104', '105', '106', '107', '108', '109', '110', '111', '112', '113', '114', '115', '9999']
Values	['File Server', 'Print Server', 'DHCP Server', 'DTC', 'Message Queuing', 'WINS Server', ' DFS Namespace Server', 'Generic Application', 'Generic Service', 'Generic Script', 'iSNS Cluster Resource', 'Virtual Machine', 'TS Session Broker', 'iSCSI Target Server', 'Scale-Out File Server', 'Hyper-V Replica Broker', 'Unknown']
GetGroupType method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ GetPreferredOwners method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NodeNames	string	0	-	✓	{'Description':'Node name(s) in order of preference that can be owners of this resource group.'}

Bypass_GetObject

True

Description

'Get the list of preferred owners for this resource group.'

Implemented

True

GetPreferredOwners method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ MoveToNewNode method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NodeName	string	0	✓	-	{'Description':'Name of the node to move to or NULL to move to any node.'}
TimeOut	uint32	1	✓	-	{'Description':'How long (in seconds) the method should wait for the resource group to move to another node.'}

Bypass_GetObject

True

Description

'To move the resource group to different node.'

Implemented

True

MoveToNewNode method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ MoveToNewNodeEx method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NodeName	string	0	✓	-	{'Description':'Name of the node to move to or NULL to move to any node.'}
Parameters	object:MSCluster_Property	1	✓	-	{'Description':'Any parameters for the resource group move.'}
Flags	uint32	2	✓	-	{'Description':'Any flags for the resource group move.'}

Bypass_GetObject

True

Description

'To move the resource group to different node.'

Implemented

True

MoveToNewNodeEx method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ MoveToNewNodeParams method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NodeName	string	0	✓	-	{'Description':'Name of the node to move to or NULL to move to any node.'}
Parameters	uint8	1	✓	-	{'Description':'Any parameters for the resource group move.'}
Flags	uint32	2	✓	-	{'Description':'Any flags for the resource group move.'}

Bypass_GetObject

True

Description

'To move the resource group to different node allowing the parameters to be specified as a raw buffer.'

Implemented

True

MoveToNewNodeParams method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ Rename method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NewName	string	0	✓	-	{'Description':'New name of the resource group.'}

Bypass_GetObject

True

Description

'Rename the resource group.'

Implemented

True

Rename method is in 4 classes of ROOT\MSCluster and in 11 namespaces

…

▲ SetGroupType method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
GroupType	uint32	0	✓	-	{'Description':'The new group type of this resource group.'}

Bypass_GetObject

True

Description

'Set the group type of this resource group. This method is obsolete'

Implemented

True

SetGroupType method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ SetPreferredOwners method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
NodeNames	string	0	✓	-	{'Description':'Node name(s) in order of preference that can be owners of this resource group.'}

Bypass_GetObject

True

Description

'Set the preferred owner list for this resource group.'

Implemented

True

SetPreferredOwners method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace

…

▲ TakeOffline method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
TimeOut	uint32	0	✓	-	{'Description':'How long (in seconds) the method should wait for the resource group to go offline.'}
Parameters	object:MSCluster_Property	1	✓	-	{'Description':'Any parameters for the resource group offline.'}
Flags	uint32	2	✓	-	{'Description':'Any flags for the resource group offline.'}

Bypass_GetObject

True

Description

'Takes the resource group offline.'

Implemented

True

TakeOffline method is in 2 classes of ROOT\MSCluster and in 1 namespace

…

▲ TakeOfflineParams method

Return

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
TimeOut	uint32	0	✓	-	{'Description':'How long (in seconds) the method should wait for the resource group to go offline.'}
Parameters	uint8	1	✓	-	{'Description':'Any parameters for the resource group offline.'}
Flags	uint32	2	✓	-	{'Description':'Any flags for the resource group offline.'}

Bypass_GetObject

True

Description

'Takes the resource group offline allowing the parameters to be specified as a raw buffer.'

Implemented

True

TakeOfflineParams method is in 2 classes of ROOT\MSCluster and in 1 namespace

Detailed description of MSCluster_ResourceGroup properties

Local properties (16) of MSCluster_ResourceGroup class

…

▲ AntiAffinityClassNames property
CIMTYPE	'string'
Description	'The AntiAffinityClassNames property is used to identify groups that should not be hosted on the same cluster node.'
read	True
write	True
AntiAffinityClassNames property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ AutoFailbackType property
CIMTYPE	'uint32'
Description	'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.'
read	True
write	True
AutoFailbackType property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ DefaultOwner property
CIMTYPE	'uint32'
Description	'Number of the last node the resource group was activated on or explictly moved to.'
Max	512
Min	-1
read	True
write	True
DefaultOwner property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ FailbackWindowEnd property
CIMTYPE	'sint32'
Description	'The FailbackWindowEnd property provides the latest time that the group can be moved back to the node identified as its preferred node.'
Max	23
Min	-1
read	True
Units	'hours'
write	True
FailbackWindowEnd property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ FailbackWindowStart property
CIMTYPE	'sint32'
Description	'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.'
Max	23
Min	-1
read	True
Units	'hours'
write	True
FailbackWindowStart property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ FailoverPeriod property
CIMTYPE	'uint32'
Description	'The FailoverPeriod property specifies a number of hours during which a maximum number of failover attempts, specified by FailoverThreshold, can occur.'
Max	1193
Min	1
read	True
Units	'hours'
write	True
FailoverPeriod property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ FailoverThreshold property
CIMTYPE	'uint32'
Description	'The FailoverThreshold property specifies the maximum number of failover attempts that can be made on a group within a time interval defined by FailoverPeriod.'
read	True
write	True
FailoverThreshold property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ GroupType property
CIMTYPE	'uint32'
Description	'The Type of the resource group.'
read	True
ValueMap	['100', '101', '102', '103', '104', '105', '106', '107', '108', '109', '110', '111', '112', '113', '114', '115', '9999']
Values	['File Server', 'Print Server', 'DHCP Server', 'DTC', 'Message Queuing', 'WINS Server', ' DFS Namespace Server', 'Generic Application', 'Generic Service', 'Generic Script', 'iSNS Cluster Resource', 'Virtual Machine', 'TS Session Broker', 'iSCSI Target Server', 'Scale-Out File Server', 'Hyper-V Replica Broker', 'Unknown']
GroupType property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 4 namespaces

…

▲ Id property
CIMTYPE	'string'
Description	'The Id property specifies the Id of the group.'
read	True
Id property is in 10 classes of ROOT\MSCluster and in 33 namespaces

…

▲ IsCore property
CIMTYPE	'boolean'
Description	'Indicates that the resource group is essential to the cluster and cannot be deleted.'
read	True
IsCore property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces

…

▲ OwnerNode property
CIMTYPE	'string'
Description	'The node hosting the resource group.'
read	True
OwnerNode property is in 2 classes of ROOT\MSCluster and in 2 namespaces

…

▲ PersistentState property
CIMTYPE	'boolean'
Description	'The PersistentState property specifies whether a group should be left offline or brought online when the Cluster Service starts or the group is moved to another node.'
read	True
write	True
PersistentState property is in 2 classes of ROOT\MSCluster and in 2 namespaces

…

▲ Priority property
CIMTYPE	'uint32'
Description	'Priority value of the resource group.'
Max	4999
Min	0
read	True
write	True
Priority property is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 31 namespaces

…

▲ PrivateProperties property
CIMTYPE	'object:MSCluster_Property'
Description	'Private properties of the Group.'
read	True
write	True
PrivateProperties property is in 7 classes of ROOT\MSCluster and in 2 namespaces

…

▲ State property
CIMTYPE	'uint32'
Description	'The current state of the resource group.'
read	True
ValueMap	['-1', '0', '1', '2', '3', '4']
Values	['Unknown', 'Online', 'Offline', 'Failed', 'Partial Online', 'Pending']
State property is in 6 classes of ROOT\MSCluster and in 36 namespaces

…

▲ StatusInformation property
CIMTYPE	'uint64'
Description	'List of various Status Flags for the ResourceGroup. These are set by Cluster Service.'
read	True
StatusInformation property is in 2 classes of ROOT\MSCluster and in 2 namespaces

Derived properties (7) of MSCluster_ResourceGroup class

…

▲ Caption property
CIMTYPE	'string'
Description	'The Caption property is a short textual description (one-line string) of the object.'
Caption property is in 26 classes of ROOT\MSCluster and in 37 namespaces

…

▲ Characteristics property
CIMTYPE	'uint32'
read	True
Characteristics property is in 15 classes of ROOT\MSCluster and in 9 namespaces

…

▲ Description property
CIMTYPE	'string'
Description	'The Description property provides comments about the group.'
read	True
write	True
Description property is in 28 classes of ROOT\MSCluster and in 142 namespaces

…

▲ Flags property
CIMTYPE	'uint32'
read	True
Flags property is in 16 classes of ROOT\MSCluster and in 142 namespaces

…

▲ InstallDate property
CIMTYPE	'datetime'
Description	'A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
InstallDate property is in 26 classes of ROOT\MSCluster and in 23 namespaces

…

▲ Name property
CIMTYPE	'string'
Description	'The Name property specifies the name of the group.'
key	True
read	True
Name property is in 32 classes of ROOT\MSCluster and in 142 namespaces

…

▲ Status property
CIMTYPE	'string'
Description	'A string indicating the current status of the object. Various operational and non-operational statuses are defined. Operational statuses are "OK", "Degraded", "Stressed" and "Pred Fail". "Stressed" indicates that the Element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. The condition "Pred Fail" (failure predicted) indicates that an Element is 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", "NonRecover", "Starting", "Stopping" and "Service". "NonRecover" indicates that a non-recoverable error has occurred. "Service" describes an Element being configured, maintained or cleaned, or otherwise administered. This status could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative task. Not all such work is on-line, yet the Element is neither "OK" nor in one of the other states.'
Status property is in 27 classes of ROOT\MSCluster and in 42 namespaces

MSCluster_ResourceGroup Qualifiers

…

Name	Value	ToInstance	ToSubclass	Overridable	Amended	Local
Description	'Superclass for cluster objects that provide the FLAGS and CHARACTERISTICS attributes'	✗	✓	✓	✓	✓
dynamic	True	✓	✗	✓	✗	✓
Locale	1033	✗	✗	✓	✓	✓
provider	'MS_CLUSTER_PROVIDER'	✗	✗	✓	✗	✓
UUID	'{DDE3A30E-55F7-4c31-B6CF-E360D12C5253}'	✗	✗	✓	✗	✓

MSCluster_ResourceGroup System properties

…

Name	Value	Origin	CIMType	Local	Array
__PATH	'\\.\ROOT\MSCluster:MSCluster_ResourceGroup'	___SYSTEM	8	✗	✗
__NAMESPACE	'ROOT\MSCluster'	___SYSTEM	8	✗	✗
__SERVER	'.'	___SYSTEM	8	✗	✗
__DERIVATION	['MSCluster_LogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']	___SYSTEM	8	✗	✓
__PROPERTY_COUNT	23	___SYSTEM	3	✗	✗
__RELPATH	'MSCluster_ResourceGroup'	___SYSTEM	8	✗	✗
__DYNASTY	'CIM_ManagedSystemElement'	___SYSTEM	8	✗	✗
__SUPERCLASS	'MSCluster_LogicalElement'	___SYSTEM	8	✗	✗
__CLASS	'MSCluster_ResourceGroup'	___SYSTEM	8	✗	✗
__GENUS	1	___SYSTEM	3	✗	✗

Similar Classes to MSCluster_ResourceGroup

Number of classes:3

…

Class name	Properties	Class Instances	Child Instances	Abstract	Singleton
MSCluster_ClusterToResourceGroup	2	-	-	-	-
MSCluster_ResourceGroupToPreferredNode	2	-	-	-	-
MSCluster_ResourceGroupToResource	2	-	-	-	-

WUtils.com

Includes&Samples

MSCluster_ResourceGroup, ROOT\MSCluster

Description

MSCluster_ResourceGroup methods

MSCluster_ResourceGroup properties

Detailed description of MSCluster_ResourceGroup methods

Local methods (16) of MSCluster_ResourceGroup class

Detailed description of MSCluster_ResourceGroup properties

Local properties (16) of MSCluster_ResourceGroup class

Derived properties (7) of MSCluster_ResourceGroup class

MSCluster_ResourceGroup Qualifiers

MSCluster_ResourceGroup System properties

Similar Classes to MSCluster_ResourceGroup