.. _snap-schedule: ========================== Snapshot Scheduling Module ========================== This module implements scheduled snapshots for CephFS. It provides a user interface to add, query and remove snapshots schedules and retention policies, as well as a scheduler that takes the snapshots and prunes existing snapshots accordingly. How to enable ============= The *snap_schedule* module is enabled with:: ceph mgr module enable snap_schedule Usage ===== This module uses :doc:`/dev/cephfs-snapshots`, please consider this documentation as well. This module's subcommands live under the `ceph fs snap-schedule` namespace. Arguments can either be supplied as positional arguments or as keyword arguments. Once a keyword argument was encountered, all following arguments are assumed to be keyword arguments too. Snapshot schedules are identified by path, their repeat interval and their start time. The repeat interval defines the time between two subsequent snapshots. It is specified by a number and a period multiplier, one of `h(our)`, `d(ay)` and `w(eek)`. E.g. a repeat interval of `12h` specifies one snapshot every 12 hours. The start time is specified as a time string (more details about passing times below). By default the start time is last midnight. So when a snapshot schedule with repeat interval `1h` is added at 13:50 with the default start time, the first snapshot will be taken at 14:00. Retention specifications are identified by path and the retention spec itself. A retention spec consists of either a number and a time period separated by a space or concatenated pairs of `