External Resource Control Codes

The following lists all of the external control codes for resources.

In this section

CLUSCTL_CLOUD_WITNESS_RESOURCE_UPDATE_KEY

TBD.

CLUSCTL_CLOUD_WITNESS_RESOURCE_UPDATE_TOKEN

Updates the token used to validate a set of credentials for an Cloud Witness resource.

CLUSCTL_RESOURCE_ADD_CRYPTO_CHECKPOINT

Adds a cryptographic key container to the list of keys that are replicated for a resource. Applications use this control code as a ClusterResourceControl parameter.

CLUSCTL_RESOURCE_ADD_CRYPTO_CHECKPOINT_EX

TBD.

CLUSCTL_RESOURCE_ADD_REGISTRY_CHECKPOINT

Adds a registry tree to the list of registry trees that are replicated for a resource. Applications use this control code as a parameter in the ClusterResourceControl function.

CLUSCTL_RESOURCE_ADD_REGISTRY_CHECKPOINT_32BIT

Adds a registry tree using the 32-bit view of the registry to the list of registry trees that are replicated for a resource. Applications use this control code as a parameter in the ClusterResourceControl function.

CLUSCTL_RESOURCE_ADD_REGISTRY_CHECKPOINT_64BIT

Adds a registry tree using the 64-bit view of the registry to the list of registry trees that are replicated for a resource. Applications use this control code as a parameter in the ClusterResourceControl function.

CLUSCTL_RESOURCE_DELETE_CRYPTO_CHECKPOINT

Removes a cryptographic key container from the list of keys that are being replicated for a resource.

CLUSCTL_RESOURCE_DELETE_REGISTRY_CHECKPOINT

Removes a registry tree from the list of registry trees that are being replicated for a resource. Applications use this control code as a ClusterResourceControl parameter.

CLUSCTL_RESOURCE_DISABLE_SHARED_VOLUME_DIRECTIO

Disables higher performance I/O on the cluster shared volume.

CLUSCTL_RESOURCE_ENABLE_SHARED_VOLUME_DIRECTIO

Enables higher performance I/O on the cluster shared volume.

CLUSCTL_RESOURCE_ENUM_COMMON_PROPERTIES

Retrieves a list of the read/write resource common property names.

CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES

Retrieves a list of the read/write private and read-only resource properties.

CLUSCTL_RESOURCE_FILESERVER_SHARE_ADD

Creates a new file share on a physical disk resource.

CLUSCTL_RESOURCE_FILESERVER_SHARE_DEL

Deletes a file share on a physical disk resource.

CLUSCTL_RESOURCE_FILESERVER_SHARE_MODIFY

Modifies an existing file share on a physical disk resource.

CLUSCTL_RESOURCE_FILESERVER_SHARE_REPORT

Retrieves the add/delete/change notifications for file shares managed by the File Server resource.

CLUSCTL_RESOURCE_GET_CHARACTERISTICS

Retrieves the intrinsic characteristics of a resource.

CLUSCTL_RESOURCE_GET_CLASS_INFO

Retrieves the class and subclass of a resource.

CLUSCTL_RESOURCE_GET_COMMON_PROPERTIES

Retrieves the read/write common properties for a resource. Applications use this control code as a ClusterResourceControl parameter, and resource DLLs receive the control code as a ResourceControl parameter.

CLUSCTL_RESOURCE_GET_COMMON_PROPERTY_FMTS

Retrieves a property list describing the format of each resource common property.

CLUSCTL_RESOURCE_GET_CRYPTO_CHECKPOINTS

Retrieves a list of all the cryptographic key checkpoints set for a resource.

CLUSCTL_RESOURCE_GET_DNS_NAME

Retrieves the DNS name of the designated resource.

CLUSCTL_RESOURCE_GET_FAILURE_INFO

Retrieves information about a resource failure. Applications use this control code as a parameter to the ClusterResourceControl function.

CLUSCTL_RESOURCE_GET_FLAGS

