CLUS_SHARED_VOLUME_BACKUP_MODE structure (clusapi.h)

Article
02/22/2024

Describes the backup mode for cluster shared volume (CSV). Used by the CLUSCTL_RESOURCE_SET_SHARED_VOLUME_BACKUP_MODE control code.

Syntax

typedef struct _CLUS_SHARED_VOLUME_BACKUP_MODE {
  CLUSTER_SHARED_VOLUME_BACKUP_STATE BackupState;
  DWORD                              DelayTimerInSecs;
  WCHAR                              VolumeName[MAX_PATH];
} CLUS_SHARED_VOLUME_BACKUP_MODE, *PCLUS_SHARED_VOLUME_BACKUP_MODE;

Members

BackupState

Value from CLUSTER_SHARED_VOLUME_BACKUP_STATE enumeration.

VolumeBackupNone (0)

There is no backup in progress for this CSV.

VolumeBackupInProgress (1)

There is a backup in progress for this CSV.

DelayTimerInSecs

If the BackupState member is set to VolumeBackupNone then this member must be set to 0. Otherwise this member must be set to a nonzero value.

VolumeName[MAX_PATH]

Null-terminated Unicode string containing the name of the shared volume. The name provided can be either the cluster-assigned friendly name or the volume GUID path of the form "\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2 Enterprise, Windows Server 2008 R2 Datacenter
Header	clusapi.h