9 Index

A

Abstract data model

   client

      notification ports (section 3.2.1.1, section 3.2.1.1.1)

      overview

   server

      access granted - client

      cluster

         network interfaces

         networks

         node volume accessibility

         registry

         security descriptor

      nodes

      notification ports

      object properties

      overview

      quorum

      resource types

ApiAddNotifyCluster method (section 3.1.4.1.58, section 3.1.4.2.58)

ApiAddNotifyGroup method (section 3.1.4.1.60, section 3.1.4.2.60)

ApiAddNotifyKey method (section 3.1.4.1.62, section 3.1.4.2.62)

ApiAddNotifyNetInterface method (section 3.1.4.1.99, section 3.1.4.2.99)

ApiAddNotifyNetwork method (section 3.1.4.1.90, section 3.1.4.2.90)

ApiAddNotifyNode method (section 3.1.4.1.59, section 3.1.4.2.59)

ApiAddNotifyResource method (section 3.1.4.1.61, section 3.1.4.2.61)

ApiAddNotifyV2 method

ApiAddResourceDependency method (section 3.1.4.1.20, section 3.1.4.2.20)

ApiAddResourceNode method (section 3.1.4.1.24, section 3.1.4.2.24)

ApiBackupClusterDatabase method (section 3.1.4.1.104, section 3.1.4.2.104)

ApiCancelClusterGroupOperation method

ApiCanResourceBeDependent method (section 3.1.4.1.22, section 3.1.4.2.22)

ApiChangeCsvState method

ApiChangeResourceGroup method (section 3.1.4.1.26, section 3.1.4.2.26)

ApiCloseBatchPort method

ApiCloseCluster method (section 3.1.4.1.2, section 3.1.4.2.2)

ApiCloseGroup method (section 3.1.4.1.45, section 3.1.4.2.45)

ApiCloseKey method (section 3.1.4.1.38, section 3.1.4.2.38)

ApiCloseNetInterface method (section 3.1.4.1.93, section 3.1.4.2.93)

ApiCloseNetwork method (section 3.1.4.1.82, section 3.1.4.2.82)

ApiCloseNode method (section 3.1.4.1.68, section 3.1.4.2.68)

ApiCloseNotify method (section 3.1.4.1.57, section 3.1.4.2.57)

ApiCloseResource method (section 3.1.4.1.12, section 3.1.4.2.12)

ApiClusterControl method (section 3.1.4.1.106, section 3.1.4.2.106)

ApiCreateBatchPort method

ApiCreateEnum method (section 3.1.4.1.8, section 3.1.4.2.8)

ApiCreateEnumEx method

ApiCreateGroup method (section 3.1.4.1.43, section 3.1.4.2.43)

ApiCreateGroupEnum method

ApiCreateGroupEx method

ApiCreateGroupResourceEnum method (section 3.1.4.1.54, section 3.1.4.2.54)

ApiCreateKey method (section 3.1.4.1.30, section 3.1.4.2.30)

ApiCreateNetworkEnum method (section 3.1.4.1.85, section 3.1.4.2.85)

ApiCreateNodeEnum method (section 3.1.4.1.101, section 3.1.4.2.101)

ApiCreateNodeEnumEx method

ApiCreateNotify method (section 3.1.4.1.56, section 3.1.4.2.56)

ApiCreateNotifyV2 method

ApiCreateResEnum method (section 3.1.4.1.23, section 3.1.4.2.23)

ApiCreateResource method (section 3.1.4.1.10, section 3.1.4.2.10)

ApiCreateResourceEnum method

ApiCreateResourceType method (section 3.1.4.1.27, section 3.1.4.2.27)

ApiCreateResTypeEnum method (section 3.1.4.1.103, section 3.1.4.2.103)

ApiDeleteGroup method (section 3.1.4.1.44, section 3.1.4.2.44)

ApiDeleteKey method (section 3.1.4.1.36, section 3.1.4.2.36)

ApiDeleteResource method (section 3.1.4.1.11, section 3.1.4.2.11)

ApiDeleteResourceType method (section 3.1.4.1.28, section 3.1.4.2.28)

ApiDeleteValue method (section 3.1.4.1.34, section 3.1.4.2.34)

ApiEnumKey method (section 3.1.4.1.32, section 3.1.4.2.32)

ApiEnumValue method (section 3.1.4.1.37, section 3.1.4.2.37)

ApiEvictNode method (section 3.1.4.1.72, section 3.1.4.2.72)

ApiExecuteBatch method

ApiExecuteReadBatch method (section 3.1.4.2.141, section 3.1.4.2.145)

