This documentation supports releases of BMC Helix Continuous Optimization up to December 31, 2021. To view the latest version, select the version from the Product version menu.

Microsoft Cluster Service metrics


The Microsoft Cluster Service (MSCS) metric groups are available for Windows Server 2000 and 2003. Even though the metric groups are labeled as Windows 2000, they are common across Windows Server 2012 R2 or later versions.

Windows MSCS Cluster Configuration

A cluster is a group of independent computer systems working as a unified computing resource. A cluster provides a single name for clients to use and a single administrative interface, and it guarantees that data is consistent across nodes.

The following table describes the Windows 2000 MSCS Cluster Configuration metric group.

Metric

Description

Cluster Name

The name of the cluster.

Major Version

Major version number of Microsoft Cluster Services software. Used to determine whether node can join cluster. A node can join a cluster only if one of the following is true:

  • NodeHighestVersion=ClusterHighestVersion
  • NodeLowestVersion=ClusterHighestVersion
  • NodeHighestVersion=ClusterLowestVersion

Minor Version

Minor version number of Microsoft Cluster Services software. Used to determine whether node can join cluster. A node can join a cluster only if one of the following is true:

  • NodeHighestVersion=ClusterHighestVersion
  • NodeLowestVersion=ClusterHighestVersion
  • NodeHighestVersion=ClusterLowestVersion

Build Number

Build number of Microsoft Cluster Services software. Used to determine whether node can join cluster.

Quorum Resource

Describes the resource selected to maintain cluster data.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the cluster. Their purpose is to extend the functionality of clustering administration by being able to support new types of cluster objects that are treated as resources.

Default Network Role

Specifies the Role (how the network will be used: client and/or private communication) that the cluster automatically assigns to any newly discovered or created network.

Description

Stores administrative comments about the cluster.

Security

Stores the security descriptor of a cluster. The security descriptor contains information related to a securable object.

Windows MSCS Node Configuration

A node is a computing entity within a cluster. The Windows 2000 MSCS Node Configuration metric group provides information about nodes in a cluster.

The following table describes the Windows 2000 MSCS Node Configuration metric group.

Metric

Description

Node Name

Name of the node.

Cluster State

State of the cluster on the node. One of the following:

  • ClusterStateNotInstalled
  • ClusterStateNotConfigured
  • ClusterStateNotRunning
  • ClusterStateRunning

Node State

State of the node. One of the following:

  • ClusterNodeUp
  • ClusterNodeDown
  • ClusterNodeJoining
  • ClusterNodePaused
  • ClusterNodeStateUnknown

Cluster Highest Version

The highest version of the cluster service for which the node is compatible. This information is needed so that a given node can join a cluster.

Cluster Lowest Version

The lowest version of the cluster service for which the node is compatible. This information is needed so that a given node can join a cluster.

Network Interface

Names of the network interfaces on the node. For details about a Network Interface, see NT Network Interface Statistics.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the node. The purpose is to extend the functionality of the cluster administration facility.

Build Number

Specifies the build number of Microsoft Windows NT/Windows 2000 installed on a node.

CSD Version

Specifies the name of the most recent service pack installed on the node (if any).

Description

Provides comments about the node.

Enable Event Log Replication

Controls whether the Windows NT/Windows 2000 Event Log is replicated.

Major Version

Specifies the integer component of the Windows NT/Window 2000 version installed on the node.

Minor Version

Specifies the decimal component of the Windows NT/Window 2000 version installed on the node.

Node Highest Version

Specifies the highest possible version of the Cluster service with which the node can join or communicate.

Node Lowest Version

Specifies the lowest possible version of the Cluster service with which the node can join or communicate.

 Windows MSCS Group Configuration

A group is a collection of resources managed as a server cluster object. Typically, a group contains all the resources needed to run a specific application or service.

The following table describes the Windows 2000 MSCS Group Configuration metric group.

Metric

Description

Group Name

Name of the group.

Owner Node

Node on which the group runs.

Preferred Owner Nodes

A node on which a group prefers to run. Each group is associated with a list of possible owners. Resources will fail over only to nodes that are listed as possible owners.

State

