.. meta::
   :description: The tlctl load command displays the current load
                 status of a ThinLinc cluster, to help monitor system
                 health and load balancing.

.. raw:: pdf

   PageBreak

tlctl load
==========

Synopsis
--------

**tlctl load** [*options*] <*command*> [*args*]

Description
-----------

:program:`tlctl load` displays the current load status of the ThinLinc
cluster, as currently measured by ThinLinc. It can be used to get a
quick overview of the health of the system, or to help debug unexpected
load balancing decisions.

Options
-------

.. option:: -h, --help

   Prints a short help text and exits.

Commands
--------

**list** [*options*]
   List the basic load numbers for all agents in the cluster, with
   subcluster association displayed if multiple subclusters exist.

   Note that the listed information is updated at a fixed interval, and
   may therefore be outdated. If you want to get the most up-to-date
   information use the :option:`--refresh` option, this operation can be
   time consuming.

   .. option:: --refresh

      Force a refresh of the load information.

   .. option:: --sort=HEADER

      Sort the list of agents specified by *HEADER*. The default is
      "AGENT". Available headers are found in the list below.

   Definition of command output:

   AGENT
       Agent names.
   WEIGHT
       Agent weight, as configured in /agents/weights/<hostname>,
       only shown if at least one agent has a non-default value.
   USERS
       Number of users on the agent running one or more ThinLinc
       sessions.
