/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: Teddy Hogeborn
  • Date: 2012-05-05 10:52:11 UTC
  • Revision ID: teddy@recompile.se-20120505105211-58z3hyjfzep3z2q9
* mandos: White space and other misc. format fixes only.

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 "2013-10-15">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
117
117
          <para>
118
118
            How long to wait for external approval before resorting to
119
119
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
120
            default is <quote>0s</quote>, i.e. not to wait.
121
121
          </para>
122
122
          <para>
123
123
            The format of <replaceable>TIME</replaceable> is the same
167
167
            This option is <emphasis>optional</emphasis>.
168
168
          </para>
169
169
          <para>
170
 
            This option overrides the default shell command that the
171
 
            server will use to check if the client is still up.  Any
172
 
            output of the command will be ignored, only the exit code
173
 
            is checked:  If the exit code of the command is zero, the
174
 
            client is considered up.  The command will be run using
175
 
            <quote><command><filename>/bin/sh</filename>
 
170
            This option allows you to override the default shell
 
171
            command that the server will use to check if the client is
 
172
            still up.  Any output of the command will be ignored, only
 
173
            the exit code is checked:  If the exit code of the command
 
174
            is zero, the client is considered up.  The command will be
 
175
            run using <quote><command><filename>/bin/sh</filename>
176
176
            <option>-c</option></command></quote>, so
177
177
            <varname>PATH</varname> will be searched.  The default
178
178
            value for the checker command is <quote><literal
335
335
            <option>extended_timeout</option> option.
336
336
          </para>
337
337
          <para>
338
 
            The <replaceable>TIME</replaceable> is specified as an RFC
339
 
            3339 duration; for example
340
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
 
            one year, two months, three days, four hours, five
342
 
            minutes, and six seconds.  Some values can be omitted, see
343
 
            RFC 3339 Appendix A for details.
 
338
            The <replaceable>TIME</replaceable> is specified as a
 
339
            space-separated number of values, each of which is a
 
340
            number and a one-character suffix.  The suffix must be one
 
341
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
342
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
343
            minutes, hours, and weeks, respectively.  The values are
 
344
            added together to give the total time value, so all of
 
345
            <quote><literal>330s</literal></quote>,
 
346
            <quote><literal>110s 110s 110s</literal></quote>, and
 
347
            <quote><literal>5m 30s</literal></quote> will give a value
 
348
            of five minutes and thirty seconds.
344
349
          </para>
345
350
        </listitem>
346
351
      </varlistentry>
404
409
        <quote><literal>approval_duration</literal></quote>,
405
410
        <quote><literal>created</literal></quote>,
406
411
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>expires</literal></quote>,
408
412
        <quote><literal>fingerprint</literal></quote>,
409
413
        <quote><literal>host</literal></quote>,
410
414
        <quote><literal>interval</literal></quote>,
460
464
    <informalexample>
461
465
      <programlisting>
462
466
[DEFAULT]
463
 
timeout = PT5M
464
 
interval = PT2M
 
467
timeout = 5m
 
468
interval = 2m
465
469
checker = fping -q -- %%(host)s
466
470
 
467
471
# Client "foo"
484
488
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
489
        QlnHIvPzEArRQLo=
486
490
host = foo.example.org
487
 
interval = PT1M
 
491
interval = 1m
488
492
 
489
493
# Client "bar"
490
494
[bar]
491
495
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
496
secfile = /etc/mandos/bar-secret
493
 
timeout = PT15M
 
497
timeout = 15m
494
498
approved_by_default = False
495
 
approval_delay = PT30S
 
499
approval_delay = 30s
496
500
      </programlisting>
497
501
    </informalexample>
498
502
  </refsect1>
507
511
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
512
      <manvolnum>5</manvolnum></citerefentry>,
509
513
      <citerefentry><refentrytitle>mandos</refentrytitle>
510
 
      <manvolnum>8</manvolnum></citerefentry>,
511
 
      <citerefentry><refentrytitle>fping</refentrytitle>
512
514
      <manvolnum>8</manvolnum></citerefentry>
513
515
    </para>
514
 
    <variablelist>
515
 
      <varlistentry>
516
 
        <term>
517
 
          RFC 3339: <citetitle>Date and Time on the Internet:
518
 
          Timestamps</citetitle>
519
 
        </term>
520
 
      <listitem>
521
 
        <para>
522
 
          The time intervals are in the "duration" format, as
523
 
          specified in ABNF in Appendix A of RFC 3339.
524
 
        </para>
525
 
      </listitem>
526
 
      </varlistentry>
527
 
    </variablelist>
528
516
  </refsect1>
529
517
</refentry>
530
518
<!-- Local Variables: -->