![]() |
The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
|
Execute scripts when a server event occurs. More...
#include <freeradius-devel/server/cf_util.h>
#include <freeradius-devel/server/module.h>
#include <freeradius-devel/server/request.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/talloc.h>
Go to the source code of this file.
Typedefs | |
typedef int(* | fr_trigger_worker_t) (request_t *request, module_method_t process, void *ctx) |
Functions | |
int | trigger (unlang_interpret_t *intp, CONF_SECTION const *cs, char const *name, bool rate_limit, fr_pair_list_t *args)) |
Execute a trigger - call an executable to process an event. | |
void | trigger_args_afrom_server (TALLOC_CTX *ctx, fr_pair_list_t *list, char const *server, uint16_t port) |
Create trigger arguments to describe the server the pool connects to. | |
bool | trigger_enabled (void) |
Return whether triggers are enabled. | |
int | trigger_init (CONF_SECTION const *cs) |
Execute scripts when a server event occurs.
Definition in file trigger.h.
typedef int(* fr_trigger_worker_t) (request_t *request, module_method_t process, void *ctx) |
int trigger | ( | unlang_interpret_t * | intp, |
CONF_SECTION const * | cs, | ||
char const * | name, | ||
bool | rate_limit, | ||
fr_pair_list_t * | args | ||
) |
Execute a trigger - call an executable to process an event.
A trigger ties a state change (e.g. connection up) in a module to an action (e.g. send an SNMP trap) defined in raqddb/triggers.conf or in the trigger section of a module, and can be created with one call to trigger().
The trigger function expands the configuration item, and runs the given function (exec, sql insert, etc.) asynchronously, allowing the server to keep processing packets while the action is being taken.
The name of each trigger is based on the module or portion of the server which runs the trigger, and is usually taken from the state when the module has a state change.
Triggers are separate from logs, because log messages are generally informational, are not time sensitive, and usually require log files to be parsed and filtered in order to find relevant information.
In contrast, triggers are something specific which the administrator needs to be notified about immediately and can't wait to post-process a log file.
[in] | intp | Interpreter to run the trigger with. If this is NULL the trigger will be executed synchronously. |
[in] | cs | to search for triggers in. If cs is not NULL, the portion after the last '.' in name is used for the trigger. If cs is NULL, the entire name is used to find the trigger in the global trigger section. |
[in] | name | the path relative to the global trigger section ending in the trigger name e.g. module.ldap.pool.start. |
[in] | rate_limit | whether to rate limit triggers. |
[in] | args | to make available via the %trigger(<arg>)xlat. |
Definition at line 143 of file trigger.c.
void trigger_args_afrom_server | ( | TALLOC_CTX * | ctx, |
fr_pair_list_t * | list, | ||
char const * | server, | ||
uint16_t | port | ||
) |
Create trigger arguments to describe the server the pool connects to.
[in] | ctx | to allocate fr_pair_t s in. |
[out] | list | to append Pool-Server and Pool-Port pairs to |
[in] | server | we're connecting to. |
[in] | port | on that server. |
Definition at line 397 of file trigger.c.
bool trigger_enabled | ( | void | ) |
int trigger_init | ( | CONF_SECTION const * | cs | ) |