# pool.snapshot.create

Take a snapshot from a given dataset.

Type: object

##

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

Type: object
No Additional Properties

##

#### Dataset

Type: string

Name of the dataset to create a snapshot of.

Must be at least `1` characters long

##

#### Recursive

Type: boolean Default: false

Whether to recursively snapshot child datasets.

##

#### 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

Type: boolean Default: false

Whether to sync VMware VMs before taking the snapshot.

##

#### Properties

Type: object Default: {}

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

##

#### Name

Type: string

Explicit name for the snapshot.

Must be at least `1` characters long

#### PoolSnapshotCreateWithSchema

Type: object
No Additional Properties

##

#### Dataset

Type: string

Name of the dataset to create a snapshot of.

Must be at least `1` characters long

##

#### Recursive

Type: boolean Default: false

Whether to recursively snapshot child datasets.

##

#### 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

Type: boolean Default: false

Whether to sync VMware VMs before taking the snapshot.

##

#### Properties

Type: object Default: {}

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

##

#### Naming Schema

Type: string

Naming schema pattern to generate the snapshot name automatically.

Must be at least `1` characters long

##

Type: object

Information about the newly created snapshot.

Required roles: SNAPSHOT_WRITE