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.

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 ]

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.

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:\OODI\Image20111005.obk</backup_name>

</command>