| GeViScope SDK > Action documentation > Backup actions

Backup actions

All actions for backup.

 

Abort all auto backups

Action name:AbortAllAutoBackups()Action category: logical Abort all auto backups.

 

Abort auto backup

Action name:AbortAutoBackup(Schedule)Action category: logical Abort auto backup.

Parameter Function
schedule Schedule Schedule.

 

Auto backup capacity warning

Action name:AutoBackupCapacityMonitoringCapacityWarning(Warning, Destination, TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, PercentAllocatedByGbf)Action category: logical Auto backup capacity monitoring: capacity warning.

Parameter Function
warning Warning Warning.
destination Destination Destination.
total capacity TotalCapacity Total capacity.
free capacity FreeCapacity Free capacity.
allocated by GBF AllocatedByGbf Allocated by GBF.
percent free PercentFree Percent free.
percent allocated PercentAllocated Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.

 

Auto backup capacity file auto deleted

Action name:AutoBackupCapacityMonitoringFileAutoDeleted(Warning, Destination, TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, PercentAllocatedByGbf, FileSize, FileName)Action category: logical Auto backup capacity monitoring: file auto deleted.

Parameter Function
warning Warning Warning.
destination Destination Destination.
total capacity TotalCapacity Total capacity.
free capacity FreeCapacity Free capacity.
allocated by GBF AllocatedByGbf Allocated by GBF.
percent free PercentFree Percent free.
percent allocated PercentAllocated Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.
file size FileSize File size.
file name FileName File name.

 

Auto backup capacity out of disk space

Action name:AutoBackupCapacityMonitoringOutOfDiskSpace(Warning, Destination, TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, PercentAllocatedByGbf)Action category: logical Auto backup capacity monitoring: out of disk space.

Parameter Function
warning Warning Warning.
destination Destination Destination.
total capacity TotalCapacity Total capacity.
free capacity FreeCapacity Free capacity.
allocated by GBF AllocatedByGbf Allocated by GBF.
percent free PercentFree Percent free.
percent allocated PercentAllocated Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.

 

Auto backup file done

Action name:AutoBackupFileDone(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileSizeLimit, BandWidthLimit, FileIndex, FileName, FileSize)Action category: logical Auto backup progress notification: file done.

Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.
operation index OperationIndex Operation index.
operation start time OperationStartTime Operation start time.
source Source Source.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
file index FileIndex File index.
file name FileName File name.
file size FileSize File size.

 

Auto backup file progress

Action name:AutoBackupFileProgress(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileSizeLimit, BandWidthLimit, FileIndex, FileName, FileSize)Action category: logical Auto backup progress notification: file progress.

     
Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.
operation index OperationIndex Operation index.
operation start time OperationStartTime Operation start time.
source Source Source.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
file index FileIndex File index.
file name FileName File name.
file size FileSize File size.

 

Auto backup file started

Action name:AutoBackupFileStarted(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileSizeLimit, BandWidthLimit, FileIndex, FileName)Action category: logical Auto backup progress notification: file started.

Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.
operation index OperationIndex Operation index.
operation start time OperationStartTime Operation start time.
source Source Source.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
file index FileIndex File index.
file name FileName File name.

 

Auto backup operation done

Action name:AutoBackupOperationDone(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart, OperationIndex, OperationStartTime, OperationStopTime, Source, Destination, FileSizeLimit, BandWidthLimit)Action category: logical Auto backup progress notification: operation done.

     
Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.
operation index OperationIndex Operation index.
operation start time OperationStartTime Operation start time.
operation stop time OperationStopTime Operation stop time.
source Source Source.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.

 

Auto backup operation started

Action name:AutoBackupOperationStarted(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileSizeLimit, BandWidthLimit)Action category: logical Auto backup progress notification: operation started.

Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.
operation index OperationIndex Operation index.
operation start time OperationStartTime Operation start time.
source Source Source.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.

 

Auto backup schedule done

Action name:AutoBackupScheduleDone(Schedule, StartTime, EffectiveStartTime, StopTime, OperationCount, TimerStart)Action category: logical Auto backup progress notification: schedule done.

     
Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
stop time StopTime Schedule stop time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.

 

Auto backup schedule started

Action name:AutoBackupScheduleStarted(Schedule, StartTime, EffectiveStartTime, OperationCount, TimerStart)Action category: logical Auto backup progress notification: schedule started.

Parameter Function
schedule Schedule Schedule.
start time StartTime Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count OperationCount Operation count.
timer start TimerStart Timer start.

 

Backup event

Action name:BackupEvent(EventID, TypeID, Destination, StartHintID, StopHintID, Subfolder)Action category: logical Backup event.

Parameter Function
instance ID EventID Instance ID of the event.
event type TypeID Type of the event.
destination Destination Destination.
start hint ID StartHintID Optional start hint ID.
stop hint ID StopHintID Optional stop hint ID.
sub folder Subfolder Sub folder to backup event.

 

Event backup done

Action name:EventBackupDone(JobID, EventTypeID, EventID, Destination, FileSizeLimit, BandWidthLimit, StartTime, StopTime)Action category: logical Event backup progress notification: backup done.

Parameter Function
job ID JobID Backup job ID.
event type EventTypeID Type of the event.
instance ID EventID Instance ID of the event.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
start time StartTime Backup start time.
stop time StopTime Backup stop time.

 

Event backup file done

Action name:EventBackupFileDone(JobID, EventTypeID, EventID, Destination, FileSizeLimit, BandWidthLimit, StartTime, FileIndex, FileName, FileSize)Action category: logical Event backup progress notification: file done.

Parameter   Function
job ID JobID Backup job ID.
event type EventTypeID Type of the event.
instance ID EventID Instance ID of the event.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
start time StartTime Effective backup start time.
file index FileIndex File index.
file name FileName File name.
file size FileSize File size.

 

Event backup file progress

Action name:EventBackupFileProgress(JobID, EventTypeID, EventID, Destination, FileSizeLimit, BandWidthLimit, StartTime, FileIndex, FileName, FileSize)Action category: logical Event backup progress notification: file progress.

Parameter Function
job ID JobID Backup job ID.
event type EventTypeID Type of the event.
instance ID EventID Instance ID of the event.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
start time StartTime Effective backup start time.
file index FileIndex File index.
file name FileName File name.
file size FileSize File size.

 

Event backup file started

Action name:EventBackupFileStarted(JobID, EventTypeID, EventID, Destination, FileSizeLimit, BandWidthLimit, StartTime, FileIndex, FileName)Action category: logical Event backup progress notification: file started.

Parameter Function
job ID JobID Backup job ID.
event type EventTypeID Type of the event.
instance ID EventID Instance ID of the event.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
start time StartTime Effective backup start time.
file index FileIndex File index.
file name FileName File name.

 

Event backup started

Action name:EventBackupStarted(JobID, EventTypeID, EventID, Destination, FileSizeLimit, BandWidthLimit, StartTime)Action category: logical Event backup progress notification: backup started.

Parameter Function
job ID JobID Backup job ID.
event type EventTypeID Type of the event.
instance ID EventID Instance ID of the event.
destination Destination Destination.
file size limit FileSizeLimit File size limit.
band width limit BandWidthLimit Band width limit.
start time StartTime Backup start time.

 

Start auto backup

Action name:StartAutoBackup(Schedule)Action category: logical Start auto backup.

Parameter Function
schedule Schedule Schedule.