# iscsi.target.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: integer

##### Parameter 2: options

#### options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

##

#### 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

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

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

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

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

##

#### 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

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

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

Type: boolean Default: false

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

##

#### iSCSITargetEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the iSCSI target.

##

#### 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

Default: null

Optional alias name for the iSCSI target.

## Any of

Type: string
Type: null

##

#### Mode

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

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

Type: array of object Default: []

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

Type: integer

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

##

#### Initiator

Default: null

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

## Any of

Type: integer
Type: null

##

#### Authmethod

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

Authentication method for this target group.

##### Must be one of:

- "NONE"
- "CHAP"
- "CHAP_MUTUAL"

##

#### Auth

Default: null

ID of the authentication credential or `null` if no authentication.

## Any of

Type: integer
Type: null

##

#### Auth Networks

Type: array of string Default: []

Array of network addresses allowed to access this target.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Rel Tgt Id

Type: integer

Relative target ID number assigned by the system.

##

Default: null

Optional iSCSI-specific parameters for this target.

## Any of

#### IscsiTargetParameters

Type: object
No Additional Properties

##

#### 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

Type: enum (of integer)

##### Must be one of:

- 32
- 128

Type: null
Type: null

Required roles: SHARING_ISCSI_TARGET_READ