Share via


Failover Cluster Enumerations

This section contains the enumerations of the Failover Cluster API.

In this section

CLCTL_CODES

enumerates the possible operations that a control code will perform.

CLUS_CHARACTERISTICS

Enumerates characteristics of resource types and resources.

CLUS_FLAGS

Identifies the resource or group as a core resource.

CLUS_GROUP_START_SETTING

Enumerates the start settings for a cluster group.

CLUS_RESSUBCLASS

Identifies a resource subclass that manages a shared resource.

CLUS_RESSUBCLASS_NETWORK

Identifies a resource subclass that manages an IP address provider.

CLUS_RESSUBCLASS_STORAGE

Identifies a resource subclass that manages a shared bus.

CLUSCTL_CLUSTER_CODES

Enumerates cluster control codes used by the ClusterControl function.

CLUSCTL_GROUP_CODES

Enumerates groupcontrol codes.

CLUSCTL_GROUPSET_CODES

Enumerates groupset control codes used by the ClusterGroupSetControl function.

CLUSCTL_NETINTERFACE_CODES

Enumerates Network Interface control codes.

CLUSCTL_NETWORK_CODES

Enumerates network control codes.

CLUSCTL_NODE_CODES

Enumerates node control codes.

CLUSCTL_RESOURCE_CODES

Enumerates resource control codes.

CLUSCTL_RESOURCE_TYPE_CODES

Enumerates resource type control codes.

CLUSGROUP_TYPE

Specifies the type of cluster group to create.

CLUSPROP_IPADDR_ENABLENETBIOS

When used with the CLUSPROP_DWORD structure, enables or disables the functionality of the EnableNetBIOS property of IP Address resources.

CLUSPROP_PIFLAGS

Represents disk partition information. The enumeration flags identify certain properties of a disk partition, which is a storage class resource.

CLUSTER_CHANGE

Describes the type of notification returned.

CLUSTER_CHANGE_CLUSTER_V2

Defines the list of notifications that are generated for a cluster.

CLUSTER_CHANGE_GROUP_V2

Defines the list of notifications that are generated for a group.

CLUSTER_CHANGE_GROUPSET_V2

Defines the list of notifications that are generated for a groupset.

CLUSTER_CHANGE_NETINTERFACE_V2

Defines the set of notifications that are generated for a cluster network interface.

CLUSTER_CHANGE_NETWORK_V2

Defines the notifications that are generated for a cluster network.

CLUSTER_CHANGE_NODE_UPGRADE_PHASE_V2

Defines the notifications that are generated for the upgrade of a cluster node.

CLUSTER_CHANGE_NODE_V2

Defines the notifications that are generated for a cluster node.

CLUSTER_CHANGE_QUORUM_V2

Defines the notifications that are generated for quorum-specific information.

CLUSTER_CHANGE_REGISTRY_V2

Defines the notifications that are generated for a registry key.

CLUSTER_CHANGE_RESOURCE_TYPE_V2

Defines the set of notifications that are generated for a resource type.

CLUSTER_CHANGE_RESOURCE_V2

Defines the list of notifications that are generated for a resource.

CLUSTER_CHANGE_SHARED_VOLUME_V2

Defines the notifications that are generated for a cluster shared volume.

CLUSTER_CHANGE_SPACEPORT_V2

TBD

CLUSTER_CONTROL_OBJECT

The 8-bit object component of a control code that indicates the type of cluster object to which the control code applies. For more information, see Control Code Architecture.

CLUSTER_CSV_VOLUME_FAULT_STATE

Defines the various fault states for a cluster shared volume (CSV).

CLUSTER_ENUM

Describes the type of cluster objects being enumerated.

CLUSTER_GROUP_AUTOFAILBACK_TYPE

Used by the AutoFailbackType group common property to specify whether the group should be failed back to the node identified as its preferred owner when that node comes back online following a failover.

CLUSTER_GROUP_ENUM

Describes the type of cluster object being enumerated by the ClusterGroupEnum and ClusterGroupOpenEnum functions.

CLUSTER_GROUP_PRIORITY

Specifies the priority level of a group.

CLUSTER_GROUP_STATE

Enumerates the possible states of a group.

CLUSTER_MGMT_POINT_TYPE

Specifies the type of the management point for the cluster.

CLUSTER_NETINTERFACE_STATE

Enumerates the possible values of the state of a network interface.

CLUSTER_NETWORK_ENUM

Describes the type of cluster object being enumerated by the ClusterNetworkEnum and ClusterNetworkOpenEnum functions.

CLUSTER_NETWORK_ROLE

Describes the role a network plays in the cluster.

CLUSTER_NETWORK_STATE

Enumerates the possible values of the state of a network.

CLUSTER_NODE_DRAIN_STATUS

Enumerates the possible values of the status of a node drain.

CLUSTER_NODE_ENUM

Describes the types of cluster objects that are enumerated by the ClusterNodeEnum and ClusterNodeOpenEnum functions.

