zfs.resource.query ================== Query ZFS resources (datasets and volumes) with flexible filtering options. This method provides a high-performance interface for retrieving information about ZFS resources, including their properties, hierarchical relationships, and metadata. The query can be customized to retrieve specific resources, properties, and control the output format. Raises: ValidationError: If: - Snapshot paths are provided (snapshots not currently supported) - Overlapping paths are provided with get_children=True - Requested paths don't exist (errno.ENOENT) Examples: # Query all resources with default properties query() # Query specific resources with all properties query({"paths": ["tank/documents", "tank/media"]}) # Query with specific properties and children query({ "paths": ["tank"], "properties": ["mounted", "compression", "used"], "get_children": True }) # Get hierarchical view of resources query({"paths": ["tank"], "nest_results": True, "get_children": True}) .. raw:: html
A list of zfs filesystem or volume paths to be queried. In almost all scenarios, you should provide a path of what you want to query. By providing path(s) here, it allows the API to apply optimizations so that the requested information is retrieved as efficiently and quickly as possible.
Example 1:
{"paths": ["tank/foo"]} will query the relevant information for this resource only.
Example 2:
{"paths": ["tank/foo", "dozer/test"]} will query the relevant information for these resources only.
NOTE:
paths must be non-overlapping if get_children
is True.
(i.e. this won't work and will raise a validation error)
{
"paths": ["tank/foo1", "tank/foo1/foo2"],
"get_children": True
}
All items must be unique
No Additional ItemsA list of zfs properties to be retrieved. Defaults to an empty list which will return a default set of zfs properties.
Setting this to None will retrieve no zfs properties.
Retrieve user properties for zfs resource(s).
Hidden field to retrieve source information for a zfs property.
NOTE: This should only ever be toggled by internal consumers and you should know what you're doing by toggling this to False.
Return a nested object that associates all children to their respective parents in the filesystem. By default, each zfs resource is returned as a separate item in the array and is not associated to its parent.
Retrieve children information for the zfs resource.
Transaction group when resource was created.
Globally unique identifier for the resource.
The name of the zfs resource.
The name of the zpool that the zfs resouce is associated to.
The zfs properties for the resource.
No Additional PropertiesControls how ACEs are inherited for new files/directories.
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.
Determines how ACLs are modified during chmod operations.
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.
Controls whether access time is updated on file reads.
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 filesystem can be mounted.
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.
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 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 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.
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 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.
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 direct I/O behavior (standard or always).
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 dnode size for new objects.
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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Maximum number of child filesystems 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.
Controls support for long 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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls mount point used for this 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 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.
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.
Controls overlay mount 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.
Limits space consumed 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.
Maximum block size for files in this 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.
Limits space consumed by dataset itself (no 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.
Minimum space reserved for volume itself.
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 relative access time updates.
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 snapshot directory visibility (hidden or visible).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Size threshold for storing blocks on special vdevs.
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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls volume mode (default, geom, dev, 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 virus scanning 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.
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.
Controls whether filesystem is managed from a zone.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Amount of space available to dataset and its children.
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 checksum algorithm used to verify data integrity.
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 compression algorithm used for 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.
The 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.
Controls number of copies of data stored (1, 2, or 3).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls data deduplication 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 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.
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.
The 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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Encryption key format (raw, hex, or passphrase).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Location where encryption key is stored.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls ZIL write behavior (latency or throughput).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The 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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Number of PBKDF2 iterations for key derivation.
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 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 whether dataset can be modified.
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls redundant metadata storage (all or most).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Minimum space reserved for 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.
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 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.
Controls snapshot device visibility (hidden or visible).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Maximum number of snapshots 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.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Controls synchronous write behavior (standard, always, disabled).
No Additional PropertiesThe raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
The raw value of the property.
The source from where this property received its value.
The parsed raw value of the property.
Block size for volume (typically 8K or 16K).
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.
Controls volume threading 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.
The type of ZFS resource.
Custom metadata properties with colon-separated names (max 256 chars).
Each additional property must conform to the following schema
Type: stringThe children of this zfs resource.
No Additional Items