Command-specific parameters
all_devices
Initializes and displays all drive types of system.
Valid values: "yes", "no", "true" and "false"
Example
<all_devices>yes</all_devices>
all_sources
All (Source-) objects from an image should be included in the processing.
Valid values: "yes", "no", "true" and "false"
Example
<all_sources>yes</all_sources>
all_splits
All parts of an image should be used for the processing.
It can be specified during the check, whether the current part of the image should be checked.
Valid values: “yes”, “no”, “true” and “false”
Example
<all_splits>false</all_splits>
allocation_unit_size
The selected cluster size when creating a file system on a drive. The size is specified in bytes.
Example
<allocation_unit_size>4096</allocation_unit_size>
append_on_target_drive
Denotes that the selected object should be appended onto the storage volume. Existing partitions of the disk will not be affected by it.
Valid values: "yes" or "true"
Example
<append_on_target_drive>true</append_on_target_drive>
automatically_create_target_drive_like_source_drive
The target layout is automatically created equally to the source layout. A restoration/cloning will not take place with the interpretations of the file systems.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_create_target_drive_like_source_drive>true
</automatically_create_target_drive_like_source_drive>
automatically_checkdisk
Mark if the default parameters should be run after processing the command chkdsk automatically.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_checkdisk>true</automatically_checkdisk>
automatically_convert_multi_disk_volumes
Label that without prompting a volume, which was originally distributed on several hard disks, should be the target of a partition when allocating on an empty space of the basic disk. Valid values: "yes", "no", "true" and "false"
Example
<automatically_convert_multi_disk_volumes>true</automatically_convert_multi_disk_volumes>
automatically_convert_to_vhd
Label indicating whether, the image should be converted into a "Virtual Hard disk Image" with the same nameafter the command has been processed.Valid values: "yes", "no", "true" and "false"
Example
<automatically_convert_to_vhd>true</automatically_convert_to_vhd>
automatically_overwrite_backup
Label indicating whether the existing imaging file should be deleted without asking beforehand.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_overwrite_backup>true</automatically_overwrite_backup>
automatically_overwrite_image
Label indicating whether the existing imaging file should be deleted without asking beforehand.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_overwrite_image>true</automatically_overwrite_image>
automatically_validate_image
Denotes whether the image file should be checked automatically after the processing of the command.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_validate_image>true</automatically_validate_image>
automatically_validate_backup
Denotes whether the image file should be checked automatically after the processing of the command.
Valid values: "yes", "no", "true" and "false"
Example
<automatically_validate_backup>true</automatically_validate_backup>
backup_name
Defines the name of the image file including path.
Example
<backup_name>C:\Image20111006.obk</backup_name>
backup_type
Labels the type of backup, the desired backup method for data-based backup.
extended ZIP file backup: creation of backup file that displays a ZIP format extension.
Example
<backup_type>extended ZIP file backup</backup_type>
backupset_comments
A backupset is a resume of criteria used to describe the files/folders being backed up. This parameter will help you include comments within the backupset.
Example
<backupset_comments>backup personal files</backupset_comments>
backupset_id
This parameter displays an ID with which a backupset can be clearly identified. This parameter is currently not being used and should be filled with "0".
Example
<backupset_id>{00000000-0000-0000-0000-000000000000}</backupset_id>
backupset_name
The name of a backupset for easier classification and display.
Example
<backupset_name>my documents</backupset_name>
backupset_exclude
A backupset is a resume of criteria used to describe the files/folders being backed up.This parameter is for excluding a data volume determined by a criterion. It describes files or folders using path and/or filename details. The established wildcards "*" and "?"are also permitted here.
Example
<backupset_exclude>*.tmp</backupset_exclude>
backupset_criteria
A backupset is a resume of criteria used to describe the files/folders being backed up. This parameter is a criterion for creating a file-based backup. This criterion describes files or folders using path and/or filename details. The established wildcards "*" and "?"are also permitted here.
Example
<backupset_criteria>C:Documents and SettingsMy Documents</backupset_criteria>
basic_disk
Initialization of a disk as a "basic disk".
Valid values: "yes", "no", "true" and "false"
Example
<basic_disk>yes</basic_disk>
begin
Definition of a position at the beginning of a disk.
Example
<drivenumber>1</drivenumber>
<begin>32256</begin>
cddvd_devices
Only CD/DVDs should be initialized and prepared for display.
Valid values: "yes", "no", "true" and "false"
Example
<cddvd_devices>yes</cddvd_devices>
change_initial_condition
Label indicating that the original values should be adapted dynamically to a command in order to repeat that command.While creating an incremental image file it is possible to set an image file created with the help of template parameter as base image for the sucessive processing.
Valid values: "yes", "no", "true" and "false"
Example
<change_initial_condition>yes</change_initial_condition>
check_only_if_dirty
Checks a drive only when it is labeled as defective or will check only its defective regions.
Valid values: "yes", "no", "true" and "false"
Example
<check_only_if_dirty>no</check_only_if_dirty>
checksum_type
| Value | Meaning |
|---|---|
| none | No checksum procedure selected |
| MD5 | checksum procedure using the MD5 algorithm |
| SHA1 | checksum procedure using the SHA1algorithm |
| SHA2 256 | checksum procedure using the SHA2 256 algorithm |
| SHA2 512 | checksum procedure using the SHA2 512 algorithm |
| CRC32 | checksum procedure using the CRC32 algorithm |
Example
<checksum_type>MD5</checksum_type>
chs_alignment
Specifies the alignment on partitions. This parameter will force the alignment on cylinders (cylinder/head/sector).
Valid values: "yes", "no", "true" and "false"
Example
<chs_alignment>true</chs_alignment>
clear_target_drive
Automatic deletion of the target disk. All existing partitions/volumes will be deleted.
Important! This parameter disables the confirmation dialogue and automatically deletes all drives!
Valid values: "yes", "no", "true" and "false"
Example
<clear_target_drive>yes</clear_target_drive>
clone_type
Label indicating the clone type.
| Value | Meaning |
|---|---|
| used sector | cloning of the used sectors |
| forensic sector | forensic cloning of all sections of a drive |
| direct forensic sector | direct forensic cloning of all sectors of a drive |
Example
<clone_type>used sector</clone_type>
comments
You can use this parameter to add comments to the image.
Example
<comments>This is a sample for creating incremental images... </comments>
complete_region_size
The complete region should be used for processing. When creating a partition, the complete size of the region will be used as the basis for the partition.
Valid values: "yes", "no", "true" and "false"
Example
<complete_region_size>true</complete_region_size>
compression_type
Label indicating the compression type.
| Value | Meaning |
|---|---|
| none | No compression selected |
| LZNT1 standard | LZNT 1 standard compression |
| LZNT1 maximum | LZNT 1 maximum, stronger compression - considerably more time required |
| BZIP2 1K | BZIP2 compression with block size of 100000 Bytes |
| BZIP2 4K | BZIP2 compression with block size of 400000 Bytes |
| BZIP2 9K | BZIP2 compression with block size of 900000 Bytes |
Example
<compression_type>LZNT1 standard</compression_type>
correct_errors
Detected errors should be corrected.
Valid values: "yes", "no", "true" and "false"
Example
<correct_errors>no</correct_errors>
data_volumes
Label indicating only non-system volumes or non-system partitions should be included for processing.
Valid values: "yes", "no", "true" and "false"
Example
<data_volumes>yes</data_volumes>
default_devices
The standard disks should be initialized and be ready display. The initialized standard disks include hard disks, CDROMs and DVDROMs.
Valid values: "yes", "no", "true" and "false"
Example
<default_devices>yes</default_devices>
default_windows_alignment
Specifies how partitions will be aligned. This parameter draws on the type of alignment from the operating system or the hard disk to align the partition.
Valid values: "yes", "no", "true" and "false"
Example
<default_windows_alignment>yes
</default_windows_alignment>
device_name
The name of the selected drive/disk.
Example
<device_name>DeviceHarddiskVolume2</device_name>
device_name_two
The name of a second device.
Example
<device_name_two>DeviceIenIenDeviceP1T0L0-e</device_name_two>
device_type
Indicates the type or description of the target or source drive.
| Value | Meaning |
|---|---|
| filesystem | Standard – file system |
Comment:
Reserved for future versions. A value other than "filesystem" is currently invalid and will lead to error.
Example
<device_type>filesystem</device_type>
disk_devices
Only hard disks should be initialized and prepared for display.
Valid values: "yes", "no", "true" and "false"
Example
<disk_devices>yes</disk_devices>
drivenumber
The number of the selected drive.
Example
<drivenumber>1</drivenumber>
drive_number_one
The number of the first selected drive.
Example
<drivenumber_one>2</drivenumber_one>
drive_number_two
The number of the second selected drive.
Example
<drive_number_two>2</drive_number_two>
driveletter
The drive letter of the selected drive.
Example
<driveletter>C</driveletter>
driveletter_to_set
The drive letter to be set.
Example
<driveletter_to_set>Y</driveletter_to_set>
dynamic_disk
Initializing a disk as a „dynamic disk“.
Valid values: "yes", "no", "true" and "false"
Example
<dynamic_disk>true</dynamic_disk>
enable_compression
Files created on a new volume or partition will be compressed by default.
Valid values: "yes", "no", "true" and "false"
Example
<enable_compression>yes</enable_compression>
encryption_type
Label indicating the type of encryption.
| Value | Meaning |
|---|---|
| none | No encryption type selected |
| AES 128 | AES – encryption with 128 bit |
| AES 192 | AES – encryption with 192 bit |
| AES 256 | AES – encryption with 256 bit |
Example
<encryption_type>AES 192</encryption_type>
extended
Creates an extended partition, i.e., a drive upon which a logical drive can be created.
Valid values: "yes", "no", "true" and "false"
Example
<extended>yes</extended>
FAT16
Indicates the partition and/or file system that will be created when you want to create a FAT16 drive and/or file system.
Valid values: "yes", "no", "true" and "false"
Example
<FAT16>true</FAT16>
FAT32
Indicates the partition and/or file system that will be created when you want to create a FAT 32 drive and/or file system.
Valid values: "yes", "no", "true" and "false"
Example
<FAT32>yes</FAT32>
fill_empty_blocks
Fills empty regions on the target drive with the value „0“.
Valid values: "yes", "no", "true" and "false"
Example
<fill_empty_blocks>no</fill_empty_blocks>
floppy_devices
Use this parameter when you only want to initialize floppy drives and prepare them for display.
Valid values: "yes", "no", "true" and "false"
Example
<floppy_devices>true</floppy_devices>
force_dismount
Forces the cancellation of the volume’s deployment when necessary. All files/handles opened to the volume will be closed.
Valid values: "yes", "no", "true" and "false"
Example
<force_dismount>yes</force_dismount>
format
Indicates whether or not the drive should be formatted after creation, and if the file system should be created.
Valid values: "yes", "no", "true" and "false"
Example
<format>yes</format>
gpt_disk
Initializes a disk as a „gpt disk“.
Valid values: "yes", "no", "true" and "false"
Example
<gpt_disk>yes</gpt_disk>
hash_unchanged_data
Indicates whether the unchanged data of an incremental image should be stored in the image as a hash-value (checksums). This increases the size of the incremental image but will accelerate data access for the next imaging procedure.
Valid values: "yes", "no", "true" and "false"
Example
<hash_unchanged_data>no</hash_unchanged_data>
huge
Indicates the drive that will be created, especially for labeling a large partition.
Valid values: "yes", "no", "true" and "false"
Example
<huge>yes</huge>
ignore_data_modification
Influences the behavior while restoring or validating images, if it was detected that data was changed within the image. If these parameters are not set with a negation, the handling will be cancelled. Otherwise, only the change will be recorded in the report and the process will continue.
Valid values: "yes", "no", "true" and "false"
If the data in the image is changed outside the program, they might contain errors and be rendered useless.
Example
<ignore_data_modification>yes</ignore_data_modification>
ignore_snapshot_cache_overflow
Label indicating whether a potential overflow of the cache should be considered as an error, and as a result, will be canceled.
Valid values: "yes", "no", "true" and "false"
Should you exceed the available cache space, the original data sectors will no longer be saved and included in the image. This makes the image inconsistent and may render it unusable.
Example
<ignore_snapshot_cache_overflow>yes</ignore_snapshot_cache_overflow>
ignore_invalid_free_size_appointment
Indicates whether an error occurring during the detection for free storage space on a drive should be ignored and the process continued.
Valid values: "yes", "no", "true" and "false"
When creating the image file, this parameter could lead to its being made invalid when nothing more can be written onto the target drive. It should be used mainly for allowing access to NAS drives that do not report free regions and are not able to be imaged.
Example
<ignore_invalid_free_size_appointment>yes</ignore_invalid_free_size_appointment>
ignored_file
Indicates files that should be excluded. Data from these files will not be applied to the image.
Example
<ignored_file>*.temp</ignored_file>
<ignored_file_pattern>*.~</ignored_file_pattern>
ignored_read_errors
Possible read errors that occur should be ignored without a confirmation dialogue. These sectors will be skipped during the read procedure and noted in the log file.
Valid values: "yes", "no", "true" and "false"
Example
<ignored_read_errors>yes</ignored_read_errors>
image_begin
Defines a position at the beginning of a disk and indicates a region of the image file.
Example
<image_drivenumber>2</image_drivenumber>
<image_begin>1048576</image_begin>
image_drivenumber
Defines the number of the selected disk from the image.
Example
<image_drivenumber>1</image_drivenumber>
image_driveletter
Defines the drive letters of the selected drive from the image.
Example
<image_driveletter>D</image_driveletter>
image_name
Defines the name of the image file including path.
Example
<image_name>C:ImageFilesImage20071127.omg</image_name>
image_object_id
Defines the ID of the selected object from/in the image.
Example
<image_object_id>3</image_object_id>
image_type
Label indicating the type of imaging, i.e., the selected imaging method.
| Value | Meaning |
|---|---|
| used sector | imaging of the used sectors |
| forensic sector | forensic imaging of all sectors of a drive |
| direct forensic sector | direct forensic imaging of all sectors of a drive |
Example
<image_type>used sector</image_type>
is_superfloppy
Labels a storage volume as "superfloppy". Such a disk consists of one drive only and contains no system regions, i.e., no partition structure will be written on it.
Valid values: "yes", "no", "true" and "false"
Example
<is_superfloppy>yes</is_superfloppy>
label
Label of the selected drive based on the drive´s name.
Example
<label>System</label>
localname
The local name of the resource.
Example
<localname>Z</localname>
locates_bad_sectors_recover_readable_information
An investigation of bad sectors and the restoration of the readable data are requested.
Valid values: "yes", "no", "true" and "false"
Example
<locates_bad_sectors_recover_readable_information>yes
</locates_bad_sectors_recover_readable_information>
max_backup_size
Fixes the maximal size of the image file in bytes. A division will be made when this level is almost reached.
The minimum value of a backup file is 1 megabyte, or 1048576 bytes. If a value lower than this amount is entered, the maximum size of the backup file will be set to 1 MB.
Example
<max_backup_size>786432000</max_backup_size>
new_comments
This parameter will let you add comments into the new image file.
Example
<new_comments>incremental image wg. Windowsupdate </new_comments>
max_image_size
Fixes the maximal size of the image file in bytes. A division will be made when this level is almost reached.
The minimum value of an image file is 5 Megabyte, more exactly 5242880 bytes. If the value is smaller than this, the maximal size of the image file will set at 5 MB.
Example
<max_image_size>786432000</max_image_size>
new_device_type
Indicates the type or description of the new target drive.
| Value | Meaning |
|---|---|
| filesystem | Standard – file system |
Comment:
Reserved for future versions.A value other than "filesystem" is currently invalid and will lead to error.
Example
<new_device_type> filesystem </new_device_type>
new_backup_name
Describes the name of the new backup file including path.
Example
<new_backup_name>C:\backup\20111006_new.obk</new_backup_name>
new_image_name
Describes the name of the new image file including path.
Example
<new_image_name>C:\Temp\Image20071031.omg</new_image_name>
new_password
Define a password as a parameter for creation.
Example
<new_password>my new password</new_password>
no_alignment
Specifies how partitions will be aligned.This parameter will use no type of alignment: the position will be considered as absolute.
Valid values: "yes", "no", "true" and "false"
Example
<no_alignment>true</no_alignment>
NTFS
Label indicating the partitions and/or the file system that will be created if you want to create an NTFS drive and/or data system.
Valid values: "yes", "no", "true" and "false"
Example
<NTFS>true</NTFS>
operating_system_path
Path to the folder where the installed operating system files can be found.
Example
<operating_system_path>E:Windows</operating_system_path>
overwrite_target_data
Automatic deletion of the target drive. All existing data on partitions/volumes will be deleted.
These parameters deactivate the confirmations and data on the target drive will be automatically deleted!
Valid values: "yes", "no", "true" and "false"
part_of_disk_size
Part of the selected size of the drive being created in relation to the size of the disk.
Example
<part_of_disk_size>1/3</part_of_disk_size>
password
Marks a password as a parameter.
Example
<password>My_Passwort</password>
quickformat
Runs a formatting with quick formatting.
Valid values: "yes", "no", "true" and "false"
Example
<quickformat>no</quickformat>
remotename
The name of the server and the shared resource.
Example
<remotename>WantedServerSharedFolder </remotename>
serialnumber
The serial number of the desired disk.
Example
<serialnumber>JK1101YAH6KWMZ</serialnumber>
serialnumber_one
The serial number of the first desired disk.
Example
<serialnumber_one>2</serialnumber_one>
serialnumber_two
The serial number of the second desired disk.
Example
<serialnumber_two>2</serialnumber_two>
setup_type
Label indicating the type of installation being activated.
mini_setup: Minimum setup installation of the operating system
Example
<setup_type>mini_setup</setup_type>
sequential_access
Sequential access to the image file is requested. This will mean an advantage in performance over non-sequential access, given that larger data regions can be included here.
Valid values: "yes", "no", "true" and "false"
Example
<sequential_access>true</sequential_access>
set_active
Labels whether "enable" or "disable" should be set for the selected drive.
Valid values: "yes", "no", "true" and "false"
Example
<set_active>true</set_active>
set_bootable_partition_bootable
Automatic setting of the bootable source partition as bootable. The confirmation dialogue will be disabled with this parameter.
Valid values: "yes", "no", "true" and "false"
Example
<set_bootable_partition_bootable>yes
</set_bootable_partition_bootable>
size
The size of an object in bytes.
Example
<size>1073741824</size>
snapshot
As an option to the parameter "force_dismount", the installed filter drivers will help log changes in data so that unchanged data can be included in the backup.
See also parameter "vss".
Example
<snapshot>true</snapshot>
system_volume
Label indicating that only the system volume or system partition will be drawn into the processing.
Valid values: "yes", "no", "true" and "false"
Example
<system_volume>yes</system_volume>
target_begin
Defines a position at the beginning of a target disk.
Example
<target_drivenumber>1</target_drivenumber>
<target_begin>32256</target_begin>
target_devicename
The name of the requested target drive/target disk.
Example
<target_device_name>DeviceHarddiskVolume6</target_device_name>
target_drivenumber
Number of the target drive.
Example
<target_drivenumber>2</target_drivenumber>
target_driveletter
Drive letter of the target drive.
Example
<target_driveletter>G</target_driveletter>
target_image_type
Type of the image to be created.
o&o image - the goal is to create an image by O&O DiskImage.
vhd image - a virtual hard disk of the Microsoft Virtual PC should be the target.
Example
<target_image_type>o&o image</target_image_type>
target_path
A target parameter where files/data should be written.
Example
<target_path>C:\New Folder</target_path>
target_serialnumber
Serial number of the target disk.
Example
<target_serialnumber>GTA0L2PBGJPSSF</target_serialnumber>
uncompressed_file
Label indicating the files that should not be compressed.
Example
<uncompressed_file>*.zip</uncompressed_file>
unattended
Label indicating an unattended installation, i.e., standard components will be installed and prompting questions avoided.Valid values: "yes", "no", "true" and "false"
Example
<unattended>yes</unattended>
username
User name for identification of the person doing the requested operation.Such a user name can be extended through the name of a domain.
Example
<username>domainHMuster</username>
value_to_fill
Label indicating the value which will be used to fill (overwrite) an object. Possible are values from 0 to 9.
Example
<value_to_fill>0</value_to_fill>
verbose
Display of extended information.
Valid values: "yes", "no", "true" and "false"
Example
<verbose>true</verbose>
vss
As an alternative to the parameter "force_dismount", the Microsoft VolumeShadowCopyService can log changes in data so that unchanged data is included in the backup.
See also parameter "snapshot".
Valid values: "yes", "no", "true" and "false"
Example
<vss>true</vss>
write_data_directly
Data should be written directly on the drive, meaning without use of the file system driver.This is needed by an image file or cloning process of the type "direct forensic" for restoring an encrypted drive back to its original condition, or for cloning.
Valid values: "yes", "no", "true" and "false"
Example
<write_data_directly>true</write_data_directly>