mysql-zrm-scheduler man page

mysql-zrm-scheduler(1)                                  mysql-zrm-scheduler(1)

NNAAMMEE
      mmyyssqqll--zzrrmm--sscchheedduulleerr - backup scheduler utility for ZRM for MySQL

SSYYNNOOPPSSIISS
      mmyyssqqll--zzrrmm--sscchheedduulleerr ----aadddd|----qquueerryy|----ddeelleettee|----nnooww
                      [----ssttaarrtt--ttiimmee _s_t_a_r_t _t_i_m_e]
                      [----ddaayy--ooff--wweeeekk _d_a_y _o_f _w_e_e_k]
                      [----ddaayy--ooff--mmoonntthh _d_a_y _o_f _m_o_n_t_h]
                      [----iinntteerrvvaall _i_n_t_e_r_v_a_l]
                      [----bbaacckkuupp--lleevveell _l_e_v_e_l]
                      [----bbaacckkuupp--sseett _b_a_c_k_u_p_s_e_t _n_a_m_e]
                      [----hheellpp]

DDEESSCCRRIIPPTTIIOONN
      mysql-zrm-scheduler  is  the utility for ZRM for MySQL used to schedule
      MySQL backups using mmyyssqqll--zzrrmm--bbaacckkuupp(1).

      At the scheduled time, this utility will  first  execute  the  optional
      pre-scheduler  plugin (see Pre-Scheduler section) to determine the sys-
      tem load before running the backup. If no pre-scheduler plugin  exists,
      it will directly run the backup.

      mmyyssqqll--zzrrmm--sscchheedduulleerr  also  implements  the  backup retention policy and
      purges backup files. By default, the backup image purge action will  be
      performed  at  4:00am daily. See mysql-zrm-backup(1) ----rreetteennttiioonn--ppoolliiccyy
      parameter for details.

      When ----nnooww option is specified, the  mmyyssqqll--zzrrmm--sscchheedduulleerr  utility  will
      run mysql-zrm immediately.

OOPPTTIIOONNSS
      ----aadddd  Add  a  mmyyssqqll--zzrrmm  backup  run to the schedule based on the time
             specified by other options.

      ----ddeelleettee
             Delete a scheduled backup run. Use the ----ssttaarrtt option to  delete
             a scheduled run with specific time.

      ----qquueerryy
             Display a list of backup runs scheduled.

      ----iinntteerrvvaall _i_n_t_e_r_v_a_l
             Valid options are daily, weekly or monthly. Default: weekly

      ----nnooww  Immediately do the backup of MySQL.

      ----bbaacckkuupp--sseett _n_a_m_e
             Specify the backup set name for the backup run. Default is Back-
             upSet1.

      ----bbaacckkuupp--lleevveell _L_e_v_e_l
             Choose 0 for full backup. Choose 1 for  an  incremental  backup.
             Default is 0.

      ----ssttaarrtt--ttiimmee _s_t_a_r_t _t_i_m_e
             Start  time  for the backup run in HH:MM format.  Default values
             are 00:00 for monthly, 02:00 for  weekly  and  03:00  for  daily
             interval.

      ----ddaayy--ooff--wweeeekk _d_a_y _o_f _w_e_e_k
             Value  used  with weekly interval to specify the day(s) of week.
             Use a single number from 0-6 (0=Sunday, 6=Saturday), or a  range
             of two numbers separated with a hyphen.

             Example: 1, to start on Monday
                      0-2, to start on Sunday, Monday and Tuesday.

             Default value is 0 (Sunday).

      ----ddaayy--ooff--mmoonntthh _d_a_y _o_f _m_o_n_t_h
             Value used with monthly interval to specify the day(s) of month.
             Use a single number from 1-31 or a range of  two  numbers  sepa-
             rated  with  a  hyphen. Interval must be set to "monthly" to use
             this option.

             Example: 2, to start on second day of the month
                      10-12, to start on the 10th, 11th and 12th day  of  the
             month.  Default value is 1 (first day of the month).

      ----hheellpp Display help message and exits.

