Configure the Backup Service Using staservadm

Use the staservadm utility to configure the STA Backup Service.

Prerequisites

Parameters

The staservadm utility uses the parameters listed in the table below. You can submit as many parameters as you want in each staservadm command line. The utility only updates the parameters you specify. The unspecified parameters remain at their current value.

Some settings (denoted by * in the table) require you to stop and restart the Services Daemon if you want the setting to take effect immediately. Otherwise these changes take effect as soon as the Backup Service wakes from its current sleep interval.

Name Parameter Description Sample Value

Help

-h, --help

Displays command usage information.

NA

Clear Settings

-C, --clear

Clears all settings and disables the backup service.

NA

Query Settings

-Q, --query

Displays the current Backup service settings.

NA

File Transfer

-S, --scp | -F, --ftp

The file transfer method: SCP or FTP. SCP is recommended.

SCP (default)

Full Backup Time*

-T, --time

The time of day full backups are performed. Format is hh:mm, using 24-hour time. The dump is performed automatically every 24 hours at approximately this time. The actual time is within one incremental backup interval after this time.

23:30

00:00 (default)

Sleep Interval*

-i, --int

The number of seconds between incremental backups. Valid entries: integers 1 to 86399.

1800 (=30 minutes)

300 (default)

Backup Hostname

-s, --server

The hostname or IP address of the server which the STA Backup service copies the backup files to. You can specify an IPv4 or IPv6 address, or a fully qualified DNS host name.

stabackup

Backup Username

-u, --usr

System username that writes the database backup files to the target directory. This must be a user on the backup server that has write privileges to the target directory. If you specify a username, you must also specify a password.

root

Backup Password

-p, --pwd

The password for the backup username.

If you enter just -p on the command line, the utility will prompt for the password, which is hidden when you type it.

NA

Backup Directory

-d, --dir

Directory on the backup server where the backup files will be copied. This directory must already exist on the server.

/dbbackup

Database Username

-U, --dbusr

The MySQL database administrator account created during STA installation.

stadba

blank (default)

Database Password

-P, --dbpwd

Password for the database root username.

blank (default)