pool.snapshottask.update_will_change_retention_for ================================================== Returns a list of snapshots which will change the retention if periodic snapshot task `id` is updated with `data`. .. 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"

Result

Type: object

Each additional property must conform to the following schema

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


*Required roles:* SNAPSHOT_TASK_READ