Retrieves the flags that are set for a resource.

CLUSCTL_RESOURCE_GET_ID

Retrieves the cluster database subkey identifier for a resource.

CLUSCTL_RESOURCE_GET_LOADBAL_PROCESS_LIST

Retrieves the load balancing processor list.

CLUSCTL_RESOURCE_GET_NAME

Retrieves the name of a resource.

CLUSCTL_RESOURCE_GET_NETWORK_NAME

Retrieves the name private property of a Network Name resource. This control code is unsupported by the other default resource types. Applications can use this control code as a parameter to the ClusterResourceControl function.

CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTIES

Retrieves the read/write private properties for a resource. Applications use this control code as a ClusterResourceControl parameter, and resource DLLs receive the control code as a ResourceControl parameter.

CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTY_FMTS

Retrieves a property list describing the format of each resource private property.

CLUSCTL_RESOURCE_GET_REGISTRY_CHECKPOINTS

Retrieves a list of all the registry checkpoints set for a resource. Applications use this control code as a ClusterResourceControl parameter.

CLUSCTL_RESOURCE_GET_REQUIRED_DEPENDENCIES

Retrieves a list of all required dependencies for a resource.

CLUSCTL_RESOURCE_GET_RESOURCE_TYPE

Retrieves the resource type name for a resource.

CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES

Retrieves the read-only common properties for a resource.

CLUSCTL_RESOURCE_GET_RO_PRIVATE_PROPERTIES

Retrieves the read-only private properties for a resource.

CLUSCTL_RESOURCE_GET_STATE_CHANGE_TIME

Retrieves the time of last state change for a resource.

CLUSCTL_RESOURCE_IPADDRESS_RELEASE_LEASE

Releases the DHCP based lease of an IP address associated with a designated resource.

CLUSCTL_RESOURCE_IPADDRESS_RENEW_LEASE

Renews the DHCP based lease of an IP address associated with a designated resource.

CLUSCTL_RESOURCE_IS_QUORUM_BLOCKED

Prevents a resource from being designated as the quorum resource.

CLUSCTL_RESOURCE_NETNAME_CREDS_UPDATED

Notifies the resource that the credentials for the domain account associated with the resource has changed.. Applications use this control code as a parameter to the ClusterResourceControl function.

Note

The CLUSCTL_RESOURCE_NETNAME_CREDS_UPDATED control code is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.

 

CLUSCTL_RESOURCE_NETNAME_DELETE_CO

Deletes the security principal associated with a designated resource. Applications use this control code as a parameter to the ClusterResourceControl function.

CLUSCTL_RESOURCE_NETNAME_GET_VIRTUAL_SERVER_TOKEN

Used by custom resources, services, and applications to get a token in the Network Name's logon session.

CLUSCTL_RESOURCE_NETNAME_REGISTER_DNS_RECORDS

Instructs the designated resource to re-register its DNS Host records with the DNS server associated with the designated node.

CLUSCTL_RESOURCE_NETNAME_REPAIR_VCO

Repairs the password for a security principal on a client based on the client's alternate computer name.

CLUSCTL_RESOURCE_NETNAME_RESET_VCO

Resets the password for a security principal on a client based on the client's alternate computer name.

Applications use this control code as a parameter to the ClusterResourceControl function.

CLUSCTL_RESOURCE_NETNAME_SET_PWD_INFO

Updates information about the security principal associated with a designated resource.

CLUSCTL_RESOURCE_NETNAME_VALIDATE_VCO

Confirms whether the security principal of the designated resource can be managed by the cluster.

CLUSCTL_RESOURCE_POOL_GET_DRIVE_INFO

Retrieves drive information for a storage pool.

CLUSCTL_RESOURCE_QUERY_DELETE

The CLUSCTL_RESOURCE_QUERY_DELETE control code is reserved for future use.

CLUSCTL_RESOURCE_QUERY_MAINTENANCE_MODE

Queries the maintenance mode state of the specified disk resource.

