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: []

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

Type: array of object

Array of active iSCSI sessions.

No Additional Items

Each item of this array must be:

IscsiSession

Type: object
No Additional Properties

initiator Required

Initiator

Type: string

iSCSI Qualified Name (IQN) of the initiator.

initiator_addr Required

Initiator Addr

Type: string

IP address of the initiator.

initiator_alias Required

Initiator Alias

Alias name of the initiator or null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

target Required

Target

Type: string

iSCSI Qualified Name (IQN) of the target.

target_alias Required

Target Alias

Type: string

Alias name of the target.

header_digest Required

Header Digest

Header digest algorithm used for the session or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

data_digest Required

Data Digest

Data digest algorithm used for the session or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

max_data_segment_length Required

Max Data Segment Length

Maximum data segment length for the session or null.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_receive_data_segment_length Required

Max Receive Data Segment Length

Maximum receive data segment length or null.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_xmit_data_segment_length Required

Max Xmit Data Segment Length

Maximum transmit data segment length or null.

Any of

• Option 1
• Option 2

Type: integer

Type: null

max_burst_length Required

Max Burst Length

Maximum burst length for the session or null.

Any of

• Option 1
• Option 2

Type: integer

Type: null

first_burst_length Required

First Burst Length

First burst length for the session or null.

Any of

• Option 1
• Option 2

Type: integer

Type: null

immediate_data Required

Immediate Data

Type: boolean

Whether immediate data transfer is enabled.

iser Required

Iser

Type: boolean

Whether this session is using iSER (iSCSI Extensions for RDMA).

offload Required

Offload

Type: boolean

Whether hardware offload is enabled for this session.

Required roles: SHARING_ISCSI_GLOBAL_READ