Mysql-zrm.conf: Difference between revisions

From wiki.zmanda.com
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==NAME==
==NAME==
     
 
mysql-zrm.conf - Configuration file for ZRM for MySQL
mysql-zrm.conf - Configuration file for ZRM for MySQL


Line 6: Line 6:


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


==DESCRIPTION==
==DESCRIPTION==


The configuration file ''mysql-zrm.conf'' stores all global ZRM parameters for ZRM for MySQL suite. Parameters can be made specific to a backup set by specifying them in the ''mysql-zrm.conf'' under ''/etc/mysql-zrm/<backup set name>/'' directory. Global parameters are default values, but specific parameters in a backup set directory over ride the default values and command line parameters override them.
The configuration file mysql-zrm.conf stores site-wide (or backup-set specific) parameters that control operation of the ZRM for MySQL suite. Custom  parameters  can be associated with a particular backup set by specifying     them in a mysql-zrm.conf file stored  in  a /etc/mysql-zrm/<backup set name>/   directory,   or  by specifying  an --options  conf_file  on  most of the command line  utilities.  Parameters (and --options)  specified on the command line override both site-wide and  backup-set  specific parameters. Note that if certain  parameters are not specified in the the site-wide  mysql-zrm.conf file, ZRM for MySQL suite can also use the MySQL options file (my.cnf)
 
parameters.
If parameters are not specified in global ''mysql-zrm.conf'' file, ZRM for MySQL suite can also use MySQL client options file (''my.cnf'') parameters.


===SYNTAX===
===SYNTAX===


This section describes  the configuration  file syntax for all ''mysql-zrm.conf'' configuration files.
This section describes  the  syntax   for   mysql-zrm.conf configuration file. All parameters are specified as


All parameters are specified as
<parameter>=<value>


      <parameter>=<value>
All  parameters are optional; if a parameter is not specified, an appropriate ’factory default’ is applied.


All parameters are optional and have default values.
All white space is ignored unless quoted. All lines   beginning with # are treated as comments (i.e., they are ignored).
 
All white spaces are ignored unless it is within quotes. All lines beginning with # are comments and are ignored.


Parameters can be:
Parameters can be:


; Backup parameters : comment, backup-level, backup-mode, lvm-snapshot, destination, retention-policy, replication, compress, compress-plugin, encrypt, encrypt-plugin, decrypt-option.
; Backup parameters : comment,   backup-level, backup-mode, lvm-snapshot,   destination,     retention-policy, replication, compress, compress-plugin, encrypt, encrypt-plugin, decrypt-option


; Database parameters : all-databases, databases, tables, database
; Database parameters : all-databases, databases, tables, database


; MySQL server parameters : user, password, host, port, socket, ssl-options, mysql-binpath, mysql-binlogpath, tmpdir
; MySQL server parameters : user, password, host, port, socket, ssl-options, ndb-connectstring, mysql-binpath, mysql-binlogpath, tmpdir


; ZRM parameters : verbose, mailto, html-report-directory, html-reports, webserver-url, rss-header-location
; ZRM   parameters :   verbose,   mailto,   html-report-directory, html-reports, webserver-url, rss-header-location


; ZRM plugin parameters : copy-plugin, pre-backup-plugin, pre-backup-plugin-options, post-backup-plugin, post-backup-plugin-options, pre-scheduler-plugin, passfile, ssh-user, remote-mysql-binpath, socket-remote-port
; ZRM plugin parameters : copy-plugin,   pre-backup-plugin, pre-backup-plugin-options, post-backup-plugin, post-backup-plugin-options, pre-scheduler-plugin, passfile, ssh-user, remote-mysql-binpath, socket-remote-port


Description of these parameters and their values are available in [[mysql-zrm]](1) and [[Zmanda_Recovery_Manager_for_MySQL|Zmanda Recovery  Manager  for  MySQL manual]].
Description of ZRM for MySQL parameters and their values are available in [[mysql-zrm]](1).


==FILES==
==FILES==
; /etc/mysql-zrm/mysql-zrm.conf : Global configuration file
; /etc/mysql-zrm/mysql-zrm.conf : Global configuration file


; /etc/mysql-zrm/<backup set name>/mysql-zrm.conf : Backup set specific configuration file.
; /etc/mysql-zrm/backup set name/mysql-zrm.conf : Configuration file ZRM for MySQL.


==SEE ALSO==
==SEE ALSO==
[[mysql-zrm-scheduler]](1), [[mysql-zrm-reporter]](1), [[mysql-zrm]](1), [[Zmanda_Recovery_Manager_for_MySQL|Zmanda Recovery  Manager  for  MySQL]].
 
[[mysql-zrm]](1), [[mysql-zrm-backup]](1), [[mysql-zrm-restore]](1), [[mysql-zrm-check]](1), [[mysql-zrm-list]](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).


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

Revision as of 21:14, 31 March 2008

NAME

mysql-zrm.conf - Configuration file for ZRM for MySQL

SYNOPSIS

/etc/mysql-zrm/mysql-zrm.conf

/etc/mysql-zrm/backup_set_name/mysql-zrm.conf

DESCRIPTION

The configuration file mysql-zrm.conf stores site-wide (or backup-set specific) parameters that control operation of the ZRM for MySQL suite. Custom parameters can be associated with a particular backup set by specifying them in a mysql-zrm.conf file stored in a /etc/mysql-zrm/<backup set name>/ directory, or by specifying an --options conf_file on most of the command line utilities. Parameters (and --options) specified on the command line override both site-wide and backup-set specific parameters. Note that if certain parameters are not specified in the the site-wide mysql-zrm.conf file, ZRM for MySQL suite can also use the MySQL options file (my.cnf) parameters.

SYNTAX

This section describes the syntax for mysql-zrm.conf configuration file. All parameters are specified as 

<parameter>=<value>

All parameters are optional; if a parameter is not specified, an appropriate ’factory default’ is applied.

All white space is ignored unless quoted. All lines beginning with # are treated as comments (i.e., they are ignored).

Parameters can be:

Backup parameters
comment, backup-level, backup-mode, lvm-snapshot, destination, retention-policy, replication, compress, compress-plugin, encrypt, encrypt-plugin, decrypt-option
Database parameters
all-databases, databases, tables, database
MySQL server parameters
user, password, host, port, socket, ssl-options, ndb-connectstring, mysql-binpath, mysql-binlogpath, tmpdir
ZRM parameters
verbose, mailto, html-report-directory, html-reports, webserver-url, rss-header-location
ZRM plugin parameters
copy-plugin, pre-backup-plugin, pre-backup-plugin-options, post-backup-plugin, post-backup-plugin-options, pre-scheduler-plugin, passfile, ssh-user, remote-mysql-binpath, socket-remote-port

Description of ZRM for MySQL parameters and their values are available in mysql-zrm(1).

FILES

/etc/mysql-zrm/mysql-zrm.conf
Global configuration file
/etc/mysql-zrm/backup set name/mysql-zrm.conf
Configuration file ZRM for MySQL.

SEE ALSO

mysql-zrm(1), mysql-zrm-backup(1), mysql-zrm-restore(1), mysql-zrm-check(1), mysql-zrm-list(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).

AUTHOR

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

Retrieved from ‘http://wiki.zmanda.com/index.php?title=Mysql-zrm.conf&oldid=5760’