ApiFailResource method (section 3.1.4.1.17, section 3.1.4.2.17)

ApiGetBatchNotification method

ApiGetClusterName method (section 3.1.4.1.4, section 3.1.4.2.4)

ApiGetClusterVersion method (section 3.1.4.1.5, section 3.1.4.2.5)

ApiGetClusterVersion2 method (section 3.1.4.1.102, section 3.1.4.2.102)

ApiGetGroupId method (section 3.1.4.1.48, section 3.1.4.2.48)

ApiGetGroupState method (section 3.1.4.1.46, section 3.1.4.2.46)

ApiGetKeySecurity method (section 3.1.4.1.41, section 3.1.4.2.41)

ApiGetNetInterface method (section 3.1.4.1.95, section 3.1.4.2.95)

ApiGetNetInterfaceId method (section 3.1.4.1.96, section 3.1.4.2.96)

ApiGetNetInterfaceState method (section 3.1.4.1.94, section 3.1.4.2.94)

ApiGetNetworkId method (section 3.1.4.1.86, section 3.1.4.2.86)

ApiGetNetworkState method (section 3.1.4.1.83, section 3.1.4.2.83)

ApiGetNodeId method (section 3.1.4.1.49, section 3.1.4.2.49)

ApiGetNodeState method (section 3.1.4.1.69, section 3.1.4.2.69)

ApiGetNotify method (section 3.1.4.1.66, section 3.1.4.2.66)

ApiGetNotifyAsync method

ApiGetNotifyV2 method

ApiGetQuorumResource method (section 3.1.4.1.6, section 3.1.4.2.6)

ApiGetResourceDependencyExpression method

ApiGetResourceId method (section 3.1.4.1.15, section 3.1.4.2.15)

ApiGetResourceNetworkName method

ApiGetResourceState method (section 3.1.4.1.13, section 3.1.4.2.13)

ApiGetResourceType method (section 3.1.4.1.16, section 3.1.4.2.16)

ApiGetRootKey method (section 3.1.4.1.29, section 3.1.4.2.29)

ApiGroupControl method (section 3.1.4.1.78, section 3.1.4.2.78)

ApiMoveGroup method (section 3.1.4.1.52, section 3.1.4.2.52)

ApiMoveGroupEx method

ApiMoveGroupToNode method (section 3.1.4.1.53, section 3.1.4.2.53)

ApiMoveGroupToNodeEx method

ApiNetInterfaceControl method (section 3.1.4.1.98, section 3.1.4.2.98)

ApiNetworkControl method (section 3.1.4.1.89, section 3.1.4.2.89)

ApiNodeClusterControl method (section 3.1.4.1.105, section 3.1.4.2.105)

ApiNodeControl method (section 3.1.4.1.80, section 3.1.4.2.80)

ApiNodeGroupControl method (section 3.1.4.1.77, section 3.1.4.2.77)

ApiNodeNetInterfaceControl method (section 3.1.4.1.97, section 3.1.4.2.97)

ApiNodeNetworkControl method (section 3.1.4.1.88, section 3.1.4.2.88)

ApiNodeNodeControl method (section 3.1.4.1.79, section 3.1.4.2.79)

ApiNodeResourceControl method (section 3.1.4.1.73, section 3.1.4.2.73)

ApiNodeResourceTypeControl method (section 3.1.4.1.75, section 3.1.4.2.75)

ApiOfflineGroup method (section 3.1.4.1.51, section 3.1.4.2.51)

ApiOfflineGroupEx method

ApiOfflineResource method (section 3.1.4.1.19, section 3.1.4.2.19)

ApiOfflineResourceEx method

ApiOnlineGroup method (section 3.1.4.1.50, section 3.1.4.2.50)

ApiOnlineGroupEx method

ApiOnlineResource method (section 3.1.4.1.18, section 3.1.4.2.18)

ApiOnlineResourceEx method

ApiOpenCluster method (section 3.1.4.1.1, section 3.1.4.2.1)

ApiOpenClusterEx method

ApiOpenGroup method (section 3.1.4.1.42, section 3.1.4.2.42)

ApiOpenGroupEx method

ApiOpenKey method (section 3.1.4.1.31, section 3.1.4.2.31)

ApiOpenNetInterface method (section 3.1.4.1.92, section 3.1.4.2.92)

ApiOpenNetInterfaceEx method

ApiOpenNetwork method (section 3.1.4.1.81, section 3.1.4.2.81)

ApiOpenNetworkEx method