CLUSCTL_RESOURCE_RLUA_GET_VIRTUAL_SERVER_TOKEN

TBD.

CLUSCTL_RESOURCE_RLUA_SET_PWD_INFO

TBD.

CLUSCTL_RESOURCE_SET_COMMON_PROPERTIES

Updates the read/write common properties for a resource.

CLUSCTL_RESOURCE_SET_CSV_MAINTENANCE_MODE

Enables or disables maintenance mode for the specified cluster shared volume

CLUSCTL_RESOURCE_SET_MAINTENANCE_MODE

Enables or disables maintenance mode for the specified disk resource.

CLUSCTL_RESOURCE_SET_PRIVATE_PROPERTIES

Updates the read/write private properties for a resource.

CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE

Sets the backup mode for a CSV

CLUSCTL_RESOURCE_STORAGE_CLUSTER_DISK

TBD. Applications use this control code as a parameter to the ClusterResourceControl function.

Note

The CLUSCTL_RESOURCE_STORAGE_CLUSTER_DISK control code is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.

 

CLUSCTL_RESOURCE_STORAGE_GET_DIRTY

Retrieves a list of dirty volumes on the disk resource.

CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO

Retrieves information about a particular storage class resource.

CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX

Retrieves information about a particular storage class resource.

CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO_EX2

Retrieves extended information about a storage class resource.

CLUSCTL_RESOURCE_STORAGE_GET_DISK_NUMBER_INFO

Retrieves the disk number of a physical disk resource in a cluster.

CLUSCTL_RESOURCE_STORAGE_GET_DISKID

Retrieves the disk ID for a storage class resource.

CLUSCTL_RESOURCE_STORAGE_GET_MOUNTPOINTS

Retrieves a list of path names for the specified partition.

CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_INFO

Retrieves information on the specified shared volume. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.

CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_PARTITION_NAMES

Retrieves partition names for a Cluster Shared Volume (CSV).

CLUSCTL_RESOURCE_STORAGE_GET_SHARED_VOLUME_STATES

Retrieves the status of a Cluster Shared Volume (CSV).

CLUSCTL_RESOURCE_STORAGE_IS_PATH_VALID

Verifies that a specified path exists on a storage class resource.

CLUSCTL_RESOURCE_STORAGE_IS_SHARED_VOLUME

Verifies that a storage class resource is a Cluster Shared Volume (CSV).

CLUSCTL_RESOURCE_STORAGE_SET_DRIVELETTER

Modifies the drive letter associated with the designated storage-class resource.

CLUSCTL_RESOURCE_UNKNOWN

verifies that control codes are being processed on the node where execution of the control is directed.

CLUSCTL_RESOURCE_UPGRADE_DLL

Allows a setup application to upgrade a resource DLL without stopping the Cluster service. Applications use this control code as a ClusterResourceControl parameter.

CLUSCTL_RESOURCE_VALIDATE_COMMON_PROPERTIES

Verifies that a property list contains valid resource common property names and values and that the list is properly formatted.

CLUSCTL_RESOURCE_VALIDATE_PRIVATE_PROPERTIES

Verifies that a property list contains valid resource private property names and values and that the list is properly formatted.

CLUSCTL_RESOURCE_VM_CANCEL_MIGRATION

cancels an ongoing Live Migration of a VM

CLUSCTL_RESOURCE_VM_CONFIG_UPDATE

updates the VmSwitchPorts and VmPhysicalDisks properties of the Virtual Machine configuration resource instances.

CLUSCTL_RESOURCE_VM_SET_NEXT_OFFLINE_ACTION

Specifies the offline action for the next Offline operation on the virtual machine (VM) resource instance. This can be used to temporarily change the value of the OfflineAction property without the overhead of modifying and restoring the resource property. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.

CLUSCTL_RESOURCE_VM_START_MIGRATION

initiates the live migration of a VM from one node of a cluster to another node of the cluster

Resource Control Codes

ClusterResourceControl

ResourceControl