docs/user-guide/usecplugin-aaa-user-guide.rst

   1 Usecplugin-AAA User Guide
   2 =========================
   3
   4 The Usecplugin User Guide contains information about configuration,
   5 administration, management, using and troubleshooting the feature.
   6
   7 Overview
   8 --------
   9
  10 AAA plugin provides authorization, authentication and accounting
  11 services to OpenDaylight. A user logs in to OpenDaylight through the
  12 username and password provided by AAA plugin. Usecplugin-AAA collects
  13 and stores information about both successful and failed login attempts
  14 to OpenDaylight.
  15
  16 Usecplugin-AAA Architecture
  17 ---------------------------
  18
  19 AAA plugin creates log messages about successful and failed login
  20 attempts to OpenDaylight. Usecplugin-AAA continuously reads this log
  21 file and checks for either successful and failed attempt information.
  22 Whenever Usecpluin-AAA identifies a new attempt entry in the log file it
  23 is stored in YANG Data Store and its own log file.
  24
  25 Administering or Managing Usecplugin-AAA
  26 ----------------------------------------
  27
  28 -  Install feature ``odl-usecplugin-aaa``
  29
  30 -  Enable odl-aaa log using command
  31    ``log:set DEBUG org.opendaylight.aaa.shiro.filters``
  32
  33 -  Login to the RESTCONF documentation.
  34
  35 -  Check operational datastore for login attempts.
  36
  37 -  POST URI ::
  38    http://localhost:8181/restconf/operations/usecpluginaaa:attemptFromIP
  39
  40    -  Sample Input :: {"usecpluginaaa:input":{"ScrIP":"10.0.0.1"}}
  41
  42 -  POST URI ::
  43    http://localhost:8181/restconf/operations/usecpluginaaa:attemptOnDateTime
  44
  45    -  Sample Input :: {"usecpluginaaa:input":{"dateTime":"2016-07-27
  46       14:11:18"}}
  47