iscsi.target.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
• IscsiTargetQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

IscsiTargetQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the iSCSI target.

name

Name

Type: string

Name of the iSCSI target (maximum 120 characters).

Must be at least 1 characters long

Must be at most 120 characters long

alias

Alias

Optional alias name for the iSCSI target.

Any of

• Option 1
• Option 2

Type: string

Type: null

mode

Mode

Type: enum (of string)

Protocol mode for the target.

• ISCSI: iSCSI protocol only
• FC: Fibre Channel protocol only
• BOTH: Both iSCSI and Fibre Channel protocols

Fibre Channel may only be selected on TrueNAS Enterprise-licensed systems with a suitable Fibre Channel HBA.

Must be one of:

• "ISCSI"
• "FC"
• "BOTH"

groups

Groups

Type: array of object

Array of portal-initiator group associations for this target.

No Additional Items

Each item of this array must be:

IscsiGroup

Type: object
No Additional Properties

portal Required

Portal

Type: integer

ID of the iSCSI portal to use for this target group.

initiator

Initiator

Default: null

ID of the authorized initiator group or null to allow any initiator.

Any of

• Option 1
• Option 2

Type: integer

Type: null

authmethod

Authmethod

Type: enum (of string) Default: "NONE"

Authentication method for this target group.

Must be one of:

• "NONE"
• "CHAP"
• "CHAP_MUTUAL"

auth

Auth

Default: null

ID of the authentication credential or null if no authentication.

Any of

• Option 1
• Option 2

Type: integer

Type: null

auth_networks

Auth Networks

Type: array of string

Array of network addresses allowed to access this target.

No Additional Items

Each item of this array must be:

Type: string

rel_tgt_id

Rel Tgt Id

Type: integer

Relative target ID number assigned by the system.

iscsi_parameters

Optional iSCSI-specific parameters for this target.

Any of

• IscsiTargetParameters
• Option 2

IscsiTargetParameters

Type: object
No Additional Properties

QueuedCommands

Queuedcommands

Default: null

Maximum number of queued commands per iSCSI session.

• 32: Standard queue depth for most use cases
• 128: Higher queue depth for performance-critical applications

Any of

• Option 1
• Option 2

Type: enum (of integer)

Must be one of:

• 32
• 128

Type: null

Type: null

IscsiTargetQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

Unique identifier for the iSCSI target.

name

Name

Type: string

Name of the iSCSI target (maximum 120 characters).

Must be at least 1 characters long

Must be at most 120 characters long

alias

Alias

Optional alias name for the iSCSI target.

Any of

• Option 1
• Option 2

Type: string

Type: null

mode

Mode

Type: enum (of string)

Protocol mode for the target.

• ISCSI: iSCSI protocol only
• FC: Fibre Channel protocol only
• BOTH: Both iSCSI and Fibre Channel protocols

Fibre Channel may only be selected on TrueNAS Enterprise-licensed systems with a suitable Fibre Channel HBA.

Must be one of:

• "ISCSI"
• "FC"
• "BOTH"

groups

Groups

Type: array

Array of portal-initiator group associations for this target.

No Additional Items

Each item of this array must be:

Type: object

auth_networks

Auth Networks

Type: array of string

Array of network addresses allowed to access this target.

No Additional Items

Each item of this array must be:

Type: string

rel_tgt_id

Rel Tgt Id

Type: integer

Relative target ID number assigned by the system.

iscsi_parameters

Optional iSCSI-specific parameters for this target.

Any of

• Option 1
• Option 2

Type: object

Type: null

Type: integer

Required roles: SHARING_ISCSI_TARGET_READ