Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode
TrueNAS.com Software Systems Company Community Security iX Portal Download

  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. UI Reference Guide
  6. /
  7. Shares
  8. /
  9. Block Shares (iSCSI)
  10. /
  11. Block (iSCSI) Share Target Screens
Edit this page

Block (iSCSI) Share Target Screens

  12 minute read.

Last Modified 2022-12-13 12:31 -0500

The Sharing screen opens after you click Shares on the main navigation panel.

Block (iSCSI) Shares Targets Widget

The Block (iSCSI) Shares Targets widget displays the widget toolbar with the status of the iSCSI service and two buttons, Configure and Add. After adding a block share, the widget displays shares below the toolbar.

BlockiSCSIShareTargetsWidgetToolbar

After adding an iSCSI target or share, the widget toolbar displays the STOPPED service status in red and includes the share below.

Before you add your first iSCSI block share, click anywhere on Block (iSCSI) Shares Targets launch to open the Sharing > iSCSI screen with the Targets iSCSI configuration tab displayed.

The No Targets screen opens only when the system does not have an iSCSI target configured on the system.

iSCSINoTargetsScreen

Add Targets and the Add button on the toolbar opens the Add ISCSI Target screen.

Configure on the widget toolbar opens the Sharing > iSCSI screen with the configuration tabs displayed. Target Global Configuration displays the first time you click Configure.

The more_vert on the toolbar displays options to turn the iSCSI service on or off. Turn Off Service displays if the service is running. Otherwise, Turn On Service displays. The Config Service option opens the configuration tabs Target Global Configuration screen.

If you have other share types added to your TrueNAS, the widget displays as a card occupying a quarter of the Sharing screen.

SharingScreenWithiSCSIShareAdded

View Details also opens the iSCSI configuration tabs. Each tab includes details on the block shares added to the system.

Add and Edit iSCSI Target Screens

The Add iSCSI Target and Edit iSCSI Target screens display the same settings, but the current settings populate the Edit iSCSI Target screen settings for the selected share.

To access this screen from the Block (iSCSI) Shares Targets widget toolbar, click Add. Click the share to access the Edit iSCSI Target screen from the widget.

To access the Add iSCSI Target screen from the configuration tabs, while on the Targets tab, click Add at the top of the screen. To access the Edit iSCSI Target screen from the configuration tabs, while on the Targets tab, click next to the share and then click Edit.

AddiSCSITargetScreen

Basic Info Settings

Setting Description
Target Name Required. Enter a name using lowercase alphanumeric characters. Allowed characters are plus dot (.), dash (-), and colon (:). A name longer than 63 characters can prevent access to the block. See the “Constructing iSCSI names using the iqn.format” section of RFC3721. The base name is automatically prepended if the target name does not start with iqn.
Target Alias Enter an optional user-friendly name.

iSCSI Group Settings

To display the iSCSI Group settings, click Add.

Setting Description
Portal Group ID Required. Select the number of the existing portal to use or leave it empty.
Initiator Group ID Select the existing initiator group ID that has access to the target from the dropdown list of options. None, 1(init1), or 3(ALL initiators Allowed).
Authentication Method Select the method from the dropdown list of options. None, CHAP or Mutual Chap. iSCSI supports multiple authentication methods that targets can use to discover valid devices. None allows anonymous discovery. If set to None you can leave Discovery Authentication Group set to None or empty. If set to CHAP or Mutual CHAP you must enter or create a new group in Discovery Authentication Group.
Authentication Group Number Select the option from the dropdown list. This is the group ID created in Authorized Access. Required when the Discovery Authentication Method is set to CHAP or Mutual CHAP. Select None or the value representing the number of the existing authorized accesses.

iSCSI Configuration Screens

The iSCSI configuration screens display seven tabs, one for each of the share configuration areas.

SharingISCSIWizardDeviceSCALE

The Add button at the top of the Sharing > iSCSI screen works with the currently selected tab or screen. For example, if Portals is the current tab/screen, the Add button opens the Sharing > iSCSI > Portals > Add screen.

The on configure tab screens with list views display the Edit and Delete options. Edit opens the Edit screen for the selected tab screen. For example, when on the Portals tab/screen, the Sharing > iSCSI > Portals > Edit screen opens.

The Delete option opens the delete dialog for the screen currently selected.

The Add and Edit screens display the same settings.

Target Global Configuration Screen