ApiOpenNode method (section 3.1.4.1.67, section 3.1.4.2.67)

ApiOpenNodeEx method

ApiOpenResource method (section 3.1.4.1.9, section 3.1.4.2.9)

ApiOpenResourceEx method

ApiPauseNode method (section 3.1.4.1.70, section 3.1.4.2.70)

ApiPauseNodeEx method

ApiPauseNodeWithDrainTarget method

ApiQueryInfoKey method (section 3.1.4.1.39, section 3.1.4.2.39)

ApiQueryValue method (section 3.1.4.1.35, section 3.1.4.2.35)

ApiReAddNotifyGroup method (section 3.1.4.1.64, section 3.1.4.2.64)

ApiReAddNotifyNetInterface method (section 3.1.4.1.100, section 3.1.4.2.100)

ApiReAddNotifyNetwork method (section 3.1.4.1.91, section 3.1.4.2.91)

ApiReAddNotifyNode method (section 3.1.4.1.63, section 3.1.4.2.63)

ApiReAddNotifyResource method (section 3.1.4.1.65, section 3.1.4.2.65)

ApiRemoveResourceDependency method (section 3.1.4.1.21, section 3.1.4.2.21)

ApiRemoveResourceNode method (section 3.1.4.1.25, section 3.1.4.2.25)

ApiResourceControl method (section 3.1.4.1.74, section 3.1.4.2.74)

ApiResourceTypeControl method (section 3.1.4.1.76, section 3.1.4.2.76)

ApiRestartResource method

ApiResumeNode method (section 3.1.4.1.71, section 3.1.4.2.71, section 3.1.4.2.127)

ApiSetClusterName method (section 3.1.4.1.3, section 3.1.4.2.3)

ApiSetGroupName method (section 3.1.4.1.47, section 3.1.4.2.47)

ApiSetGroupNodeList method (section 3.1.4.1.55, section 3.1.4.2.55)

ApiSetKeySecurity method (section 3.1.4.1.40, section 3.1.4.2.40)

ApiSetNetworkName method (section 3.1.4.1.84, section 3.1.4.2.84)

ApiSetNetworkPriorityOrder method (section 3.1.4.1.87, section 3.1.4.2.87)

ApiSetQuorumResource method (section 3.1.4.1.7, section 3.1.4.2.7)

ApiSetResourceDependencyExpression method

ApiSetResourceName method (section 3.1.4.1.14, section 3.1.4.2.14)

ApiSetServiceAccountPassword method (section 3.1.4.1.108, section 3.1.4.2.108)

ApiSetValue method (section 3.1.4.1.33, section 3.1.4.2.33)

ApiUnblockGetNotifyCall method (section 3.1.4.1.107, section 3.1.4.2.107)

Applicability

B

BATCH_UPDATE_COMMAND packet

C

Capability negotiation

Change tracking

Client

   abstract data model

      notification ports (section 3.2.1.1, section 3.2.1.1.1)

      overview

   Closing a Context Handle method

   Cluster Nodes - Cluster Networks - and Cluster Network Interfaces method

   Cluster Registry method

   Cluster Resources and Groups method

   Determining Cluster Node Configuration and State method

   initialization

      overview

      prerequisites

      reconnect logic

      RPC connection

   local events

   message processing

      cluster

         groups

         network interfaces

         networks

         node configuration

         node state

         nodes

         registry

         resources

      context handle - closing

      notification port event queue - reading

      notification ports

      overview

      reconnect procedure

   Notification Ports method

   overview

   Reconnect Procedure method

   sequencing rules

      cluster

         groups

         network interfaces

         networks

         node configuration

         node state

         nodes

         registry

         resources

      context handle - closing

      notification port event queue - reading

      notification ports

      overview

      reconnect procedure

   timer events

   timers

Closing a Context Handle method

CLUS_CHARACTERISTICS enumeration

CLUS_CSV_MAINTENANCE_MODE_INFO packet

CLUS_CSV_VOLUME_INFO packet

CLUS_FLAGS enumeration

CLUS_MAINTENANCE_MODE_INFO packet

CLUS_MAINTENANCE_MODE_INFO_EX packet

CLUS_NETNAME_PWD_INFO packet

CLUS_PARTITION_INFO packet

CLUS_PARTITION_INFO_EX packet

CLUS_POOL_DRIVE_INFO packet

CLUS_RESOURCE_CLASS_INFO packet

CLUS_SCSI_ADDRESS packet

CLUS_SHARED_VOLUME_BACKUP_MODE packet

CLUS_STORAGE_REMAP_DRIVELETTER packet

