pool.snapshottask.update

Update a Periodic Snapshot Task with specific id

See the documentation for create method for information on payload contents

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: data

data

Type: object
No Additional Properties

dataset

Dataset

Type: string

recursive

Recursive

Type: boolean

lifetime_value

Lifetime Value

Type: integer

lifetime_unit

Lifetime Unit

Type: enum (of string)

Must be one of:

• "HOUR"
• "DAY"
• "WEEK"
• "MONTH"
• "YEAR"

enabled

Enabled

Type: boolean

exclude

Exclude

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

naming_schema

Naming Schema

Type: string

allow_empty

Allow Empty

Type: boolean

schedule

PoolSnapshotTaskCron

Type: object
No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

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

dow

Dow

Type: string Default: "*"

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

begin

Begin

Type: string Default: "00:00"

end

End

Type: string Default: "23:59"

fixate_removal_date

Fixate Removal Date

Type: boolean

Return value

PoolSnapshotTaskEntry

Type: object
No Additional Properties

dataset Required

Dataset

Type: string

recursive

Recursive

Type: boolean Default: false

lifetime_value

Lifetime Value

Type: integer Default: 2

lifetime_unit

Lifetime Unit

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

Must be one of:

• "HOUR"
• "DAY"
• "WEEK"
• "MONTH"
• "YEAR"

enabled

Enabled

Type: boolean Default: true

exclude

Exclude

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

Each item of this array must be:

Type: string

naming_schema

Naming Schema

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

allow_empty

Allow Empty

Type: boolean Default: true

schedule

PoolSnapshotTaskCron

Type: object
No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

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

dow

Dow

Type: string Default: "*"

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

begin

Begin

Type: string Default: "00:00"

end

End

Type: string Default: "23:59"

id Required

Id

Type: integer

state Required

State

Type: object

vmware_sync Required

Vmware Sync

Type: boolean

Required roles: SNAPSHOT_TASK_WRITE