Failover Cluster Management Functions

The failover cluster management functions manage cluster objects.

In this section

CloseCluster

Closes a cluster handle.

CloseClusterNotifyPort

Closes a notification port established through CreateClusterNotifyPort.

ClusterCloseEnum

Closes a cluster enumeration handle originally opened by ClusterOpenEnum.

ClusterCloseEnumEx

Closes a handle to an enumeration that was opened by the ClusterOpenEnumEx function.

ClusterEnum

Enumerates the cluster objects in a cluster, returning the name of one object with each call.

ClusterEnumEx

Enumerates the objects in a cluster, and then gets the name and properties of the cluster object.

ClusterGetEnumCount

Returns the number of cluster objects associated with a cluster enumeration handle.

ClusterGetEnumCountEx

Returns the number of cluster objects that are associated with a cluster enumeration handle.

ClusterOpenEnum

Opens an enumerator for iterating through cluster objects in a cluster.

ClusterOpenEnumEx

Opens a handle to a cluster in order to iterate through its objects.

ClusterSetupProgressCallback

Callback function that receives regular updates on the progression of the setup of the cluster.

ClusterUpgradeFunctionalLevel

Initiates a rolling upgrade of the operating system on a cluster. PCLUSAPI_CLUSTER_UPGRADE defines a pointer to this function.

ClusterUpgradeProgressCallback

Retrieves status information for a rolling upgrade of the operating system on a cluster. PCLUSTER_UPGRADE_PROGRESS_CALLBACK type defines a pointer to this function.

CreateCluster

Creates and starts a cluster.

CreateClusterCNOless

Creates a cluster without cluster name and IP Address resources. The allows you to create clusters that are ___domain joined but not managed by Active Directory, and clusters that are not members of a ___domain. PCLUSAPI_CREATE_CLUSTER_CNOLESS defines a pointer to this function.

CreateClusterNameAccount

Creates a cluster name resource and then uses it add a cluster to a ___domain, even if the machines that host the cluster aren't members of the ___domain.

CreateClusterNotifyPort

Creates or modifies a notification port. For information on notification ports, see Receiving Cluster Events.

CreateClusterNotifyPortV2

Creates or modifies a notification port. For information about notification ports, see Receiving Cluster Events.

DestroyCluster

Removes a cluster.

GetClusterInformation

Retrieves a cluster's name and version.

GetClusterNotify

information relating to the next notification event that is stored for a notification port.

GetClusterNotifyV2

Retrieves information about the next notification event for a notification port.

GetClusterQuorumResource

Returns the name of a cluster's quorum resource.

GetNotifyEventHandle

Retrieves a handle to a notification event.

OpenCluster

Opens a connection to a cluster and returns a handle to it.

OpenClusterEx

Opens a connection to a cluster and returns a handle to it.

RegisterClusterNotify

Adds an event type to the list of events stored for a notification port.

RegisterClusterNotifyV2

Registers an event type with a notification port by adding the notification key to the event type.

SetClusterName

Sets the name for a cluster.

SetClusterQuorumResource

Establishes a resource as the quorum resource for a cluster.

SetClusterServiceAccountPassword

Changes the password for the Cluster service user account on all available cluster nodes.

Failover Cluster Object Management Functions