summaryrefslogtreecommitdiffstats
path: root/raddb/mods-available/always
diff options
context:
space:
mode:
Diffstat (limited to 'raddb/mods-available/always')
-rw-r--r--raddb/mods-available/always81
1 files changed, 81 insertions, 0 deletions
diff --git a/raddb/mods-available/always b/raddb/mods-available/always
new file mode 100644
index 0000000..b77d00c
--- /dev/null
+++ b/raddb/mods-available/always
@@ -0,0 +1,81 @@
+# -*- text -*-
+#
+# $Id$
+
+#
+# The "always" module is here for debugging purposes, or
+# for use in complex policies.
+# Instance simply returns the same result, always, without
+# doing anything.
+#
+# rcode may be one of the following values:
+# - reject - Reject the user.
+# - fail - Simulate or indicate a failure.
+# - ok - Simulate or indicate a success.
+# - handled - Indicate that the request has been handled,
+# stop processing, and send response if set.
+# - invalid - Indicate that the request is invalid.
+# - userlock - Indicate that the user account has been
+# locked out.
+# - notfound - Indicate that a user account can't be found.
+# - noop - Simulate a no-op.
+# - updated - Indicate that the request has been updated.
+#
+# If an instance is listed in a session {} section,
+# this simulates a user having <integer> sessions.
+#
+# simulcount = <integer>
+#
+# If an instance is listed in a session {} section,
+# this simulates the user having multilink
+# sessions.
+#
+# mpp = <integer>
+#
+# An xlat based on the instance name can be called to change the status
+# returned by the instance, in this example "always db_status { ... }"
+#
+# Force the module status to be alive or dead:
+#
+# %{db_status:alive}
+# %{db_status:dead}
+#
+# Update the rcode returned by an alive module (a dead module returns fail):
+#
+# %{db_status:ok}
+# %{db_status:fail}
+# %{db_status:notfound}
+# ...
+#
+# The above xlats expand to the current status of the module. To fetch the
+# current status without affecting it call the xlat with an empty argument:
+#
+# %{db_status:}
+#
+always reject {
+ rcode = reject
+}
+always fail {
+ rcode = fail
+}
+always ok {
+ rcode = ok
+}
+always handled {
+ rcode = handled
+}
+always invalid {
+ rcode = invalid
+}
+always userlock {
+ rcode = userlock
+}
+always notfound {
+ rcode = notfound
+}
+always noop {
+ rcode = noop
+}
+always updated {
+ rcode = updated
+}