# pool.snapshottask.create

Create a Periodic Snapshot Task

Create a Periodic Snapshot Task that will take snapshots of specified dataset at specified schedule. Recursive snapshots can be created if recursive flag is enabled. You can exclude specific child datasets or zvols from the snapshot.

Snapshots will be automatically destroyed after a certain amount of time, specified by lifetime_value and lifetime_unit.

If multiple periodic tasks create snapshots at the same time (for example hourly and daily at 00:00) the snapshot will be kept until the last of these tasks reaches its expiry time.

Snapshots will be named according to naming_schema which is a strftime-like template for snapshot name and must contain %Y, %m, %d, %H and %M.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object
No Additional Properties

##

#### Dataset

Type: string

##

#### Recursive

Type: boolean Default: false

##

#### Lifetime Value

Type: integer Default: 2

##

#### Lifetime Unit

Type: enum (of string) Default: "WEEK"

##### Must be one of:

- "HOUR"
- "DAY"
- "WEEK"
- "MONTH"
- "YEAR"

##

#### Enabled

Type: boolean Default: true

##

#### Exclude

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

##### Each item of this array must be:

Type: string

##

#### Naming Schema

Type: string Default: "auto-%Y-%m-%d_%H-%M"

##

#### Allow Empty

Type: boolean Default: true

##

#### PoolSnapshotTaskCron

Type: object
No Additional Properties

##

#### Minute

Type: string Default: "00"

##

#### Hour

Type: string Default: "*"

"00" - "23"

##

#### Dom

Type: string Default: "*"

"1" - "31"

##

#### Month

Type: string Default: "*"

"1" (January) - "12" (December)

##

#### Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

##

#### Begin

Type: string Default: "00:00"
Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### End

Type: string Default: "23:59"
Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### PeriodicSnapshotTaskEntry

Type: object
No Additional Properties

##

#### Dataset

Type: string

##

#### Recursive

Type: boolean Default: false

##

#### Lifetime Value

Type: integer Default: 2

##

#### Lifetime Unit

Type: enum (of string) Default: "WEEK"

##### Must be one of:

- "HOUR"
- "DAY"
- "WEEK"
- "MONTH"
- "YEAR"

##

#### Enabled

Type: boolean Default: true

##

#### Exclude

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

##### Each item of this array must be:

Type: string

##

#### Naming Schema

Type: string Default: "auto-%Y-%m-%d_%H-%M"

##

#### Allow Empty

Type: boolean Default: true

##

#### PoolSnapshotTaskCron

Type: object
No Additional Properties

##

#### Minute

Type: string Default: "00"

##

#### Hour

Type: string Default: "*"

"00" - "23"

##

#### Dom

Type: string Default: "*"

"1" - "31"

##

#### Month

Type: string Default: "*"

"1" (January) - "12" (December)

##

#### Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

##

#### Begin

Type: string Default: "00:00"
Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### End

Type: string Default: "23:59"
Examples:

    "00:00"

    "06:30"

    "18:00"

    "23:00"

##

#### Id

Type: integer

##

#### Vmware Sync

Type: boolean

##

#### State

Type: object

Required roles: SNAPSHOT_TASK_WRITE