The Target Global Configuration displays configuration settings that apply to all iSCSI shares. There are no add, edit, or delete options for this screen. It opens after you click Configure on the Block (iSCSI) Share Target widget on the Sharing screen. It also opens when you click Config Service.

The System Settings > Services > iSCSI displays the Target Global Configuration and all the other configuration screens after you click the iSCSI Config option on the Services screen.

SharingISCSIManualTargetGlobalConfigSCALE

Setting Description
Base Name Enter a name using lowercase alphanumeric characters. Allowed characters include the dot (.), dash (-), and colon (:). See the “Constructing iSCSI names using the iqn.format” section of RFC3721.
ISNS Servers Enter host names or IP addresses of the ISNS servers to register with the iSCSI targets and portals of the system. Separate entries by pressing Enter.
Pool Available Space Threshold (%) Enters a value for the threshold percentage that generates an alert when the pool has this percent space remaining. This is typically configured at the pool level when using zvols or at the extent level for both file and device-based extents.
iSCSI listen port The TCP port number that the controller uses to listen for iSCSI logins from host iSCSI initiators.

Portal Screens

The configuration tabs Portals screen displays a list of portal ID groups on the TrueNAS system.

SharingiSCSIPortalsScreen

The next to the portal displays the Edit and Delete options. Delete opens the Delete dialog for the selected portal ID. Click Confirm and then Delete to delete the selected portal.

Add opens the Sharing > iSCSI > Portals > Add screen. Edit opens the Sharing > iSCSI > Portals > Edit screen. Both screens have the same setting options.

SharingiSCSIPortalsAddScreen

Basic Info Settings

Setting Description
Description Enter an optional description. Portals are automatically assigned a numeric group.

Authentication Method and Group Settings

Setting Description
Discovery Authentication Method Select the discovery method you want to use for authentication from the dropdown list. iSCSI supports multiple authentication methods that targets can use to discover valid devices. None allows anonymous discovery. If set to None, you can leave Discovery Authentication Group set to None or empty. If set to CHAP or Mutual CHAP, you must enter or create a new group in Discovery Authentication Group.
Discovery Authentication Group Select the discovery authentication group you want to use from the dropdown list. This is the group ID created in Authorized Access. Required when the Discovery Authentication Method is CHAP or Mutual CHAP. Select None or Create New. Create New displays additional setting options.

IP Address Settings

Setting Description
IP Address Select the IP addresses the portal listens to. Click Add to add IP addresses with a different network port. 0.0.0.0 listens on all IPv4 addresses, and :: listens on all IPv6 addresses.
Port TCP port used to access the iSCSI target. The default is 3260.
ADD Adds another IP address row.

Initiators Groups Screen

The Initiators Groups screen display settings to create new authorized access client groups or edit existing ones in the list.

SharingiSCSIInitiatorsGroupsScreen

The next to the initiator group displays the Edit and Delete options. Delete opens the Delete dialog for the selected group ID. Click Confirm and then Delete to delete the selected portal.

Add opens the Sharing > iSCSI > Initiators > Add screen. Edit opens the Sharing > iSCSI > Initiators > Edit screen. Both screens have the same setting options.

SharingISCSIInitiatorsAddScreen

Setting Description
Allow All Initiators Select to allows all initiators.
Allowed Initiators (IQN) Enter initiators allowed access to this system. Enter an iSCSI Qualified Name (IQN) and click + to add it to the list. Example: iqn.1994-09.org.freebsd:freenas.local.
Authorized Networks Enter network addresses allowed to use this initiator. Each address can include an optional CIDR netmask. Click + to add the network address to the list. Example: 192.168.2.0/24.
Description Enter any notes about the initiators.

Authorized Access Screen

The Authorized Access screen displays settings to create new authorized access networks or edit existing ones in the list.

If you have not set up authorized access yet, the No Authorized Access screen displays with the Add Authorized Access button in the center of the screen. Add Authorized Access or Add at the top of the screen opens the Sharing > iSCSI > Authorized Access > Add screen.

SharingiSCSIAuthAccessNoAuthAccess

After adding authorized access to the system, the Authorized Access screen displays a list of users.

SharingiSCSIAuthorizedAccessScreen

ADD opens the Sharing > iSCSI > Authorized ACcess > Add screen.

The next to each entry displays two options, Edit and Delete. Edit opens the Sharing > iSCSI > Authorized ACcess > Edit screen, and Delete opens a dialog to delete the authorized access for the selected user. The Add and Edit screens display the same settings.

