Banner
------

.. index:: system;system banner

An administrator can manage a custom banner on the system 
from the CLI to display before login. The banner needs to be
configured on a per node basis, in other words on each node 
in a cluster.

Banners are maintained on system update.

Banner text:

* Must be ASCII text in a UTF-8 file
* Can be up to 1600 characters. This includes
  spaces, tabs and other non-printing characters.
* Displays before login (SSH, SFTP, SCP)  


An error message will display if the banner text is longer
than the required length.

The following is an example:

::


   $ ssh username@host
   
    ########################################################################
    # WARNING: Unauthorized access to this system is forbidden and will be #
    # prosecuted by law. By accessing this system, you agree that your     #
    # actions may be monitored if unauthorized usage is suspected.         #
    ########################################################################

    username@host's password: 


The banner can be created in a file, uploaded to the system and then enabled.

1. Create the banner in a file, for example ``banner``.
#. Upload the banner file, for example:
   
   ::
   
     scp banner username@host:media/

#. When logged in on the system, remove any previous banner
   and add the uploaded banner:

   ::

      system banner remove
      system banner add media/banner

#. The banner will then be shown as in the example above. 

* To show the current banner, use: **system banner read**
  If no banner is available, a message will show.
* To remove the current banner, use: **system banner remove**


.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM