sysutils/zfsnap/pkg-message

   1
   2         To run zfSnap periodically you can add these options to your
   3         /etc/periodic.conf
   4
   5         xPERIODICx_zfsnap_enable        - Enable xPERIODICx snapshots
   6                                           (values: YES | NO)
   7         xPERIODICx_zfsnap_fs            - Space separated zfs filesystems
   8                                           to create non-recursive snapshots
   9         xPERIODICx_zfsnap_recursive_fs  - Space separated zfs filesystems
  10                                           to create recursive snapshots
  11         xPERIODICx_zfsnap_ttl           - Set Time To Live
  12         xPERIODICx_zfsnap_verbose       - Verbose output (values: YES | NO)
  13         xPERIODICx_zfsnap_flags         - zfSnap generic flags
  14                                           (except -v and -d)
  15         xPERIODICx_zfsnap_enable_prefix - Create snapshots with prefix
  16                                           (Default = YES)
  17         xPERIODICx_zfsnap_prefix        - Set prefix to use for new snapshots
  18                                           (Default = "xPERIODICx-")
  19         (where xPERIODICx is any of hourly, daily, weekly, monthly, reboot)
  20
  21         xPERIODICx_zfsnap_delete_enable    - Delete old snapshots periodically
  22                                              (values: YES | NO)
  23         xPERIODICx_zfsnap_delete_flags     - zfSnap generic flags
  24                                              (except -v and -d)
  25         xPERIODICx_zfsnap_delete_verbose   - Verbose output (values: YES | NO)
  26         xPERIODICx_zfsnap_delete_prefixes  - Space separated list of prefixes
  27                                              of old zfSnap snapshots to delete
  28                                              'hourly-', 'daily-', 'weekly-',
  29                                              'monthly-' and 'reboot-' prefixes
  30                                              are hard-coded
  31         (where xPERIODICx is any of daily, weekly, monthly)
  32
  33
  34         Add these lines to your /etc/crontab
  35         4       *       *       *       *       root    periodic hourly
  36         @reboot                                 root    periodic reboot
  37
  38         NOTE: it is not recommended to delete zfSnap snapshots every hour.
  39         Deleting zfs snapshots takes more time than creating them.
  40         There for it's better to delete snapshots once per day...
  41
  42
  43         Periodic scripts provide very limited feature set. If you want to use
  44         more advanced setup, you need to call zfSnap from crontab directly.
  45         This way you can combine all sort of parameter combinations.
  46
  47         Don't forget to check https://github.com/graudeejs/zfSnap/wiki for more
  48         info.
  49
  50         Feedback welcomed: graudeejs@gmail.com