mysql-zrm-backup man page

mysql-zrm-backup(1) mysql-zrm-backup(1)

mmyyssqqll--zzrrmm--bbaacckkuupp - Backup utility for ZRM for MySQL.

[----bbaacckkuupp--sseett _n_a_m_e]
[_B_a_c_k_u_p _S_o_u_r_c_e _O_p_t_i_o_n_s]
[_M_y_S_Q_L _A_c_c_e_s_s _O_p_t_i_o_n_s]
[_B_a_c_k_u_p _M_e_t_h_o_d _O_p_t_i_o_n_s]
[_B_a_c_k_u_p _D_e_s_t_i_n_a_t_i_o_n _O_p_t_i_o_n_s]
[_L_o_g_g_i_n_g _a_n_d _N_o_t_i_f_i_c_a_t_i_o_n _O_p_t_i_o_n_s]
[----ooppttiioonnss--ffiillee _c_o_n_f___f_i_l_e]

BBaacckkuupp SSoouurrccee SSyynnooppssiiss
[----aallll--ddaattaabbaasseess] | [----ddaattaabbaasseess "_d_b_n_a_m_e_1 _d_b_n_a_m_e_2"...] |
[----ddaattaabbaassee "_n_a_m_e" [----ttaabblleess _t_n_a_m_e_1 _t_n_a_m_e_2 ...]]
[----eexxcclluuddee--ppaatttteerrnn _p_a_t_t_e_r_n]
[----rroouuttiinneess | ----nnoo--rroouuttiinneess]
[----mmyyssqqll--bbiinnppaatthh _M_y_S_Q_L___c_o_m_m_a_n_d___d_i_r]
[----mmyyssqqll--bbiinnlloogg--ppaatthh _M_y_S_Q_L___b_i_n_a_r_y___l_o_g___d_i_r]

MMyySSQQLL AAcccceessss SSyynnooppssiiss
[----uusseerr _u_s_e_r]
[----ppaasssswwoorrdd _p_a_s_s_w_o_r_d]
[----hhoosstt _h_o_s_t_n_a_m_e]
[----ppoorrtt _p_o_r_t_n_u_m_b_e_r]
[----ssoocckkeett _n_a_m_e]
[----ssssll--ooppttiioonnss _"_M_y_S_Q_L _s_s_l _o_p_t_i_o_n_s_"]
[----ssiinnggllee--ttrraannssaaccttiioonn [aallwwaayyss|nneevveerr|oonnllyy--iinnnnooddbb]]
[----eexxttrraa--mmyyssqqlldduummpp--ooppttiioonnss _m_y_s_q_l_d_u_m_p___o_p_t_i_o_n_s]
[----eexxttrraa--mmyydduummppeerr--ooppttiioonnss _m_y_d_u_m_p_e_r___o_p_t_i_o_n_s]

