3.1.4.3.1.54 CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE
The CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE resource control code changes the backup mode of the designated cluster shared volume.
ClusAPI Protocol version 2.0 servers fail this method by using error code ERROR_INVALID_FUNCTION (0x00000001).
ClusAPI Protocol version 3.0 servers SHOULD<175> support this control code.
The server MUST fail this method by using error ERROR_INVALID_FUNCTION (0x00000001) if the resource designated by hResource does not contain a cluster shared volume (ResourceSharedVolumes MUST be TRUE).
The server MUST fail this method by using error ERROR_RESOURCE_NOT_ONLINE (0x0000138C) if the resource designated by hResource is not currently online.
The client MUST provide a CLUS_SHARED_VOLUME_BACKUP_MODE (section 2.2.3.20) structure in the buffer that is designated by lpInBuffer. The client MUST set the VolumeName field to a unique volume identifier as specified in section 2.2.3.20.
If the client sets the CLUS_SHARED_VOLUME_BACKUP_MODE BackupState field to VolumeBackupInProgress, the server MUST enable backup mode and complete the method. In the meantime, the server MUST monitor the cluster shared volume for initiation of a backup operation. If no backup operation has been detected within the number of seconds designated by the client in the CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE DelayTimerInSecs field, then the server MUST disable backup mode for the cluster shared volume.
If the client sets the CLUS_SHARED_VOLUME_BACKUP_MODE BackupState field to VolumeBackupInProgress, the server MUST enable backup mode and complete the method. In the meantime, the server MUST initialize the volume backup timer associated with the designated cluster shared volume to the value specified by the client in the CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE DelayTimerInSecs field. The server MUST monitor the cluster shared volume for initiation of a backup operation. If no backup operation has been detected by the time the volume backup timer has expired, the server MUST disable backup mode for the cluster shared volume. If the cluster shared volume transitions out of backup mode for any other reason, or if the server detects a backup operation on the cluster shared volume, the server MUST cancel the volume backup timer.
If the server detects a backup operation while the cluster shared volume is not in backup mode, the server MUST enable backup mode. When a backup operation completes, the server MUST disable backup mode for the cluster shared volume. The method of server detecting the start of a backup operation, the server detecting the completion of a backup operation, and performing backup operation are all implementation-specific. If the storage class resource associated with a cluster shared volume transitions out of the ClusterResourceOnline state, the server MUST reinitialize the backup mode to disabled.
After successful completion of the method, the server SHOULD NOT write any data to the buffer that is designated by lpOutBuffer.The server MUST accept a CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE resource control code request only if it is in the read/write state, as specified in section 3.1.1.