<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;

]>

<section id="tls.rpc">
	<sectioninfo>
	</sectioninfo>
	<title>RPC Commands</title>
	<section id="tls.r.tls.info">
		<title><function>tls.info</function></title>
		<para>
			List internal information related to the TLS module in
			a short list - max connections, open connections and the
			write queue size.
		</para>
		<para>Parameters: </para>
                <itemizedlist>
                        <listitem><para>
                                None.
                        </para></listitem>
                </itemizedlist>
	</section>
	<section id="tls.r.tls.list">
		<title><function>tls.list</function></title>
		<para>
			List details about all active TLS connections.
		</para>
		<para>Parameters: </para>
                <itemizedlist>
                        <listitem><para>
                                None.
                        </para></listitem>
                </itemizedlist>
	</section>
	<section id="tls.r.tls.options">
		<title><function>tls.options</function></title>
		<para>
			List the current TLS configuration.
		</para>
		<para>Parameters: </para>
                <itemizedlist>
                        <listitem><para>
                                None.
                        </para></listitem>
                </itemizedlist>
	</section>
	<section id="tls.r.tls.kill">
		<title><function>tls.kill</function></title>
		<para>
			Kill a TLS session by id.
		</para>
		<para>Parameters: </para>
                <itemizedlist>
                        <listitem><para>
                                None.
                        </para></listitem>
                </itemizedlist>
	</section>
	<section id="tls.r.tls.reload">
		<title><function>tls.reload</function></title>
		<para>
			Reload the external TLS configuration file (aka tls.cfg). It does not reload
			modparam() parameters. Note that existing active TLS connections are not
			terminated and they continue to use the old certificates. The new configuration
			will be used for new connections.
		</para>
		<para>
		Reload is generally safe and usable in production environments. If possible should
		be done in a time where the service has lower usage/connections.
		</para>
		<para>
			This RPC command is exported with "RPC_EXEC_DELTA" flag, therefore its
			execution rate can be restricted to specific time intervals by setting
			the "rpc_exec_delta" core parameter.
		</para>
		<para>Parameters: </para>
                <itemizedlist>
                        <listitem><para>
                                None.
                        </para></listitem>
                </itemizedlist>
	</section>

</section>
