acct.sgml

H.323网守实现

<tt>RotateTime=23:00</tt><newline>
</descrip>

<descrip>
<tag/Example 6 - rotate per every 10000 CDRs:/
<tt/&lsqb;FileAcct&rsqb;/<newline>
<tt>DetailFile=/var/log/gk/cdr.log</tt><newline>
<tt>Rotate=L10000</tt><newline>
</descrip>

<descrip>
<tag/Example 7 - rotate per every 10 kilobytes:/
<tt/&lsqb;FileAcct&rsqb;/<newline>
<tt>DetailFile=/var/log/gk/cdr.log</tt><newline>
<tt>Rotate=S10k</tt><newline>
</descrip>

</itemize>

<sect1>Section &lsqb;RadAcct&rsqb;
<label id="radacct">
<p>
This accounting module sends accounting data to a RADIUS server. Module
configuration is almost the same as for RADIUS authenticators (see
<ref id="radauth" name="[RadAuth]"> and <ref id="radaliasauth" name="[RadAliasAuth]">
for more details on the parameters).

<itemize>
<item><tt/Servers=SERVER1[:AUTH_PORT:ACCT_PORT[:SECRET]];SERVER2[:AUTH_PORT:ACCT_PORT[:SECRET]];.../<newline>
Default: <tt>N/A</tt>
<p>
RADIUS servers to send accounting data to. If no port information is given,
port number from <tt/DefaultAcctPort/ is be used. If no secret is set, 
the default shared secret from <tt/SharedSecret/ is used. Server names could 
be either IP addresses or DNS names.

<descrip>
<tag>Sample <tt/Servers/ lines:</tag>
<tt>Servers=192.168.1.1</tt><newline>
<tt>Servers=192.168.1.1:1645:1646</tt><newline>
<tt>Servers=192.168.1.1:1645:1646:secret1</tt><newline>
<tt>Servers=radius1.mycompany.com:1812:1813</tt><newline>
<tt>Servers=radius1.mycompany.com;radius2.mycompany.com</tt><newline>
<tt>Servers=radius1.mycompany.com:1812:1813:secret1;radius2.mycompany.com:1812:1813:secret2</tt><newline>
</descrip>

<item><tt/LocalInterface=IP_OR_FQDN/<newline>
Default: <tt>N/A</tt>
<p>
Particular local network interface that RADIUS client should
use in order to communicate with RADIUS servers.

<item><tt/RadiusPortRange=10000-11000/<newline>
Default: <tt>N/A</tt>
<p>
By default (if this option is not set) RADIUS client
allocates ports dynamically as specified by the operating system.
If you want to restrict RADIUS client to use ports from
a particular range only - set this parameter.

<item><tt/DefaultAcctPort=PORT_NO/<newline>
Default: <tt>1813</tt>
<p>
Default port number to be used for RADIUS accounting requests,
if not overriden by <tt/Servers/ attribute.

<item><tt/SharedSecret=SECRET/<newline>
Default: <tt>N/A (empty string)</tt>
<p>
A secret used to authenticate this GnuGk (NAS client) to RADIUS
server. It should be a cryptographically strong password. This is the default
value used, if no server-specific secret is set in the <tt/Servers/.
If <tt/EncryptAllPasswords/ is enabled, or a <tt/KeyFilled/ variable is defined
in this section, the password is in encrypted form and should be created using
the <tt/addpasswd/ utility.

<item><tt/RequestTimeout=TIMEOUT_MS/<newline>
Default: <tt/2000/ (miliseconds)
<p>
Timeout (miliseconds) for RADIUS server response to a request
sent by GnuGk. If no response is received within this time period,
next RADIUS server is queried.

<item><tt/IdCacheTimeout=TIMEOUT_MS/<newline>
Default: <tt/9000/ (miliseconds)
<p>
Timeout (miliseconds) for RADIUS request 8-bit identifiers to be
unique.

<item><tt/SocketDeleteTimeout=TIMEOUT_MS/<newline>
Default: <tt/60000/ (miliseconds) - 60 s
<p>
Timeout for unused RADIUS sockets to be closed.

<item><tt/RequestRetransmissions=NUMBER/<newline>
Default: <tt/2/
<p>
How many times a single RADIUS request is transmissed to every
configured RADIUS server (if no response is received).

<item><tt/RoundRobinServers=BOOLEAN/<newline>
Default: <tt/1/
<p>
RADIUS requests retransmission method.

<item><tt/AppendCiscoAttributes=BOOLEAN/<newline>
Default: <tt/0/
<p>
If set, Cisco Vendor Specific RADIUS attibutes are included
in RADIUS requests (h323-conf-id,h323-call-origin,h323-call-type).

<item><tt/TimestampFormat=ISO8601/<newline>
Default: <tt>N/A</tt>
<p>
Format of timestamp strings sent in RADIUS attributes. If this setting
is not specified, a global one from the main gatekeeper section is applied.

<item><tt/UseDialedNumber=BOOLEAN/<newline>
Default: <tt/0/
<p>
Select Called-Station-Id number type between the original one (as dialed
by the user) - <tt/UseDialedNumber=1/ - and the rewritten one - <tt/UseDialedNumber=0/.

</itemize>

<sect1>Section &lsqb;SQLAcct&rsqb;
<label id="sqlacct">
<p>
This accounting module stores accounting information directly
to an SQL database. Many configuration settings are common with
other SQL modules.

<itemize>
<item><tt/Driver=MySQL | PostgreSQL/<newline>
Default: N/A
<p>
SQL database driver to use. Currently, <tt/MySQL/ and <tt/PostgreSQL/ drivers
are implemented.

