pool.snapshot.query

Sent on pool.snapshot changes.

Type: object

PoolSnapshotAddedEvent

Type: object
No Additional Properties

Id

Type: string

PoolSnapshotEntry

Type: object
No Additional Properties

Id

Type: string

Full snapshot identifier including dataset and snapshot name.

Properties

Type: object

Object mapping ZFS property names to their values and metadata.

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

Value

Type: string

Current effective value of the ZFS property as a string.

Rawvalue

Type: string

Raw string value of the ZFS property as stored.

Source

Type: enum (of string)

Source of the property value.

  • NONE: Property is not set
  • DEFAULT: Using ZFS default value
  • LOCAL: Set locally on this snapshot
  • TEMPORARY: Temporary override value
  • INHERITED: Inherited from parent dataset
  • RECEIVED: Set by ZFS receive operation
Must be one of:
  • "NONE"
  • "DEFAULT"
  • "LOCAL"
  • "TEMPORARY"
  • "INHERITED"
  • "RECEIVED"

Parsed

Type: object

Property value parsed into the appropriate type (string, boolean, integer, etc.).

Pool

Type: string

Name of the ZFS pool containing this snapshot.

Name

Type: string

Full name of the snapshot including dataset path.

Type

Type: const

Type identifier indicating this is a ZFS snapshot.

Must be one of:
  • "SNAPSHOT"
Specific value: "SNAPSHOT"

Snapshot Name

Type: string

Just the snapshot name portion without the dataset path.

Dataset

Type: string

Name of the dataset this snapshot was taken from.

Createtxg

Type: string

Transaction group ID when the snapshot was created.

Holds

Type: object

Returned when options.extra.holds is set.

 No Additional Properties

Truenas

Type: integer

Present if a hold has been placed on the snapshot.

Retention


Returned when options.extra.retention is set.


PoolSnapshotRetentionPST

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by a periodic snapshot task.

Must be one of:
  • "periodic_snapshot_task"
Specific value: "periodic_snapshot_task"

Periodic Snapshot Task Id

Type: integer

ID of the periodic snapshot task managing this retention.

PoolSnapshotRetentionProperty

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by ZFS properties.

Must be one of:
  • "property"
Specific value: "property"
Type: null

PoolSnapshotChangedEvent

Type: object
No Additional Properties

Id

Type: string

PoolSnapshotEntry

Type: object
No Additional Properties

Id

Type: string

Full snapshot identifier including dataset and snapshot name.

Properties

Type: object

Object mapping ZFS property names to their values and metadata.

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

Value

Type: string

Current effective value of the ZFS property as a string.

Rawvalue

Type: string

Raw string value of the ZFS property as stored.

Source

Type: enum (of string)

Source of the property value.

  • NONE: Property is not set
  • DEFAULT: Using ZFS default value
  • LOCAL: Set locally on this snapshot
  • TEMPORARY: Temporary override value
  • INHERITED: Inherited from parent dataset
  • RECEIVED: Set by ZFS receive operation
Must be one of:
  • "NONE"
  • "DEFAULT"
  • "LOCAL"
  • "TEMPORARY"
  • "INHERITED"
  • "RECEIVED"

Parsed

Type: object

Property value parsed into the appropriate type (string, boolean, integer, etc.).

Pool

Type: string

Name of the ZFS pool containing this snapshot.

Name

Type: string

Full name of the snapshot including dataset path.

Type

Type: const

Type identifier indicating this is a ZFS snapshot.

Must be one of:
  • "SNAPSHOT"
Specific value: "SNAPSHOT"

Snapshot Name

Type: string

Just the snapshot name portion without the dataset path.

Dataset

Type: string

Name of the dataset this snapshot was taken from.

Createtxg

Type: string

Transaction group ID when the snapshot was created.

Holds

Type: object

Returned when options.extra.holds is set.

 No Additional Properties

Truenas

Type: integer

Present if a hold has been placed on the snapshot.

Retention


Returned when options.extra.retention is set.


PoolSnapshotRetentionPST

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by a periodic snapshot task.

Must be one of:
  • "periodic_snapshot_task"
Specific value: "periodic_snapshot_task"

Periodic Snapshot Task Id

Type: integer

ID of the periodic snapshot task managing this retention.

PoolSnapshotRetentionProperty

Type: object
No Additional Properties

Datetime

Type: stringFormat: date-time

Timestamp when the snapshot will be eligible for removal.

Source

Type: const

Indicates retention is managed by ZFS properties.

Must be one of:
  • "property"
Specific value: "property"
Type: null

PoolSnapshotRemovedEvent

Type: object
No Additional Properties

Id

Type: string


Required roles: SNAPSHOT_READ