PPrree--SScchheedduulleerr
      The pre-scheduler plugin has to be specified in mysql-zrm.conf(5).

      mysql-zrm-scheduler calls the specified pre-scheduler plugin before the
      scheduled MySQL backup run.  The plugin should return "0"  to  continue
      to  perform  MySQL backup run immediately. It should return "n" where n
      is a positive integer smaller or equal to 11 to delay the MySQL  backup
      run by "n" hour(s) from the current time.

      Returning  any  number greater than "11" would skip the scheduled MySQL
      backup run.

      mysql-zrm-scheduler skips the daily backup  run  if  the  pre-scheduler
      plugin  does  not find a suitable time (return "0" or "n"") in 24 hours
      (from the initial scheduled start time).

      For weekly or monthly backup run, mysql-zrm-scheduler  will  perform  a
      backup run at the end of the 24 hours (from the initial scheduled start
      time) even if pre-scheduler plugin have not found a  suitable  time  in
      the 24 hours cycle.

      The  pre-scheduler  plugin is used to tell mysql-zrm if a backup should
      happen at a particular time.

      It is to be customized by the user to control if at the scheduled  time
      a  backup  should run or not. For example: a user has scheduled backups
      to happen every night at midnight. But he wants to do delay the  backup
      if  the number of users in the system is more than 5. For this the user
      needs to write a pre-scheduler script that can determine how many users
      are  there  in  the  system and inform the scheduler to go ahead and do
      backup or delay the backup.

EEXXAAMMPPLLEESS
      To schedule a daily mysql-zrm run that starts at 1:35pm:

      ## mmyyssqqll--zzrrmm--sscchheedduulleerr ----aadddd --iinntteerrvvaall ddaaiillyy ----ssttaarrtt 1133::3355

      To schedule a weekly mysql-zrm run on Tuesday and Wednesday:

      ## mmyyssqqll--zzrrmm--sscchheedduulleerr ----aadddd --iinntteerrvvaall wweeeekkllyy ----ddaayy--ooff--wweeeekk 22--33

      To schedule a monthly mysql-zrm run on the tenth day of each month:

      ## mmyyssqqll--zzrrmm--sscchheedduulleerr ----aadddd ----iinntteerrvvaall  mmoonntthhllyy  ----ddaayy--ooff--mmoonntthh  1100  To
      query scheduled runs:

      ## mmyyssqqll--zzrrmm--sscchheedduulleerr ----qquueerryy

      35  13  *  *  * /usr/bin/zrm-pre-scheduler --action backup --backup-set
      BackupSet1 --interval daily

      0 2 * * 2-3  /usr/bin/zrm-pre-scheduler  --action  backup  --backup-set
      BackupSet1  --interval weekly

      0  0  10  *  *  /usr/bin/zrm-pre-scheduler --action backup --backup-set
      BackupSet1 --interval monthly

      To delete a daily mysql-zrm run with specific start time:

      ## mmyyssqqll--zzrrmm--sscchheedduulleerr ----ddeelleettee ----iinntteerrvvaall ddaaiillyy ----ssttaarrtt 0088::2200

FFIILLEESS
      //vvaarr//lliibb//mmyyssqqll--zzrrmm
             Directory under which all backup data is stored.

      //eettcc//mmyyssqqll--zzrrmm//_b_a_c_k_u_p _s_e_t _n_a_m_e//mmyyssqqll--zzrrmm..ccoonnff
             Configuration file read by mysql-zrm utility.

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

SSEEEE AALLSSOO
      mysql-zrm(1),     mysql-zrm-backup(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-ver-
      ify-backup(1),      mysql-zrm-abort-backup(1),       mysql-zrm.conf(5),
      mysql-zrm-reporter(1),   mysql(1),  Zmanda  Recovery  Manager for MySQL
      (http://mysqlbackup.zmanda.com/)

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

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

Referenced By

mysql-zrm(1), mysql-zrm-abort-backup(1), mysql-zrm-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-verify-backup(1).