.. meta::
   :description: Guide to using the Status module in ThinLinc's web
                 administration interface for monitoring licenses,
                 server load, and managing sessions.

.. _tlwebadm_status:

Status module
~~~~~~~~~~~~~

The status module allows you to view or manipulate the following aspects
of ThinLinc, by selecting the relevant submenu:

-  :guilabel:`Licenses` allows you to view license usage.

-  :guilabel:`Load` allows you to check the current workload on the
   ThinLinc agents.

-  :guilabel:`Sessions` allows you to terminate, shadow or view details
   of sessions.

.. _tlwebadm_licenses:

Licenses
^^^^^^^^

The licenses menu provides license information along with graphs showing
current and historical license usage. It shows the current total number
of licenses, the hard limit, the support agreement ID as well as the
latest ThinLinc version the licenses are valid for. If the licenses have
an expiration date, it is also shown. It also includes functionality to
generate a graph displaying license usage over a specified number of
days in the past.

.. _tlwebadm_load:

Load
^^^^

The load page displays information about system utilization across the
ThinLinc agents, enabling administrators to monitor ThinLinc usage and
evaluate the capacity for adding more users to the cluster.

Each agent in the ThinLinc cluster is shown, along with the number of
users who are running one or more ThinLinc sessions on the agent. The
agent weights are also shown, if at least one agent has a configured
:servconf:`/agents/weights/\<hostname\>` that is different from the
default value.

If an agent is set in draining mode by :servconf:`/agents/draining`, the
agent is shown as draining. If an agent isn't responding to the master,
the agent is shown as down.

To ensure the data is up-to-date there is a refresh button, which will
verify the sessions on all agents. The time it takes to refresh the data
may vary from system to system, and this operation will block
interaction on the webpage while running.

.. _tlwebadm_sessions:

Sessions
^^^^^^^^

When you select the sessions menu, a table with all currently active
sessions is displayed. See :numref:`tlwebadm_session_list` for an
example.

.. _tlwebadm_session_list:

.. figure:: images/tlwebadm-session-list.svg

   Session overview

To perform tasks for a user, click on the corresponding username. This
will open the session details popup, which displays additional
information about the chosen session. See
:numref:`tlwebadm_session_popup` for the layout of the popup, followed
by descriptions for each field.

.. _tlwebadm_session_popup:

.. figure:: images/tlwebadm-session-popup.svg

   Popup with session information

-  :guilabel:`Created`: A timestamp for when the session was initially
   created.

-  :guilabel:`Session status`: The health status of the session as seen
   by the master machine.

-  :guilabel:`Connection status`: The current connection status between
   the client and the session.

-  :guilabel:`Last connection`: A timestamp for when the last connection
   was initiated and the IP address of the last connected client.

-  :guilabel:`Agent`: The DNS host name of the server that is hosting
   the session, as seen by the master machine.

-  :guilabel:`Agent server address`: The DNS host name of the server
   that is hosting this session, as seen by the client machine.

-  :guilabel:`Display number`: Each session on a certain server has a
   unique number, the X Window System display number. Display zero is
   reserved, and never used for ThinLinc sessions.

-  :guilabel:`Terminal ID`: An identification of the thin terminal. This
   is the terminal's hardware address (MAC address).

-  :guilabel:`Framebuffer size`: The size (resolution) of the active
   session.

-  :guilabel:`Local screen size`: The size (resolution) of the
   terminal's screen.

-  :guilabel:`Session process ID`: The PID (process identification
   number) of the :program:`tl-session` process, which is the parent for
   all processes belonging to a certain session.

-  :guilabel:`Command`: The command line that was specified when
   starting this session. This is usually empty for full desktop
   sessions.

The two buttons in the popup do the following:

-  :guilabel:`Terminate session`: By clicking this button, you can
   terminate a session immediately. Caution: This can lead to data loss,
   since applications running on the ThinLinc servers may not hold
   unsaved data.

-  :guilabel:`Shadow session`: This button will generate a ThinLinc
   "launch file" (see :ref:`clientplatforms_web_integration`) that
   starts the native ThinLinc client, preconfigured to shadow the
   current user.

   .. note::

      The user might not be informed that shadowing is in progress if
      shadowing notification has been disabled. See :ref:`shadowing` for
      details.
