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
No Additional Properties
No Additional Items
Type: array
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: data
data
Type: objectNo Additional Properties
Dataset
Type: stringRecursive
Type: boolean Default: falseLifetime Value
Type: integer Default: 2Lifetime Unit
Type: enum (of string) Default: "WEEK"Must be one of:
- "HOUR"
- "DAY"
- "WEEK"
- "MONTH"
- "YEAR"
Enabled
Type: boolean Default: trueExclude
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 Type: object
PoolSnapshotTaskEntry
Type: objectNo Additional Properties
Dataset
Type: stringRecursive
Type: boolean Default: falseLifetime Value
Type: integer Default: 2Lifetime Unit
Type: enum (of string) Default: "WEEK"Must be one of:
- "HOUR"
- "DAY"
- "WEEK"
- "MONTH"
- "YEAR"
Enabled
Type: boolean Default: trueExclude
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 Type: object
Id
Type: integerVmware Sync
Type: booleanState
Type: objectRequired roles: SNAPSHOT_TASK_WRITE