zfs.resource.snapshot.query =========================== This method provides an interface for retrieving information about ZFS snapshots, including their properties and user properties. Args: data: Query parameters containing: - paths: List of dataset or snapshot paths to query. If empty, queries all. - properties: List of ZFS properties to retrieve. Empty list = defaults, None = none. - get_user_properties: Whether to include user-defined properties. - get_source: Whether to include property source information. - recursive: Include snapshots from child datasets. - min_txg: Minimum transaction group filter (0 = no minimum). - max_txg: Maximum transaction group filter (0 = no maximum). Returns: List of snapshot entries with requested properties. Examples: # Query all snapshots query({}) # Query snapshots for a specific dataset query({"paths": ["tank/data"]}) # Query a specific snapshot query({"paths": ["tank/data@backup"]}) # Query with recursion and specific properties query({ "paths": ["tank"], "recursive": True, "properties": ["used", "referenced", "creation"] }) .. raw:: html
Query parameters for retrieving ZFS snapshot information.
No Additional PropertiesDataset paths to count snapshots for. If empty, counts all snapshots.
All items must be unique
No Additional ItemsInclude snapshots from child datasets when counting.
List of ZFS properties to retrieve. Empty list returns default properties. None returns no properties.
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.
The zfs resource for the given snapshot.
The zpool of the snapshot.
The zfs resource for the given snapshot.
The name of the snapshot.
The type of zfs resource.
Specific value:"SNAPSHOT"
A list of tags that hold the snapshot.
Requested properties for the snapshot.
(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-defined properties for snapshots.
Each additional property must conform to the following schema
Type: string