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

Any of

• PoolSnapshotCreateWithName
• PoolSnapshotCreateWithSchema

PoolSnapshotCreateWithName

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

exclude

Exclude

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

vmware_sync

Vmware Sync

Type: boolean Default: false

properties

Properties

Type: object Default: {}

name Required

Name

Type: string

Must be at least 1 characters long

PoolSnapshotCreateWithSchema

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

exclude

Exclude

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

vmware_sync

Vmware Sync

Type: boolean Default: false

properties

Properties

Type: object Default: {}

naming_schema Required

Naming Schema

Type: string

Must be at least 1 characters long

Return value

PoolSnapshotCreateUpdateEntry

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

Required roles: SNAPSHOT_WRITE