pool.snapshot.query

Sent on pool.snapshot changes.

Type: object

ADDED

PoolSnapshotAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

fields Required

PoolSnapshotEntry

Type: object
No Additional Properties

id Required

Id

Type: string

properties Required

Properties

Type: object

Additional Properties

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

value Required

Value

Type: string

rawvalue Required

Rawvalue

Type: string

source Required

Source

Type: enum (of string)

Must be one of:

• "NONE"
• "DEFAULT"
• "LOCAL"
• "TEMPORARY"
• "INHERITED"
• "RECEIVED"

parsed Required

Parsed

Type: object

pool Required

Pool

Type: string

name Required

Name

Type: string

type Required

Type

Type: const

Must be one of:

• "SNAPSHOT"

Specific value: "SNAPSHOT"

snapshot_name Required

Snapshot Name

Type: string

dataset Required

Dataset

Type: string

createtxg Required

Createtxg

Type: string

holds

Holds

Type: object

Returned when options.extra.holds is set.

No Additional Properties

truenas

Truenas

Type: integer

Present if a hold has been placed on the snapshot.

retention

Retention

Returned when options.extra.retention is set.

Any of

• Option 1
• Option 2

One of

• PoolSnapshotRetentionPST
• PoolSnapshotRetentionProperty

PoolSnapshotRetentionPST

Type: object
No Additional Properties

datetime Required

Datetime

Type: stringFormat: date-time

source Required

Source

Type: const

Must be one of:

• "periodic_snapshot_task"

Specific value: "periodic_snapshot_task"

periodic_snapshot_task_id Required

Periodic Snapshot Task Id

Type: integer

PoolSnapshotRetentionProperty

Type: object
No Additional Properties

datetime Required

Datetime

Type: stringFormat: date-time

source Required

Source

Type: const

Must be one of:

• "property"

Specific value: "property"

Type: null

CHANGED

PoolSnapshotChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

fields Required

PoolSnapshotEntry

Type: object
No Additional Properties

id Required

Id

Type: string

properties Required

Properties

Type: object

Additional Properties

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

value Required

Value

Type: string

rawvalue Required

Rawvalue

Type: string

source Required

Source

Type: enum (of string)

Must be one of:

• "NONE"
• "DEFAULT"
• "LOCAL"
• "TEMPORARY"
• "INHERITED"
• "RECEIVED"

parsed Required

Parsed

Type: object

pool Required

Pool

Type: string

name Required

Name

Type: string

type Required

Type

Type: const

Must be one of:

• "SNAPSHOT"

Specific value: "SNAPSHOT"

snapshot_name Required

Snapshot Name

Type: string

dataset Required

Dataset

Type: string

createtxg Required

Createtxg

Type: string

holds

Holds

Type: object

Returned when options.extra.holds is set.

No Additional Properties

truenas

Truenas

Type: integer

Present if a hold has been placed on the snapshot.

retention

Retention

Returned when options.extra.retention is set.

Any of

• Option 1
• Option 2

One of

• PoolSnapshotRetentionPST
• PoolSnapshotRetentionProperty

PoolSnapshotRetentionPST

Type: object
No Additional Properties

datetime Required

Datetime

Type: stringFormat: date-time

source Required

Source

Type: const

Must be one of:

• "periodic_snapshot_task"

Specific value: "periodic_snapshot_task"

periodic_snapshot_task_id Required

Periodic Snapshot Task Id

Type: integer

PoolSnapshotRetentionProperty

Type: object
No Additional Properties

datetime Required

Datetime

Type: stringFormat: date-time

source Required

Source

Type: const

Must be one of:

• "property"

Specific value: "property"

Type: null

REMOVED

PoolSnapshotRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

Required roles: SNAPSHOT_READ