webui.dataset.details¶
Return every dataset with the shares, virtual machines, containers, apps and data protection tasks that use it.
This method is designed for the Datasets page of the web interface and is not a general purpose API. Use zfs.resource.list, zfs.resource.snapshot.count and zfs.resource.attachments for programmatic access.
Each consumer list, task count and the snapshot count is null when the caller is not authorized to call the method it comes from, for example sharing.smb.query for SMB shares.
No Additional Items
Result
Type: array of objectEvery dataset outside the system's internal datasets, each placed after its parent with siblings ordered by name.
No Additional ItemsEach item of this array must be:
WebUIDatasetDetailsEntry
Type: objectNo Additional Properties
Id
Type: stringDataset name, used as its identifier.
Name
Type: stringName of the dataset.
Pool
Type: stringName of the pool that holds the dataset.
Type
Type: enum (of string)Type of the dataset.
Must be one of:
- "FILESYSTEM"
- "VOLUME"
Createtxg
Type: integerTransaction group in which the dataset was created.
Guid
Type: integerGlobally unique identifier of the dataset.
ZFSPropertiesEntry
Type: objectZFS properties of the dataset, as returned by zfs.resource.list.
Aclinherit
Type: objectControls how ACEs are inherited for new files/directories.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
SourceValue
Type: objectNo Additional Properties
Type
Type: enum (of string)The source type.
Must be one of:
- "NONE"
- "DEFAULT"
- "TEMPORARY"
- "LOCAL"
- "INHERITED"
- "RECEIVED"
Value
The source value.
Value
The parsed raw value of the property.
Aclmode
Type: objectDetermines how ACLs are modified during chmod operations.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Acltype
Type: objectSpecifies type of ACL to use (off, nfsv4, posix).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Atime
Type: objectControls whether access time is updated on file reads.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Canmount
Type: objectControls whether filesystem can be mounted.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Casesensitivity
Type: objectDetermines filename matching algorithm sensitivity.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultgroupobjquota
Type: objectDefault object quota for new groups.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultgroupquota
Type: objectDefault space quota for new groups.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultprojectobjquota
Type: objectDefault object quota for new projects.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultprojectquota
Type: objectDefault space quota for new projects.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultuserobjquota
Type: objectDefault object quota for new users.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defaultuserquota
Type: objectDefault space quota for new users.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Devices
Type: objectControls whether device files can be opened.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Direct
Type: objectControls direct I/O behavior (standard or always).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Dnodesize
Type: objectControls dnode size for new objects.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Exec
Type: objectControls whether programs can be executed from filesystem.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Filesystem Count
Type: object(READ-ONLY): Count of child filesystems.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Filesystem Limit
Type: objectMaximum number of child filesystems allowed.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Longname
Type: objectControls support for long filenames.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Mounted
Type: object(READ-ONLY): Property indicating if filesystem is mounted.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Mountpoint
Type: objectControls mount point used for this filesystem.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Nbmand
Type: objectControls non-blocking mandatory locking behavior.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Normalization
Type: objectUnicode normalization property for filenames.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Overlay
Type: objectControls overlay mount behavior.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Quota
Type: objectLimits space consumed by dataset and descendants.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Recordsize
Type: objectMaximum block size for files in this filesystem.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Refquota
Type: objectLimits space consumed by dataset itself (no descendants).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Refreservation
Type: objectMinimum space reserved for volume itself.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Relatime
Type: objectControls relative access time updates.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Setuid
Type: objectControls setuid/setgid bit respect on executable files.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Snapdir
Type: objectControls snapshot directory visibility (hidden or visible).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Special Small Blocks
Type: objectSize threshold for storing blocks on special vdevs.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Utf8Only
Type: objectControls whether only UTF-8 filenames are allowed.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Version
Type: object(READ-ONLY): Filesystem version number.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Volmode
Type: objectControls volume mode (default, geom, dev, none).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Vscan
Type: objectControls virus scanning behavior.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Xattr
Type: objectControls extended attribute behavior (on, off, sa, dir).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Zoned
Type: objectControls whether filesystem is managed from a zone.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Available
Type: objectAmount of space available to dataset and its children.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Checksum
Type: objectControls checksum algorithm used to verify data integrity.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Compression
Type: objectControls compression algorithm used for this dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Compressratio
Type: object(READ-ONLY): Property showing achieved compression ratio.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Context
Type: objectSELinux security context for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Copies
Type: objectControls number of copies of data stored (1, 2, or 3).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Createtxg
Type: object(READ-ONLY): Transaction group when dataset was created.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Creation
Type: object(READ-ONLY): Timestamp when dataset was created.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Dedup
Type: objectControls data deduplication for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Defcontext
Type: objectSELinux default security context for new files.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Encryption
Type: objectControls encryption cipher suite for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Encryptionroot
Type: object(READ-ONLY): Property showing encryption root dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Fscontext
Type: objectSELinux filesystem security context.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Guid
Type: object(READ-ONLY): Globally unique identifier for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Keyformat
Type: objectEncryption key format (raw, hex, or passphrase).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Keylocation
Type: objectLocation where encryption key is stored.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Keystatus
Type: object(READ-ONLY): Encryption key status (available/unavailable).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Logbias
Type: objectControls ZIL write behavior (latency or throughput).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Logicalreferenced
Type: object(READ-ONLY): Logical space referenced by dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Logicalused
Type: object(READ-ONLY): Logical space used by dataset and descendants.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Mlslabel
Type: objectMulti-level security label for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Objsetid
Type: object(READ-ONLY): Object set identifier for the dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Origin
Type: object(READ-ONLY): Snapshot this dataset was cloned from.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Pbkdf2Iters
Type: objectNumber of PBKDF2 iterations for key derivation.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Prefetch
Type: objectControls prefetch behavior (all, metadata, or none).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Primarycache
Type: objectControls primary cache usage (all, metadata, or none).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Readonly
Type: objectControls whether dataset can be modified.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Receive Resume Token
Type: object(READ-ONLY): Token for resuming interrupted zfs receive.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Redact Snaps
Type: object(READ-ONLY): List of redaction snapshots.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Redundant Metadata
Type: objectControls redundant metadata storage (all or most).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Refcompressratio
Type: object(READ-ONLY): Compression ratio for referenced data.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Referenced
Type: object(READ-ONLY): Space referenced by this dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Reservation
Type: objectMinimum space reserved for dataset and descendants.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Rootcontext
Type: objectSELinux root directory security context.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Secondarycache
Type: objectControls secondary cache usage (all, metadata, or none).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Snapdev
Type: objectControls snapshot device visibility (hidden or visible).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Snapshot Count
Type: object(READ-ONLY): Count of snapshots in this dataset.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Snapshot Limit
Type: objectMaximum number of snapshots allowed.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Snapshots Changed
Type: object(READ-ONLY): Property indicating snapshot changes.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Sync
Type: objectControls synchronous write behavior (standard, always, disabled).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Type
(READ-ONLY): Type of ZFS dataset (filesystem, volume, etc).
PropertyValue
Type: objectNo Additional Properties
Raw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Used
Type: object(READ-ONLY): Space used by dataset and descendants.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Usedbychildren
Type: object(READ-ONLY): Space used by child datasets.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Usedbydataset
Type: object(READ-ONLY): Space used by this dataset itself.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Usedbyrefreservation
Type: object(READ-ONLY): Space used by refreservation.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Usedbysnapshots
Type: object(READ-ONLY): Space used by snapshots.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Written
Type: object(READ-ONLY): Space referenced since previous snapshot.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Volblocksize
Type: objectBlock size for volume (typically 8K or 16K).
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Volsize
Type: objectLogical size of the volume.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
Volthreading
Type: objectControls volume threading behavior.
No Additional PropertiesRaw
Type: stringThe raw value of the property.
The source from where this property received its value.
Value
The parsed raw value of the property.
User Properties
Type: objectZFS user properties of the dataset, as returned by zfs.resource.list.
Each additional property must conform to the following schema
Type: stringStorage tier of a filesystem, or null for a volume, when ZFS tiering is disabled, when the pool has no special vdev, or when the dataset uses deduplication.
TierInfo
Type: objectNo Additional Properties
Tier Type
Type: enum (of string)Storage performance tier for this share.
Must be one of:
- "REGULAR"
- "PERFORMANCE"
Most recent rewrite job for this share's dataset, or null if no job history exists.
ZfsTierRewriteJobEntry
Type: objectNo Additional Properties
Tier Job Id
Type: stringRewrite job identifier in dataset_name@job_uuid format.
Must be at least 1 characters long
Dataset Name
Type: stringZFS dataset this job is operating on.
Must be at least 1 characters long
Job Uuid
Type: stringUnique identifier for this rewrite job.
Must be at least 1 characters long
Status
Type: enum (of string)Current lifecycle state of the job.
COMPLETE- All files in the dataset have been processed.RUNNING- Job is actively processing files.QUEUED- Job is waiting for a free execution slot (seemax_concurrent_jobs).CANCELLED- Job was stopped viazfs_tier_job.cancel. Not resumable.STOPPED- Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.ERROR- Job halted due to an unrecoverable error. Usezfs_tier_job.recoverto retry failed files.
Must be one of:
- "COMPLETE"
- "RUNNING"
- "QUEUED"
- "CANCELLED"
- "STOPPED"
- "ERROR"
Snapshot Count
Number of snapshots of the dataset, or null unless the caller may call zfs.resource.snapshot.count.
Thick Provisioned
Whether a zvol has space reserved for it, or null for a filesystem.
WebUIDatasetConsumers
Type: objectShares, virtual machines, containers and apps that use the dataset.
No Additional PropertiesSmb
SMB shares of the dataset, or null unless the caller may call sharing.smb.query.
No Additional Items
Each item of this array must be:
WebUIDatasetSMBShare
Type: objectNo Additional Properties
Enabled
Type: booleanWhether the SMB share is enabled.
Path
Type: stringPath of the SMB share.
Nfs
NFS shares of the dataset, or null unless the caller may call sharing.nfs.query.
No Additional Items
Each item of this array must be:
WebUIDatasetNFSShare
Type: objectNo Additional Properties
Enabled
Type: booleanWhether the NFS share is enabled.
Path
Type: stringPath of the NFS share.
Iscsi
iSCSI extents of the dataset that are mapped to a target with a portal group, or null unless the caller may call iscsi.extent.query, iscsi.target.query and iscsi.targetextent.query.
No Additional Items
Each item of this array must be:
WebUIDatasetISCSIExtent
Type: objectNo Additional Properties
Enabled
Type: booleanWhether the iSCSI extent is enabled.
Type
Type: enum (of string)Whether the extent is the zvol itself or a file stored on the dataset.
Must be one of:
- "DISK"
- "FILE"
Path
Type: stringDevice path of a zvol extent or file path of a file extent.
Nvmet
NVMe-oF namespaces of the dataset, or null unless the caller may call nvmet.namespace.query.
No Additional Items
Each item of this array must be:
WebUIDatasetNVMetNamespace
Type: objectNo Additional Properties
Enabled
Type: booleanWhether the NVMe-oF namespace is enabled.
Type
Type: enum (of string)Whether the namespace is the zvol itself or a file stored on the dataset.
Must be one of:
- "ZVOL"
- "FILE"
Path
Type: stringDevice path of a zvol namespace or file path of a file namespace.
Vms
Virtual machine disks that use the dataset, or null unless the caller may call vm.query and vm.device.query.
No Additional Items
Each item of this array must be:
WebUIDatasetVM
Type: objectNo Additional Properties
Name
Type: stringName of the virtual machine.
Path
Type: stringPath of the virtual machine disk that uses the dataset.
Containers
Container filesystem devices that use the dataset, or null unless the caller may call container.query and container.device.query.
No Additional Items
Each item of this array must be:
WebUIDatasetContainer
Type: objectNo Additional Properties
Name
Type: stringName of the container.
Path
Type: stringHost path mounted into the container.
Apps
Running apps that mount a path on the dataset, or null unless the caller may call app.query.
No Additional Items
Each item of this array must be:
WebUIDatasetApp
Type: objectNo Additional Properties
Name
Type: stringName of the app.
Path
Type: stringHost path the app mounts.
WebUIDatasetTasks
Type: objectData protection tasks that cover the dataset.
No Additional PropertiesSnapshot
Number of periodic snapshot tasks of the dataset, or null unless the caller may call pool.snapshottask.query.
Replication
Number of push replication tasks that use the dataset as a source, or null unless the caller may call replication.query.
Cloudsync
Number of push cloud sync tasks whose path contains the dataset, or null unless the caller may call cloudsync.query.
Rsync
Number of push rsync tasks whose path contains the dataset, or null unless the caller may call rsynctask.query.
Required roles: DATASET_READ