pool.snapshot.create

Take a snapshot from a given dataset.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Configuration for creating a snapshot with either an explicit name or naming schema.

Any of

• PoolSnapshotCreateWithName
• PoolSnapshotCreateWithSchema

PoolSnapshotCreateWithName

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

Name of the dataset to create a snapshot of.

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

Whether to recursively snapshot child datasets.

exclude

Exclude

Type: array of string Default: []

Array of dataset patterns to exclude from recursive snapshots.

No Additional Items

Each item of this array must be:

Type: string

vmware_sync

Vmware Sync

Type: boolean Default: false

Whether to sync VMware VMs before taking the snapshot.

properties

Properties

Type: object Default: {}

Object mapping ZFS property names to values to set on the snapshot.

name Required

Name

Type: string

Explicit name for the snapshot.

Must be at least 1 characters long

PoolSnapshotCreateWithSchema

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

Name of the dataset to create a snapshot of.

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

Whether to recursively snapshot child datasets.

exclude

Exclude

Type: array of string Default: []

Array of dataset patterns to exclude from recursive snapshots.

No Additional Items

Each item of this array must be:

Type: string

vmware_sync

Vmware Sync

Type: boolean Default: false

Whether to sync VMware VMs before taking the snapshot.

properties

Properties

Type: object Default: {}

Object mapping ZFS property names to values to set on the snapshot.

naming_schema Required

Naming Schema

Type: string

Naming schema pattern to generate the snapshot name automatically.

Must be at least 1 characters long

Return value

PoolSnapshotCreateUpdateEntry

Type: object

Information about the newly created snapshot.

No Additional Properties

id Required

Id

Type: string

Full snapshot identifier including dataset and snapshot name.

properties Required

Properties

Type: object

Object mapping ZFS property names to their values and metadata.

Additional Properties

Each additional property must conform to the following schema

PoolSnapshotEntryPropertyFields

Type: object
No Additional Properties

value Required

Value

Type: string

Current effective value of the ZFS property as a string.

rawvalue Required

Rawvalue

Type: string

Raw string value of the ZFS property as stored.

source Required

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 Required

Parsed

Type: object

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

pool Required

Pool

Type: string

Name of the ZFS pool containing this snapshot.

name Required

Name

Type: string

Full name of the snapshot including dataset path.

type Required

Type

Type: const

Type identifier indicating this is a ZFS snapshot.

Must be one of:

• "SNAPSHOT"

Specific value: "SNAPSHOT"

snapshot_name Required

Snapshot Name

Type: string

Just the snapshot name portion without the dataset path.

dataset Required

Dataset

Type: string

Name of the dataset this snapshot was taken from.

createtxg Required

Createtxg

Type: string

Transaction group ID when the snapshot was created.

Required roles: SNAPSHOT_WRITE