iscsi.target.update

Update iSCSI Target of id.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the iSCSI target to update.

Parameter 2: iscsi_target_update

iscsi_target_update

Type: object

Updated iSCSI target configuration data.

No Additional Properties

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

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

Return value

IscsiTargetEntry

Type: object

The updated iSCSI target configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the iSCSI target.

name Required

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

Default: null

Optional alias name for the iSCSI target.

Any of

• Option 1
• Option 2

Type: string

Type: null

mode

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

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

Rel Tgt Id

Type: integer

Relative target ID number assigned by the system.

iscsi_parameters

Default: null

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

Required roles: SHARING_ISCSI_TARGET_WRITE