RADIUS Module
~~~~~~~~~~~~~

This is the main menu for controlling the Radius server.

* Enables you to stop/start or restart Radius which is needed in order for some configuration changes to have effect.
* Enables you to make configuration changes to the radius server, modes, backends and such.
* Enables you to do the initial installation of the radius related database, database user and tables, also contains the HA configuration.
* The radius postauth logs, logs are also availible through syslog.

::

    ┌────────────────────────────────────────────────────────────────────────────┐
    │         StoredSafe Radius Console on xx (Version 2.x.x build xxxx)         │
    └────────────────────────────────────────────────────────────────────────────┘

    ┌─┬──────────────────────────────────────────────────────────────────────────┐
    │1│Stop/Start/Restart Radius                                                 │
    │2│Radius Settings                                                           │
    │3│Radius Installation                                                       │
    │4│Logging                                                                   │
    └─┴──────────────────────────────────────────────────────────────────────────┘

    Move the cursor or enter a it's corresponding number (Q to Quit)              

    Main> Modules> Radius>                      

Stop/Start/Restart Radius
#########################

Options to start, stop and restart the RADIUS server.

::

    ┌────────────────────────────────────────────────────────────────────────────┐
    │              Radius Control on xx (Version 2.x.x build xxxx)               │
    └────────────────────────────────────────────────────────────────────────────┘

    ┌─┬──────────────────────────────────────────────────────────────────────────┐
    │1│Start Radius                                                              │
    │2│Stop Radius                                                               │
    │3│Restart Radius                                                            │
    └─┴──────────────────────────────────────────────────────────────────────────┘

    Move the cursor or enter a it's corresponding number (Q to Quit)              

    Main> Modules> Radius> Control>

Radius Settings
###############

These are configuration menus for the Radius server

::

    ┌────────────────────────────────────────────────────────────────────────────┐
    │              Radius Settings on xx (Version 2.x.x build xxxx)              │
    └────────────────────────────────────────────────────────────────────────────┘

    ┌─┬──────────────────────────────────────────────────────────────────────────┐
    │1│Radius Mode                                                               │
    │2│TLS Settings                                                              │
    │3│Enable/Disable Auto Provisioning                                          │
    │4│Backend Auth Menu                                                         │
    │5│Radius Clients                                                            │
    │6│Manual Provision of keys                                                  │
    └─┴──────────────────────────────────────────────────────────────────────────┘

    Move the cursor or enter a it's corresponding number (Q to Quit)              

    Main> Modules> Radius> Settings>    

.. toctree::
   :maxdepth: 2

   radius_mode.rst
   tls_settings.rst
   auto_provisioning.rst
   backend_auth_menu.rst
   radius_clients.rst
   manual_provision_of_keys.rst

Radius Installation
###################

This menu is basically only used when setting up the module initially.

::

    ┌────────────────────────────────────────────────────────────────────────────┐
    │                  Logging on xx (Version 2.x.x build xxxx)                  │
    └────────────────────────────────────────────────────────────────────────────┘

    ┌─┬──────────────────────────────────────────────────────────────────────────┐
    │1│Create Database for Radius                                                │
    │2│Create Tables for Radius Database                                         │
    │3│Create/Change Database User for Radius                                    │
    │4│Setup HA for Radius                                                       │
    │5│Enable/Disable HA for Radius                                              │
    └─┴──────────────────────────────────────────────────────────────────────────┘

    Move the cursor or enter a it's corresponding number (Q to Quit)              

    Main> Modules> Radius> Install> 

Create Database for Radius
##########################

Create needed database.

Create Tables for Radius Database
#################################

Create tables relevant for radius.

Create/Change Database User for Radius
######################################

Create a database user for the radius server, you can choose a password
or generate a random string by following the instructions (press .)

Setup HA for Radius
###################

This option is used to define the HA peer.

.. note:: Make sure to add rules for radius in general (under the
  firewall section of system configuration)
.. note:: Make sure to configure HA rules for radius (basically database
  communication)

Enable/Disable HA for Radius
############################

Enables or disables HA

Logging
#######

This menu allows you to display Radius postauth logs, keep in mind that
there is also logging done via syslog.

::

    ┌────────────────────────────────────────────────────────────────────────────┐
    │                  Logging on xx (Version 2.x.x build xxxx)                  │
    └────────────────────────────────────────────────────────────────────────────┘

    ┌─┬──────────────────────────────────────────────────────────────────────────┐
    │1│View Logs from Database                                                   │
    │2│Search Logs in Database                                                   │
    │3│Purge Logs from local Database                                            │
    │4│Enable/Disable or set max age for Logs in local Database                  │
    └─┴──────────────────────────────────────────────────────────────────────────┘

    Move the cursor or enter a it's corresponding number (Q to Quit)              

    Main> Modules> Radius> Logs>

View Logs from Database
#######################

Display all postauth logs, when done with local database ha peers logs
will be displayed if in HA mode.

Search Logs in Database
#######################

Search logs based on accept or denys or a specific username.

Purge Logs from local Database
##############################

Purge the logs in the database, does not affect syslog entries.

Enable/Disable or set max age for Logs in local Database
########################################################

This option enables you to define auto ageout of logs in the local
radpostauth database so that it wont grow out of control, recommended
setting would be a few days, but you can also disable it by setting it
to 0 (zero).