CLUS_STORAGE_SET_DRIVELETTER packet

CLUSCTL_RESOURCE_NETNAME_CHECK_OU_PERMISSIONS_INPUT packet

CLUSCTL_RESOURCE_NETNAME_CHECK_OU_PERMISSIONS_OUTPUT packet

CLUSDSK_DISKID structure

CLUSDSK_DISKID_ENUM enumeration

Cluster Nodes - Cluster Networks - and Cluster Network Interfaces method

Cluster Registry method

Cluster Resources and Groups method

CLUSTER_CHANGE enumeration

CLUSTER_CHANGE_CLUSTER_V2 enumeration

CLUSTER_CHANGE_GROUP_V2 enumeration

CLUSTER_CHANGE_NETINTERFACE_V2 enumeration

CLUSTER_CHANGE_NETWORK_V2 enumeration

CLUSTER_CHANGE_NODE_V2 enumeration

CLUSTER_CHANGE_QUORUM_V2 enumeration

CLUSTER_CHANGE_REGISTRY_V2 enumeration

CLUSTER_CHANGE_RESOURCE_TYPE_V2 enumeration

CLUSTER_CHANGE_RESOURCE_V2 enumeration

CLUSTER_CHANGE_SHARED_VOLUME_V2 enumeration

CLUSTER_CREATE_GROUP_INFO_RPC structure

CLUSTER_OBJECT_TYPE enumeration

CLUSTER_OPERATIONAL_VERSION_INFO

CLUSTER_OPERATIONAL_VERSION_INFO structure

CLUSTER_PROPERTY_FORMAT enumeration

CLUSTER_PROPERTY_SYNTAX enumeration

CLUSTER_PROPERTY_TYPE enumeration

CLUSTER_QUORUM_VALUE enumeration

CLUSTER_REG_BATCH_COMMAND enumeration

CLUSTER_REG_BATCH_UPDATE packet

CLUSTER_SHARED_VOLUME_STATE_INFO packet

CLUSTER_SHARED_VOLUME_STATE_INFO_EX packet

Common data types

D

Data model - abstract

   client

      notification ports (section 3.2.1.1, section 3.2.1.1.1)

      overview

   server

      access granted - client

      cluster

         network interfaces

         networks

         node volume accessibility

         registry

         security descriptor

      nodes

      notification ports

      object properties

      overview

      quorum

      resource types

Data types

   common - overview

   HBATCH_PORT_RPC

   HCLUSTER_RPC

   HGENERIC_RPC

   HGROUP_RPC

   HKEY_RPC

   HNETINTERFACE_RPC

   HNETWORK_RPC

   HNODE_RPC

   HNOTIFY_RPC

   HRES_RPC

   overview

Determining Cluster Node Configuration and State method

E

ENUM_ENTRY structure

ENUM_LIST structure

Events

   local

      client

      server

   local - client

   local - server

   timer

      client

      server

         Arbitration

         GetNotify

         IsAlive

         LooksAlive

         overview

         Volume Backup

   timer - client

   timer - server

EXAMPLEENUM enumeration

Examples

   moving a group

   moving group example

   querying private properties of resource example

   querying the private properties of resources

   receiving cluster object event indications

   receiving cluster object event indications example

   setting a complex dependency for a resource

   setting a complex dependency for a resource example

F

Fields - vendor-extensible

Full IDL (section 6, section 6.1, section 6.2)

G

Glossary

GROUP_ENUM_ENTRY structure

GROUP_ENUM_LIST structure

H

HBATCH_PORT_RPC data type

HCLUSTER_RPC data type

HGENERIC_RPC data type

HGROUP_RPC data type

HKEY_RPC data type

HNETINTERFACE_RPC data type

HNETWORK_RPC data type

HNODE_RPC data type

HNOTIFY_RPC data type

HRES_RPC data type

I

IDL (section 6, section 6.1, section 6.2)

IDL_CLUSTER_SET_PASSWORD_FLAGS enumeration

IDL_CLUSTER_SET_PASSWORD_STATUS structure

Implementer - security considerations

Index of security parameters

Informative references

Initialization

   client

      overview

      prerequisites

      reconnect logic

      RPC connection

   server

      cluster registry keys

      ClusterInstallationState registry value

      overview

      service control manager

Introduction

L

Local events

   client

   server

M

Message processing

   client

      cluster

         groups

         network interfaces

         networks

         node configuration

         node state

         nodes

         registry

         resources

      context handle - closing

      notification port event queue - reading

      notification ports

      overview

      reconnect procedure

   server

      method control codes

      overview

      Protocol Version 2

      Protocol Version 3