<item><tt/Host=DNS[:PORT] | IP[:PORT]/<newline>
Default: <tt/localhost/
<p>
SQL server host address. Can be in the form of <tt/DNS[:PORT]/ or <tt/IP[:PORT]/.
Like <tt/sql.mycompany.com/ or <tt/sql.mycompany.com:3306/ or <tt/192.168.3.100/.

<item><tt/Database=billing/<newline>
Default: <tt/billing/
<p>
The database name to connect to.

<item><tt/Username=gnugk/<newline>
<p>
The username used to connect to the database.

<item><tt/Password=secret/<newline>
<p>
The password used to connect to the database.
If the password is not specified, a database connection attempt 
without any password will be made.
If <tt/EncryptAllPasswords/ is enabled, or a <tt/KeyFilled/ variable is defined
in this section, the password is in an encrypted form and should be created 
using the <tt/addpasswd/ utility.

<item><tt/StartQuery=INSERT .../<newline>
Default: <tt>N/A</tt>
<p>
Defines SQL query used to insert a new call record to the database. The query
is parametrized - that means parameter replacement is made before each query
is executed. Parameter placeholders are denoted by % character and can be one
letter (like %u) or whole strings (like %{src-info}). Specify %% to embed 
a percent character inside the query string (like <bf/%%/).
For <tt/SQLAcct/ the following parameters are defined:
<itemize>
<item><tt/%g/ - gatekeeper name
<item><tt/%n/ - call number (not unique after gatekeeper restart)
<item><tt/%d/ - call duration (seconds)
<item><tt/%t/ - total call duration (from Setup to Release Complete)
<item><tt/%c/ - Q.931 disconnect cause (<bf/hexadecimal/ integer)
<item><tt/%r/ - who disconnected the call (-1 - unknown, 0 - the gatekeeper, 1 - the caller, 2 - the callee)
<item><tt/%p/ - PDD (Post Dial Delay) in seconds
<item><tt/%s/ - unique (for this gatekeeper) call (Acct-Session-Id)
<item><tt/%u/ - H.323 ID of the calling party
<item><tt/%{gkip}/ - IP address of the gatekeeper
<item><tt/%{CallId}/ - H.323 call identifier (16 hex 8-bit digits)
<item><tt/%{ConfId}/ - H.323 conference identifier (16 hex 8-bit digits)
<item><tt/%{setup-time}/ - timestamp string for Q.931 Setup message
<item><tt/%{alerting-time}/ - timestamp string for Q.931 Alerting message
<item><tt/%{connect-time}/ - timestamp string for a call connected event
<item><tt/%{disconnect-time}/ - timestamp string for a call disconnect event
<item><tt/%{ring-time}/ - time a remote phone was ringing for (from Alerting till Connect or Release Complete)
<item><tt/%{caller-ip}/ - signaling IP addres of the caller
<item><tt/%{caller-port}/ - signaling port of the caller
<item><tt/%{callee-ip}/ - signaling IP addres of the called party
<item><tt/%{callee-port}/ - signaling port of the called party
<item><tt/%{src-info}/ - a colon separated list of source aliases
<item><tt/%{dest-info}/ - a colon separated list of destination aliases
<item><tt/%{Calling-Station-Id}/ - calling party number
<item><tt/%{Called-Station-Id}/ - called party number (rewritten Dialed-Number)
<item><tt/%{Dialed-Number}/ - dialed number (as received from the calling party)
</itemize>
<p>
Sample query string:
<tscreen><verb>
INSERT INTO call (gkname, sessid, username, calling, called) 
	VALUES ('%g', '%s', '%u', '%{Calling-Station-Id}', '%{Called-Station-Id}')
</verb></tscreen>

<item><tt/StartQueryAlt=INSERT .../<newline>
Default: <tt>N/A</tt>
<p>
Defines SQL query used to insert a new call record to the database in case
the <tt/StartQuery/ failed for some reason (the call already exists, for example).
The syntax and parameters are the same as for <tt/StartQuery/.

<item><tt/UpdateQuery=UPDATE .../<newline>
Default: <tt>N/A</tt>
<p>
Defines SQL query used to update call record in the database with the current 
call state. The syntax and parameters are the same as for <tt/StartQuery/.
<p>
Sample query string:
<tscreen><verb>
UPDATE call SET duration = %d WHERE gkname = '%g' AND sessid = '%s'
</verb></tscreen>

<item><tt/StopQuery=UPDATE .../<newline>
Default: <tt>N/A</tt>
<p>
Defines SQL query used to update call record in the database when the call
is finished (disconnected). The syntax and parameters are the same 
as for <tt/StartQuery/.
<p>
Sample query string:
<tscreen><verb>
UPDATE call SET duration = %d, dtime = '%{disconnect-time}' WHERE gkname = '%g' AND sessid = '%s'
</verb></tscreen>

<item><tt/StopQueryAlt=INSERT .../<newline>
Default: <tt>N/A</tt>
<p>
Defines SQL query used to update call record in the database when the call
is finished (disconnected) in case the regular <tt/StopQuery/ failed (because
the call record does not yet exist, for example). The syntax and parameters 
are the same as for <tt/StartQuery/.
<p>
Sample query string:
<tscreen><verb>
INSERT INTO call (gkname, sessid, username, calling, called, duration) 
	VALUES ('%g', '%s', '%u', '%{Calling-Station-Id}', '%{Called-Station-Id}', %d)
</verb></tscreen>

<item><tt/TimestampFormat=MySQL/<newline>
Default: <tt>N/A</tt>
<p>
Format of timestamp strings used in queries. If this setting
is not specified, a global one from the main gatekeeper section is applied.

<item><tt/MinPoolSize=5/<newline>
Default: <tt>1</tt>
<p>
Number of concurrent SQL connections in the pool. The first available connection
in the pool is used to store accounting data.

</itemize>