MSCluster_Resource, ROOT\MSCluster\ms_409
Class
| Methods (25)
| Properties (40)
| Qualifiers (3)
| 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_Resource methods MSCluster_Resource has 25 methods (25 Local )
MSCluster_Resource properties MSCluster_Resource has 40 properties (35 Local , 5 Derived )
Detailed description of MSCluster_Resource methods Local methods (25) of MSCluster_Resource class ▲ AddCryptoCheckpoint methodReturn Parameters Name CIMType ID IN OUT Qualifiers CheckpointName string 0 ✓ -
Description 'Add an encrypted checkpoint to this resource.' AddCryptoCheckpoint method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ AddDependency methodReturn Parameters Name CIMType ID IN OUT Qualifiers Resource string 0 ✓ - {'Description':'The resource that this resource should depend on.'}
Description 'Create a dependency relationship between two resources.' AddDependency method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 4 namespaces
▲ AddPossibleOwner methodReturn Parameters Name CIMType ID IN OUT Qualifiers NodeName string 0 ✓ - {'Description':'A node that can be an owner (host) of this resource.'}
Description 'Adds a possibile owner nodes which can be an owner (host) of this resource' AddPossibleOwner method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ AddRegistryCheckpoint methodReturn Parameters Name CIMType ID IN OUT Qualifiers CheckpointName string 0 ✓ -
Description 'Add a registry checkpoint to this resource.' AddRegistryCheckpoint method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ AttachStorageDevice methodReturn Parameters Name CIMType ID IN OUT Qualifiers StorageDevice ref:MSCluster_AvailableDisk 0 ✓ - {'Description':'The refrence to an instance of the MSCluster_AvailableDisk which the storage will be attached to.'}
Description 'Attaches the underlying storage of a resource to another device.' AttachStorageDevice method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ BringOnline methodReturn Parameters Name CIMType ID IN OUT Qualifiers TimeOut uint32 0 ✓ - {'Description':'How long (in seconds) the method should wait for the resource to come online.'}
Description 'Brings the resource online.' BringOnline method is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ CreateResource methodReturn Parameters Name CIMType ID IN OUT Qualifiers Group string 0 ✓ - {'Description':'The group name to receive the resource.'} ResourceName string 1 ✓ - {'Description':'The name to assign to the resource.'} ResourceType string 2 ✓ - {'Description':'The type of resource to create.'} SeparateMonitor boolean 3 ✓ - {'Description':'TRUE if the resource needs a separate resource monitor.'} Id string 4 - ✓ {'Description':'Id of the resource.'}
Description 'Create a new resource.' CreateResource method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ DeleteResource methodReturn Parameters Name CIMType ID IN OUT Qualifiers Options uint32 0 ✓ - {'BitMap':['0', '1'],'BitValues':['None', 'PerformCleanup'],'Description':'Any options which to perform while deleting the resource.'}
Description 'Delete the resource.' DeleteResource method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ ExecuteResourceControl methodReturn 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.'}
Description 'Executes a control code on the resource.' ExecuteResourceControl method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ FailResource methodReturn Description 'Force this resource to become unavailable to simulate failure. Used by applications to test their failover configurations.' FailResource method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ GetDependencies methodReturn Parameters Name CIMType ID IN OUT Qualifiers Expression string 0 - ✓ {'Description':'The expression representing the resource dependencies.'} AsResourceIds boolean 1 ✓ - {'Description':'If the expression should contain the id of the resource instead of the resource friendly name.'}
Description 'Get the resource dependency expression.' GetDependencies method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ GetPossibleOwners methodReturn Parameters Name CIMType ID IN OUT Qualifiers NodeNames string 0 - ✓ {'Description':'The nodes that can be an owner (host) of this resource.'}
Description 'Gets the list of nodes which can be an owner (host) of this resource' GetPossibleOwners method is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ MigrateVirtualMachine methodReturn Parameters Name CIMType ID IN OUT Qualifiers SnapshotDestinationPath string 0 ✓ - {'Description':'The snapshot path.'} ConfigurationDestinationPath string 1 ✓ - {'Description':'The configuration path.'} SwapFileDestinationPath string 2 ✓ - {'Description':'The swapfile path.'} SourcePaths string 3 ✓ - {'Description':'The source paths which to migrate.'} DestinationPaths string 4 ✓ - {'Description':'The destination paths which to migrate to.'} ResourceDestinationPools string 5 ✓ - {'Description':'The destination resource pools which to migrate to.'}
Description 'Migrates the virtual machine settings.' MigrateVirtualMachine method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ MoveToNewGroup methodReturn Parameters Name CIMType ID IN OUT Qualifiers Group string 0 ✓ - {'Description':'The group name to receive the resource.'}
Description 'Move the resource to a different group.' MoveToNewGroup method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ ReleaseAddress methodReturn Description 'Release the IPv4 Address DHCP lease. Valid only for IP Address resources.' ReleaseAddress method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RemoveCryptoCheckpoint methodReturn Parameters Name CIMType ID IN OUT Qualifiers CheckpointName string 0 ✓ -
Description 'Remove an encrypted checkpoint to this resource.' RemoveCryptoCheckpoint method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RemoveDependency methodReturn Parameters Name CIMType ID IN OUT Qualifiers Resource string 0 ✓ - {'Description':'The resource that this resource should no longer depend on.'}
Description 'Remove a dependency relationship between two resources.' RemoveDependency method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 4 namespaces
▲ RemovePossibleOwner methodReturn Parameters Name CIMType ID IN OUT Qualifiers NodeName string 0 ✓ - {'Description':'The node that can no longer own (host) this resource.'}
Description 'Remove a possible owner node (host) from the list of possible owners for this resource.' RemovePossibleOwner method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RemoveRegistryCheckpoint methodReturn Parameters Name CIMType ID IN OUT Qualifiers CheckpointName string 0 ✓ -
Description 'Remove a registry checkpoint to this resource.' RemoveRegistryCheckpoint method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RenewAddress methodReturn Description 'Renew the IPv4 Address DHCP lease. Valid only for IP Address resources.' RenewAddress method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ SetDependencies methodReturn Parameters Name CIMType ID IN OUT Qualifiers Expression string 0 ✓ - {'Description':'The dependency expression that this resource should depend on.'}
Description 'Set the resource dependency expression.' SetDependencies method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ TakeOffline methodReturn Parameters Name CIMType ID IN OUT Qualifiers TimeOut uint32 0 ✓ - {'Description':'How long (in seconds) the method should wait for the resource to go offline.'} Parameters object :MSCluster_Property 1 ✓ - {'Description':'Any parameters for the resource offline.'} Flags uint32 2 ✓ - {'Description':'Any flags for the resource offline.'}
Description 'Take the resource offline.' TakeOffline method is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ TakeOfflineParams methodReturn Parameters Name CIMType ID IN OUT Qualifiers TimeOut uint32 0 ✓ - {'Description':'How long (in seconds) the method should wait for the resource to go offline.'} Parameters uint8 1 ✓ - {'Description':'Any parameters for the resource offline as a raw buffer.'} Flags uint32 2 ✓ - {'Description':'Any flags for the resource offline.'}
Description 'Take the resource offline specifing the parameters as a raw buffer.' TakeOfflineParams method is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ UpdateVirtualMachine methodReturn Description 'Updates the configuration of a clustered virtual machine.' UpdateVirtualMachine method is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
Detailed description of MSCluster_Resource properties Local properties (35) of MSCluster_Resource class ▲ CoreResource propertyCIMTYPE 'boolean' Description 'Indicates that the resource is essential to the cluster and cannot be deleted.' CoreResource property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ CryptoCheckpoints propertyCIMTYPE 'string' Description 'List of crypto checkpoints for this resource.' CryptoCheckpoints property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ EmbeddedFailureAction propertyCIMTYPE 'uint32' Description 'The EmbeddedFailureAction property specifies the action to be taken by the Cluster Service if the resource experiences an embedded failure.' EmbeddedFailureAction property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ IsAlivePollInterval propertyCIMTYPE 'uint32' Description 'The IsAlivePollInterval property provides the recommended interval in milliseconds at which the Cluster Service should poll the resource to determine if it is operational. If it is sets to 0xFFFFFFFF, the Cluster Service uses the IsAlivePollInterval property for the resource type associated with the resource.' Units 'Milliseconds' IsAlivePollInterval property is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ IsClusterSharedVolume propertyCIMTYPE 'boolean' Description 'Specifies if the resource is a cluster shared volume resource.' IsClusterSharedVolume property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ LastOperationStatusCode propertyCIMTYPE 'uint64' Description 'The last Application Specific Error Code returned by the Resource DLL during a Cluster Operation.' LastOperationStatusCode property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ LooksAlivePollInterval propertyCIMTYPE 'uint32' Description 'The LooksAlivePollInterval property provides the recommended interval in milliseconds at which the Cluster Service should poll the resource to determine if it appears operational. If it is sets to 0xFFFFFFFF, the Cluster Service uses the LooksAlivePollInterval property for the resource type associated with the resource.' Units 'Milliseconds' LooksAlivePollInterval property is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ MonitorProcessId propertyCIMTYPE 'uint32' Description 'The MonitorProcessId property provides the process ID of the Resource Host Service that is currently hosting the resource.' MonitorProcessId property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ OwnerGroup propertyCIMTYPE 'string' Description 'The resource group which the resource belongs to.' OwnerGroup property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ PendingTimeout propertyCIMTYPE 'uint32' Description 'If a resource cannot be brought online or taken offline in the number of milliseconds specified by the PendingTimeout property, the resource is forcibly terminated.' PendingTimeout property is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ PersistentState propertyCIMTYPE 'boolean' Description 'The PersistentState property specifies whether the resource should be brought online or left offline when the Cluster Service is started.' PersistentState property is in 2 classes of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RegistryCheckpoints propertyCIMTYPE 'string' Description 'List of registry checkpoints for this resource.' RegistryCheckpoints property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ ResourceSpecificData1 propertyCIMTYPE 'uint64' Description 'Resource Specific Information.' ResourceSpecificData1 property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ ResourceSpecificData2 propertyCIMTYPE 'uint64' Description 'Resource Specific Information.' ResourceSpecificData2 property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ ResourceSpecificStatus propertyCIMTYPE 'string' Description 'A resource specific status message that compliments the current resource state.' ResourceSpecificStatus property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RestartAction propertyCIMTYPE 'uint32' Description 'The RestartAction property describes the action to be taken by the Cluster Service if the resource fails.' RestartAction property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RestartDelay propertyCIMTYPE 'uint32' Description 'The time delay before a failed resource is restarted.' RestartDelay property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RestartPeriod propertyCIMTYPE 'uint32' Description 'The RestartPeriod property defines an interval of time, in milliseconds, during which a specified number of restart attempts can be made on a nonresponsive resource.' RestartPeriod property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RestartThreshold propertyCIMTYPE 'uint32' Description 'The RestartThreshold property specifies the maximum number of restart attempts that can be made on a resource within an interval defined by the RestartPeriod property before the Cluster Service initiates the action specified by the RestartAction property.' RestartThreshold property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ RetryPeriodOnFailure propertyCIMTYPE 'uint32' Description 'The RetryPeriodOnFailure property specifies the interval of time (in milliseconds) that a resource should remain in a failed state before the Cluster service attempts to restart it.' RetryPeriodOnFailure property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ SeparateMonitor propertyCIMTYPE 'boolean' Description 'The SeparateMonitor property indicates whether the resource requires its own Resource Monitor.' SeparateMonitor property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
▲ State propertyCIMTYPE 'uint32' Description 'The current state of the resource.' Values ['Unknown', 'Inherited', 'Initializing', 'Online', 'Offline', 'Failed', 'Pending', 'Online Pending', 'Offline Pending'] State property is in 6 classes of ROOT\MSCluster\ms_409 and in 36 namespaces
▲ Subclass propertyCIMTYPE 'uint32' Description 'The resource sub class.' Subclass property is in 1 class (MSCluster_Resource) of ROOT\MSCluster\ms_409 and in 2 namespaces
Derived properties (5) of MSCluster_Resource class
▲ Status propertyCIMTYPE '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 24 classes of ROOT\MSCluster\ms_409 and in 42 namespaces
MSCluster_Resource Qualifiers Name Value ToInstance ToSubclass Overridable Amended Local
AMENDMENT True ✗ ✗ ✓ ✗ ✓
Description 'Superclass for cluster objects that provide the FLAGS and CHARACTERISTICS attributes' ✗ ✓ ✓ ✗ ✗
LOCALE 1033 ✗ ✗ ✓ ✗ ✓
MSCluster_Resource System properties Name Value Origin CIMType Local Array
__PATH '\\.\ROOT\MSCluster\ms_409:MSCluster_Resource' ___SYSTEM 8 ✗ ✗
__NAMESPACE 'ROOT\MSCluster\ms_409' ___SYSTEM 8 ✗ ✗
__SERVER '.' ___SYSTEM 8 ✗ ✗
__DERIVATION ['MSCluster_LogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement'] ___SYSTEM 8 ✗ ✓
__PROPERTY_COUNT 40 ___SYSTEM 3 ✗ ✗
__RELPATH 'MSCluster_Resource ' ___SYSTEM 8 ✗ ✗
__DYNASTY 'CIM_ManagedSystemElement ' ___SYSTEM 8 ✗ ✗
__SUPERCLASS 'MSCluster_LogicalElement ' ___SYSTEM 8 ✗ ✗
__CLASS 'MSCluster_Resource ' ___SYSTEM 8 ✗ ✗
__GENUS 1 ___SYSTEM 3 ✗ ✗
Similar Classes to MSCluster_Resource Number of classes:17
Please enable JavaScript to view the comments powered by Disqus.