MSCluster_ResourceGroup, ROOT\MSCluster

Class | Methods (16) | Properties (23) | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Superclass for cluster objects that provide the FLAGS and CHARACTERISTICS attributes

MSCluster_ResourceGroup methods

MSCluster_ResourceGroup has 16 methods (16 Local)

NameOriginReturn
BringOnlineMSCluster_ResourceGroup
CancelOperationMSCluster_ResourceGroup
CreateGroupMSCluster_ResourceGroup
DeleteGroupMSCluster_ResourceGroup
DestroyGroupMSCluster_ResourceGroup
ExecuteGroupControlMSCluster_ResourceGroup
GetGroupTypeMSCluster_ResourceGroupuint32 {'out':True}
GetPreferredOwnersMSCluster_ResourceGroup
MoveToNewNodeMSCluster_ResourceGroup
MoveToNewNodeExMSCluster_ResourceGroup
MoveToNewNodeParamsMSCluster_ResourceGroup
RenameMSCluster_ResourceGroup
SetGroupTypeMSCluster_ResourceGroup
SetPreferredOwnersMSCluster_ResourceGroup
TakeOfflineMSCluster_ResourceGroup
TakeOfflineParamsMSCluster_ResourceGroup

MSCluster_ResourceGroup properties

MSCluster_ResourceGroup has 23 properties (16 Local, 7 Derived)

NameOriginCIMType
AntiAffinityClassNamesMSCluster_ResourceGroup8 [string]
AutoFailbackTypeMSCluster_ResourceGroup19 [uint32]
CaptionCIM_ManagedSystemElement8 [string]
CharacteristicsMSCluster_LogicalElement19 [uint32]
DefaultOwnerMSCluster_ResourceGroup19 [uint32]
DescriptionCIM_ManagedSystemElement8 [string]
FailbackWindowEndMSCluster_ResourceGroup3 [sint32]
FailbackWindowStartMSCluster_ResourceGroup3 [sint32]
FailoverPeriodMSCluster_ResourceGroup19 [uint32]
FailoverThresholdMSCluster_ResourceGroup19 [uint32]
FlagsMSCluster_LogicalElement19 [uint32]
GroupTypeMSCluster_ResourceGroup19 [uint32]
IdMSCluster_ResourceGroup8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
IsCoreMSCluster_ResourceGroup11 [boolean]
key
Name
CIM_ManagedSystemElement8 [string]
OwnerNodeMSCluster_ResourceGroup8 [string]
PersistentStateMSCluster_ResourceGroup11 [boolean]
PriorityMSCluster_ResourceGroup19 [uint32]
PrivatePropertiesMSCluster_ResourceGroup13 [object:MSCluster_Property]
StateMSCluster_ResourceGroup19 [uint32]
StatusCIM_ManagedSystemElement8 [string]
StatusInformationMSCluster_ResourceGroup21 [uint64]

Detailed description of MSCluster_ResourceGroup methods

Local methods (16) of MSCluster_ResourceGroup class