SharingiSCSIAuthAccessAddScreen

Group Settings

Setting Description
Group ID Enter a number. This allows configuring different groups with different authentication profiles. Example: all users with a group ID of 1 inherit the authentication profile associated with Group 1.

User Settings

Setting Description
User User account to create CHAP authentication with the user on the remote system. Many initiators use the initiator name as the user name.
Secret Enter the user password. Secret must be at least 12 and no more than 16 characters long. The screen displays a “password does not match” error until you enter the same password in Secret (Confirm).
Secret (Confirm) Enter the same password to confirm the user password.

Peer User Settings

Setting Description
Peer User Optional. Enter only when configuring mutual CHAP. Usually the same value as User.
Peer Secret Enter the mutual secret password. Required if entering a Peer User. Must be a different password than the password in Secret.
Peer Secret (Confirm) Enter the same password to confirm the mutual secret password.

Targets Screen

The Targets screen displays settings to create new TrueNAS storage resources or edit existing ones in the list.

SharingiSCSITargetsScreen

ADD opens the Add iSCSI Targets screen.

The next to each entry displays two options, Edit and Delete. Edit opens the Edit iSCSI Targets screen, and Delete opens a dialog to delete the select target. The Add iSCSI Targets and Edit iSCSI Targets screens display the same settings.

Extents Screen

The Extents screen displays settings to create new shared storage units or edit existing ones in the list.

SharingiSCSIExtentsScreen

ADD opens the Sharing > iSCSI > Extents > Add screen.

The next to each entry opens two options, Edit and Delete. Edit opens the Sharing > iSCSI > Extents > Edit screen, and Delete opens a dialog to delete the extents for the selected user. The Add and Edit screens display the same settings.

SharingISCSIExtentsAddScreentop

Basic Info Settings

Setting Description
Name Enter a name for the extent. An Extent where the size is not 0, cannot be an existing file within the pool or dataset.
Description Enter any notes about this extent.
Enabled Select to enable the iSCSI extent.

Type Settings

SharingiSCSIExtentAddFilename

Setting Description
Extent Type elect the extent (zvol) option from the dropdown list. Device provides virtual storage access to zvols, zvol snapshots, or physical devices. File provides virtual storage access to a single file. Device provides virtual storage access to zvols, zvol snapshots, or physical devices. File provides virtual storage access to a single file.
Device Required. Displays if Extent Type is set to Device. Select the unformatted disk, controller, or zvol snapshot.
Path to the Extent Displays when Extent Type is set to File. Click the play_arrow to browse an existing file. Create a new file by browsing to a dataset and appending /{filename.ext} to the path. Users cannot create extents inside a jail root directory.
Filesize Only appears if File is selected. Entering 0 uses the actual file size and requires that the file already exists. Otherwise, specify the file size for the new file.
Logical Block Size Enter a new value or leave it at the default of 512 unless the initiator requires a different block size.
Disable Physical Block Size Reporting Select if the initiator does not support physical block size values over 4K (MS SQL).

Compatibility Settings

Setting Description
Enable TPC Select to allow an initiator to bypass normal access control and access any scannable target. This allows xcopy operations that are otherwise blocked by access control.
Xen initiator compat mode Select when using Xen as the iSCSI initiator.
LUN RPM Select the option from the dropdown list. Options are UNKNOWN, 5400, 7200, 10000 or 15000. Do not change this setting when using Windows as the initiator. Only change LUN RPM in large environments where the number of systems using a specific RPM is needed for accurate reporting statistics.
Read-only Select to prevent the initiator from initializing this LUN.

Associated Targets Screen

The Associated Targets screen displays settings to create new associated TrueNAS storage resources or edit existing ones in the list.

SharingiSCSIAssociatedTargetsScreen

ADD opens the Sharing > iSCSI > Associated Targets > Add screen.

The next to each entry displays two options, Edit and Delete. Edit opens the Sharing > iSCSI >Associated Targets > Edit screen, and Delete opens a dialog to delete the associated targets for the selected user. The Add and Edit screens display the same settings.

SharingISCSIAssociatedTargetsAdd

Setting Description
Target Required. Select an existing target.
LUN ID Select the value or enter a value between 0 and 1023. Some initiators expect a value below 256. Leave this field blank to automatically assign the next available ID.
Extent Required. Select an existing extent.

Related Content