acc_user.sgml

来自「性能优秀的SIP Proxy」· SGML 代码 · 共 1,271 行 · 第 1/3 页

	</section>
	<section>
		<title><varname>report_ack</varname> (integer)</title>
		<para>
		Shall acc attempt to account e2e ACKs too ? Note that this is really 
		only an attempt, as e2e ACKs may take a different path 
		(unless RR enabled) and mismatch original INVITE (e2e ACKs are 
		a separate transaction).
		</para>
		<para>
		Default value is 1 (yes).
		</para>
		<example>
		<title>report_ack example</title>
		<programlisting format="linespecific">
modparam("acc", "report_ack", 0)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>report_cancels</varname> (integer)</title>
		<para>
		By default, CANCEL reporting is disabled -- most accounting
		applications are happy to see INVITE's cancellation status.
		Turn on if you explicitly want to account CANCEL transactions.
		</para>
		<para>
		Default value is 0 (no).
		</para>
		<example>
		<title>report_cancels example</title>
		<programlisting format="linespecific">
modparam("acc", "report_cancels", 1)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>multi_leg_enabled</varname> (integer)</title>
		<para>
		If set to a non 0 value, it will enables the logging of the 
		call-legs. See <xref linkend="multi-call-legs"> for a 
		detailed description of the Multi Call-Legs accounting.
		</para>
		<para>
		Default value is 0 (disabled).
		</para>
		<example>
		<title>multi_leg_enabled example</title>
		<programlisting format="linespecific">
modparam("acc", "multi_leg_enabled", 1)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>src_leg_avp_id</varname> (integer)</title>
		<para>
		Defines the AVP (ID AVP) which contains the source URI part of a 
		call-leg. See <xref linkend="multi-call-legs"> for a 
		detailed description of the Multi Call-Legs accounting.
		</para>
		<para>
		Default value is 0 (undefined).
		</para>
		<example>
		<title>src_leg_avp_id example</title>
		<programlisting format="linespecific">
modparam("acc", "src_leg_avp_id", 110)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>dst_leg_avp_id</varname> (integer)</title>
		<para>
		Defines the AVP (ID AVP) which contains the destination URI part of a 
		call-leg. See <xref linkend="multi-call-legs"> for a 
		detailed description of the Multi Call-Legs accounting.
		</para>
		<para>
		Default value is 0 (undefined).
		</para>
		<example>
		<title>dst_leg_avp_id example</title>
		<programlisting format="linespecific">
modparam("acc", "dst_leg_avp_id", 110)
</programlisting>
		</example>
	</section>
	<!-- SYSLOG specific ACC parameters -->
	<section>
		<title><varname>log_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account a transaction.
		</para>
		<para>
		Default value is 1.
		</para>
		<example>
		<title>log_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "log_flag", 2)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>log_missed_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account missed calls.
		</para>
		<para>
		Default value is 2.
		</para>
		<example>
		<title>log_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "log_missed_flag", 3)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>log_level</varname> (integer)</title>
		<para>
		Log level at which accounting messages are issued to syslog.
		</para>
		<para>
		Default value is L_NOTICE.
		</para>
		<example>
		<title>log_level example</title>
		<programlisting format="linespecific">
modparam("acc", "log_level", 2)   # Set log_level to 2
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>log_fmt</varname> (string)</title>
		<para>
		Defines what parts of header fields will be printed to
		syslog, see <quote>overview</quote> for list of accepted values.
		</para>
		<para>
		Default value is <quote>miocfs</quote>.
		</para>
		<example>
		<title>log_fmt example</title>
		<programlisting format="linespecific">
modparam("acc", "log_fmt", "mfs")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>log_extra</varname> (string)</title>
		<para>
		Extra values to be logged.
		</para>
		<para>
		Default value is NULL.
		</para>
		<example>
		<title>log_extra example</title>
		<programlisting format="linespecific">
modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
</programlisting>
		</example>
	</section>
	<!-- RADIUS specific ACC parameters -->
	<section>
		<title><varname>radius_config</varname> (string)</title>
		<para>
		<emphasis>This parameter is radius specific.</emphasis> Path to 
		radius client configuration file, set the referred config file 
		correctly and specify there address of server, shared secret 
		(should equal that in /usr/local/etc/raddb/clients for
		freeRadius servers) and dictionary, see etc for an example of 
		config file and dictionary.
		</para>
		<para>
		Default value is <quote>/usr/local/etc/radiusclient/radiusclient.conf
		</quote>.
		</para>
		<example>
		<title>radius_config example</title>
		<programlisting format="linespecific">
modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>radius_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account a 
		transaction -- RADIUS specific.
		</para>
		<para>
		Default value is 1.
		</para>
		<example>
		<title>radius_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "radius_flag", 2)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>radius_missed_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account missed 
		calls -- RADIUS specific.
		</para>
		<para>
		Default value is 2.
		</para>
		<example>
		<title>radius_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "radius_missed_flag", 3)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>service_type</varname> (integer)</title>
		<para>
		Radius service type used for accounting.
		</para>
		<para>
		Default value is 15 (SIP).
		</para>
		<example>
		<title>service_type example</title>
		<programlisting format="linespecific">
modparam("acc", "service_type", 16)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>radius_extra</varname> (string)</title>
		<para>
		Extra values to be logged via RADIUS - RADIUS specific.
		</para>
		<para>
		Default value is NULL.
		</para>
		<example>
		<title>radius_extra example</title>
		<programlisting format="linespecific">
modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
</programlisting>
		</example>
	</section>
	<!-- DIAMETER specific ACC parameters -->
	<section>
		<title><varname>diameter_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account a 
		transaction -- DIAMETER specific.
		</para>
		<para>
		Default value is 1.
		</para>
		<example>
		<title>diameter_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_flag", 2)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>diameter_missed_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account missed 
		calls -- DIAMETER specific.
		</para>
		<para>
		Default value is 2.
		</para>
		<example>
		<title>diameter_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_missed_flag", 3)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>diameter_client_host</varname> (string)</title>
		<para>
		Hostname of the machine where the DIAMETER Client is 
		running -- DIAMETER specific.
		</para>
		<para>
		Default value is <quote>localhost</quote>.
		</para>
		<example>
		<title>diameter_client_host example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_client_host", "3a_server.net")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>diameter_client_port</varname> (int)</title>
		<para>
		Port number where the Diameter Client is 
		listening -- DIAMETER specific.
		</para>
		<para>
		Default value is 3000.
		</para>
		<example>
		<title>diameter_client_host example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_client_port", 3000)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>diamter_extra</varname> (string)</title>
		<para>
		Extra values to be logged via DIAMETER - DIAMETER specific.
		</para>
		<para>
		Default value is NULL.
		</para>
		<example>
		<title>diameter_extra example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:email)")
</programlisting>
		</example>
	</section>
	<!-- SQL specific ACC parameters -->
	<section>
		<title><varname>db_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account a 
		transaction -- database specific.
		</para>
		<para>
		Default value is 1.
		</para>
		<example>
		<title>db_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "db_flag", 2)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_missed_flag</varname> (integer)</title>
		<para>
		Request flag which needs to be set to account missed 
		calls -- database specific.
		</para>
		<para>
		Default value is 2.
		</para>
		<example>
		<title>db_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "db_missed_flag", 3)
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_table_acc</varname> (string)</title>
		<para>
		Table name of accounting successfull calls -- database specific.
		</para>
		<para>
		Default value is <quote>acc</quote>
		</para>
		<example>
		<title>db_table_acc example</title>
		<programlisting format="linespecific">
modparam("acc", "db_table_acc", "myacc_table")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_table_missed_calls</varname> (string)</title>
		<para>
		Table name for accounting missed calls -- database specific.
		</para>
		<para>
		Default value is <quote>missed_calls</quote>
		</para>
		<example>
		<title>db_table_missed_calls example</title>
		<programlisting format="linespecific">
modparam("acc", "db_table_missed_calls", "myMC_table")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_url</varname> (string)</title>
		<para>
		SQL address -- database specific. If is set to NULL or emty string,
		the SQL support is disabled.
		</para>
		<para>
		Default value is <quote>NULL</quote> (SQL disabled).
		</para>
		<example>
		<title>db_url example</title>
		<programlisting format="linespecific">
modparam("acc", "db_url", "mysql://user:password@localhost/openser")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_localtime</varname> (int)</title>
		<para>
		If DB timestamps should follow localtime or GMT time. Any non-zero value
		enables this option.
		</para>
		<para>
		Default value is <quote>0</quote>.
		</para>
		<example>
		<title>db_localtime example</title>
		<programlisting format="linespecific">
modparam("acc", "db_localtime", 1)  # use GMT time
</programlisting>
		</example>
	</section>
	<section>