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.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the periodic snapshot task to analyze.

Parameter 2: data

data

Type: object

Proposed configuration changes to analyze.

No Additional Properties

dataset

Dataset

Type: string

The dataset to take snapshots of.

recursive

Recursive

Type: boolean

Whether to recursively snapshot child datasets.

lifetime_value

Lifetime Value

Type: integer

Number of time units to retain snapshots. lifetime_unit gives the time unit.

lifetime_unit

Lifetime Unit

Type: enum (of string)

Unit of time for snapshot retention.

Must be one of:

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

enabled

Enabled

Type: boolean

Whether this periodic snapshot task is enabled.

exclude

Exclude

Type: array of string

Array of dataset patterns to exclude from recursive snapshots.

No Additional Items

Each item of this array must be:

Type: string

naming_schema

Naming Schema

Type: string

Naming pattern for generated snapshots using strftime format.

allow_empty

Allow Empty

Type: boolean

Whether to take snapshots even if no data has changed.

schedule

PoolSnapshotTaskCron

Type: object

Cron schedule for when snapshots should be taken.

No Additional Properties

minute

Minute

Type: string Default: "00"

Minute when snapshots should be taken (cron format).

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"

Start time of the window when snapshots can be taken.

Examples:

"00:00"

"06:30"

"18:00"

"23:00"

end

End

Type: string Default: "23:59"

End time of the window when snapshots can be taken.

Examples:

"00:00"

"06:30"

"18:00"

"23:00"

Return value

Result

Type: object

Object mapping retention change types to arrays of affected snapshot names.

Additional Properties

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