BringOnline method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
TimeOutuint320-{'Description':'How long (in seconds) the method should wait for the resource group to come online.'}
Bypass_GetObjectTrue
Description'Brings the resource group online.'
ImplementedTrue
BringOnline method is in 2 classes of ROOT\MSCluster and in 1 namespace
CancelOperation method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
Flagsuint320-{'Description':'Any flags for the cancel operation.'}
Bypass_GetObjectTrue
Description'Cancels any pending operations on the resource group.'
ImplementedTrue
CancelOperation method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
CreateGroup method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
GroupNamestring0-{'Description':'Name of the resource group.'}
GroupTypeuint321-{'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']}
Idstring2-{'Description':'Id of the resource group.'}
Description'Create a new resource group.'
ImplementedTrue
StaticTrue
CreateGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces
DeleteGroup method
Return
Bypass_GetObjectTrue
Description'Delete the resource group.'
ImplementedTrue
DeleteGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 2 namespaces
DestroyGroup method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
Optionsuint320-{'BitMap':['0', '1'],'BitValues':['None', 'PerformCleanup'],'Description':'Any options which to perform while destroying the cluster group.'}
Bypass_GetObjectTrue
Description'Destroys the cluster group and any resources in this group.'
ImplementedTrue
DestroyGroup method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
ExecuteGroupControl method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
ControlCodesint320-{'Description':'A control code specifying the operation to be performed.'}
InputBufferuint81-{'Description':'An input buffer containing information needed for the operation, or NULL if no information is needed.'}
OutputBufferuint82-{'Description':'An output buffer to receive the data resulting from the operation, or NULL if no data will be returned.'}
OutputBufferSizesint323-{'Description':'The allocated size (in bytes) of the output buffer.'}
Bypass_GetObjectTrue
Description'Executes a control code on the group.'
ImplementedTrue
ExecuteGroupControl method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
GetGroupType method
Returnuint32 {'out':True}
Bypass_GetObjectTrue
Description'Get the group type of this resource group.'
ImplementedTrue
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
NameCIMTypeIDINOUTQualifiers
NodeNamesstring0-{'Description':'Node name(s) in order of preference that can be owners of this resource group.'}
Bypass_GetObjectTrue
Description'Get the list of preferred owners for this resource group.'
ImplementedTrue
GetPreferredOwners method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
MoveToNewNode method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
NodeNamestring0-{'Description':'Name of the node to move to or NULL to move to any node.'}
TimeOutuint321-{'Description':'How long (in seconds) the method should wait for the resource group to move to another node.'}
Bypass_GetObjectTrue
Description'To move the resource group to different node.'
ImplementedTrue
MoveToNewNode method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
MoveToNewNodeEx method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
NodeNamestring0-{'Description':'Name of the node to move to or NULL to move to any node.'}
Parametersobject:MSCluster_Property1-{'Description':'Any parameters for the resource group move.'}
Flagsuint322-{'Description':'Any flags for the resource group move.'}
Bypass_GetObjectTrue
Description'To move the resource group to different node.'
ImplementedTrue
MoveToNewNodeEx method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
MoveToNewNodeParams method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
NodeNamestring0-{'Description':'Name of the node to move to or NULL to move to any node.'}
Parametersuint81-{'Description':'Any parameters for the resource group move.'}
Flagsuint322-{'Description':'Any flags for the resource group move.'}
Bypass_GetObjectTrue
Description'To move the resource group to different node allowing the parameters to be specified as a raw buffer.'
ImplementedTrue
MoveToNewNodeParams method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
Rename method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
NewNamestring0-{'Description':'New name of the resource group.'}
Bypass_GetObjectTrue
Description'Rename the resource group.'
ImplementedTrue
Rename method is in 4 classes of ROOT\MSCluster and in 11 namespaces
SetGroupType method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
GroupTypeuint320-{'Description':'The new group type of this resource group.'}
Bypass_GetObjectTrue
Description'Set the group type of this resource group. This method is obsolete'
ImplementedTrue
SetGroupType method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
SetPreferredOwners method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
NodeNamesstring0-{'Description':'Node name(s) in order of preference that can be owners of this resource group.'}
Bypass_GetObjectTrue
Description'Set the preferred owner list for this resource group.'
ImplementedTrue
SetPreferredOwners method is in 1 class (MSCluster_ResourceGroup) of ROOT\MSCluster and in 1 namespace
TakeOffline method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
TimeOutuint320-{'Description':'How long (in seconds) the method should wait for the resource group to go offline.'}
Parametersobject:MSCluster_Property1-{'Description':'Any parameters for the resource group offline.'}
Flagsuint322-{'Description':'Any flags for the resource group offline.'}
Bypass_GetObjectTrue
Description'Takes the resource group offline.'
ImplementedTrue
TakeOffline method is in 2 classes of ROOT\MSCluster and in 1 namespace
TakeOfflineParams method
Return
Parameters
NameCIMTypeIDINOUTQualifiers
TimeOutuint320-{'Description':'How long (in seconds) the method should wait for the resource group to go offline.'}
Parametersuint81-{'Description':'Any parameters for the resource group offline.'}
Flagsuint322-{'Description':'Any flags for the resource group offline.'}
Bypass_GetObjectTrue
Description'Takes the resource group offline allowing the parameters to be specified as a raw buffer.'
ImplementedTrue
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.'
readTrue
writeTrue
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.'
readTrue
writeTrue
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.'
Max512
Min-1
readTrue
writeTrue
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.'
Max23
Min-1
readTrue
Units'hours'
writeTrue
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.'
Max23
Min-1
readTrue
Units'hours'
writeTrue
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.'
Max1193
Min1
readTrue
Units'hours'
writeTrue
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.'
readTrue
writeTrue
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.'
readTrue
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.'
readTrue
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.'
readTrue
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.'
readTrue
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.'
readTrue
writeTrue
PersistentState property is in 2 classes of ROOT\MSCluster and in 2 namespaces
Priority property
CIMTYPE'uint32'
Description'Priority value of the resource group.'
Max4999
Min0
readTrue
writeTrue
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.'
readTrue
writeTrue
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.'
readTrue
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.'
readTrue
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'
readTrue
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.'
readTrue
writeTrue
Description property is in 28 classes of ROOT\MSCluster and in 142 namespaces
Flags property
CIMTYPE'uint32'
readTrue
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.'
keyTrue
readTrue
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

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Superclass for cluster objects that provide the FLAGS and CHARACTERISTICS attributes'
dynamicTrue
Locale1033
provider'MS_CLUSTER_PROVIDER'
UUID'{DDE3A30E-55F7-4c31-B6CF-E360D12C5253}'

MSCluster_ResourceGroup System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\MSCluster:MSCluster_ResourceGroup'___SYSTEM8
__NAMESPACE'ROOT\MSCluster'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['MSCluster_LogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']___SYSTEM8
__PROPERTY_COUNT23___SYSTEM3
__RELPATH'MSCluster_ResourceGroup'___SYSTEM8
__DYNASTY'CIM_ManagedSystemElement'___SYSTEM8
__SUPERCLASS'MSCluster_LogicalElement'___SYSTEM8
__CLASS'MSCluster_ResourceGroup'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSCluster_ResourceGroup

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSCluster_ClusterToResourceGroup020----
MSCluster_ResourceGroupToPreferredNode020----
MSCluster_ResourceGroupToResource020----
comments powered by Disqus
WUtils.com