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:

{}

List every snapshot:

{"recursive": true}

List the snapshots of a dataset:

{"paths": ["tank/data"]}

Get one snapshot with its holds:

{"paths": ["tank/data@backup"], "get_holds": true}

List the snapshots of a dataset and its descendants with selected properties:

{"paths": ["tank"], "recursive": true, "properties": ["used", "referenced", "creation"]}
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Parameters selecting the snapshots to list and the information to retrieve.

No Additional Properties

Paths

Type: array of string Default: []

Dataset 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 Items
Each item of this array must be:
Type: string

Recursive

Type: boolean Default: false

Also include the snapshots of the descendants of each dataset path, or of every pool's root filesystem when paths is empty.

Properties

Default: []

ZFS properties to retrieve for each snapshot. Snapshots have no default properties, so an empty list or null retrieves none.

Type: array of string
No Additional Items
Each item of this array must be:
Type: string
Type: null

Get User Properties

Type: boolean Default: false

Retrieve user-defined properties for snapshots.

Get Source

Type: boolean Default: false

Include source information for each property value.

Get Holds

Type: boolean Default: false

Include holds information (if any) for the snapshot.

Min Txg

Type: integer Default: 0

Minimum transaction group for filtering snapshots. 0 means no minimum.

Max Txg

Type: integer Default: 0

Maximum transaction group for filtering snapshots. 0 means no maximum.

Result

Type: array of object
No Additional Items
Each item of this array must be:

ZFSResourceSnapshotEntry

Type: object
No Additional Properties

Createtxg

Type: integer

The TXG in which the snapshot was created.

Guid

Type: integer

A GUID for the snapshot.

Name

Type: string

Full snapshot path (dataset@snapshot).

Pool

Type: string

The zpool of the snapshot.

Dataset

Type: string

Path of the filesystem or volume the snapshot was taken of.

Snapshot Name

Type: string

The name of the snapshot.

Type

Type: const Default: "SNAPSHOT"

The type of zfs resource.

Specific value: "SNAPSHOT"

Holds


Hold tags on the snapshot when get_holds is set. Null when it is not set or the snapshot has no holds.

Type: array
No Additional Items
Each item of this array must be:
Type: object
Type: null


The properties requested through properties.

ZFSResourceSnapshotPropertiesEntry

Type: object
No Additional Properties

Type

Type: object

(READ-ONLY): Type of ZFS dataset (filesystem, volume, etc).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

SourceValue

Type: object
No Additional Properties

Type

Type: enum (of string)

The source type.

Must be one of:
  • "NONE"
  • "DEFAULT"
  • "TEMPORARY"
  • "LOCAL"
  • "INHERITED"
  • "RECEIVED"

Value


The source value.

Type: string
Type: null
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Creation

Type: object

(READ-ONLY): Timestamp when dataset was created.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Used

Type: object

(READ-ONLY): Space used by dataset and descendants.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Referenced

Type: object

(READ-ONLY): Space referenced by this dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Compressratio

Type: object

(READ-ONLY): Property showing achieved compression ratio.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Createtxg

Type: object

(READ-ONLY): Transaction group when dataset was created.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Guid

Type: object

(READ-ONLY): Globally unique identifier for the dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Primarycache

Type: object

Controls primary cache usage (all, metadata, or none).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Secondarycache

Type: object

Controls secondary cache usage (all, metadata, or none).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Objsetid

Type: object

(READ-ONLY): Object set identifier for the dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Mlslabel

Type: object

Multi-level security label for the dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Refcompressratio

Type: object

(READ-ONLY): Compression ratio for referenced data.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Written

Type: object

(READ-ONLY): Space referenced since previous snapshot.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Logicalreferenced

Type: object

(READ-ONLY): Logical space referenced by dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Context

Type: object

SELinux security context for the dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Fscontext

Type: object

SELinux filesystem security context.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defcontext

Type: object

SELinux default security context for new files.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Rootcontext

Type: object

SELinux root directory security context.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Encryption

Type: object

Controls encryption cipher suite for the dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Encryptionroot

Type: object

(READ-ONLY): Property showing encryption root dataset.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Keystatus

Type: object

(READ-ONLY): Encryption key status (available/unavailable).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Redact Snaps

Type: object

(READ-ONLY): List of redaction snapshots.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Prefetch

Type: object

Controls prefetch behavior (all, metadata, or none).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Devices

Type: object

Controls whether device files can be opened.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Exec

Type: object

Controls whether programs can be executed from filesystem.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Setuid

Type: object

Controls setuid/setgid bit respect on executable files.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Xattr

Type: object

Controls extended attribute behavior (on, off, sa, dir).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Version

Type: object

(READ-ONLY): Filesystem version number.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Utf8Only

Type: object

Controls whether only UTF-8 filenames are allowed.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Normalization

Type: object

Unicode normalization property for filenames.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Casesensitivity

Type: object

Determines filename matching algorithm sensitivity.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Nbmand

Type: object

Controls non-blocking mandatory locking behavior.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Acltype

Type: object

Specifies type of ACL to use (off, nfsv4, posix).

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultuserquota

Type: object

Default space quota for new users.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultgroupquota

Type: object

Default space quota for new groups.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultprojectquota

Type: object

Default space quota for new projects.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultuserobjquota

Type: object

Default object quota for new users.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultgroupobjquota

Type: object

Default object quota for new groups.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Defaultprojectobjquota

Type: object

Default object quota for new projects.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null

Volsize

Type: object

Logical size of the volume.

No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

Type: integer
Type: number
Type: string
Type: boolean
Type: null
Type: null

User Properties


User properties of the snapshot when get_user_properties is set.

Type: object

Each additional property must conform to the following schema

Type: string
Type: null


Required roles: SNAPSHOT_READ