pool.snapshottask.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

order_by

Order By

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

Each item of this array must be:

Type: string

select

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

count

Count

Type: boolean Default: false

get

Get

Type: boolean Default: false

offset

Offset

Type: integer Default: 0

limit

Limit

Type: integer Default: 0

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• PoolSnapshotTaskQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

PoolSnapshotTaskQueryResultItem

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"

Examples:

"00:00"

"06:30"

"18:00"

"23:00"

end

End

Type: string Default: "23:59"

Examples:

"00:00"

"06:30"

"18:00"

"23:00"

id

Id

Type: integer

vmware_sync

Vmware Sync

Type: boolean

state

State

Type: object

PoolSnapshotTaskQueryResultItem

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

Type: object

id

Id

Type: integer

vmware_sync

Vmware Sync

Type: boolean

state

State

Type: object

Type: integer

Required roles: SNAPSHOT_TASK_READ