pool.snapshottask.create

Create a periodic snapshot task.

Snapshots are automatically destroyed after their configured lifetime. If multiple periodic tasks create a snapshot at the same time (for example, an hourly and a daily task at 00:00), the snapshot is kept until the last of those tasks reaches its expiry time.

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