zfs.resource.snapshot.list ========================== List ZFS snapshots and, on request, their properties, user properties and holds. ``paths`` takes dataset paths, which select the snapshots of that dataset, and snapshot paths, which select that one snapshot. A path that does not exist is skipped. Without ``paths`` the snapshots of every pool's root filesystem are listed; set ``recursive`` to include the snapshots of descendants. Snapshots of internal datasets are left out unless one is named in ``paths``. Snapshots have no default properties, so request the ones needed in ``properties``. A validation error is raised when ``recursive`` is set and one dataset path lies below another (``EINVAL``). Examples: List the snapshots of every pool's root filesystem: .. code:: json {} List every snapshot: .. code:: json {"recursive": true} List the snapshots of a dataset: .. code:: json {"paths": ["tank/data"]} Get one snapshot with its holds: .. code:: json {"paths": ["tank/data@backup"], "get_holds": true} List the snapshots of a dataset and its descendants with selected properties: .. code:: json {"paths": ["tank"], "recursive": true, "properties": ["used", "referenced", "creation"]} .. raw:: html
Parameters selecting the snapshots to list and the information to retrieve.
No Additional PropertiesDataset paths, which select the snapshots of that dataset, and snapshot paths (dataset@snapshot), which select that one snapshot. A path that does not exist is skipped. When empty, the root filesystem of every imported pool is used.
All items must be unique
No Additional ItemsAlso include the snapshots of the descendants of each dataset path, or of every pool's root filesystem when paths is empty.
ZFS properties to retrieve for each snapshot. Snapshots have no default properties, so an empty list or null retrieves none.
Retrieve user-defined properties for snapshots.
Include source information for each property value.
Include holds information (if any) for the snapshot.
Minimum transaction group for filtering snapshots. 0 means no minimum.
Maximum transaction group for filtering snapshots. 0 means no maximum.
The TXG in which the snapshot was created.
A GUID for the snapshot.
Full snapshot path (dataset@snapshot).
The zpool of the snapshot.
Path of the filesystem or volume the snapshot was taken of.
The name of the snapshot.
The type of zfs resource.
Specific value:"SNAPSHOT"
Hold tags on the snapshot when get_holds is set. Null when it is not set or the snapshot has no holds.
The properties requested through properties.
(READ-ONLY): Type of ZFS dataset (filesystem, volume, etc).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The source type.
The source value.
The parsed raw value of the property.
(READ-ONLY): Timestamp when dataset was created.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Space used by dataset and descendants.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Space referenced by this dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Property showing achieved compression ratio.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Transaction group when dataset was created.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Globally unique identifier for the dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls primary cache usage (all, metadata, or none).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls secondary cache usage (all, metadata, or none).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Object set identifier for the dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Multi-level security label for the dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Compression ratio for referenced data.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Space referenced since previous snapshot.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Logical space referenced by dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
SELinux security context for the dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
SELinux filesystem security context.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
SELinux default security context for new files.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
SELinux root directory security context.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls encryption cipher suite for the dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Property showing encryption root dataset.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Encryption key status (available/unavailable).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): List of redaction snapshots.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls prefetch behavior (all, metadata, or none).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls whether device files can be opened.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls whether programs can be executed from filesystem.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls setuid/setgid bit respect on executable files.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls extended attribute behavior (on, off, sa, dir).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
(READ-ONLY): Filesystem version number.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls whether only UTF-8 filenames are allowed.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Unicode normalization property for filenames.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Determines filename matching algorithm sensitivity.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls non-blocking mandatory locking behavior.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Specifies type of ACL to use (off, nfsv4, posix).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default space quota for new users.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default space quota for new groups.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default space quota for new projects.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default object quota for new users.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default object quota for new groups.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Default object quota for new projects.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Logical size of the volume.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
User properties of the snapshot when get_user_properties is set.
Each additional property must conform to the following schema
Type: string