TrueNASTrueNAS Nightly Development Documentation
This content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.

Fibre Channel Screens

TrueNAS Enterprise
Fibre Channel is a TrueNAS Enterprise feature. Only TrueNAS systems licensed for Fibre Channel show iSCSI Fibre Channel screens and settings found by going to Sharing > Block Shares (iSCSI).

Enterprise systems with fibre channel hardware can access fibre channel settings and screens through various iSCSI wizard and share screens.

iSCSI Wizard Screens - Fibre Channel.

The Block (iSCSI) Shares Targets widget shows iSCSI shares configured for fibre channels. The Wizard button on the header opens the Wizard iSCSI wizard on the Target screen. See Target Screens - Fibre Channel below.

Block (iSCSI) Shares Targets Widget with Fibre Channel
Figure 1: Block (iSCSI) Shares Targets Widget with Fibre Channel

The more_vert icon button shows two options: a toggle for Turn On Service/Turn Off Service and Config Service. Config Service opens the iSCSI Global Configuration screen.

iSCSI Target Wizard Screen - Fibre Channel

The Wizard button opens the iSCSI wizard on the Targets screen with the Fibre Channel option. The wizard has three screens:

  • Target
  • Extent
  • Protocol Options

To access the individual iSCSI screens click on the iSCSI widget header. The Targets screen opens by default. For more information on iSCSI screens and settings, see iSCSI Screens - Fibre Channel below.

Next advances to the next wizard screen. Back shows the previous wizard screen. Save creates the iSCSI share.

iSCSI Wizard Target Screen - Fibre Channel

The iSCSI Wizard opens showing the Target screen with the Fibre Channel option. Select to configure the target for fibre channel.

iSCSI Wizard Target Screen - Fibre Channel
Figure 2: iSCSI Wizard Target Screen - Fibre Channel

The Target dropdown shows the default Create New. Selecting Create New creates a share. Selecting an existing target from the dropdown list allows you to edit that target.

iSCSI Wizard Extent Screen - Fibre Channel

The iSCSI wizard Extent screen shows settings to name the share, set the type of extent devices, and the sharing platform for the device.

