/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl.xml

* mandos-ctl: Bug fix: only show properties of specifies clients.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-ctl">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2010-09-21">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
101
101
      </group>
102
102
      <sbr/>
103
103
      <group>
104
 
        <arg choice="plain"><option>--approve-by-default</option
105
 
        ></arg>
106
 
        <sbr/>
107
 
        <arg choice="plain"><option>--deny-by-default</option></arg>
108
 
      </group>
109
 
      <sbr/>
110
 
      <group>
111
 
        <arg choice="plain"><option>--approval-delay
112
 
        <replaceable>TIME</replaceable></option></arg>
113
 
      </group>
114
 
      <sbr/>
115
 
      <group>
116
 
        <arg choice="plain"><option>--approval-duration
117
 
        <replaceable>TIME</replaceable></option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <group>
121
 
        <arg choice="plain"><option>--interval
122
 
        <replaceable>TIME</replaceable></option></arg>
123
 
        <arg choice="plain"><option>-i
124
 
        <replaceable>TIME</replaceable></option></arg>
125
 
      </group>
126
 
      <sbr/>
127
 
      <group>
128
104
        <arg choice="plain"><option>--host
129
105
        <replaceable>STRING</replaceable></option></arg>
130
106
        <arg choice="plain"><option>-H
297
273
          <para>
298
274
            Set the <varname>checker</varname> option of the specified
299
275
            client(s); see <citerefentry><refentrytitle
300
 
            >mandos-clients.conf</refentrytitle><manvolnum
301
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
302
278
          </para>
303
279
        </listitem>
304
280
      </varlistentry>
312
288
          <para>
313
289
            Set the <varname>timeout</varname> option of the specified
314
290
            client(s); see <citerefentry><refentrytitle
315
 
            >mandos-clients.conf</refentrytitle><manvolnum
316
 
            >5</manvolnum></citerefentry>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
317
293
          </para>
318
294
        </listitem>
319
295
      </varlistentry>
325
301
        <replaceable>TIME</replaceable></option></term>
326
302
        <listitem>
327
303
          <para>
328
 
            Set the <varname>interval</varname> option of the
329
 
            specified client(s); see <citerefentry><refentrytitle
330
 
            >mandos-clients.conf</refentrytitle><manvolnum
331
 
            >5</manvolnum></citerefentry>.
332
 
          </para>
333
 
        </listitem>
334
 
      </varlistentry>
335
 
      
336
 
      <varlistentry>
337
 
        <term><option>--approve-by-default</option></term>
338
 
        <term><option>--deny-by-default</option></term>
339
 
        <listitem>
340
 
          <para>
341
 
            Set the <varname>approved_by_default</varname> option of
342
 
            the specified client(s) to <literal>True</literal> or
343
 
            <literal>False</literal>, respectively; see
344
 
            <citerefentry><refentrytitle
345
 
            >mandos-clients.conf</refentrytitle><manvolnum
346
 
            >5</manvolnum></citerefentry>.
347
 
          </para>
348
 
        </listitem>
349
 
      </varlistentry>
350
 
      
351
 
      <varlistentry>
352
 
        <term><option>--approval-delay
353
 
        <replaceable>TIME</replaceable></option></term>
354
 
        <listitem>
355
 
          <para>
356
 
            Set the <varname>approval_delay</varname> option of the
357
 
            specified client(s); see <citerefentry><refentrytitle
358
 
            >mandos-clients.conf</refentrytitle><manvolnum
359
 
            >5</manvolnum></citerefentry>.
360
 
          </para>
361
 
        </listitem>
362
 
      </varlistentry>
363
 
      
364
 
      <varlistentry>
365
 
        <term><option>--approval-duration
366
 
        <replaceable>TIME</replaceable></option></term>
367
 
        <listitem>
368
 
          <para>
369
 
            Set the <varname>approval_duration</varname> option of the
370
 
            specified client(s); see <citerefentry><refentrytitle
371
 
            >mandos-clients.conf</refentrytitle><manvolnum
372
 
            >5</manvolnum></citerefentry>.
 
304
            Set the <varname>interval</varname> option of the specified
 
305
            client(s); see <citerefentry><refentrytitle
 
306
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
307
            ></citerefentry>.
373
308
          </para>
374
309
        </listitem>
375
310
      </varlistentry>
383
318
          <para>
384
319
            Set the <varname>host</varname> option of the specified
385
320
            client(s); see <citerefentry><refentrytitle
386
 
            >mandos-clients.conf</refentrytitle><manvolnum
387
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
388
323
          </para>
389
324
        </listitem>
390
325
      </varlistentry>
398
333
          <para>
399
334
            Set the <varname>secfile</varname> option of the specified
400
335
            client(s); see <citerefentry><refentrytitle
401
 
            >mandos-clients.conf</refentrytitle><manvolnum
402
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
403
338
          </para>
404
339
        </listitem>
405
340
      </varlistentry>
487
422
    <title>EXAMPLE</title>
488
423
    <informalexample>
489
424
      <para>
490
 
        To list all clients:
 
425
        List all clients with some of their settings:
491
426
      </para>
492
427
      <para>
493
428
        <userinput>&COMMANDNAME;</userinput>
494
429
      </para>
495
430
    </informalexample>
496
 
    
497
 
    <informalexample>
498
 
      <para>
499
 
        To list <emphasis>all</emphasis> settings for the clients
500
 
        named <quote>foo1.example.org</quote> and <quote
501
 
        >foo2.example.org</quote>:
502
 
      </para>
503
 
      <para>
504
 
 
505
 
<!-- do not wrap this line -->
506
 
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
507
 
 
508
 
      </para>
509
 
    </informalexample>
510
 
    
511
 
    <informalexample>
512
 
      <para>
513
 
        To enable all clients:
514
 
      </para>
515
 
      <para>
516
 
        <userinput>&COMMANDNAME; --enable --all</userinput>
517
 
      </para>
518
 
    </informalexample>
519
 
    
520
 
    <informalexample>
521
 
      <para>
522
 
        To change timeout and interval value for the clients
523
 
        named <quote>foo1.example.org</quote> and <quote
524
 
        >foo2.example.org</quote>:
525
 
      </para>
526
 
      <para>
527
 
 
528
 
<!-- do not wrap this line -->
529
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
530
 
 
531
 
      </para>
532
 
    </informalexample>
533
 
    
534
 
    <informalexample>
535
 
      <para>
536
 
        To approve all clients currently waiting for it:
537
 
      </para>
538
 
      <para>
539
 
        <userinput>&COMMANDNAME; --approve --all</userinput>
 
431
    <informalexample>
 
432
      <para>
 
433
        Show all settings for the clients named <quote>foo</quote> and
 
434
        <quote>bar</quote>:
 
435
      </para>
 
436
      <para>
 
437
 
 
438
<!-- do not wrap this line -->
 
439
<userinput>&COMMANDNAME; --verbose foo bar</userinput>
 
440
 
540
441
      </para>
541
442
    </informalexample>
542
443
  </refsect1>