/list-zfs-snapshots

list ZFS snapshots in multiple ways

Primary LanguagePerlGNU General Public License v3.0GPL-3.0

list-zfs-snapshots

Build Status Coverage Status GPL 3+

list-zfs-snapshots can list ZFS snapshots in various ways.

usage

  • Calling list-zfs-snapshots without any arguments will list all ZFS volumes.
    The output contains the snapshot names, relative and absolute snapshot sizes and is ordered by snapshot size.

  • Calling list-zfs-snapshots with the name of a ZFS pool as first argument will list the snapshot usage of only that pool.
    The output contains the snapshot names, relative and absolute snapshot sizes and is ordered by snapshot size.

  • Calling list-zfs-snapshots with the name of a ZFS volume as first argument will list the individual snapshots in that volume.
    The output contains the snapshot names, relative and absolute snapshot sizes and is ordered by snapshot creation time.
    Because of ZFS internals the used space per snapshot might not be correct. The sum of the used space of all snapshots seldom matches the snapshot usage listed at the volume. The volume value is correct. Deleting individual snapshots will change the used space of other snapshots – this is a byproduct of the copy-on-write semantics and completely normal.

  • Calling list-zfs-snapshots with the name of a snapshot as first argument followed by either after or before as second argument will list all other snapshots of in the corresponding volume that have been created either after or before the given snapshot.
    The output contains only the snapshot names and is ordered by snapshot creation time.

  • Calling list-zfs-snapshots with either -h or --help as first argument will show a brief help text.

configuration

By default the zfs binary is expected at /sbin/zfs. The location can be overridden by setting the ZFS_BINARY environment variable.

dependencies

  • a not-so-ancient version of Perl
  • the Number::Bytes::Human Perl module
  • ZFS

resources

Project homepage, git repository and bug tracker are available at https://github.com/mmitch/list-zfs-snapshots

license

Copyright (C) 2020 Christian Garbs mitch@cgarbs.de
Licensed under GNU GPL v3 or later.

list-zfs-snapshots is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

list-zfs-snapshots is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with list-zfs-snapshots. If not, see http://www.gnu.org/licenses/.