← Back to branch summary

~ubuntu-branches/ubuntu/natty/freeradius/natty-updates

« back to all changes in this revision

Viewing changes to doc/configurable_failover

  • Committer: Bazaar Package Importer
  • Author(s): Jeremie Corbier
  • Date: 2006-07-08 19:41:05 UTC
  • mto: (3.1.8 edgy) (4.1.3 sid) (1.1.14 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20060708194105-bxbr4e6m4dfw2x4x
Tags: upstream-1.1.2
Import upstream version 1.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/configurable_failover
114
114
        fail            the module failed
115
115
        reject          the module rejected the user
116
116
        userlock        the user was locked out
117
 
        invalid         the users configuration entry was invilad
 
117
        invalid         the user's configuration entry was invalid
118
118
        handled         the module has done everything to handle the request
119
119
        
120
120
  In a configurable fail-over section, each of these codes may be
121
121
listed, with a value.  If the code is not listed, or a configurable
122
 
fail-over section is not defined, then default values are used.
 
122
fail-over section is not defined, then values that make sense for the
 
123
requested "group" (group, redundant, load-balance, etc) are used.
123
124
 
124
125
  The values for each code may be one of two things:
125
126
 
126
127
        Value           Meaning
127
128
        -----           -------
128
 
        <number>        Priority for this return code
 
129
        <number>        Priority for this return code.
129
130
        return          stop processing this configurable fail-over list.
130
 
        reject          Stop processing this configurable fail-over list
 
131
        reject          Stop processing this configurable fail-over list.
131
132
                        and immediately return a reject.
132
133
 
133
134
  The <number> used for a value may be any decimal number between 1
138
139
modules will be "ok", because it has higher priority than "fail".
139
140
 
140
141
  This configurability allows the administrator to permit some modules
141
 
to fail, so long as a later module succeds.
 
142
to fail, so long as a later module succeeds.
142
143
 
143
144
 
144
145
  More Complex Configurations
252
253
  }
253
254
}
254
255
 
255
 
This is the same as the first example, with the default behavior explicitly
 
256
This is the same as the first example, with the behavior explicitly
256
257
spelled out. Each SINGLE becomes its own section, containing a list of
257
258
RESULTs that it may return and what ACTION should follow from them. So
258
 
preprocess is called, and if it returns for example RLM_MODULE_REJECT, then
259
 
the reject=return rule is applied, and the authorize{...} GROUP itself
260
 
immediately returns RLM_MODULE_REJECT.
 
259
preprocess is called, and if it returns for example RLM_MODULE_REJECT,
 
260
then the reject=return rule is applied, and the authorize{...} GROUP
 
261
itself immediately returns RLM_MODULE_REJECT.
261
262
 
262
263
If preprocess returns RLM_MODULE_NOOP, the corresponding ACTION is "2". An
263
264
integer ACTION serves two purposes - first, it tells the parent GROUP to go