1rlm_always(5)                  FreeRADIUS Module                 rlm_always(5)
2
3
4

NAME

6       rlm_always - FreeRADIUS Module
7

DESCRIPTION

9       The  rlm_always module provides a simple way to "always" return a value
10       during the processing of a configuration section.
11
12       The main configuration item is rcode, which sets the return  code  that
13       this  instantiation  of  the  module  will return. The default, if none
14       specified, is 'fail'.
15
16       The valid options for rcode are as follows:
17
18              reject reject the user;
19
20              fail   a failure has occurred;
21
22              ok     success;
23
24              handled
25                     the  request  has  been  handled:  processing  should  be
26                     stopped and the response sent;
27
28              invalid
29                     request is invalid;
30
31              userlock
32                     the user account has been locked out;
33
34              notfound
35                     the user account cannot be found;
36
37              noop   no-op: nothing has happened;
38
39              updated
40                     the request has been updated.
41

CONFIGURATION

43       rcode = <code>
44              This  module  will  always  return  with  the code specified, as
45              listed in the table  above.   If  unspecified,  the  default  is
46              'fail'.
47
48       simulcount = <n>
49              If  this module is used in the session{} section, the simulcount
50              option simulates the  user  having  'n'  current  sessions.  The
51              default is to not override the number of sessions.
52
53       mpp = <yes|no>
54              If set to yes, and this module is used in the session{} section,
55              this simulates the user having multilink sessions.  The  default
56              is 'no'.
57

EXAMPLE

59       modules {
60         ...
61         # instantiate the "always" module with the name "ok"
62         always ok {
63            # return code for this instantiation is "ok":
64            rcode = ok
65         }
66         ...
67       }
68
69       authorize {
70         ...
71         redundant {
72            sql1          # try to find the user in sql1
73            sql2          # try to find the user in sql2
74            # the default here would be to fail, but...
75            ok            # if still not found, it's OK.
76         }
77         ...
78       }
79

SECTIONS

81       authorization,   authentication,   postauthentication,   preaccounting,
82       accounting, preproxy, postproxy
83

FILES

85       /etc/raddb/mods-available/always
86

SEE ALSO

88       radiusd(8), radiusd.conf(5), unlang(5)
89
90       Further details of how module return codes  operate  can  be  found  at
91       <http://wiki.freeradius.org/config/Fail-over>.
92

AUTHOR

94       Chris  Parker <cparker@segv.org>, Matthew Newton <matthew@newtoncomput‐
95       ing.co.uk>.
96
97
98
99                                10 January 2015                  rlm_always(5)
Impressum