Restoring Files from Full Backup

--restore

Yes

Instructs ubax to perform restore.

--restore_all

No

Defines that all data from the backup file residing in the default backup location must be restored. Without this option specified, you must specify a path to the restore script that contains a list of files and/directories to restore.

--acl=<n>

No

Defines whether to use POSIX Access Control Lists (ACLs) during restore. Possible values:

• 0 — Not to use ACLs
• 1 — Use ACLs

The default value is 1.

--device=<device>

No

Specifies the name of the backup location where the backup file resides. The backup location must be defined in a configuration file.

--device_file=<file>

No

Specifies the configuration file where backup location settings are defined. The default file with information about backup locations is /etc/veeam/devices.ini.

--ini_file=<file.ini>

No

Specifies the configuration file where settings for the ubax utility are defined. The default configuration file is /etc/veeam/ubax.ini.

--mlfile=<file>

No

Specifies a path to the media library entry file that you want to use for data restore. If no file is specified, the latest media library entry will be used for data restore.

--overwrite=<n>

No

Defines whether to overwrite the existing files and directories during restore. Possible values:

• 0 — Not to overwrite
• 1 — Overwrite

The default value is 0.

--path_prefix

No

Specifies the path prefix that will be added to all restored paths.

--read_ml=<n>

No

Defines whether to use the backup script or media library for data restore. Possible values:

• 0 — Backup script
• 1 — Media library

The default value is 0.

--set_owner=<n>

No

Defines whether to preserve original file ownership during restore. Possible values:

• 0 — Not to preserve
• 1 — Preserve

The default value is 1.

--set_perms=<n>

No

Defines whether to preserve original file permissions during restore. Possible values:

• 0 — Not to preserve
• 1 — Preserve

The default value is 1.

--set_time=<n>

No

Defines whether to preserve original file time during restore. Possible values:

• 0 — Not to preserve
• 1 — Preserve

The default value is 1.

--snumber=<n>

No

Specifies the number of the dataset from which to restore data.

Encryption Options

No

You can specify data encryption options for the restore process. To learn more, see Data Encryption Options.

Logging Options

No

You can specify logging options for the ubax utility. To learn more, see Logging Options.

--encryption_key=<key>

No

Specifies the encryption key used for backup. ASK should be used if the key is to be entered interactively, or SESSION if a session key is to be automatically generated.

--encryption_ref=<keyname>

No

Specifies the encryption key used for backup by reference to the key repository file.

--encryption_type=<n>

No

Specifies the encryption type. Possible values:

• 0 — No encryption
• 1 — AES256
• 2 — Blowfish

The default value is 0.

--generate_key=<keyname>

No

Generates a new key with the name <keyname>.

--key_repository=<file>

No

Specifies the path to the encryption key repository file.

--passphrase_hash_type=<n>

No

Specifies the type of hashing used to generate an encryption key from a passphrase. Possible values:

• 0 — No hashing
• 1 — SHA256
• 2 — SHA512
• 3 — WHIRLPOOL

--append_log

No

Specifies whether to overwrite or append the log file. Possible values:

• 0 — Overwrite
• 1 — Append

The default value is 0.

--errfile=<file>

No

Specifies the error file. Note that this option does not use the --logdir option to form a path to the error file.

--err_level=<n>

No

Specifies the error file output level (the default value is 4). Note that the error level should be equal to or less than the logging level. For details, see the description of the log_level option below.

--logdir=<dir>

No

Specifies the path to the directory where the backup.log log file will be created. The default path is /var/log/veeam.

--logfile=<file>

No

Specifies the log file name. Note that this option does not use the --logdir option to form a path to the log file.

--log_level=<n>

No

Specifies the log file and screen output level. The following values are available:

• 0 — Level 0 (NONE): no logging.
• 1 — Level 1 (FATAL): only fatal errors are logged.
• 2 — Level 2 (ERROR): only errors are logged.
• 3 — Level 3 (WARNING): errors and warnings are logged.
• 4 — Level 4 (INFO): errors, warnings and volume/area headers are logged.
• 5 — Level 5 (PATH): all file and directory names are logged.
• 6 — Level 6 (DEBUG): debugging information is logged.

The default value is 5.

--show_skipped=<n>

No

Defines whether to show skipped files and directories. Possible values:

• 0 — Not to show
• 1 — Show

The default value is 0.

--syslog=<n>

No

Defines whether to use syslog to record fatal events. Possible values:

• 0 — Not to use syslog
• 1 — Use syslog

The default value is 0.