Scriptinterface Product manual

Scriptinterface 
File-based backup functions

create backup

Creates a file-based backup using transferred criteria.

Parameters

  • backup_type
  • compression_type
  • encryption_type
  • checksum_type
  • device_type
  • backup_name
  • backupset_id
  • backupset_criteria
  • [ password ]
  • [ comments ]
  • [ max_backup_size ]
  • [ force_dismount | snapshot | vss ]
  • [ ignored_read_errors ]
  • [ ignore_invalid_free_size_appointment ]
  • [ automatically_validate_backup ]
  • [ automatically_overwrite_backup ]
  • [ ignore_snapshot_cache_overflow ]
  • [ automatically_convert_to_vhd ]
  • [ backupset_name ]
  • [ backupset_comments ]
  • [ backupset_exclude ]
Note:
When the maximum file size of the target drive's file system is reached or the drive is full, the backup file will be automatically split unless there's a maximum size set for it.

Example
<command name="create backup">
<backup_type>extended ZIP file backup<backup_type>
<compression_type>BZIP24K</compression_type>
<device_type>filesystem</device_type>
<backup_name>c:\OODIImage20171005.obk</backup_name>
<ignored_read_errors>yes</ignored_read_errors>
<backupset_id>{00000000-0000-0000-0000-000000000000}</backupset_id>>
<backupset_criteria>I:documents</backupset_criteria>
</command>

create incremental backup

Creates an incremental file-based backup. A backup will be created that contains only the changed files from a selected existing backup.

Parameters

  • device_type
  • backup_name
  • compression_type
  • encryption_type
  • new_backup_name
  • new_device_type
  • [ password ]
  • [ new_password ]
  • [ new_comments ]
  • [ new_max_backup_size ]
  • [ force_dismount | snapshot | vss ]
  • [ignore_data_modification ]
  • [ ignored_read_errors ]
  • [ ignore_invalid_free_size_appointment ]
  • [ automatically_validate_backup ]
  • [ automatically_overwrite_backup ]
  • [ ignore_snapshot_cache_overflow ]

Example
<command name="create incremental backup">
<device_type>filesystem</device_type>
<backup_name> c:\OODIImage20171005.obk </backup_name>
<compression_type> BZIP2 4K </compression_type>
<new_device_type>filesystem</new_device_type>
<new_backup_name> c:\OODIImage20171005_INC.obk</new_backup_name>
<ignored_read_errors>yes</ignored_read_errors>
<max_backup_size>-1</max_backup_size>
</command>

restore backup

Restores files/data from a file-based backup.

Parameters

  • device_type
  • backup_name
  • [ password ]
  • [ target_path ]
  • [ overwrite_target_data ]
  • [ ignored_read_errors ]
  • [ ignore_data_modification ]
Note:
If no target parameter (target_path)is indicated, the original data will be overwritten with data from the backup.

Example
<command name="restore backup">
<device_type>filesystem</device_type>
<backup_name>c:\OODIImage20117005.obk</backup_name>
<overwrite_target_data>yes</overwrite_target_data>
</command>

validate backup

This function checks the structural integrity of the backup file. It will examine whether the required logical structure is intact or undamaged. In addition, encrypted and/or compressed backups will be checked to determine whether decryption or decompression is possible without error.

Parameters

  • device_type
  • backup_name
  • [ all_splits ]
  • [ password ]
  • [ ignore_data_modification ]
Note:
If no target parameter (target_path) is indicated, the original data will be overwritten with data from the backup.

Example
<command name="validate backup">
<device_type>filesystem</device_type>
<backup_name>c:\OODIImage20171005.obk</backup_name>
</command>