iscsi.global.sessions

Get a list of currently running iSCSI sessions. This includes initiator and target names and the unique connection IDs.

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: {}

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

Return value

Result

Any of

• Option 1
• IscsiSessionQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

IscsiSessionQueryResultItem

Type: object
No Additional Properties

initiator

Initiator

Type: string

initiator_addr

Initiator Addr

Type: string

initiator_alias

Initiator Alias

Any of

• Option 1
• Option 2

Type: string

Type: null

target

Target

Type: string

target_alias

Target Alias

Type: string

header_digest

Header Digest

Any of

• Option 1
• Option 2

Type: string

Type: null

data_digest

Data Digest

Any of

• Option 1
• Option 2

Type: string

Type: null

max_data_segment_length

Max Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_receive_data_segment_length

Max Receive Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_xmit_data_segment_length

Max Xmit Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_burst_length

Max Burst Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

first_burst_length

First Burst Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

immediate_data

Immediate Data

Type: boolean

iser

Iser

Type: boolean

offload

Offload

Type: boolean

IscsiSessionQueryResultItem

Type: object
No Additional Properties

initiator

Initiator

Type: string

initiator_addr

Initiator Addr

Type: string

initiator_alias

Initiator Alias

Any of

• Option 1
• Option 2

Type: string

Type: null

target

Target

Type: string

target_alias

Target Alias

Type: string

header_digest

Header Digest

Any of

• Option 1
• Option 2

Type: string

Type: null

data_digest

Data Digest

Any of

• Option 1
• Option 2

Type: string

Type: null

max_data_segment_length

Max Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_receive_data_segment_length

Max Receive Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_xmit_data_segment_length

Max Xmit Data Segment Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_burst_length

Max Burst Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

first_burst_length

First Burst Length

Any of

• Option 1
• Option 2

Type: integer

Type: null

immediate_data

Immediate Data

Type: boolean

iser

Iser

Type: boolean

offload

Offload

Type: boolean

Type: integer

Required roles: SHARING_ISCSI_GLOBAL_READ