Indicates the state of the cluster group. Possible values are:

  • ClusterGroupFailed
  • ClusterGroupPendingin
  • ClusterGroupOnline
  • ClusterGroupPartialOnline
  • ClusterGroupOffline
  • ClusterGroupStateUnknown

Group Resources

Names of all the resources in the group. For details about a resource, see Resource metric group.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the group.

Auto Failback Type

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.

Description

Provides comments about the group.

Failback Window Start

Provides the earliest time (that is, local time as kept by the cluster) that the group can be failed back to the node identified as its preferred owner node.

Failback Window End

Provides the latest time that the group can be failed back to the node identified as its preferred owner node.

Failover Period

Specifies a number of hours during which a maximum number of failover attempts, specified by Failover Threshold, can occur.

Failover Threshold

Specifies the maximum number of failover attempts that can be made on a group within a time interval defined by Failover Period.

Persistent State

Specifies whether a group should be automatically brought online when the cluster forms.

Windows MSCS Network Configuration

A network is a server cluster object that carries internal communication between nodes or provides client access to cluster resources, or both.

The following table describes the Windows 2000 MSCS Network Configuration metric group.

Metric

Description

Network Name

Name of network.

State

Indicates the state of the cluster network. Possible values are:

  • ClusterNetworkStateUnknown
  • ClusterNetworkUnavailable
  • ClusterNetworkDown
  • ClusterNetworkPartitioned
  • ClusterNetworkUp

Network Interfaces

Names of the network interfaces on the network. For details about a Network Interface, see Windows 2000 MSCS Network Interface Configuration.

IP Address

Provides the IP address for the entire network or subnet.

Address Mask

Provides the mask that distinguishes the network and host portions of an address.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the network.

Description

Provides comments about the network.

Network Role

Provides the role of the network in the cluster. Possible values are:

  • ClusterNetworkRoleNone
  • ClusterNetworkRoleClientAccess
  • ClusterNetworkRoleInternalUse
  • ClusterNetworkRoleInternalAndClient

Windows MSCS Network Interface Configuration

A network interface connects a node to a local area network. This network could be a high-speed private network or public network.

The following table describes the Windows 2000 MSCS Network Interface Configuration metric group.

Metric

Description

Network Interface Name

Name of network interface (Should be some sort of NIC card ID).

Connection Network

Network to which the network interface is attached.

Connection Node

Node to which the network interface is attached.

State

Provides the cluster network interface state. Possible values are:

  • ClusterNetInterfaceFailed
  • ClusterNetInterfaceUnreachable
  • ClusterNetInterfaceUp
  • ClusterNetInterfaceUnavailable
  • ClusterNetInterfaceStateUnknown

Adapter

Provides the name that is used to uniquely identify the network interface in the cluster.

Address

Provides the primary network address that the node uses for the network interface.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the network interface.

Description

Provides comments about the network interface.

Windows MSCS Resource Configuration

A resource is a physical or logical entity (such as a disk or application) that is capable of being owned by a node, brought on and off line and managed by a cluster server object. It can be managed in a cluster. It can be hosted (owned) by only one node at a time. A resource is an instance of a resource type.

The following table describes the Windows 2000 MSCS Resource Configuration metric group.

Metric

Description

Resource Name

Name of resource (for example, disk or application).

Resource Type

Type of resource (see next section).

State

Indicates the state of the cluster resource. Possible values are:

  • ClusterResourceStateUnknown
  • ClusterResourceInherited
  • ClusterResourceInitializing,
  • ClusterResourceOnline
  • ClusterResourceOffline
  • ClusterResourceFailed
  • ClusterResourcePending
  • ClusterResourceOnlinePending
  • ClusterResourceOfflinePending

Group

The cluster group contains resources related to cluster administration. Adding more resources to the group can hinder the ability to administer the cluster. Failure of any additional resources within the cluster group may trigger failover or inability to successfully administer the cluster. For best results and higher availability of the cluster, do not add resources to the cluster group. Instead, create groups for the additional resources, or place the resources in other groups within the cluster.

Owner Node

Node that currently owns the resource.

Characteristics

One of the following:

  • CLUS_CHAR_UNKNOWN
  • CLUS_CHAR_QUORUM
  • CLUS_CHAR_DELETE_REQUIRES_ALL_NODES

Cryptographic Key Checkpoints

Defined for the resource. Related to security and registry information.