Messages

   common data types

   data types

   HBATCH_PORT_RPC data type

   HCLUSTER_RPC data type

   HGENERIC_RPC data type

   HGROUP_RPC data type

   HKEY_RPC data type

   HNETINTERFACE_RPC data type

   HNETWORK_RPC data type

   HNODE_RPC data type

   HNOTIFY_RPC data type

   HRES_RPC data type

   transport

Method Control Codes method

Methods

   Closing a Context Handle

   Cluster Nodes - Cluster Networks - and Cluster Network Interfaces

   Cluster Registry

   Cluster Resources and Groups

   Determining Cluster Node Configuration and State

   Method Control Codes

   Notification Ports

   Protocol Version 2

   Protocol Version 3

   Reconnect Procedure

Moving a group example

Moving group example

N

Normative references

Notification Ports method

NOTIFICATION_DATA_ASYNC_RPC structure

NOTIFICATION_DATA_RPC structure

NOTIFICATION_RPC structure

NOTIFY_FILTER_AND_TYPE_RPC structure

O

Overview

Overview (synopsis)

P

Parameters - security index

PCLUSDSK_DISKID

PCLUSTER_CREATE_GROUP_INFO_RPC

PENUM_ENTRY

PENUM_LIST

PGROUP_ENUM_ENTRY

PGROUP_ENUM_LIST

PIDL_CLUSTER_SET_PASSWORD_STATUS

PNOTIFICATION_DATA_RPC

PNOTIFICATION_RPC

PNOTIFY_FILTER_AND_TYPE_RPC

Preconditions

Prerequisites

PRESOURCE_ENUM_ENTRY

PRESOURCE_ENUM_LIST

Product behavior

PROPERTY_LIST packet

PROPERTY_VALUE packet

Protocol Details

   overview

Protocol Version 2 method

Protocol Version 3 method

PRPC_SECURITY_ATTRIBUTES

PRPC_SECURITY_DESCRIPTOR

Q

Querying private properties of resource example

Querying the private properties of resources example

R

Receiving cluster object event indications example

Reconnect Procedure method

References

   informative

   normative

Relationship to other protocols

RESOURCE_ENUM_ENTRY structure

RESOURCE_ENUM_LIST structure

RPC_SECURITY_ATTRIBUTES structure

RPC_SECURITY_DESCRIPTOR structure

S

Security

   implementer considerations

   parameter index

Sequencing rules

   client

      cluster

         groups

         network interfaces

         networks

         node configuration

         node state

         nodes

         registry

         resources

      context handle - closing

      notification port event queue - reading

      notification ports

      overview

      reconnect procedure

   server

      method control codes

      overview

      Protocol Version 2

      Protocol Version 3

Server

   abstract data model

      access granted - client

      cluster

         network interfaces

         networks

         node volume accessibility

         registry

         security descriptor

      nodes

      notification ports

      object properties

      overview

      quorum

      resource types

   initialization

      cluster registry keys

      ClusterInstallationState registry value

      overview

      service control manager

   local events

   message processing

      method control codes

      overview

      Protocol Version 2

      Protocol Version 3

   Method Control Codes method

   Protocol Version 2 method

   Protocol Version 3 method

   sequencing rules

      method control codes

      overview

      Protocol Version 2

      Protocol Version 3

   timer events

      Arbitration

      GetNotify

      IsAlive

      LooksAlive

      overview

      Volume Backup

   timers

      Arbitration

      GetNotify

      IsAlive

      LooksAlive

      overview

      Volume Backup

Setting a complex dependency for a resource example

SR_RESOURCE_TYPE_ELIGIBLE_DISKS_RESULT packet

SR_RESOURCE_TYPE_QUERY_ELIGIBLE_LOGDISKS packet

SR_RESOURCE_TYPE_QUERY_ELIGIBLE_SOURCE_DATADISKS packet

SR_RESOURCE_TYPE_QUERY_ELIGIBLE_TARGET_DATADISKS packet

SR_RESOURCE_TYPE_REPLICATED_DISK

SR_RESOURCE_TYPE_REPLICATED_DISKS_RESULT packet

Standards assignments

T

Timer events

   client

   server

      Arbitration

      GetNotify

      IsAlive

      LooksAlive

      overview

      Volume Backup

Timers

   client

   server

      Arbitration

      GetNotify

      IsAlive

      LooksAlive

      overview

      Volume Backup

Tracking changes

Transport

V

Vendor-extensible fields

Versioning

Show: