test/script/l7directord/materials/l7directord-help.txt

   1 L7DIRECTORD(1)        User Contributed Perl Documentation       L7DIRECTORD(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        l7directord - UltraMonkey-L7 Director Daemon
   7
   8        Daemon to monitor remote services and control UltraMonkey-L7
   9
  10 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
  11        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd [-\b-d\bd] [_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn] {s\bst\bta\bar\brt\bt|s\bst\bto\bop\bp|r\bre\bes\bst\bta\bar\brt\bt|t\btr\bry\by-\b-
  12        r\bre\bes\bst\bta\bar\brt\bt|r\bre\bel\blo\boa\bad\bd|s\bst\bta\bat\btu\bus\bs|c\bco\bon\bnf\bfi\big\bgt\bte\bes\bst\bt}
  13
  14        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd -\b-t\bt [_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn]
  15
  16        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd -\b-h\bh|\b|-\b--\b-h\bhe\bel\blp\bp
  17
  18        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd -\b-v\bv|\b|-\b--\b-v\bve\ber\brs\bsi\bio\bon\bn
  19
  20 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  21        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd is a daemon to monitor and administer real servers in a
  22        cluster of load balanced virtual servers. l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd is similar to
  23        l\bld\bdi\bir\bre\bec\bct\bto\bor\brd\bd in terms of functionality except that it triggers l\bl7\b7v\bvs\bsa\bad\bdm\bm.
  24        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd typically is started from command line but can be included
  25        to start from heartbeat. On startup l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd reads the file
  26        /\b/e\bet\btc\bc/\b/h\bha\ba.\b.d\bd/\b/c\bco\bon\bnf\bf/\b/_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn.  After parsing the file, entries for
  27        virtual servers are created on the UltraMonkey-L7.  Now at regular
  28        intervals the specified real servers are monitored and if they are
  29        considered alive, added to a list for each virtual server. If a real
  30        server fails, it is removed from that list. Only one instance of
  31        l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd can be started for each configuration, but more instances
  32        of l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd may be started for different configurations. This helps
  33        to group clusters of services.  This can be done by putting an entry
  34        inside /\b/e\bet\btc\bc/\b/h\bha\ba.\b.d\bd/\b/h\bha\bar\bre\bes\bso\bou\bur\brc\bce\bes\bs
  35
  36        _\bn_\bo_\bd_\be_\bn_\ba_\bm_\be _\bv_\bi_\br_\bt_\bu_\ba_\bl_\b-_\bi_\bp_\b-_\ba_\bd_\bd_\br_\be_\bs_\bs _\bl_\b7_\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\bd_\b:_\b:_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
  37
  38        to start l7directord from heartbeat.
  39
  40 O\bOP\bPT\bTI\bIO\bON\bNS\bS
  41        _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn:
  42            This is the name for the configuration as specified in the file
  43            /\b/e\bet\btc\bc/\b/h\bha\ba.\b.d\bd/\b/c\bco\bon\bnf\bf/\b/_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn
  44
  45        -\b-d\bd  Don't start as daemon. Useful for debugging.
  46
  47        -\b-h\bh  Help. Print user manual of l7directord.
  48
  49        -\b-v\bv  Version. Print version of l7directord.
  50
  51        -\b-t\bt  Run syntax tests for configuration files only. The program
  52            immediately exits after these syntax parsing tests with either a
  53            return code of 0 (Syntax OK) or return code not equal to 0 (Syntax
  54            Error).
  55
  56        s\bst\bta\bar\brt\bt
  57            Start the daemon for the specified configuration.
  58
  59        s\bst\bto\bop\bp
  60            Stop the daemon for the specified configuration. This is the same
  61            as sending a TERM signal to the running daemon.
  62
  63        r\bre\bes\bst\bta\bar\brt\bt
  64            Restart the daemon for the specified configuration. The same as
  65            stopping and starting.
  66
  67        t\btr\bry\by-\b-r\bre\bes\bst\bta\bar\brt\bt
  68            Try to restart the daemon for the specified configuration. If
  69            l7directord is already running for the specified configuration,
  70            then the same is stopped and started (Similar to restart).
  71            However, if l7directord is not already running for the specified
  72            configuration, then an error message is thrown and the program
  73            exits.
  74
  75        r\bre\bel\blo\boa\bad\bd
  76            Reload the configuration file. This is only useful for
  77            modifications inside a virtual server entry. It will have no effect
  78            on adding or removing a virtual server block. This is the same as
  79            sending a HUP signal to the running daemon.
  80
  81        s\bst\bta\bat\btu\bus\bs
  82            Show status of the running daemon for the specified configuration.
  83
  84        c\bco\bon\bnf\bfi\big\bgt\bte\bes\bst\bt
  85            This is the same as -\b-t\bt.
  86
  87 S\bSY\bYN\bNT\bTA\bAX\bX
  88    D\bDe\bes\bsc\bcr\bri\bip\bpt\bti\bio\bon\bn h\bho\bow\bw t\bto\bo w\bwr\bri\bit\bte\be c\bco\bon\bnf\bfi\big\bgu\bur\bra\bat\bti\bio\bon\bn f\bfi\bil\ble\bes\bs
  89        v\bvi\bir\brt\btu\bua\bal\bl =\b= _\b(_\bi_\bp_\b__\ba_\bd_\bd_\br_\be_\bs_\bs_\b|_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be_\b:_\bp_\bo_\br_\bt_\bn_\bu_\bm_\bb_\be_\br_\b|_\bs_\be_\br_\bv_\bi_\bc_\be_\bn_\ba_\bm_\be_\b)
  90            Defines a virtual service by IP-address (or hostname) and port (or
  91            servicename). All real services and flags for a virtual service
  92            must follow this line immediately and be indented.  For ldirectord,
  93            Firewall-mark settings could be set. But for l7directord Firewall-
  94            mark settings cannot be set.
  95
  96        c\bch\bhe\bec\bck\bkt\bti\bim\bme\beo\bou\but\bt =\b= _\bn
  97            Timeout in seconds for connect checks. If the timeout is exceeded
  98            then the real server is declared dead.  Default is 5 seconds. If
  99            defined in virtual server section then the global value is
 100            overridden.
 101
 102        n\bne\beg\bgo\bot\bti\bia\bat\bte\bet\bti\bim\bme\beo\bou\but\bt =\b= _\bn
 103            Timeout in seconds for negotiate checks. Default is 5 seconds.  If
 104            defined in virtual server section then the global value is
 105            overridden.
 106
 107        c\bch\bhe\bec\bck\bki\bin\bnt\bte\ber\brv\bva\bal\bl =\b= _\bn
 108            Defines the number of second between server checks. Default is 10
 109            seconds.  If defined in virtual server section then the global
 110            value is overridden.
 111
 112        r\bre\bet\btr\bry\byi\bin\bnt\bte\ber\brv\bva\bal\bl =\b= _\bn
 113            Defines the number of second between server checks when server
 114            status is NG.  Default is 10 seconds. If defined in virtual server
 115            section then the global value is overridden.
 116
 117        c\bch\bhe\bec\bck\bkc\bco\bou\bun\bnt\bt =\b= _\bn
 118            The number of times a check will be attempted before it is
 119            considered to have failed. Note that the checktimeout is additive,
 120            so if checkcount is 3 and checktimeout is 2 seconds and
 121            retryinterval is 1 second, then a total of 8 seconds (2 + 1 + 2 + 1
 122            + 2) worth of timeout will occur before the check fails. Default is
 123            1. If defined in virtual server section then the global value is
 124            overridden.
 125
 126        c\bco\bon\bnf\bfi\big\bgi\bin\bnt\bte\ber\brv\bva\bal\bl =\b= _\bn
 127            Defines the number of second between configuration checks.  Default
 128            is 5 seconds.
 129
 130        a\bau\but\bto\bor\bre\bel\blo\boa\bad\bd =\b= [y\bye\bes\bs|n\bno\bo]
 131            Defines if <l7directord> should continuously check the
 132            configuration file for modification each c\bco\bon\bnf\bfi\big\bgi\bin\bnt\bte\ber\brv\bva\bal\bl seconds. If
 133            this is set to y\bye\bes\bs and the configuration file changed on disk and
 134            its modification time (mtime) is newer than the previous version,
 135            the configuration is automatically reloaded.  Default is n\bno\bo.
 136
 137        c\bca\bal\bll\blb\bba\bac\bck\bk =\b= "\b"_\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk"\b"
 138            If this directive is defined, l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd automatically calls the
 139            executable _\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk after the configuration file has
 140            changed on disk. This is useful to update the configuration file
 141            through s\bsc\bcp\bp on the other heartbeated host. The first argument to
 142            the callback is the name of the configuration.
 143
 144            This directive might also be used to restart l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd
 145            automatically after the configuration file changed on disk.
 146            However, if a\bau\but\bto\bor\bre\bel\blo\boa\bad\bd is set to y\bye\bes\bs, the configuration is reloaded
 147            anyway.
 148
 149        f\bfa\bal\bll\blb\bba\bac\bck\bk =\b= _\bi_\bp_\b__\ba_\bd_\bd_\br_\be_\bs_\bs_\b|_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be_\b[_\b:_\bp_\bo_\br_\bt_\bn_\bu_\bm_\bb_\be_\br_\b|_\bs_\be_\br_\bv_\bi_\bc_\be_\bn_\ba_\bm_\be_\b] [m\bma\bas\bsq\bq|t\btp\bpr\bro\box\bxy\by]
 150            the server onto which a web service is redirected if all real
 151            servers are down. Typically this would be 127.0.0.1 with an
 152            emergency page.
 153
 154            This directive may also appear within a virtual server, in which
 155            case it will override the global fallback server, if set.  Also you
 156            can set either m\bma\bas\bsq\bq or t\btp\bpr\bro\box\bxy\by as fallback forwarding mechanism. The
 157            default is m\bma\bas\bsq\bq.
 158
 159        l\blo\bog\bgf\bfi\bil\ble\be =\b= "\b"_\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\bl_\bo_\bg_\bf_\bi_\bl_\be"\b"|syslog_facility
 160            An alternative logfile might be specified with this directive. If
 161            the logfile does not have a leading '/', it is assumed to be a
 162            _\bs_\by_\bs_\bl_\bo_\bg(3) facility name.
 163
 164            The default is to log directly to the file
 165            _\b/_\bv_\ba_\br_\b/_\bl_\bo_\bg_\b/_\bl_\b7_\bv_\bs_\b/_\bl_\b7_\bd_\bi_\br_\be_\bc_\bt_\bo_\br_\bd_\b._\bl_\bo_\bg.
 166
 167        e\bex\bxe\bec\bcu\but\bte\be =\b= "\b"_\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn"\b"
 168            Use this directive to start an instance of l7directord for the
 169            named _\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn.
 170
 171        s\bsu\bup\bpe\ber\brv\bvi\bis\bse\bed\bd
 172            If this directive is specified, the daemon does not go into
 173            background mode.  All log-messages are redirected to stdout instead
 174            of a logfile.  This is useful to run l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd supervised from
 175            daemontools.  See http://untroubled.org/rpms/daemontools/ or
 176            http://cr.yp.to/daemontools.html for details.
 177
 178        q\bqu\bui\bie\bes\bsc\bce\ben\bnt\bt =\b= [y\bye\bes\bs|n\bno\bo]
 179            If y\bye\bes\bs, then when real or fallback servers are determined to be
 180            down, they are not actually removed from the UltraMonkey-L7, but
 181            set weight to zero.  If n\bno\bo, then the real or fallback servers will
 182            be removed from the UltraMonkey-L7. The default is y\bye\bes\bs.
 183
 184            This directive may also appear within a virtual server, in which
 185            case it will override the global fallback server, if set.
 186
 187    S\bSe\bec\bct\bti\bio\bon\bn v\bvi\bir\brt\btu\bua\bal\bl
 188        The following commands must follow a v\bvi\bir\brt\btu\bua\bal\bl entry and must be indented
 189        with a minimum of 4 spaces or one tab.
 190
 191        r\bre\bea\bal\bl =\b=
 192        _\bi_\bp_\b__\ba_\bd_\bd_\br_\be_\bs_\bs_\b|_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be_\b[_\b-_\b>_\bi_\bp_\b__\ba_\bd_\bd_\br_\be_\bs_\bs_\b|_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be_\b]_\b[_\b:_\bp_\bo_\br_\bt_\bn_\bu_\bm_\bb_\be_\br_\b|_\bs_\be_\br_\bv_\bi_\bc_\be_\bn_\ba_\bm_\be]
 193        [m\bma\bas\bsq\bq|t\btp\bpr\bro\box\bxy\by] [_\bn] ["\b"_\br_\be_\bq_\bu_\be_\bs_\bt"\b",\b, "\b"_\br_\be_\bc_\be_\bi_\bv_\be"\b"]
 194            Defines a real service by IP-address (or hostname) and port (or
 195            servicename). If the port is omitted then a 0 will be used.
 196            Optionally a range of IP addresses (or two hostnames) may be given,
 197            in which case each IP address in the range will be treated as a
 198            real server using the given port. The second argument defines the
 199            forwarding mechanism, it must be m\bma\bas\bsq\bq or t\btp\bpr\bro\box\bxy\by.  The third
 200            argument defines the weight of each real service. This argument is
 201            optional. Default is 1. The last two arguments are optional too.
 202            They define a request-receive pair to be used to check if a server
 203            is alive. They override the request-receive pair in the virtual
 204            server section. These two strings must be quoted. If the request
 205            string starts with _\bh_\bt_\bt_\bp_\b:_\b/_\b/_\b._\b._\b. the IP-address and port of the real
 206            server is overridden, otherwise the IP-address and port of the real
 207            server is used.
 208
 209        m\bmo\bod\bdu\bul\ble\be =\b= _\bp_\br_\bo_\bt_\bo_\b-_\bm_\bo_\bd_\bu_\bl_\be _\bm_\bo_\bd_\bu_\bl_\be_\b-_\ba_\br_\bg_\bs _\b[_\bo_\bp_\bt_\b-_\bm_\bo_\bd_\bu_\bl_\be_\b-_\ba_\br_\bg_\bs_\b]
 210            Indicates the module parameter of l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd. Here p\bpr\bro\bot\bto\bo-\b-m\bmo\bod\bdu\bul\ble\be
 211            denotes the protocol module name (For example, pfilter). m\bmo\bod\bdu\bul\ble\be-\b-
 212            a\bar\brg\bgs\bs denotes the arguments for the protocol module (For example,
 213            --pattern-match '*.html*').  m\bmo\bod\bdu\bul\ble\be-\b-a\bar\brg\bgs\bs is optional only when set
 214            s\bse\bes\bss\bsi\bio\bon\bnl\ble\bes\bss\bs, i\bip\bp and s\bss\bsl\bli\bid\bd module to p\bpr\bro\bot\bto\bo-\b-m\bmo\bod\bdu\bul\ble\be.  The last
 215            argument is optional (For example, --reschedule).
 216
 217    M\bMo\bor\bre\be t\bth\bha\ban\bn o\bon\bne\be o\bof\bf t\bth\bhe\bes\bse\be e\ben\bnt\btr\bri\bie\bes\bs m\bma\bay\by b\bbe\be i\bin\bns\bsi\bid\bde\be a\ba v\bvi\bir\brt\btu\bua\bal\bl s\bse\bec\bct\bti\bio\bon\bn:\b:
 218        m\bma\bax\bxc\bco\bon\bnn\bn =\b= _\bn
 219            Defines the maximum connection that the virtual service can handle.
 220            If the number of requests cross the maxconn limit, the requests
 221            would be redirected to the sorry server.
 222
 223        q\bqo\bos\bsu\bup\bp =\b= _\bn[K\bK|M\bM|G\bG]
 224            Defines the bandwidth quota size in bps for up stream. If the
 225            number of the bandwidth is over the qosup limit, a packet to the
 226            virtual service will be delayed until the number of bandwidth
 227            become below the qosup limit.  K\bK(kilo), M\bM(mega) and G\bG(giga) unit
 228            are available.
 229
 230        q\bqo\bos\bsd\bdo\bow\bwn\bn =\b= _\bn[K\bK|M\bM|G\bG]
 231            Defines the bandwidth quota size in bps for down stream. If the
 232            number of the bandwidth is over the qosdown limit, a packet to the
 233            client will be delayed until the number of bandwidth become below
 234            the qosdown limit.  K\bK(kilo), M\bM(mega) and G\bG(giga) unit are
 235            available.
 236
 237        s\bso\bor\brr\bry\bys\bse\ber\brv\bve\ber\br =\b=_\bi_\bp_\b__\ba_\bd_\bd_\br_\be_\bs_\bs_\b|_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be_\b[_\b:_\bp_\bo_\br_\bt_\bn_\bu_\bm_\bb_\be_\br_\b|_\bs_\be_\br_\bv_\bi_\bc_\be_\bn_\ba_\bm_\be_\b] [m\bma\bas\bsq\bq|t\btp\bpr\bro\box\bxy\by]
 238            Defines a sorry server by IP-address (or hostname) and port (or
 239            servicename). The second argument defines the forwarding mechanism,
 240            it must be m\bma\bas\bsq\bq or t\btp\bpr\bro\box\bxy\by.  Firewall-mark settings cannot be set.
 241            If the number of requests to the virtual service cross the maxconn
 242            limit, or no available real server exists, then the requests would
 243            be redirected to the sorry server.
 244
 245        c\bch\bhe\bec\bck\bkt\bty\byp\bpe\be =\b= n\bne\beg\bgo\bot\bti\bia\bat\bte\be|c\bco\bon\bnn\bne\bec\bct\bt|_\bN|p\bpi\bin\bng\bg|c\bcu\bus\bst\bto\bom\bm|o\bof\bff\bf|o\bon\bn
 246            Type of check to perform. Negotiate sends a request and matches a
 247            receive string. Connect only attempts to make a TCP/IP connection,
 248            thus the request and receive strings may be omitted.  If checktype
 249            is a number then negotiate and connect is combined so that after
 250            each N connect attempts one negotiate attempt is performed. This is
 251            useful to check often if a service answers and in much longer
 252            intervals a negotiating check is done. Ping means that ICMP ping
 253            will be used to test the availability of real servers.  Ping is
 254            also used as the connect check for UDP services. Custom means that
 255            custom command will be used to test the availability of real
 256            servers.  Off means no checking will take place and no real or
 257            fallback servers will be activated.  On means no checking will take
 258            place and real servers will always be activated. Default is
 259            _\bn_\be_\bg_\bo_\bt_\bi_\ba_\bt_\be.
 260
 261        s\bse\ber\brv\bvi\bic\bce\be =\b=
 262        f\bft\btp\bp|s\bsm\bmt\btp\bp|h\bht\btt\btp\bp|p\bpo\bop\bp|n\bnn\bnt\btp\bp|i\bim\bma\bap\bp|l\bld\bda\bap\bp|h\bht\btt\btp\bps\bs|d\bdn\bns\bs|m\bmy\bys\bsq\bql\bl|p\bpg\bgs\bsq\bql\bl|s\bsi\bip\bp|n\bno\bon\bne\be
 263            The type of service to monitor when using checktype=negotiate. None
 264            denotes a service that will not be monitored. If the port specified
 265            for the virtual server is 21, 25, 53, 80, 110, 119, 143, 389, 443,
 266            3306, 5432 or 5060 then the default is f\bft\btp\bp, s\bsm\bmt\btp\bp, d\bdn\bns\bs, h\bht\btt\btp\bp, p\bpo\bop\bp,
 267            n\bnn\bnt\btp\bp, i\bim\bma\bap\bp, l\bld\bda\bap\bp, h\bht\btt\btp\bps\bs, m\bmy\bys\bsq\bql\bl, p\bpg\bgs\bsq\bql\bl or s\bsi\bip\bp respectively.
 268            Otherwise the default service is n\bno\bon\bne\be.
 269
 270        c\bch\bhe\bec\bck\bkp\bpo\bor\brt\bt =\b= _\bn
 271            Number of port to monitor. Sometimes check port differs from
 272            service port.  Default is port specified for the real server.
 273
 274        r\bre\beq\bqu\bue\bes\bst\bt =\b= "\b"_\bu_\br_\bi _\bt_\bo _\br_\be_\bq_\bu_\be_\bs_\bt_\be_\bd _\bo_\bb_\bj_\be_\bc_\bt"\b"
 275            This object will be requested each checkinterval seconds on each
 276            real server.  The string must be inside quotes. Note that this
 277            string may be overridden by an optional per real-server based
 278            request-string.
 279
 280            For a DNS check this should the name of an A record, or the address
 281            of a PTR record to look up.
 282
 283            For a MySQL or PostgreSQL checks, this should be a SQL query.  The
 284            data returned is not checked, only that the answer is one or more
 285            rows.  This is a required setting.
 286
 287        r\bre\bec\bce\bei\biv\bve\be =\b= "\b"_\br_\be_\bg_\be_\bx_\bp _\bt_\bo _\bc_\bo_\bm_\bp_\ba_\br_\be"\b"
 288            If the requested result contains this _\br_\be_\bg_\be_\bx_\bp _\bt_\bo _\bc_\bo_\bm_\bp_\ba_\br_\be, the real
 289            server is declared alive. The regexp must be inside quotes. Keep in
 290            mind that regexps are not plain strings and that you need to escape
 291            the special characters if they should as literals. Note that this
 292            regexp may be overridden by an optional per real-server based
 293            receive regexp.
 294
 295            For a DNS check this should be any one the A record's addresses or
 296            any one of the PTR record's names.
 297
 298            For a MySQL check, the receive setting is not used.
 299
 300        h\bht\btt\btp\bpm\bme\bet\bth\bho\bod\bd =\b= G\bGE\bET\bT|H\bHE\bEA\bAD\bD
 301            Sets the HTTP method, which should be used to fetch the URI
 302            specified in the request-string. GET is the method used by default
 303            if the parameter is not set. If HEAD is used, the receive-string
 304            should be unset.
 305
 306        v\bvi\bir\brt\btu\bua\bal\blh\bho\bos\bst\bt =\b= "\b"_\bh_\bo_\bs_\bt_\bn_\ba_\bm_\be"\b"
 307            Used when using a negotiate check with HTTP or HTTPS. Sets the host
 308            header used in the HTTP request.  In the case of HTTPS this
 309            generally needs to match the common name of the SSL certificate. If
 310            not set then the host header will be derived from the request url
 311            for the real server if present.  As a last resort the IP address of
 312            the real server will be used.
 313
 314        l\blo\bog\bgi\bin\bn =\b= "\b"_\bu_\bs_\be_\br_\bn_\ba_\bm_\be"\b"
 315            Username to use to login to FTP, POP, IMAP, MySQL and PostgreSQL
 316            servers.  For FTP, the default is anonymous. For POP and IMAP, the
 317            default is the empty string, in which case authentication will not
 318            be attempted.  For a MySQL and PostgreSQL, the username must be
 319            provided.
 320
 321            For SIP the username is used as both the to and from address for an
 322            OPTIONS query. If unset it defaults to l7directord\@<hostname>,
 323            hostname is derived as per the passwd option below.
 324
 325        p\bpa\bas\bss\bsw\bwd\bd =\b= "\b"_\bp_\ba_\bs_\bs_\bw_\bo_\br_\bd"\b"
 326            Password to use to login to FTP, POP, IMAP, MySQL and PostgreSQL
 327            servers.  Default is for FTP is l7directord\@<hostname>, where
 328            hostname is the environment variable HOSTNAME evaluated at run
 329            time, or sourced from uname if unset. The default for all other
 330            services is an empty password, in the case of MySQL and PostgreSQL
 331            this means authentication will not be performed.
 332
 333        d\bda\bat\bta\bab\bba\bas\bse\be =\b= "\b"_\bd_\ba_\bt_\ba_\bb_\ba_\bs_\be_\bn_\ba_\bm_\be"\b"
 334            Database to use for MySQL and PostgreSQL servers, this is the
 335            database that the query (set by r\bre\bec\bce\bei\biv\bve\be above) will be performed
 336            against.  This is a required setting.
 337
 338        s\bsc\bch\bhe\bed\bdu\bul\ble\ber\br =\b= _\bs_\bc_\bh_\be_\bd_\bu_\bl_\be_\br_\b__\bn_\ba_\bm_\be
 339            Scheduler to be used by UltraMonkey-L7 for load balancing.  The
 340            available schedulers are only l\blc\bc and r\brr\br. The default is _\br_\br.
 341
 342        p\bpr\bro\bot\bto\boc\bco\bol\bl =\b= t\btc\bcp\bp
 343            Protocol to be used. l\bl7\b7v\bvs\bsa\bad\bdm\bm supports only t\btc\bcp\bp.  Since the virtual
 344            is specified as an IP address and port, it would be tcp and will
 345            default to tcp.
 346
 347        r\bre\bea\bal\bld\bdo\bow\bwn\bnc\bca\bal\bll\blb\bba\bac\bck\bk =\b= "\b"_\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\br_\be_\ba_\bl_\bd_\bo_\bw_\bn_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk"\b"
 348            If this directive is defined, l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd automatically calls the
 349            executable _\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\br_\be_\ba_\bl_\bd_\bo_\bw_\bn_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk after a real server's status
 350            changes to down. The first argument to the realdowncallback is the
 351            real server's IP-address and port (ip_address:portnumber).
 352
 353        r\bre\bea\bal\blr\bre\bec\bco\bov\bve\ber\brc\bca\bal\bll\blb\bba\bac\bck\bk =\b= "\b"_\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\br_\be_\ba_\bl_\br_\be_\bc_\bo_\bv_\be_\br_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk"\b"
 354            If this directive is defined, l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd automatically calls the
 355            executable _\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\br_\be_\ba_\bl_\br_\be_\bc_\bo_\bv_\be_\br_\bc_\ba_\bl_\bl_\bb_\ba_\bc_\bk after a real server's
 356            status changes to up. The first argument to the realrecovercallback
 357            is the real server's IP-address and port (ip_address:portnumber).
 358
 359        c\bcu\bus\bst\bto\bom\bmc\bch\bhe\bec\bck\bk =\b= "\b"_\bc_\bu_\bs_\bt_\bo_\bm _\bc_\bh_\be_\bc_\bk _\bc_\bo_\bm_\bm_\ba_\bn_\bd"\b"
 360            If this directive is defined and set c\bch\bhe\bec\bck\bkt\bty\byp\bpe\be to custom,
 361            l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd exec custom command for real servers health checking.
 362            Only if custom command returns 0, real servers will change to up.
 363            Otherwise real servers will change to down. Custom check command
 364            has some macro string. See below.
 365
 366            _\b_I\bIP\bP_\b_
 367                Change to real server IP address.
 368
 369            _\b_P\bPO\bOR\bRT\bT_\b_
 370                Change to real server port number.
 371
 372        s\bss\bsl\blc\bco\bon\bnf\bfi\big\bgf\bfi\bil\ble\be =\b= "\b"_\b/_\bp_\ba_\bt_\bh_\b/_\bt_\bo_\b/_\bs_\bs_\bl_\bc_\bo_\bn_\bf_\bi_\bg_\bf_\bi_\bl_\be"\b"
 373            When communication with Client is SSL, the file name for SSL
 374            setting is designated.
 375
 376        s\bso\boc\bck\bke\bet\bto\bop\bpt\bti\bio\bon\bn =\b= "\b"_\bO_\bP_\bT_\bI_\bO_\bN_\b._\b._\b."\b"
 377            An option of the socket used in VirtualService is designated.  The
 378            setting possible value is described.
 379
 380            t\btr\bra\ban\bns\bsp\bpa\bar\bre\ben\bnt\bt
 381                Set IP_TRANSPARENT option to the RealServer socket.
 382
 383            d\bde\bef\bfe\ber\bra\bac\bcc\bce\bep\bpt\bt
 384                Set TCP_DEFER_ACCEPT option to the listener socket of
 385                VirtualService.
 386
 387            n\bno\bod\bde\bel\bla\bay\by
 388                Set TCP_NODELAY option to the Client and RealServer socket.
 389
 390            c\bco\bor\brk\bk
 391                Set TCP_CORK option to the Client and RealServer socket.
 392
 393            q\bqu\bui\bic\bck\bka\bac\bck\bko\bon\bn or q\bqu\bui\bic\bck\bka\bac\bck\bko\bof\bff\bf
 394                Set or unset TCP_QUICKACK option to the Client and RealServer
 395                socket.
 396
 397        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg =\b= [y\bye\bes\bs|n\bno\bo]
 398            If y\bye\bes\bs, then output client access log. The default is n\bno\bo.
 399
 400        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_t\bty\byp\bpe\be =\b= [d\bda\bat\bte\be|s\bsi\biz\bze\be|d\bda\bat\bte\bes\bsi\biz\bze\be]
 401            d\bda\bat\bte\be means rotate access log with the specified date/time. s\bsi\biz\bze\be
 402            means rotate access log when that file size exceeds the specified
 403            size. d\bda\bat\bte\bes\bsi\biz\bze\be means both d\bda\bat\bte\be and s\bsi\biz\bze\be.
 404
 405        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_m\bma\bax\bx_\b_b\bba\bac\bck\bku\bup\bp_\b_i\bin\bnd\bde\bex\bx =\b= _\bn
 406            Maximum number of backup files.
 407
 408        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_m\bma\bax\bx_\b_f\bfi\bil\ble\bes\bsi\biz\bze\be =\b=  _\bn[K\bK|M\bM|G\bG]
 409            Threshold file size of access log when a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_t\bty\byp\bpe\be is set
 410            to s\bsi\biz\bze\be or d\bda\bat\bte\bes\bsi\biz\bze\be. K\bK(kilo), M\bM(mega) and G\bG(giga) units are
 411            available.
 412
 413        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg =\b= [y\bye\bea\bar\br|m\bmo\bon\bnt\bth\bh|w\bwe\bee\bek\bk|d\bda\bat\bte\be|h\bho\bou\bur\br]
 414            Rotate timing type when a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_t\bty\byp\bpe\be is set to d\bda\bat\bte\be or
 415            d\bda\bat\bte\bes\bsi\biz\bze\be.
 416
 417        a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg_\b_v\bva\bal\blu\bue\be =\b= "\b"_\br_\bo_\bt_\ba_\bt_\bi_\bo_\bn_\b__\bt_\bi_\bm_\bi_\bn_\bg_\b__\bv_\ba_\bl_\bu_\be"\b"
 418            Rotate timing. The formats are different by
 419            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg setting.
 420
 421            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg=\b=y\bye\bea\bar\br
 422                FORMAT: "\b"M\bMM\bM/\b/d\bdd\bd H\bHH\bH:\b:m\bmm\bm"\b"
 423
 424            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg=\b=m\bmo\bon\bnt\bth\bh
 425                FORMAT: "\b"d\bdd\bd H\bHH\bH:\b:m\bmm\bm"\b"
 426
 427            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg=\b=w\bwe\bee\bek\bk
 428                FORMAT: "\b"[s\bsu\bun\bn|m\bmo\bon\bn|t\btu\bue\be|w\bwe\bed\bd|t\bth\bhu\bu|f\bfr\bri\bi|s\bsa\bat\bt] H\bHH\bH:\b:m\bmm\bm"\b"
 429
 430            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg=\b=d\bda\bat\bte\be
 431                FORMAT: "\b"H\bHH\bH:\b:m\bmm\bm"\b"
 432
 433            a\bac\bcc\bce\bes\bss\bsl\blo\bog\bg_\b_r\bro\bot\bta\bat\bte\be_\b_r\bro\bot\bta\bat\bti\bio\bon\bn_\b_t\bti\bim\bmi\bin\bng\bg=\b=h\bho\bou\bur\br
 434                FORMAT: "\b"m\bmm\bm"\b"
 435
 436 F\bFI\bIL\bLE\bES\bS
 437        /\b/e\bet\btc\bc/\b/h\bha\ba.\b.d\bd/\b/c\bco\bon\bnf\bf/\b/l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd.\b.c\bcf\bf
 438
 439        /\b/v\bva\bar\br/\b/l\blo\bog\bg/\b/l\bl7\b7v\bvs\bs/\b/l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd.\b.l\blo\bog\bg
 440
 441        /\b/v\bva\bar\br/\b/r\bru\bun\bn/\b/l\bl7\b7d\bdi\bir\bre\bec\bct\bto\bor\brd\bd.\b._\bc_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn.\b.p\bpi\bid\bd
 442
 443        /\b/e\bet\btc\bc/\b/s\bse\ber\brv\bvi\bic\bce\bes\bs
 444
 445 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 446        l7vsadm, heartbeat
 447
 448 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
 449        NTT COMWARE
 450
 451
 452
 453 perl v5.10.1                      2010-10-25                    L7DIRECTORD(1)