/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Björn Påhlsson
  • Date: 2011-09-18 16:00:55 UTC
  • mto: This revision was merged to the branch mainline in revision 498.
  • Revision ID: belorn@fukt.bsnet.se-20110918160055-04y4aoz1j87iyjo2
updated DBUS-API documentation for extended timeout

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2010-09-26">
 
6
<!ENTITY TIMESTAMP "2011-08-08">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
 
38
      <year>2011</year>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
228
229
            will wait for a checker to complete until the below
229
230
            <quote><varname>timeout</varname></quote> occurs, at which
230
231
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
232
            killed.  The default interval is 2 minutes.
232
233
          </para>
233
234
          <para>
234
235
            The format of <replaceable>TIME</replaceable> is the same
301
302
            The timeout is how long the server will wait (for either a
302
303
            successful checker run or a client receiving its secret)
303
304
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
 
305
            this server holds.  By default Mandos will use 5 minutes.
305
306
          </para>
306
307
          <para>
307
308
            The <replaceable>TIME</replaceable> is specified as a
318
319
          </para>
319
320
        </listitem>
320
321
      </varlistentry>
 
322
 
 
323
      <varlistentry>
 
324
        <term><option>extended_timeout<literal> = </literal><replaceable
 
325
        >TIME</replaceable></option></term>
 
326
        <listitem>
 
327
          <para>
 
328
            This option is <emphasis>optional</emphasis>.
 
329
          </para>
 
330
          <para>
 
331
            Extended timeout is an added timeout that is given once
 
332
            after a password has been sent sucessfully to a client.
 
333
            The timeout is by default longer than the normal timeout,
 
334
            and is used for handling the extra long downtime while a
 
335
            matchine is booting up.  Time to take into consideration
 
336
            when changing this value is system file checks and quota
 
337
            checks.  The default value is 15 minutes.
 
338
          </para>
 
339
          <para>
 
340
            The format of <replaceable>TIME</replaceable> is the same
 
341
            as for <varname>timeout</varname> above.
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
321
345
      
322
346
    </variablelist>
323
347
  </refsect1>
419
443
    <informalexample>
420
444
      <programlisting>
421
445
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
446
timeout = 5m
 
447
interval = 2m
424
448
checker = fping -q -- %%(host)s
425
449
 
426
450
# Client "foo"
459
483
  <refsect1 id="see_also">
460
484
    <title>SEE ALSO</title>
461
485
    <para>
 
486
      <citerefentry><refentrytitle>intro</refentrytitle>
 
487
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
488
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
489
      <manvolnum>8</manvolnum></citerefentry>,
464
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>