Mercurial > hg > freeDiameter

annotate doc/rt_ereg.conf.sample @ 1562:6219359a36a9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge latest changes from proposed branch
author Sebastien Decugis <sdecugis@freediameter.net>
date Mon, 21 Jun 2021 19:08:18 +0800
parents f1b65381c1e7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
525
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 # This file contains information for configuring the rt_ereg extension.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 # To find how to have freeDiameter load this extension, please refer to the freeDiameter documentation.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3 #
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4 # The rt_ereg extension allows creation of routing rules based on AVP value matching regular expressions.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5
1338
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
6 # This extension supports configuration reload at runtime. Send
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
7 # signal SIGUSR1 to the process to cause the process to reload its
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
8 # config.
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
9
525
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
10 # First, one must indicate which AVP should be used for matching.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
11 # At the moment, only AVP with OCTETSTRING types are valid.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
12 # AVP = "User-Name";
1338
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
13 # It is possible to specify AVPs below GROUPED AVPs with the by separating AVPs with a colon (':'):
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
14 # AVP = "Grouped-AVP1" : "Grouped-AVP2" : "Octetstring-AVP";
525
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
15 # This parameter is mandatory. There is no default value.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
16
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
17 # Then a list of rules follow. A rule has this format:
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
18 # "pattern" : "server" += score ;
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
19 # Where:
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 # pattern is the quoted-string regex to match,
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
21 # server is the next hop in the routing list that will receive the
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22 # score, which can be positive or negative.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 # Example:
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 # "[[:digit:]]*" : "serverA.example.net" += -3 ;
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 # means that if the AVP value is only numeric, the ServerA will have its score decreased by 3 points.
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
26 # (reminder: the server with the peer with the highest score gets the message)
ecfa089bd29a Forgot new files
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
27 # Note that all rules are tested for each message that contain the AVP, not only the first match.
1338
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
28
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
29 # There can be multiple blocks of AVPs and rules; just start the next one with another AVP line:
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
30 # AVP = "Other-AVP";
f1b65381c1e7 rt_ereg: Support config reload. Support grouped AVPs. Support multiple separate AVPs.
Thomas Klausner <tk@giga.or.at>
parents: 525
diff changeset
31 # and continue with rules as above.
"Welcome to our mercurial repository"