pool.snapshottask.update ======================== Update a Periodic Snapshot Task with specific `id` See the documentation for `create` method for information on payload contents .. examples(websocket):: :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.snapshottask.update", "params": [ 1, { "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: id

id

Type: integer
Parameter 2: data

data

Type: object
No Additional Properties

Dataset

Type: string

Recursive

Type: boolean

Lifetime Value

Type: integer

Lifetime Unit

Type: enum (of string)
Must be one of:
  • "HOUR"
  • "DAY"
  • "WEEK"
  • "MONTH"
  • "YEAR"

Enabled

Type: boolean

Exclude

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Naming Schema

Type: string

Allow Empty

Type: boolean

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"

Fixate Removal Date

Type: boolean

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