CLUSTER_NODE_RESUME_FAILBACK_TYPE

Specifies the failback type to use when a cluster node in a paused state is resumed by the ResumeClusterNodeEx function.

CLUSTER_NODE_STATE

Describes the state of a cluster node.

CLUSTER_NODE_STATUS

Describes the status of a cluster node.

CLUSTER_NOTIFICATIONS_VERSION

Defines the various versions of cluster notification enumerations.

CLUSTER_OBJECT_TYPE

Defines the type of object for which a notification is requested or generated.

CLUSTER_PROPERTY_FORMAT

Specifies the data type of a property value in a property list.

CLUSTER_PROPERTY_SYNTAX

Provides the possible values for the syntax structures in a property list.

CLUSTER_PROPERTY_TYPE

defines the property types that are supported by a cluster property list.

CLUSTER_QUORUM_TYPE

The type of quorum resource to be created.

CLUSTER_QUORUM_VALUE

Enumerates values returned by the ClusterControl function with the CLUSCTL_CLUSTER_CHECK_VOTER_DOWN or the CLUSCTL_CLUSTER_CHECK_VOTER_EVICT control codes.

CLUSTER_REG_COMMAND

Enumerates the possible cluster registry commands that a local node will perform when attempting to join a cluster.

CLUSTER_RESOURCE_APPLICATION_STATE

Enumerates resource application states.

CLUSTER_RESOURCE_CLASS

Defines the class of a resource.

CLUSTER_RESOURCE_CREATE_FLAGS

Determines which resource monitor a given resource will be assigned to.

CLUSTER_RESOURCE_EMBEDDED_FAILURE_ACTION

Specifies the various actions that can be performed when a resource has an embedded failure.

CLUSTER_RESOURCE_ENUM

Describes the type of cluster object being enumerated by the ClusterResourceEnum or ClusterResourceOpenEnum functions.

CLUSTER_RESOURCE_RESTART_ACTION

Used by the RestartAction resource common property to specify the action to be taken by the cluster service if the resource fails.

CLUSTER_RESOURCE_STATE

Describes the operational condition of a resource.

CLUSTER_RESOURCE_STATE_CHANGE_REASON

Used by the CLUSCTL_RESOURCE_STATE_CHANGE_REASON_STRUCT and CLUSCTL_RESOURCE_STATE_CHANGE_REASON control codes to describe the reason for a resource state change.

CLUSTER_RESOURCE_TYPE_ENUM

Describes the type of cluster object being enumerated by the ClusterResourceTypeEnum and ClusterResourceTypeOpenEnum functions.

CLUSTER_ROLE

Contains the names of the standard cluster roles.

CLUSTER_ROLE_STATE

Defines the potential return values for the ResUtilGetClusterRoleState function.

CLUSTER_SET_PASSWORD_FLAGS

Enumerates flags for the SetClusterServiceAccountPassword function that describe how the password update is to be applied to the cluster.

CLUSTER_SETUP_PHASE

Used by the ClusterSetupProgressCallback function to identify the current phase of the cluster setup process.

CLUSTER_SETUP_PHASE_SEVERITY

Describes the severity of the current phase of the cluster setup process.

CLUSTER_SETUP_PHASE_TYPE

Describes the progress of the cluster setup process.

CLUSTER_SHARED_VOLUME_BACKUP_STATE

Describes the CSV backup state

CLUSTER_SHARED_VOLUME_SNAPSHOT_STATE

Specifies the various snapshot states for a shared volume.

CLUSTER_SHARED_VOLUME_STATE

Defines the states of a cluster shared volume.

CLUSTER_UPGRADE_PHASE

Describes the state of a rolling upgrade of the operating system on a cluster. This enumeration is used by the ClusterUpgradeProgressCallback callback function.

FAILURE_TYPE

Defines the failure types for cluster resources.

FILESHARE_CHANGE_ENUM

Contains the possible change events that are used by the FILESHARE_CHANGE structure to describe an entry in a file share event notification list.

LOG_LEVEL

Represents the severity of the log event passed to the LogEvent callback function.

MAINTENANCE_MODE_TYPE_ENUM

Defines the possible states that a storage class resource can be placed in when marked for maintenance.

NODE_CLUSTER_STATE

Indicates the state of the cluster.

PLACEMENT_OPTIONS

Defines options for placing the cluster.

RESDLL_CONTEXT_OPERATION_TYPE

Specifies the various types of context operations for the GET_OPERATION_CONTEXT_PARAMS structure.

RESOURCE_EXIT_STATE

Enumerates the possible exit states of a resource.

RESOURCE_MONITOR_STATE

TBD

SR_DISK_REPLICATION_ELIGIBLE

Specifies the various reasons a disk on a cluster node can be eligible or ineligible for replication.

SR_REPLICATED_DISK_TYPE

Specifies the replicated disk types for the SR_RESOURCE_TYPE_REPLICATED_DISK structure.

VM_RESDLL_CONTEXT

Contains actions for a virtual machine to perform.

Failover Cluster API Reference