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`. .. examples(websocket):: Create a recursive Periodic Snapshot Task for dataset `data/work` excluding `data/work/temp`. Snapshots will be created on weekdays every hour from 09:00 to 18:00 and will be stored for two weeks. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.snapshottask.create", "params": [{ "dataset": "data/work", "recursive": true, "exclude": ["data/work/temp"], "lifetime_value": 2, "lifetime_unit": "WEEK", "naming_schema": "auto_%Y-%m-%d_%H-%M", "schedule": { "minute": "0", "hour": "*", "dom": "*", "month": "*", "dow": "1,2,3,4,5", "begin": "09:00", "end": "18:00" } }] } .. raw:: html
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"

End

Type: string Default: "23:59"

PoolSnapshotTaskEntry

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"

End

Type: string Default: "23:59"

Id

Type: integer

State

Type: object

Vmware Sync

Type: boolean


*Required roles:* SNAPSHOT_TASK_WRITE