iscsi.extent.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

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

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Return value

Result

Any of

• Option 1
• IscsiExtentQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

IscsiExtentQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the iSCSI extent.

name

Name

Type: string

Name of the iSCSI extent.

Must be at least 1 characters long

Must be at most 64 characters long

type

Type

Type: enum (of string)

Type of the extent storage backend.

Must be one of:

• "DISK"
• "FILE"

disk

Disk

Disk device to use for the extent or null if using a file.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Serial number for the extent or null to auto-generate.

Any of

• Option 1
• Option 2

Type: string

Type: null

path

Path

File path for file-based extents or null if using a disk.

Any of

• Option 1
• Option 2

Type: string

Type: null

filesize

Filesize

Size of the file-based extent in bytes.

Any of

• Option 1
• Option 2

Type: string

Type: integer

blocksize

Blocksize

Type: enum (of integer)

Block size for the extent in bytes.

Must be one of:

• 512
• 1024
• 2048
• 4096

pblocksize

Pblocksize

Type: boolean

Whether to use physical block size reporting.

avail_threshold

Avail Threshold

Available space threshold percentage or null to disable.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

comment

Comment

Type: string

Optional comment describing the extent.

naa

Naa

Type: string

Network Address Authority (NAA) identifier for the extent.

Must be at most 34 characters long

insecure_tpc

Insecure Tpc

Type: boolean

Whether to enable insecure Third Party Copy (TPC) operations.

xen

Xen

Type: boolean

Whether to enable Xen compatibility mode.

rpm

Rpm

Type: enum (of string)

Reported RPM type for the extent.

Must be one of:

• "UNKNOWN"
• "SSD"
• "5400"
• "7200"
• "10000"
• "15000"

ro

Ro

Type: boolean

Whether the extent is read-only.

enabled

Enabled

Type: boolean

Whether the extent is enabled and available for use.

vendor

Vendor

Type: string

Vendor string reported by the extent.

product_id

Product Id

Product ID string for the extent or null for default.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 16 characters long

Type: null

locked

Locked

Read-only value indicating whether the iscsi extent is located on a locked dataset.

• true: The extent is in a locked dataset.
• false: The extent is not in a locked dataset.
• null: Lock status is not available because path locking information was not requested.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

IscsiExtentQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the iSCSI extent.

name

Name

Type: string

Name of the iSCSI extent.

Must be at least 1 characters long

Must be at most 64 characters long

type

Type

Type: enum (of string)

Type of the extent storage backend.

Must be one of:

• "DISK"
• "FILE"

disk

Disk

Disk device to use for the extent or null if using a file.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Serial number for the extent or null to auto-generate.

Any of

• Option 1
• Option 2

Type: string

Type: null

path

Path

File path for file-based extents or null if using a disk.

Any of

• Option 1
• Option 2

Type: string

Type: null

filesize

Filesize

Size of the file-based extent in bytes.

Any of

• Option 1
• Option 2

Type: string

Type: integer

blocksize

Blocksize

Type: enum (of integer)

Block size for the extent in bytes.

Must be one of:

• 512
• 1024
• 2048
• 4096

pblocksize

Pblocksize

Type: boolean

Whether to use physical block size reporting.

avail_threshold

Avail Threshold

Available space threshold percentage or null to disable.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

comment

Comment

Type: string

Optional comment describing the extent.

naa

Naa

Type: string

Network Address Authority (NAA) identifier for the extent.

Must be at most 34 characters long

insecure_tpc

Insecure Tpc

Type: boolean

Whether to enable insecure Third Party Copy (TPC) operations.

xen

Xen

Type: boolean

Whether to enable Xen compatibility mode.

rpm

Rpm

Type: enum (of string)

Reported RPM type for the extent.

Must be one of:

• "UNKNOWN"
• "SSD"
• "5400"
• "7200"
• "10000"
• "15000"

ro

Ro

Type: boolean

Whether the extent is read-only.

enabled

Enabled

Type: boolean

Whether the extent is enabled and available for use.

vendor

Vendor

Type: string

Vendor string reported by the extent.

product_id

Product Id

Product ID string for the extent or null for default.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 16 characters long

Type: null

locked

Locked

Read-only value indicating whether the iscsi extent is located on a locked dataset.

• true: The extent is in a locked dataset.
• false: The extent is not in a locked dataset.
• null: Lock status is not available because path locking information was not requested.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

Type: integer

Required roles: SHARING_ISCSI_EXTENT_READ