.. _Additional Options:

Additional Options
==================

This section covers the remaining miscellaneous options available from
the TrueNAS\ :sup:`®` graphical administrative interface.


.. index:: Processes

.. _Display System Processes:

Display System Processes
------------------------

If you click Display System Processes, a screen will open showing the
output of
`top(1) <http://www.freebsd.org/cgi/man.cgi?query=top>`_.
An example is shown in
:numref:`Figure %s <process>`.


.. _process:

.. figure:: images/process.png

   System Processes Running on TrueNAS\ :sup:`®`


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 :command:`kill` command within it.


.. index:: Shell

.. _Shell:

Shell
-----

The TrueNAS\ :sup:`®` 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
:numref:`Figure %s <web_shell_fig>`,
the link has been clicked and Shell is open.


.. _web_shell_fig:

.. figure:: images/shell.png

   Web Shell


The prompt indicates that the current user is *root*, the hostname is
*truenas*, and the current working directory is :file:`~`
(*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
:guilabel:`Paste` button, paste the text into the box that opens, and
click the :guilabel:`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 :command:`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 :kbd:`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
:command:`exit` to leave the session.

.. note:: Not all of Shell's features render correctly in Chrome.
   Firefox is the recommended browser for using Shell.

Most FreeBSD command line utilities are available in Shell.


.. index:: Log Out
.. _Log Out:

Log Out
-------

To log out of the TrueNAS\ :sup:`®` GUI, click the :guilabel:`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.


.. index:: Reboot

.. _Reboot:

Reboot
------

If you click :guilabel:`Reboot`, you will receive the warning message
shown in
:numref:`Figure %s <reboot1>`
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\ :sup:`®` system.

.. _reboot1:

.. figure:: images/reboot.png

   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 :guilabel:`Cancel` the reboot
request and to periodically run :command:`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 :guilabel:`Cancel` button if you wish to cancel the reboot
request. Otherwise, click the :guilabel:`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\ :sup:`®` 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.


.. index:: Shutdown

.. _Shutdown:

Shutdown
--------

If you click :guilabel:`Shutdown`, you will receive the warning
message shown in
:numref:`Figure %s <shutdown1>`
and your browser color will change to red to indicate that you have
selected an option that will negatively impact users of the TrueNAS\ :sup:`®`
system.


.. _shutdown1:

.. figure:: images/shutdown.png

   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 :guilabel:`Cancel` the shutdown
request and to periodically run :command:`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 :guilabel:`Cancel` button to cancel the shutdown request.
Otherwise, click the :guilabel:`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\ :sup:`®` system.


.. index:: Support

.. _Support Icon:

Support Icon
------------

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


.. index:: Guide

.. _Guide:

Guide
-----

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


.. index:: Alert

.. _Alert:

Alert
-----

TrueNAS\ :sup:`®` provides an alert system to provide a visual warning of any
conditions that require administrative attention. The
:guilabel:`Alert` button in the far right corner flashes red when
there is an outstanding alert. In the example alert shown in
:numref:`Figure %s <alert2a>`,
the system is warning that the S.M.A.R.T. service is not running.


.. _alert2a:

.. figure:: images/alert2a.png

   Example Alert Message


Informational messages have a green :guilabel:`OK`, warning messages
flash yellow, and messages requiring attention are listed as a red
:guilabel:`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 :file:`/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
(:numref:`Figure %s <console_setup_menu_fig>`)
or from the Web Shell
(:numref:`Figure %s <web_shell_fig>`)
by running :command:`alertcli.py`.
This can be useful when the alert originates from the standby node of
a :ref:`High Availability (HA) <Failover>` 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 :guilabel:`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 :guilabel:`WebGUI IPv4 Address`
  set in
  :menuselection:`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 :ref:`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

.. note:: Alerts which could be related to a hardware issue
   automatically create a support ticket if the system is connected to
   the internet. These include a ZFS pool status change, a multipath
   failure, a failed S.M.A.R.T. test, and a failed re-key operation.


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:

.. code-block:: none

   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.