Wizard Extent Settings
SettingDescription
NameThe name given to the iSCSI block share. Enter a name using up to 64 lowercase alphanumeric and special characters. Allowed characters are dot (.), dash (-), and colon (:). A name longer than 64 characters is not allowed. See the “Constructing iSCSI names using the iqn.format” section of RFC3721. The base name (from Target Global Configuration) is automatically prepended if the target name does not start with iqn.
Extent TypeHas two options: Device and File. Select an option to show other settings for each option.
DeviceShows if Extent Type is set to Device. Shows Create New or a list of iSCSI devices added to the system. Create New shows additional settings.
Pool/DatasetShows after selecting Create New in Device. Enter or browse to select the path to the mount point. Browsing to select the dataset activates the Create Dataset option. Click to open the Create Dataset dialog, which creates a zvol.
SizeShows after clicking Create New in Device and after adding the mount point in Pool/Dataset. Enter a numerical value and suffix to specify the size of the zvol you are creating.
Path to the ExtentShows if Extent Type is set to File. Enter or browse to select the mount point for the directory the extent uses. If a directory does not exist, after selecting the dataset where you want to add the directory, then enter a / followed by the name to add the directory to the dataset.
FilesizeShows if the Extent Type is set to File. Enter the size for the directory. Leaving this set to 0 uses the actual file size and requires the file to exist. Otherwise, specify the file size for the new file.
Sharing PlatformShows for both options. Select the platform that matches your use case. Options are:
  • VMware: Extent block size 512b, TCP enabled, no Zen compat mode, SSD speed
  • Xen: Extent block size 512b, TCP enabled, Xen compat mode enabled, SSD speed
  • Legacy OS: Extent block size 512b, TCP enabled, no Xen compat mode, SSD speed
  • Modern OS: Extent block size 4k, TCP enabled, no Xen compat mode, SSD speed
  • iSCSI Wizard Protocol Options Screen - Fibre Channel

    The iSCSI wizard Protocol Options screen for fibre channel shows three setting options to configure fibre channel ports and initiators.

    iSCSI Wizard Protocol Options Create New Virtual Port
    Figure 5: iSCSI Wizard Protocol Options Create New Virtual Port
    Wizard Protocol Options for Fibre Channel Settings
    SettingDescription
    Do not connect to a fibre channel portSelect to configure the share to not connect to a fibre channel port.
    Use an existing portSelect to connect the share to an existing fibre channel port.
    Create a new virtual portSelect to create a new virtual port. Shows the Create a new virtual port field. Select from the options on the dropdown list.

    iSCSI Share Screens - Fibre Channel

    Clicking on the iSCSI widget header opens the iSCSI share screens.

    Global Target Configuration opens the iSCSI service configuration screen.

    Wizard opens the iSCSI wizard configuration screens.

    The iSCSI shares screen opens showing Targets by default.

    Six tabs show for each of the following screens: Targets, Extents, Initiators, Portals, Authorized Access, and Fibre Channel Ports. Each shows what is configured on the system, and provides access to the add and edit configuration screens for each functional area.

    iSCSI Global Configuration Screen

    The iSCSI Global Configuration screen opens when you click Edit on the iSCSI Service row of the System > Services screen, and after clicking the Global Target Configuration button at the top of all iSCSI share screens.

    Global Configuration Settings
    SettingDescription
    Base NameEnter a name using lowercase alphanumeric characters. Allowed special characters are dot (.), dash (-), and colon (:). See the “Constructing iSCSI names using the iqn.format” section RFC3721 for more information.
    ISNS ServersEnter host names or IP addresses of the ISNS servers to be registered with the iSCSI targets and portals of the system. Press Enter to separate each entry.
    Pool Available Space Threshold (%)Generate an alert when the pool reaches this percentage of 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 portTCP port used to access the iSCSI target. The default is 3260.

    Targets Screens - Fibre Channel

    The iSCSI Targets screen shows a list of targets configured in the system and provides access to the add and edit configuration screens. Select a target to see details about that item.

    iSCSI Targets Screen - Fibre Channel
    Figure 7: iSCSI Wizard Targets Screen - Fibre Channel

    Add and Edit open the configuration screen for the selected target. Delete opens a dialog with delete options.

    Details for Target

    The screen shows four widgets on the right side of the screen for the selected target: Fibre Channel Port, Fibre Channel Connections, Extents, and iSCSI Connections.

    Fibre Channel Port shows the fibre channel port showing the two HA assignments configured on the system, one for the HA primary controller and the other for the standby controller. These are created when you add the targets for an HA system or migrate existing from an earlier TrueNAS (13.0 or 13.3) release to the latest release.

    Fibre Channel Connections shows the schema name for the ports assigned to each controller in an HA system.

    Extents shows a list of LUNs, and includes two options: Associate button and a Remove Extent Association link_off icon.

    iSCSI Connections shows a list of the connections configured on the system.

    Delete Target Dialog

    Delete opens a confiration dialog with two options: Delete 1 associated extent and Force Delete. Select the options to include in the delete operation.

    Delete 1 associated extent shows the number of associated extend for the selected target.

    Force Delete deletes the target even if the share is still in use.

    Cancel closes the dialog without deleting. Delete deletes the target but does not delete the iSCSI volumes associated with the extents.

    Remove Extent Association Dialog

    The Remove Extent Association link_off icon opens the Remove extent association dialog that shows the LUN link association and two buttons: Cancel and Remove. Removing the association activates the Associate button on the widget.

    Associate Dialog

    The Associate button is inactive when the extent is associated with a LUN. Removing the association activates the button. Clicking the button opens the Associate target dialog.

    Enter a LUN ID between 0 and 1023 into LUN ID. SCALE requires at least one LUN 0. Some initiators expect a value between 0 and 256. Leaving this field blank automatically assigns the next available ID.

    Select the target on the Extent dropdown list.

    Add and Edit iSCSI Target Screens - Fibre Channel

    The Add Target and Edit Target screens show the same configuration settings.

    Target Basic Info Settings
    SettingDescription
    Target NameEnter the name for the target using up to 64 lowercase alphanumeric and special characters. Allowed characters are dot (.), dash (-), and colon (:). A name longer than 64 characters is not allowed. See the “Constructing iSCSI names using the iqn.format” section of RFC3721. The base name (from Target Global Configuration) is automatically prepended if the target name does not start with iqn.
    Target AliasEnter an optional user-friendly name.
    ModeMode shows three options for a target:
  • iSCSI - Select to create a standard iSCSI share target.
  • Fibre Channel - Select to configure an iSCSI target that includes fibre channel.
  • Both - Select to use both modes.
  • Authorized NetworksAuthorized networks allow communication between initiators (client computers) and iSCSI targets (storage devices) over the IP network. Add shows the Network field.
    NetworkShows after clicking Add to the right of Authorized Networks. Enter the IP address for the network and select the netmask (CIDR) from the dropdown list. Adds the network address to the authorized network list.
    Do not connect to a fibre channel portSelect to create an iSCSI share and target withoug fibre channel.
    Use an existing portSelect to use an existing iSCSI port(s) already configured on the system. Select when migrating an existing TrueNAS FreeBSD-based iSCSI fibre channel configuration to a later TruenNAS Debian Linux-based release. Shows a dropdown list with existing ports.
    Create new virtual portSelect to create a new virtual iSCSI port for fibre channel configuration. Use when setting up a new iSCSI share target and fibre channel ports. Shows the Create a new virtual port field. Select from the options on the dropdown list.

    Target iSCSI Group Settings
    SettingDescription
    Add GroupsAdds a collection of network interfaces, IP addresses, and TCP ports, on a storage device that an iSCSI initiator can connect to. Groups are also known as target portal groups. Add shows a group configuration field each time it is clicked.
    Portal Group IDSelect the ID from the dropdown list. Shows a group for each iSCSI share added to the system with a number assignment, for example, 1 (test2) for the test2 target/share. Portal groups are created on the Add Portal screen.
    Initiator Group IDSelect the group ID from the dropdown list. Shows a group for each portal ID configured on the system, for example, *1 (ALL Initiators Allowed). Initiator groups have access to the target.
    Authentication MethodSelect the authentication method from the dropdown list of options. Options are:
  • None - Select to allow anonymous discovery. When set to None you can leave Discovery Authentication Group set to None or empty.
  • CHAP - Select to use the Challenge Handshake Authentication Protocol (CHAP) method. CHAP verifies the identity of an iSCSI initiator (device trying to access storage) by sending a challenge that only the authentic initiator can correctly respond to. This prevents unauthorized access to the storage target. Think of it like a password-based authentication system for iSCSI connections. When set to CHAP you must enter or create a new group in Discovery Authentication on the Add or Edit Authorized Access screen.
  • Mutual CHAP- Select to use CHAP where both the iSCSI initiator (client) and target server mutually authenticate each other using the CHAP method. Each side verifies the identity of the other before establishing a connection. This provides a higher level of security compared to one-way CHAP. When set to mutual CHAP you must enter or create a new group in Discovery Authentication on the Add or Edit Authorized Access screen.
  • Authentication Group NumberSelect the group from the dropdown list. An authentication group is configured on the Add Authorized Access screen. 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.

    Extents Screens - Fibre Channel

    The Extents screen shows a table listing extents configured on the system. Extents are shared storage units.

    iSCSI Extents Screen - Fibre Channel
    Figure 13: iSCSI Extents Screen - Fibre Channel

    Add and Edit open the configuration screen for the selected target. Delete opens a dialog with delete options.

    Delete Extent Dialog

    The Delete iSCSI Extent name deletes the specified extend. The name of the extent shows in the dialog title.

    Force allows deleting the extend even if the share is active.

    Delete deletes the extent and closes the dialog. Cancel closes the dialog without deleting the extent.

    Add or Edit Extent Screens - Fibre Channel

    The Add Extent and Edit Extent screens show the same configuration settings.

    Extent Basic Info Settings
    SettingDescription
    NameEnter a name for the extent. An Extent where the size is not 0, cannot be an existing file within the pool or dataset.
    DescriptionEnter any notes about this extent.
    EnabledSelect to enable the iSCSI extent.
    Extent Compatibility Settings
    SettingDescription
    Enable TPCSelect to allow an initiator to bypass normal access control and access any scannable target. Third Party Copy (TPC) enables a disk target to process Extended Copy (XCOPY) operations that would otherwise be blocked, allowing data transfers to occur directly between storage devices without passing through the initiator.
    Xen initiator compat modeSelect when using Xen as the iSCSI initiator.
    LUN RPMSelect the option from the dropdown list. Options are UNKNOWN, SSD, 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-onlySelect to prevent the initiator from initializing this LUN.
    Extent Type Settings
    SettingDescription
    Extent TypeProvides virtual storage access to zvols, zvol snapshots, or physical devices. Select the extent (zvol) option from the dropdown list. Dropdown options:
  • Device - Select to specify a device (default option). Device provides virtual storage access to zvols, zvol snapshots, or physical devices. Shows the Device field.
  • File - Select to specify a path to a file. File provides virtual storage access to a single file. Shows the Path to the Extent and Filesize fields.
  • DeviceShows after specifying Device in Extent Type. Select the unused zvol or zvol snapshot from the dropdown list.
    Path to the ExtentEnter or browse to select the path to an existing file. Enter a slash (/) followed by a file name to create a file in a dataset and append the file name to the path (/filename.ext).
    FilesizeEnter 0 to use the actual file size of an existing file, or specify the file size for the new file added in Path to the Extent.
    Logical Block SizeShows the default 512 size. If the initiator requires a different block size, enter the numerical value.
    Disable Physical Block Size ReportingSelect if the initiator does not support physical block size values over 4K (MS SQL).

    Initiators Screens - Fibre Channel

    The Initiators Groups screen shows a table listing initiator groups configured on the system.

    iSCSI Initiator Screen - Fibre Channel
    Figure 17: iSCSI Initiator Screen - Fibre Channel

    Add opens the Add Initiator screen. Edit opens a version of the Add Initiator screen with only two fields. Delete opens a dialog to delete an initiator group.

    Add Initiator Screen - Fibre Channel

    Add opens the Add Initiator screen showing the settings to create new authorized access client groups or edit existing ones in the list.

    Add Initiator Group Settings
    SettingDescription
    Allow All InitiatorsSelect 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.
    DescriptionEnter any notes about the initiators.
    Connected InitiatorsShows the list of connected initiators on the system.
    Allowed InitiatorsShows the list of allowed initiators on the system.
    RefreshUpdates the screen.

    Edit Initiator Screen - Fibre Channel

    Edit opens the Add Initiator edit screen showing two options: Allow All Initiators and Description. Save saves changes and closes the screen. Cancel closes the screen without saving changes.

    Portal Screens - Fibre Channel

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

    iSCSI Portals Screen - Fibre Channel
    Figure 20: iSCSI Portals Screen - Fibre Channel

    Delete opens the Delete dialog for the selected portal ID. Click Confirm and then Delete to delete the selected portal.

    Add opens the Add Portal screen. Edit opens the Edit Portal screen. Both screens have the same setting options.

    Add and Edit Portal Screens - Fibre Channel

    The Add Portal and Edit Portal screens show the same configuration settings.

    Portal Basic Info Settings
    SettingDescription
    DescriptionEnter an optional description. Portals are automatically assigned a numeric group.
    Add ListenClick Add to show the IP Address field where you add the IP address and netmask (CIDR) for the portal.
    IP AddressShows several options for setting up a portal. Select from these options:
  • 0.0.0.0 - Select to listen on all IPv4 addresses.
  • :: - Select to listen on all IPv6 addresses.
  • TrueNAS server IP address - Select to use the IPv4 address assigned to the primary network interface for the TrueNAS server being configured.
  • IPv6 address assigned to the system.
  • Authorized Access Screens - Fibre Channel

    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 Add Authorized Access screen.

    iSCSI Authorized Access Screen - Fibre Channel
    Figure 23: iSCSI Authorized Access Screen - Fibre Channel

    After adding authorized access to the system, the Authorized Access screen displays a list of users. Delete opens the Delete dialog for the selected portal ID. Confirm enables the delete option. Delete deletes the selected portal and closes the dialog.

    Add opens the Add Authorized Access screen.

    Edit opens the Edit Authorized Access screen. Delete opens a dialog to delete the authorized access for the selected user.

    The Add and Edit screens display the same settings.

    Add Authorized Access Screen - Fibre Channel

    The Add Target and Edit Target screens show the same configuration settings.

    Authentication Method and Group Settings
    SettingDescription
    Group IDEnter a number. Allows configuring different groups with different authentication profiles. For example, all users with a group ID of 1 inherit the authentication profile associated with Group 1.
    Discover AuthenticationSelect the discovery method for authentication from the dropdown list. iSCSI supports multiple authentication methods that targets use to discover valid devices. Options are:
  • None - Select to allow anonymous discovery. When set to None, you can leave an iSCSI Group Authentication Method set to None or empty.
  • CHAP - Select to use CHAP as the authentication method. If set to CHAP enter or create a new group on the Add iSCSI Targetscreen.
  • Mutual Chap - Select to use the Mutual CHAP two-way authentication method. To show this option, configure the Peer User and the password.
  • User Settings
    SettingDescription
    UserUser account to create CHAP authentication with the user on the remote system. Many initiators use the initiator name as the user name.
    SecretEnter 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 Settings
    SettingDescription
    Peer User(Optional) Enter only when configuring mutual CHAP. Usually the same value as User. Configure the peer user name and password to see Mutual Chap in the Discover Authentication dropdown list.
    Peer SecretEnter the mutual secret password. Required if entering a Peer User. Peer user must use a different password than the password in Secret.
    Peer Secret (Confirm)Enter the same password to confirm the mutual secret password.

    Fibre Channel Ports Screens

    The Fibre Channel Ports screen shows a table listing fibre channels configured on the system. Virtual ports show as child elements to physical ports.

    iSCSI Fibre Channel Ports Screen
    Figure 25: iSCSI Fibre Channel Ports Screen

    Ports are configured while setting up targets and extents. When migrating from earlier versions of TrueNAS, ports map from the earlier release to the latest TrueNAS release.

    The Edit icon opens the Change Number of Virtual Ports dialog.

    Change Number of Virtual Ports Dialog

    The Change Number of Virtual Ports dialog shows the Virtual Ports field where you enter a numeric value to specify the number of ports for the selected fibre channel.

    Change Number of Virtual Ports Dialog
    Figure 26: Change Number of Virtual Ports Dialog

    Feedback