Registry Key Checkpoints

Defined for the resource. Related to security and registry information.

Dependencies

A dependent resource requires, or depends on, another resource to operate. For example, if a Generic Application resource requires access to shared physical storage, it would depend on a Physical Disk resource.

Dependents

Some resources have required dependents.

Flags

Flag Value indicating how to create the resource. Flag can be set to: CLUSTER_RESOURCE_SEPARATE_MONITOR. This value indicates that a separate Resource Monitor should be assigned to the newly created resource.

Network Name Dependency

The CLUSCTL_RESOURCE_GET_NETWORK_NAME control code retrieves the name private property of a dependent Network Name resource. This control code is unsupported by the other default resource types. Applications can use this control code as a Cluster Resource Control parameter.

Possible Owner Nodes

Possible owner nodes of resource.

Resource Class

Resource class is one of the following:

  • CLUS_RESCLASS_UNKNOWN
  • CLUS_RESCLASS_STORAGE
  • CLUS_RESCLASS_USER

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extensions that are associated with the resource.

Debug Prefix

Specifies the path to the debugger used to debug the resource.

Description

Provides comments about the resource.

Is Alive Poll Interval

Provides the recommended interval in milliseconds at which the Cluster service should poll the resource to determine if it is operational. The polling occurs when the Resource Monitor calls the resource DLL's IsAlive entry point function.

Looks Alive Poll Interval

Provides the recommended interval in milliseconds at which the Cluster service should poll the resource to determine if it appears operational. The polling occurs when the Resource Monitor calls the resource DLL's LooksAlive entry point function.

Pending Timeout

Sets the number of milliseconds that a Resource Monitor will wait for a resource DLL to update the status of a resource in an OnlinePending or OfflinePending state before terminating the resource.

Persistent State

Specifies whether the resource should be brought online or left offline when the Cluster service is started.

Restart Action

Describes the action to be taken by the Cluster service if the resource fails.

Restart Period

Defines an interval of time, in milliseconds, during which a specified number of restart attempts can be made on a nonresponsive resource.

Restart Threshold

Property specifies the allowable number of restart attempts that can occur within the interval defined by RestartPeriod before the Cluster service initiates the action specified by the RestartAction property.

Retry Period On Failure

Specifies the interval of time (in milliseconds) that a resource should remain in a failed state before the Cluster service attempts to restart it.

Separate Monitor

Indicates whether the resource requires its own Resource Monitor.

Windows MSCS Resource Type Configuration

A resource type is a server cluster object used to characterize and manage resources sharing similar characteristics. A resource type is implemented and manages all the resources of that type in the cluster. Types of resources include: DHCP Service, Distributed Transaction Coordinator, File Share, Generic Application, Generic Service, IP Address, Message Queuing, Network Name, Physical Disk, Print Spooler, and WINS Service.

Metric

Description

Resource Type Name

Name of resource type.

Characteristics

Characteristics of the resource type. This metric has one of the following values:

  • CLUS_CHAR_UNKNOWN. These resources have no known characteristics.
  • CLUS_CHAR_QUORUM. These resources can be the quorum resource type for a cluster.
  • CLUS_CHAR_DELETE_REQUIRES_ALL_NODES. These resources cannot be deleted unless all nodes are active.

Possible Owner Nodes

List of possible owners of the resource.

Administrator Extensions

Provides the class identifiers (CLSIDs) for the Cluster Administrator extension DLLs that are associated with the resource type.

Description

Comments about the resource type.

Debug Control Functions

Indicates whether the Cluster service should create a separate Resource Monitor to use for debugging the control functions of a resource type.

Debug Prefix

The path to a debugger that is used to debug all resources of the type that are running in the Resource Monitor for the resource type.

Dll Name

The name of the dynamic-link library (DLL) for the resource type.

Is Alive Poll Interval

The recommended interval in milliseconds at which a Resource Monitor should poll resources of the particular resource type to determine if they are operational. The polling occurs when the Resource Monitor calls a resource DLL's IsAlive entry point function.

Looks Alive Poll Interval

The recommended interval in milliseconds at which the Cluster service should poll resources of the particular resource type to determine if they appear operational. The polling occurs when the Resource Monitor calls a resource DLL's LooksAlive entry point function.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*