Welcome to zsm’s documentation!

ZSM is a console program that manages ZFS snapshots.

• Manage multiple sets of rolling snapshots.
• Configure a custom schedule via the config file.
• Run in background by adding it to crontab.

Technically, most of the functionality is in zsm-lib, and zsm is just a thin console interface.

Project status

Alpha but works very well and has great test coverage.

Table of Contents

• Installation
  • PyPI
• Quickstart
  • Step 1: Create config file
  • Step 2: Verify configuration
  • Step 3: Add to crontab
• Configuration file
  • Fields
• Command Line Interface
  • Commands
  • Options to cron command
  • Options to validate-config command
• FAQ
  • How does zsm store its meta data?
  • Will zsm interfere with other snapshots?
  • What happens when removing a snapshot config?
• Changelog
  • Changelog for zsm
  • Changelog for zsm-lib
• Contributing

Indices and tables

• Index
• Search Page