This is an archive version of the document. To get the most up-to-date information, see the current version.Performing Full Backup
To perform full backup, Veeam Agent for Oracle Solaris uses the ubax utility. It reads data that you choose to back up, copies the backed-up data to the target location and stores it to a backup file in the VTD format. Veeam Agent for Oracle Solaris offers the following scenarios for performing full backup with the command-line interface.
- Scenario 1. You can specify backup settings in the default Veeam Agent for Oracle Solaris backup script and configuration files.
In this scenario, before you start the full backup process, make sure that the following prerequisites are met:
- Directories with files that you want to back up are specified in the /etc/veeam/scripts/veeam.scp backup script. To learn more, see Specifying Backup Scope.
- The backup location where you want to create the full backup file is defined in the /etc/veeam/devices.ini configuration file. To learn more, see Specifying Backup Location Settings.
- The backup location where you plan to create the full backup file is specified as the default backup location in the /etc/veeam/ubax.ini configuration file. To learn more, see Specifying Default Backup Location.
You will need to provide a path to the default backup script as an option of the command that starts the full backup process. You will not need to provide paths to default configuration files where backup location settings are defined.
- Scenario 2. You can specify backup settings in custom backup scripts and configuration files.
In this scenario, before you start the full backup process, make sure that the following prerequisites are met:
- The backup scope is specified in a custom backup script. You will need to provide a path to the default backup script as an option of the command that starts the full backup process.
- The backup location where you want to create the full backup file is defined in a custom configuration file. You can provide Veeam Agent for Oracle Solaris with information about backup locations in one of the following ways:
- You can specify the name of the default backup location and a path to the custom configuration file where backup location settings are defined in the /etc/veeam/ubax.ini configuration file or a custom configuration file. If you choose to use a custom configuration file, you will need to provide a path to this file as an option of the command that starts the full backup process.
For information about the ubax.ini file format, refer to the ubax manual page. To view the manual page, use the man ubax command.
- You can provide the name of the default backup location and a path to the custom configuration file where backup location settings are defined as an option of the command that starts the full backup process.
- You can specify backup location settings in the backup script.
To perform full backup, use a command with the following syntax:
ubax --backup [--block_size=<n>] [--buffer_size=<n>] [--compression=<n>] [--device=<device>] [--device_file=<file>] [--disk_volume=<pattern>][-ini_file=<file.ini>] [--local_fs=<n>] [encryption options] [logging options] <path/to/script> |
where </path/to/script> is a path to the backup script.
|
Consider the following:
|
To perform backup with the ubax command, you can use the following options:
Option | Required | Description |
--backup | Yes | Instructs ubax to perform backup. |
--block_size=<n> | No | Specifies the block size in bytes. |
--buffer_size=<n> | No | Specifies the buffer size in bytes. The buffer size must be equal to or greater than the block size. |
--compression=<n> | No | Specifies the compression mode for backup. Possible values:
The default value is 0. |
--device=<device> | No | Specifies the name of the backup location where the backup file will be created. 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. |
--disk_volume=<pattern> | No | Specifies that only files on mounted devices whose names match the <pattern> must be backed up. |
--ini_file=<file.ini> | No | Specifies the configuration file where backup settings are defined. The default configuration file is /etc/veeam/ubax.ini. |
--local_fs=<n> | No | Specifies whether mounted file systems (that reside in network shares and on removable devices) must be backed up. Possible values:
The default value is 1. |
--mldir=<dir> | No | Specifies the directory where to create media library entries. |
--useml=<n> | No | Defines whether a media library entry will be created during backup. Possible values:
The default value is 1. |
Encryption Options | No | You can specify data encryption options for the full backup 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. |
You can use the following options of the ubax command to specify data encryption settings:
Option | Required | Description |
--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:
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:
|
You can use the following options of the ubax command to specify logging settings:
Option | Required | Description |
--append_log | No | Specifies whether to overwrite or append the log file. Possible values:
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. |
No | Specifies the log file and screen output level. The following values are available:
The default value is 5. | |
--show_skipped=<n> | No | Defines whether to show skipped files and directories. Possible values:
The default value is 0. |
--syslog=<n> | No | Defines whether to use syslog to record fatal events. Possible values:
The default value is 0. |
Examples
The following example displays a command to create a full backup using the default backup script.
ubax --backup /etc/veeam/scripts/veeam.scp |
The following example displays a command to create a full backup using the custom backup script machine01.scp in a backup location defined in the custom configuration file backup_locations.ini with advanced backup settings specified in the custom configuration file machine01.ini.
ubax --backup --device=Machine01 --device_file=/mnt/veeam/config/backup_locations.ini --ini_file=/mnt/veeam/config/machine01.ini /mnt/veeam/scripts/machine01.scp |