diff --git a/docs/chapters/subcommands/zfs.rst b/docs/chapters/subcommands/zfs.rst index fa3b4a57..dc7a8c62 100644 --- a/docs/chapters/subcommands/zfs.rst +++ b/docs/chapters/subcommands/zfs.rst @@ -1,8 +1,23 @@ zfs === -Manage ZFS properties, ceate and destroy snapshots, and check ZFS usage for -targeted jail(s). +Manage ZFS properties, create, destroy and rollback snapshots, jail and unjail datasets (ZFS only), +and check ZFS usage for targeted jail(s). + +Snapshot Management +------------------- + +Bastille has the ability to create, destroy, and rollback snapshots when using ZFS. To create a snapshot, +run ``bastille zfs TARGET snapshot``. This will create a snapshot with the default ``bastille_TARGET_DATE`` +naming scheme. You can also specify a TAG to use as the naming scheme, such as ``bastille zfs TARGET snapshot mytag``. +Bastille will then create the snapshot with ``@mytag`` as the snapshot name. + +Rolling back a snapshot follows the same syntax. If no TAG is supplied, Bastille will attempt to use the +most recent snapshot following the default naming scheme above. To rollback a snapshot with a custom tag, run +``bastille zfs TARGET rollback`` or ``bastille zfs TARGET rollback mytag``. + +To destroy a snaphot however, you must supply a TAG. To destroy a snapshot, run +``bastille zfs TARGET destroy mytag``. .. code-block:: shell