14. Additional Options¶

14.1. Display System Processes¶

If you click Display System Processes, a screen will open showing the output of top(1). An example is shown in Figure 14.1.1.

Fig. 14.1.1 System Processes Running on TrueNAS®

The display will automatically refresh itself. Simply click the X in the upper right corner to close the display when you are finished. Note that the display is read-only, meaning that you won’t be able to issue a kill command within it.

14.2. Shell¶

The TrueNAS® GUI provides a web shell, making it convenient to run command line tools from the web browser as the root user. The link to Shell is the fourth entry from the bottom of the menu tree. In Figure 14.2.1, the link has been clicked and Shell is open.

Fig. 14.2.1 Web Shell

The prompt indicates that the current user is root, the hostname is truenas, and the current working directory is ~ (root‘s home directory).

To change the size of the shell, click the 80x25 drop-down menu and select a different size.

To copy text from shell, highlight the text, right-click, and select Copy from the right-click menu. To paste into the shell, click the Paste button, paste the text into the box that opens, and click the OK button to complete the paste operation.

While you are in Shell, you will not have access to any of the other GUI menus. If you need to have access to a prompt while using the GUI menus, use tmux instead as it supports multiple shell sessions and the detachment and reattachment of sessions.

Shell provides history (use your up arrow to see previously entered commands and press Enter to repeat the currently displayed command) and tab completion (type a few letters and press tab to complete a command name or filename in the current directory). When you are finished using Shell, type exit to leave the session.

Most FreeBSD command line utilities are available in Shell.

14.3. Log Out¶

To log out of the TrueNAS® GUI, click the Log Out entry in the tree. You will immediately be logged out. An informational message will indicate that you are logged out and will provide a hyperlink which you can click on to log back in. When logging back in, you will be prompted for the root password.

14.4. Reboot¶

If you click Reboot, you will receive the warning message shown in Figure 14.4.1 and your browser window color will change to red to indicate that you have selected an option that will negatively impact users of the TrueNAS® system.

Fig. 14.4.1 Reboot Warning Message

If a scrub or resilver is in progress when a reboot is requested, an additional warning will ask you to make sure that you wish to proceed. In this case, it is recommended to Cancel the reboot request and to periodically run zpool status from Shell until it is verified that the scrub or resilver process is complete. Once complete, the reboot request can be re-issued.

Click the Cancel button if you wish to cancel the reboot request. Otherwise, click the Reboot button to reboot the system. Rebooting the system will disconnect all clients, including the web administration GUI. The URL in your web browser will change to add /system/reboot/ to the end of the IP address. Wait a few minutes for the system to boot, then use the browser’s Back button to return to the TrueNAS® system’s IP address. If all goes well, the GUI login screen is displayed. If the login screen does not appear, access the system using IPMI in order to determine what problem is preventing the system from resuming normal operation.

14.5. Shutdown¶

If you click Shutdown, you will receive the warning message shown in Figure 14.5.1 and your browser color will change to red to indicate that you have selected an option that will negatively impact users of the TrueNAS® system.

Fig. 14.5.1 Shutdown Warning Message

If a scrub or resilver is in progress when a shutdown is requested, an additional warning will ask you to make sure that you wish to proceed. In this case, it is recommended to Cancel the shutdown request and to periodically run zpool status from Shell until it is verified that the scrub or resilver process is complete. Once complete, the shutdown request can be re-issued.

Click the Cancel button to cancel the shutdown request. Otherwise, click the Shutdown button to halt the system. Shutting down the system will disconnect all clients, including the web administration GUI, and will power off the TrueNAS® system.

14.6. Support Icon¶

The Support icon, located as the third icon from the left in the top menubar, provides a shortcut to System → Support. This screen can be used to verify the system license or to create a support ticket. Refer to Support for detailed usage instructions.

14.7. Guide¶

The Guide icon, located as the second icon from the left in the top menubar, provides a built-in browser to the TrueNAS® Administrator Guide (this documentation).

14.8. Alert¶

TrueNAS® provides an alert system to provide a visual warning of any conditions that require administrative attention. The Alert button in the far right corner flashes red when there is an outstanding alert. In the example alert shown in Figure 14.8.1, the system is warning that the S.M.A.R.T. service is not running.

Fig. 14.8.1 Example Alert Message

Informational messages have a green OK, warning messages flash yellow, and messages requiring attention are listed as a red CRITICAL. CRITICAL messages are also emailed to the root user account. If you are aware of a critical condition but wish to remove the flashing alert until you deal with it, uncheck the box next to that message.

Behind the scenes, an alert daemon checks for various alert conditions, such as volume and disk status, and writes the current conditions to /var/tmp/alert. The daemon retrieves the current alert status every minute and will change the solid green alert icon to flashing red if a new alert is detected.

Current alerts can also be viewed from the Shell option of the Console Setup Menu (Figure 2.6.1) or from the Web Shell (Figure 14.2.1) by running alertcli.py. This can be useful when the alert originates from the standby node of a High Availability (HA) system.

Some of the conditions that trigger an alert include:

• used space on a volume goes over 80%
• new OpenZFS feature flags are available for the pool; this alert can be unchecked if you choose not to upgrade the pool at this time
• a new update is available
• non-optimal multipath states detected
• ZFS pool status changes from HEALTHY
• a S.M.A.R.T. error occurs
• the system dataset does not reside on the boot pool
• the system is unable to bind to the WebGUI IPv4 Address set in System → General
• the system can not find an IP address configured on an iSCSI portal
• a periodic snapshot or replication task fails
• a VMware login or a VMware-Snapshot task fails
• deleting a VMware snapshot fails
• a Certificate Authority or certificate is invalid or malformed
• an update failed, or the system needs to reboot to complete a successful update
• a re-key operation fails on an encrypted pool
• the interface which is set as critical for failover is not found or is not configured
• HA is configured but the connection is not established
• one node of an HA pair gets stuck applying its configuration journal as this condition could block future configuration changes from being applied to the standby node
• 30 days before the license expires, and when the license expires
• the usage of a HA link goes above 10MB/s
• an IPMI query to a standby node fails, indicating the standby node is down

An alert is also generated when the Avago HBA firmware version does not match the driver version. To resolve this alert, download the IT (integrated target) firmware, not the IR (integrated RAID) firmware, from the Avago website. Specify the name of the firmware image and BIOS as well as the controller to flash:

sas2flash -o -f firmwareimagename -b biosname -c controllernumber

When finished, reboot the system. The new firmware version will appear in the system messages and the alert will be cleared.