iscsi.global.config

Type: object

Call parameters

Type: array
No Additional Items

Return value

IscsiGlobalEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for the global iSCSI configuration.

basename Required

Basename

Type: string

Base name prefix for iSCSI target IQNs.

isns_servers Required

Isns Servers

Type: array of string

Array of iSNS (Internet Storage Name Service) server addresses.

No Additional Items

Each item of this array must be:

Type: string

listen_port

Listen Port

Type: integer Default: 3260

TCP port number for iSCSI connections.

Value must be greater or equal to 1025 and lesser or equal to 65535

pool_avail_threshold

Pool Avail Threshold

Default: null

Pool available space threshold percentage or null to disable.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

alua Required

Alua

Type: boolean

Whether Asymmetric Logical Unit Access (ALUA) is enabled. Enabling is limited to TrueNAS Enterprise-licensed high availability systems. ALUA only works when configured on both the client and server.

iser Required

Iser

Type: boolean

Whether iSCSI Extensions for RDMA (iSER) are enabled. Enabling is limited to TrueNAS Enterprise-licensed systems and requires the system and network environment have Remote Direct Memory Access (RDMA)-capable hardware.

Required roles: SHARING_ISCSI_GLOBAL_READ