Protect SoH server messages
[freeradius.git] / man / man8 / radsqlrelay.8
1 .\"     # DS - begin display
2 .de DS
3 .RS
4 .nf
5 .sp
6 ..
7 .\"     # DE - end display
8 .de DE
9 .fi
10 .RE
11 .sp
12 ..
13 .TH RADSQLRELAY 8 "19 June 2005" "" "FreeRADIUS helper program"
14
15 .SH NAME
16 radsqlrelay - relay SQL queries to a central database server
17
18 .SH SYNOPSIS
19 .B radsqlrelay
20 .RB [ \-d
21 .IR sql_driver ]
22 .RB [ \-b
23 .IR database ]
24 .RB [ \-f
25 .IR file ]
26 .RB [ \-h
27 .IR host ]
28 .RB [ \-u
29 .IR user ]
30 .RB [ \-p
31 .IR password ]
32 .RB [ \-1 ]
33 \fIfile_path\fP
34
35 .SH DESCRIPTION
36 \fBradsqlrelay\fP tails a SQL \fIlogfile\fP and forwards the queries
37 to a database server. Used to replicate accounting records to one
38 (central) database, even if the database has extended downtime.
39 .PP
40 The SQL logfile is created by the \fBrlm_sql_log\fP module. The module
41 must be configured in the \fBradiusd\fP server before you can use
42 \fBradsqlrelay\fP.
43
44 .SH OPTIONS
45 .IP "\-d \fIsql_driver\fP"
46 Driver to use: mysql, pg, oracle.
47 .IP "\-b \fIdatabase\fP"
48 Name of the database to use.
49 .IP "\-f \fIfile\fP"
50 Read password from file, instead of command line.
51 .IP "\-h \fIhost\fP"
52 Connect to host.
53 .IP "\-u \fIuser\fP"
54 User for login.
55 .IP "\-p \fIpassword\fP"
56 Password to use when connecting to server.
57 .IP "\-1"
58 One-shot mode: push the file to database and exit.
59 .IP "file_path"
60 The pathname of the SQL logfile to use.
61
62 .SH NOTES
63 .SS Oracle driver
64 The command "radsqlrelay -d oracle -b db.domain.tld sql-relay" reads the
65 database description stored in $TNS_ADMIN/tnsnames.ora:
66 .PP
67 .DS
68 db.domain.tld =
69   (DESCRIPTION =
70     (ADDRESS_LIST =
71       (ADDRESS = (PROTOCOL = TCP)(HOST = db.domain.tld)(PORT = 1521))
72     )
73     (CONNECT_DATA =
74       (SERVICE_NAME = <DB SID>)
75     )
76   )
77 .DE
78
79 .SH SEE ALSO
80 .BR rlm_sql_log (5)
81
82 .SH AUTHOR
83 Nicolas Baradakis <nicolas.baradakis@cegetel.net>