Mysql-zrm-scheduler

NAME

mysql-zrm-scheduler - MySQL backup scheduler

SYNOPSIS

mysql-zrm-scheduler --add|--query|--delete|--now
                   [--start <start time>]
                   [--interval <interval>]
                   [--backup-level <0|1>]
                   [--backup-set <backupset name>]
                   [--help]

DESCRIPTION

This tool is part of Zmanda Recovery Manager for MySQL (MySQL ZRM). This tool should be used to schedule MySQL backups using mysql-zrm(1).

During the first time this tool is used to add a MySQL backup, it will also schedule a mysql-zrm purge action to purge mysql-zrm backup files based on retention policy for the backup set. The purge action will take place at 4am daily. See mysql-zrm retention-policy for details.

If --now option is specified, the mysql-zrm-scheduler tool will call mysql-zrm immediately.

OPTIONS

--add

Add a mysql-zrm backup run to the schedule based on the time specified by other options.

--delete

Delete a scheduled backup run. To delete a scheduled run with specific timestamp, add --start option.

--query

Displays list of backup runs scheduled.

--interval <interval>

Valid inputs are daily, weekly or monthly.

--now

Does MySQL backup now.

--backup-set <name>

Specify the backup set for the backup run. Default is BackupSet1.

--backup-level <0|1>

If 0 is specified, then a full backup is done. If 1 is specified, an incremental backup is done. Default is 0.

--start <start time>

time in HH:MM format. Default: 00:00 for monthly, 02:00 for weekly and 03:00 for daily.

--help

Display help message and exit.

EXAMPLES

To schedule a daily mysql-zrm run:

# mysql-zrm-scheduler --add -interval daily

To schedule a daily mysql-zrm run on 1:35pm:

# mysql-zrm-scheduler --add -interval daily --start 13:35

To query mysql-zrm scheduled runs:

# mysql-zrm-scheduler --query

To delete a weekly mysql-zrm run from schedule:

# mysql-zrm-scheduler --delete --interval weekly

To delete a weekly mysql-zrm run which has specific start time from schedule:

# mysql-zrm-scheduler  --delete  --interval  weekly --start 08:20

FILES

/var/lib/mysql-zrm

Directory under which all backup data is stored.

/etc/mysql-zrm/<backup set name>/mysql-zrm.conf

Configuration file read by mysql-zrm tool.

RETURN VALUES

On success, zero is returned. On error, non-zero value is returned.

SEE ALSO

mysql-zrm(1), mysql-zrm-reporter(1), mysql(1), Zmanda Recovery Manager for MySQL (http://mysqlbackup.zmanda.com/)

AUTHOR

Zmanda Inc. (http://www.zmanda.com)