CCoommpprreessssiioonn aanndd EEnnccrryyppttiioonn SSyynnooppssiiss
[----ccoommpprreessss | ----nnoo--ccoommpprreessss ]
[----ccoommpprreessss--mmyyssqqlldduummpp--oonntthheeffllyy | ----nnoo--ccoommpprreessss--mmyyssqqll--
[----ccoommpprreessss--pplluuggiinn _p_l_u_g_i_n___n_a_m_e]
[----nnoo--eennccrryypptt | ----eennccrryypptt]
[----eennccrryypptt--pplluuggiinn pplluuggiinn__nnaammee [----ddeeccrryypptt--ooppttiioonn
[----ppaassssffiillee _f_i_l_e_n_a_m_e]

PPlluuggiinn SSyynnooppssiiss
[----pprree--bbaacckkuupp--pplluuggiinn _p_l_u_g_i_n]
[----pprree--bbaacckkuupp--pplluuggiinn--ooppttiioonnss _"_o_p_t_i_o_n_1 _o_p_t_i_o_n_2 _._._._"]
[----ccooppyy--pplluuggiinn _p_l_u_g_i_n]
[----sssshh--uusseerr _u_s_e_r]
[----sssshh--iiddeennttiittyy--ffiillee _f_i_l_e_n_a_m_e]
[----rreemmoottee--mmyyssqqll--bbiinnppaatthh _p_a_t_h]
[----ssoocckkeett--rreemmoottee--ppoorrtt _p_o_r_t]
[----ppoosstt--bbaacckkuupp--pplluuggiinn _p_l_u_g_i_n]
[----ppoosstt--bbaacckkuupp--pplluuggiinn--ooppttiioonnss _"_o_p_t_i_o_n_1 _o_p_t_i_o_n_2 _._._._"]

BBaacckkuupp MMeetthhoodd SSyynnooppssiiss
[----bbaacckkuupp--lleevveell _l_e_v_e_l]
[----bbaacckkuupp--mmooddee rraaww | llooggiiccaall]
[----llooggiiccaall--ppaarraalllleell 00 | 11]
[----ssyynncchhrroonnoouuss--cchheecckkssuumm | ----nnoo--ssyynncchhrroonnoouuss--cchheecckkssuumm]
[----rreepplliiccaattiioonn | ----nnoorreepplliiccaattiioonn]
[----rreetteennttiioonn--ppoolliiccyy _b_a_c_k_u_p___r_e_t_e_n_t_i_o_n___t_i_m_e]
[----ddeeffaauulltt--cchhaarraacctteerr--sseett _c_h_a_r___s_e_t___n_a_m_e]

SSnnaappsshhoott PPlluuggiinn SSyynnooppssiiss
[----cchheecckk--iinnnnooddbb | ----nnoo--cchheecckk--iinnnnooddbb]
[----bbaacckkuupp--ttyyppee rreegguullaarr|----bbaacckkuupp--ttyyppee qquuiicckk]]

[----ssnnaappsshhoott--ssiizzee _s_i_z_e]

(no options necessary)

BBaacckkuupp DDeessttiinnaattiioonn SSyynnooppssiiss
[----bbaacckkuupp--nnaammee _i_m_a_g_e___n_a_m_e]
[----ddeessttiinnaattiioonn _d_i_r___p_a_t_h]
[----ttmmppddiirr _t_e_m_p___d_i_r

LLooggggiinngg aanndd NNoottiiffiiccaattiioonn SSyynnooppssiiss
[----mmaaiillttoo _a_d_d_r_e_s_s]
[----mmaaiill--ppoolliiccyy _a_l_w_a_y_s_|_n_e_v_e_r_|_o_n_l_y_-_o_n_-_e_r_r_o_r]
[----ccoommmmeenntt "_c_o_m_m_e_n_t _s_t_r_i_n_g"]

ZRM for MySQL provides automated scheduling of live MySQL database
backup. You only need to configure it once to reflect the MySQL deploy-
ment, then schedule it to run unattended backups. Various options can
help an administrator:

* Verify the backups created.

* Generate various types of reports about the backups created.

* Specify compression and encryption as desired.

* Report information about the backups via an email or RSS feed.

* Access pre- and post- backup plugins to extend the suite further.

* Control full and selective restore operations on the database, both
locally and remotely.

mmyyssqqll--zzrrmm--bbaacckkuupp provides the core backup functions of ZRM for MySQL

Use the mmyyssqqll--zzrrmm..ccoonnff(5) configuration file to set mmyyssqqll--zzrrmm--bbaacckkuupp
options described on this page. Use the ----aaccttiioonn cchheecckk option to ver-
ify the configuration of mmyyssqqll--zzrrmm--bbaacckkuupp.

Use mmyyssqqll--zzrrmm--bbaacckkuupp to create full or incremental backups of MySQL

To display help on individual action options, append the --help option
to the command line. For example: ’mysql-zrm-backup --options-file

ZRM for MySQL organizes backups into Backup Sets. Each backup set
defines the list of databases or tables within a database, how it
should be backed up and the backup schedule for the data. Backup sets
are identified by a unique name.

Every backup run (each time mmyyssqqll--zzrrmm is executed) is associated with
one backup set. Various parameters can be associated with each backup

mmyyssqqll--zzrrmm first reads the global configuration file
(//eettcc//mmyyssqqll--zzrrmm//mmyyssqqll--zzrrmm..ccoonnff). The global configuration file can be
overridden by backup set specific configuration file stored in
//eettcc//mmyyssqqll--zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e directory. The mmyyssqqll--zzrrmm command line
options will override the parameters specified in the configuration

mmyyssqqll--zzrrmm backups can be either full or incremental. Full backups can
be logical backups or raw backups. Logical backups contain SQL state-
ments to recreate the database. Raw backups are actual copies of the
database files.

When logical backup is specified, the utility uses only mmyyssqqlldduummpp for
backing up specified databases and tables.

When raw backup is specified, the utility has the ability to decide
which backup mechanism to use for a particular database. If there are
no transactional storage engine based tables in the specified database,
then it uses mmyyssqqllhhoottccooppyy for backing up that database. Otherwise, it
uses mmyyssqqlldduummpp for backing up the specified database.

Snapshot backups are discussed in the Snapshot Options section of this
man page.

When rreepplliiccaattiioonn is specified and if the MySQL server is a replication
slave, then it will also backup all replication related files.

When ddeessttiinnaattiioonn specified then the backups are stored in a sub-direc-
tory under the specified directory. Default path is //vvaarr//lliibb//mmyyssqqll--zzrrmm.
If the destination specified does not exist, it will return an error
and exit; the utility does not create the directory.

An index file is also created in the backup directory. The index is a
file that contains the details of what was backed up, how much data was
backed up, what parameters were used to backup the data, how much time
it took to backup etc.

When an incremental backup is specified, the following options are







You can select a backup set by name on the command line, or select
source database(s), backup methods, plugins, etc. by using the options
described in the Options subsections that follow. You can also specify
mysql-zrm-backup options in a configuration file specified using the
----ooppttiioonnss switch.

----bbaacckkuupp--sseett _n_a_m_e
Specify backup-set for the backup run. This is a Command line
option only and cannot be specified in the configuration file.
The default value is _B_a_c_k_u_p_S_e_t_1. If such a value is already
present, it will be used.

----ooppttiioonnss--ffiillee _c_o_n_f___f_i_l_e
Set the file along with full pathname that contains
mmyyssqqll--zzrrmm--bbaacckkuupp configuration options; this file has the same
format as mmyyssqqll--zzrrmm..ccoonnff(5).

----hheellpp Displays the help message and exits. This command-line-only
parameter cannot be specified in the configuration file.

BBaacckkuupp SSoouurrccee OOppttiioonnss
Opt for all databases to be backed up or restored. This is the
default if _d_a_t_a_b_a_s_e or _d_a_t_a_b_a_s_e_s are not specified.

----ddaattaabbaasseess _"_n_a_m_e_1 _n_a_m_e_2 _._._._"
List the databases to backup or restore.

----ddaattaabbaassee _n_a_m_e [----ttaabblleess "_n_a_m_e_1 _n_a_m_e_2 _._._."]
List the tables that should be backed up. This option is valid
during the backup operation only.

----eexxcclluuddee--ppaatttteerrnn _"_p_a_t_t_e_r_n_"
All databases or tables that match the _p_a_t_t_e_r_n are not backed
up. If ----aallll--ddaattaabbaasseess or ----ddaattaabbaasseess are specified, the exclude
pattern applies to database names. If ----ddaattaabbaassee is specified,
the exclude pattern applies to table names. Wildcard characters
_* (match one or more characters), _? (match one character), _[_]
(match one of the characters specified within parenthesis) and _|
(match one of the patterns) are supported. For example: Exclude
pattern "*_db|dbase[123]|abcd" will match names tom_db, dbase1,
dbase2, abcd. All tables or databases that match this pattern
will be excluded. Character _# is not permitted in the exclude

If ----rroouuttiinneess is specified then mysqldump will dump stored rou-
tines. The default is ----nnoo--rroouuttiinneess. This parameter is optional.

----mmyyssqqll--bbiinnppaatthh _m_y_s_q_l___c_o_m_m_a_n_d___d_i_r
Set the full path where mysql binary commands are installed.
For example: //oopptt//llaammpppp//bbiinn.

----mmyyssqqll--bbiinnlloogg--ppaatthh _m_y_s_q_l___b_i_n_a_r_y___l_o_g___l_o_c_a_t_i_o_n
Set the full path of the location of mysql binary logs. For
example: //vvaarr//lloogg//mmyyssqqll

Intended for configuration file backup, this optional parameter
lets you specify a list of files to backup during a full backup
of any type (snapshot, logical, or raw). The _l_i_s_t___f_i_l_e___p_a_t_h is
the path to the file that contains the list of configuration
files to back up. The list itself should specify full pathnames,
separated by newlines.

The config-file-list is processed after the main data has been
backed up, and the list file itself is copied to the destination
directory along with the configuration files. The backup index
will record the config-file-list parameter.

Files specified by config-file-list will be restored during a
full restore to their original locations, preserving permissions
and ownership.

MMyySSQQLL AAcccceessss OOppttiioonnss
----uusseerr _u_s_e_r
Specify MySQL backup/restore user on the MySQL server. If no
user is specified here, ensure that you have the MySQL user
specified in the mmyy..ccnnff or ----ooppttiioonnss file has the necessary

----ppaasssswwoorrdd _p_a_s_s_w_o_r_d
Specify password for the MySQL user. If you wish to prevent the
password from being sent in plaintext over the network, you may
wish to configure the MySQL username and password using the
MySQL mmyy..ccnnff or ----ooppttiioonnss file.

----hhoosstt _h_o_s_t_n_a_m_e
Specify MySQL server host name or IP name.

----ppoorrtt _p_o_r_t_n_u_m_b_e_r
Specify MySQL server port.

----ssoocckkeett _n_a_m_e
Specify socket file to use for communication with MySQL server.

----ssssll--ooppttiioonnss "_M_y_S_Q_L _s_s_l _o_p_t_i_o_n_s"
Set any ----ssssll** options that MySQL supports. Refer to MySQL Docu-
mentation for SSL options details.

----ssiinnggllee--ttrraannssaaccttiioonn [aallwwaayyss|nneevveerr|oonnllyy--iinnnnooddbb]
The ssiinnggllee--ttrraannssaaccttiioonn option controls under what circumstances
MySQL for ZRM will pass the ----ssiinnggllee--ttrraannssaaccttiioonn ooppttiioonn sseettttiinngg
ttoo mmyyssqqlldduummpp when executing a database dump. Specifying aallwwaayyss
causes ----ssiinnggllee--ttrraannssaaccttiioonn to always be passed, nneevveerr causes
the ----ssiinnggllee--ttrraannssaaccttiioonn to never be passed, and oonnllyy--iinnnnooddbb
specifies that ----ssiinnggllee--ttrraannssaaccttiioonn will only be passed during
innodb-only backups. For example, if oonnllyy--iinnnnooddbb is specified,
the ----ssiinnggllee--ttrraannssaaccttiioonn wwiillll nnoott bbee ppaasssseedd ffoorr bbaacckkuuppss tthhaatt
iinncclluuddee mmyyiissaamm oorr ootthheerr nnoonn--ttrraannssaaccttiioonnaall ttaabblleess..

----eexxttrraa--mmyyssqqlldduummpp--ooppttiioonnss=="" _m_y_s_q_l_d_u_m_p___o_p_t_i_o_n_s""
Use this to pass any extra mmyyssqqlldduummpp options when ZRM for MySQL
executes a mmyyssqqlldduummpp_. _F_o_r _e_x_a_m_p_l_e_, _i_f _y_o_u _r_e_q_u_i_r_e mmyyssqqlldduummpp to
be run with the ----fflluusshh--llooggss and ----nnoo--ccrreeaattee--iinnffoo options, spec-
ify ----eexxttrraa--mmyyssqqlldduummpp--ooppttiioonnss==""----fflluusshh--llooggss ----nnoo--ccrreeaattee--iinnffoo"" in
the mysql-zrm.conf file.

----eexxttrraa--mmyydduummppeerr--ooppttiioonnss=="" _m_y_d_u_m_p_e_r___o_p_t_i_o_n_s""
Use this to pass any extra mmyydduummppeerr options when ZRM for MySQL
executes a mmyydduummppeerr_. _F_o_r _e_x_a_m_p_l_e_, _i_f _y_o_u _r_e_q_u_i_r_e mmyydduummppeerr to be
run with the ----tthhrreeaaddss and ----rreeggeexx options, specify
----eexxttrraa--mmyydduummppeerr--ooppttiioonnss==""----tthhrreeaaddss==44 ----rreeggeexx==’’RReegguullaarr eexxpprreess--
ssiioonn ffoorr ’’ddbb..ttaabbllee’’ mmaattcchhiinngg’’"" in the mysql-zrm.conf file.

BBaacckkuupp MMeetthhoodd OOppttiioonnss
----bbaacckkuupp--lleevveell _l_e_v_e_l
Choose 0 for full backup. Choose 1 for incremental back up.
Default is full backup.

----bbaacckkuupp--mmooddee rraaww|llooggiiccaall
Database/tables that use a transactional engine cannot be backed
up by mmyyssqqlldduummpp. They should be backed up by mmyyssqqllhhoottccooppyy.
Choose rraaww to use mmyyssqqllhhoottccooppyy to back up the database/tables
that use a transactional engine. Choose llooggiiccaall to use mmyyssqqll--
dduummpp to back up the database/tables that don’t use a transac-
tional engine. Default value is rraaww.

----llooggiiccaall--ppaarraalllleell |11
Choose 0 for mysqldump backup. Choose 1 for mydumper muti-thread
logical back up. Default is mydsqldump backup.

----ssyynncchhrroonnoouuss--cchheecckkssuumm | ----nnoo--ssyynncchhrroonnoouuss--cchheecckkssuumm
Specifies whether a checksum should be produced during the
backup process. Default is nnoo--ssyynncchhrroonnoouuss--cchheecckkssuumm, in which
case the checksum is produced only after the backup process is
complete. Specifying ----ssyynncchhrroonnoouuss--cchheecckkssuumm significantly
increases overall backup times.

----rreepplliiccaattiioonn | ----nnoorreepplliiccaattiioonn
Choose replication to backup replication files. They will be
backed up only if the host is a replication slave. Default
option is ----nnoorreepplliiccaattiioonn.

----ddeeffaauulltt--cchhaarraacctteerr--sseett _c_h_a_r___s_e_t___n_a_m_e
The default character set that mysqldump should use. If not
specified utf8 is used. This parameter is optional.

If the value is set to 1, the backup is compressed when it
transferred from MySQL server to ZRM server. Setting the value
to zero, no compression is performed. No compression is per-
formed by default. Data compression during transfer is indepen-
dent of the Backup compression parameter.

PPlluuggiinn OOppttiioonnss
----pprree--bbaacckkuupp--pplluuggiinn _p_l_u_g_i_n
(Optional) Specify the plugin along with full pathname to be
called before a backup run. All pre-backup plugin scripts must
accept the following command-line parameters (which are passed
to the plugin using ----pprree--bbaacckkuupp--pplluuggiinn--ooppttiioonnss:

Use when all databases on the server are being backed up.

----ddaattaabbaassee _d_a_t_a_b_a_s_e_1 _d_a_t_a_b_a_s_e_2......
Use when selected databases are being backed up.

----ddaattaabbaassee ddaattaabbaassee ----ttaabblleess ttaabbllee11 ttaabbllee22......
Use if selected tables are being backed up.

The script should be written to return a non-zero value on
error; pre-backup plugin failures should cancel the backup and
generate a failure message for reports and logs.

----pprree--bbaacckkuupp--pplluuggiinn--ooppttiioonnss ""_o_p_t_i_o_n_1 _o_p_t_i_o_n_2...""
Pass options to the pprree--bbaacckkuupp--pplluuggiinn as one of the command line

----ccooppyy--pplluuggiinn _p_l_u_g_i_n
Specify plugin along with full pathname to be used for transfer-
ring backup files to and from a remote MySQL server to the
machine running ZRM for MySQL. Use this option when
1. remote incremental backup is required
2. copying replication related files from a remote machine
3. execute mmyyssqqllhhoottccooppyy (MySQL command) and copy the data
from the remote machine
4. restore data to a remote machine using mmyyssqqllhhoottccooppyy(MySQL
command). This parameter is optional.

----sssshh--uusseerr _u_s_e_r
Specifies the user to be used for SSH. This parameter is only
used by the ssh-copy.pl plugin. The user specified should either
be the user mmyyssqqlldd runs as or root. If not specified the default
value used is mmyyssqqll. This parameter is optional.

----sssshh--iiddeennttiiffyy--ffiillee _f_i_l_e_n_a_m_e
Selects a file from which the identity (private key) for RSA or
DSA authentication is read. This identity file is used by the
ssh-copy.pl plugin for authentication.

----rreemmoottee--mmyyssqqll--bbiinnppaatthh _p_a_t_h
Full path where mysql binaries are installed on the remote
machine. For example: //oopptt//llaammpppp//bbiinn. This parameter is only
used by the socket-copy.pl and ssh-copy.pl plugins. If not spec-
ified, the default value used is //uussrr//bbiinn.

----ssoocckkeett--rreemmoottee--ppoorrtt _p_o_r_t
Port that the socket-plugin.pl should use to connect. This
parameter is only used by the socket-copy.pl plugin. If not
specified the default value used is 25300. This parameter is

----ppoosstt--bbaacckkuupp--pplluuggiinn _p_l_u_g_i_n
Set the plugin along with full pathname to be called after a
backup run. If synchronous-checksum is not set or its value is
set to zero, the post backup plugin is called twice, once at the
end of backup and once when the checksum is finished.

----ppoosstt--bbaacckkuupp--pplluuggiinn--ooppttiioonnss ""_O_p_t_i_o_n_1 _O_p_t_i_o_n_2 _O_p_t_i_o_n_3 _O_p_t_i_o_n_4...""
_o_p_t_i_o_n_1 is the value of ppoosstt--bbaacckkuupp--pplluuggiinn--ooppttiioonnss from the
mmyyssqqll--zzrrmm..ccoonnff(5) file. _o_p_t_i_o_n_2 is the data being backed up. It
will be either

Use when all databases on the server are being backed up.

----ddaattaabbaassee _d_a_t_a_b_a_s_e_1 _d_a_t_a_b_a_s_e_2......
Use when selected databases are being backed up.

----ddaattaabbaassee ddaattaabbaassee ----ttaabblleess ttaabbllee11 ttaabbllee22......
Use if selected tables are being backed up.

_O_p_t_i_o_n_3 will be ----bbaacckkuupp--ddiirreeccttoorryy _p_a_t_h

_O_p_t_i_o_n_4 will be ----cchheecckkssuumm--ppeennddiinngg or it will be ----cchheecckkssuumm--ffiinn--
iisshheedd if synchronous-checksum is set to 1.

If synchronous-checksum is not set or its value is set to zero,
the post-backup-plugin is called again and it will have 3 param-
eters First parameter is the value of ppoosstt--bbaacckkuupp--pplluuggiinn--ooppttiioonnss
from the mmyyssqqll--zzrrmm..ccoonnff(5) configuration file. Second parameter
will be ----bbaacckkuupp--ddiirreeccttoorryy _p_a_t_h. Third parameter will be

CCoommpprreessssiioonn aanndd EEnnccrryyppttiioonn OOppttiioonnss
----ccoommpprreessss | ----nnoo--ccoommpprreessss
Choose whether the files should be compressed using the utility
specified by the ----ccoommpprreessss--pplluuggiinn. The default is

----ccoommpprreessss--mmyyssqqlldduummpp--oonntthheeffllyy | ----nnoo--ccoommpprreessss--mmyyssqqlldduummpp--oonntthheeffllyy
Choose whether to compress the data dumped by mmyyssqqlldduummpp on the
fly. Default compression command used is ggzziipp. Default is no
compression on the fly.

----ccoommpprreessss--pplluuggiinn _p_l_u_g_i_n___n_a_m_e
Use _p_l_u_g_i_n___n_a_m_e to specify a path to the utility to use for com-
pression. The default is ggzziipp.

----nnoo--eennccrryypptt | ----eennccrryypptt
Choose whether the files should be encrypted using the utility
specified by the ----eennccrryypptt--pplluuggiinn. The default is ----nnoo--eennccrryypptt.

----eennccrryypptt--pplluuggiinn pplluuggiinn__nnaammee [----ddeeccrryypptt--ooppttiioonn [_o_p_t_i_o_n]
Use pplluuggiinn__nnaammee to specify a utility to use for compression
along with its full path. If ddeeccrryypptt--ooppttiioonn is not specified
then the --dd option of encrypt-plugin is used for decrypting.

----ppaassssffiillee _f_i_l_e_n_a_m_e

SSnnaappsshhoott PPlluuggiinn OOppttiioonnss
Specifies the plugin to be used for snapshot operations. The
default is the lvm-snapshot plugin.

[----cchheecckk--iinnnnooddbb | ----nnoo--cchheecckk--iinnnnooddbb]
Specifies whether to check for iinnnnooddbb shared data and log files
to back up during every snapshot-based based backup. If
----cchheecckk--iinnnnooddbb is specified, iinnnnooddbb shared data and logs are
only backed up if the databases being backed up use iinnnnooddbb. If
----nnoo--cchheecckk--iinnnnooddbb is specified (the default), the iinnnnooddbb
databases and logs are backed up regardless of whether they are
relevant. The default value is ----nnoo--cchheecckk--iinnnnooddbb, which means
iinnnnooddbb shared data and logs are always copied if the iinnnnooddbb
engine is enabled in MySQL. In most cases, ----nnoo--cchheecckk--iinnnnooddbb
provides the best performance.

----ssnnaappsshhoott--ssiizzee _s_i_z_e
Set the size of the llvvmm--ssnnaappsshhoott to be generated. For rraaww back-
ups, each specified database is first checked ensure that it is
on a LVM volume, and then a snapshot of the specified size is
created and used to backup the database. If the specified
database is not on a LVM volume, either mmyyssqqllhhoottccooppyy or mmyyssqqll--
dduummpp will be used to create the backup based on the logic speci-
fied by the ----bbaacckkuupp--mmooddee option. This option is ignored if the
----bbaacckkuupp--mmooddee is llooggiiccaall.

----bbaacckkuupp--ttyyppee rreegguullaarr|----bbaacckkuupp--ttyyppee qquuiicckk
Choose the method of snapshot backup. The rreegguullaarr option speci-
fies that the snapshot should be copied into a standard ZRM for
MySQL backup archive. The qquuiicckk option specifies that the snap-
shot itself should be used as a near-line backup. Quick backups
are convenient as they provide near-instantaneous restores, but
because they remain on the MySQL server they do not protect
against media or server failure. Note that if the ’’’quick’’’
option is specified, the ’’’compress’’’ and ’’’encrypt’’’
options are ignored, and the backup size will always be zero. In
addition, no checksums are performed, which means that quick
snapshot backups cannot be verified.

BBaacckkuupp DDeessttiinnaattiioonn OOppttiioonnss
----bbaacckkuupp--nnaammee _i_m_a_g_e___n_a_m_e
Specify a unique name to store the backup. If a name is not
specified or it already exists in the ----ddeessttiinnaattiioonn _d_i_r_p_a_t_h (see
the next option), the backup image will be named with the cur-
rent date and time.

----ddeessttiinnaattiioonn _d_i_r___p_a_t_h
Specify the directory to store the backup. The default location
is //vvaarr//lliibb//mmyyssqqll--zzrrmm//. If a directory other than the default is
specified, you must create it manually on both the MySQL server
and the ZRM server, and it must have permissions set to allow
read/write access to the mysql backup user.

LLooggggiinngg aanndd NNoottiiffiiccaattiioonn OOppttiioonnss
----mmaaiillttoo _a_d_d_r_e_s_s
Set the address to which a backup report will be sent.

----mmaaiill--ppoolliiccyy _a_l_w_a_y_s_|_n_e_v_e_r_|_o_n_l_y_-_o_n_-_e_r_r_o_r
Mail policy determines when email notification should be sent.
The value _a_l_w_a_y_s is the default value and email notification is
sent for all events. If the mail policy is set to _n_e_v_e_r, email
notification is not sent for all events. If the mail policy is
set to _o_n_l_y_-_o_n_-_e_r_r_o_r, notification is sent when there is a
backup failure if mmaaiillttoo is specified.

----ccoommmmeenntt "_C_o_m_m_e_n_t _s_t_r_i_n_g"
Insert a comment or a note about the backup run. This can be
used to tag backup runs and the note can retrieved using the
mmyyssqqll--zzrrmm--rreeppoorrtteerr(1) utility.

----qquuiieett | ----nnoo--qquuiieett
Choose quiet to suppress display of log messages on stdout.
Choose _n_o_-_q_u_i_e_t to display the log messages stdout. Default is

Provide verbose output in the log. Default is that verbose is
turned off and a terse output is generated.


Default directory for storing all backup data.

//eettcc//mmyyssqqll--zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e//mmyyssqqll--zzrrmm..ccoonnff
Default location for the backup-set configuration file used by
the mmyyssqqll--zzrrmm--bbaacckkuupp utility.

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

mysql-zrm(1), mysql-zrm-manage-backup(1), mysql-zrm-restore(1),
mysql-zrm-check(1), mysql-zrm-list(1), mysql-zrm-getconf(1),
mysql-zrm-setconf(1), mysql-zrm-parse-binlogs(1), mysql-zrm-purge(1),
mysql-zrm-extract-backup(1), mysql-zrm-verify-backup(1),
mysql-zrm-abort-backup(1), mysql-zrm-scheduler(1),
mysql-zrm-reporter(1), mysql-zrm.conf(5), mysqldump(1), mysqlbinlog(1),
mysql(1), lvm(8), Zmanda Recovery Manager for MySQL (http://mysql-

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

Zmanda, Inc. ZRM for MySQL mysql-zrm-backup(1)

Referenced By

mysql-zrm(1), mysql-zrm-abort-backup(1), mysql-zrm-check(1), mysql-zrm.conf(5), mysql-zrm-extract-backup(1), mysql-zrm-list(1), mysql-zrm-parse-binlogs(1), mysql-zrm-purge(1), mysql-zrm-restore(1), mysql-zrm-scheduler(1), mysql-zrm-verify-backup(1).

Explore man page connections for mysql-zrm-backup(1).