/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.xml: New.
* Makefile (DOCS): Added "mandos-ctl.8".
  (mandos-ctl.8): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl.xml
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 "2019-02-10">
 
5
<!ENTITY TIMESTAMP "2010-09-21">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2010</year>
35
 
      <year>2011</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
 
      <year>2016</year>
41
 
      <year>2017</year>
42
 
      <year>2018</year>
43
 
      <year>2019</year>
44
35
      <holder>Teddy Hogeborn</holder>
45
36
      <holder>Björn Påhlsson</holder>
46
37
    </copyright>
55
46
  <refnamediv>
56
47
    <refname><command>&COMMANDNAME;</command></refname>
57
48
    <refpurpose>
58
 
      Control or query the operation of the Mandos server
 
49
      Control the operation of the Mandos server
59
50
    </refpurpose>
60
51
  </refnamediv>
61
52
  
62
53
  <refsynopsisdiv>
63
54
    <cmdsynopsis>
64
55
      <command>&COMMANDNAME;</command>
65
 
      <group choice="req">
66
 
        <group>
67
 
          <arg choice="plain"><option>--enable</option></arg>
68
 
          <arg choice="plain"><option>-e</option></arg>
69
 
          <sbr/>
70
 
          <arg choice="plain"><option>--disable</option></arg>
71
 
          <arg choice="plain"><option>-d</option></arg>
72
 
        </group>
73
 
        <sbr/>
74
 
        <group>
75
 
          <arg choice="plain"><option>--bump-timeout</option></arg>
76
 
          <arg choice="plain"><option>-b</option></arg>
77
 
        </group>
78
 
        <sbr/>
79
 
        <group>
80
 
          <arg choice="plain"><option>--start-checker</option></arg>
81
 
        </group>
82
 
        <sbr/>
83
 
        <group>
84
 
          <arg choice="plain"><option>--stop-checker</option></arg>
85
 
        </group>
86
 
        <sbr/>
87
 
        <group>
88
 
          <arg choice="plain"><option>--remove</option></arg>
89
 
          <arg choice="plain"><option>-r</option></arg>
90
 
        </group>
91
 
        <sbr/>
92
 
        <group>
93
 
          <arg choice="plain"><option>--checker
94
 
          <replaceable>COMMAND</replaceable></option></arg>
95
 
          <arg choice="plain"><option>-c
96
 
          <replaceable>COMMAND</replaceable></option></arg>
97
 
        </group>
98
 
        <sbr/>
99
 
        <group>
100
 
          <arg choice="plain"><option>--timeout
101
 
          <replaceable>TIME</replaceable></option></arg>
102
 
          <arg choice="plain"><option>-t
103
 
          <replaceable>TIME</replaceable></option></arg>
104
 
        </group>
105
 
        <sbr/>
106
 
        <group>
107
 
          <arg choice="plain"><option>--extended-timeout
108
 
          <replaceable>TIME</replaceable></option></arg>
109
 
        </group>
110
 
        <sbr/>
111
 
        <group>
112
 
          <arg choice="plain"><option>--interval
113
 
          <replaceable>TIME</replaceable></option></arg>
114
 
          <arg choice="plain"><option>-i
115
 
          <replaceable>TIME</replaceable></option></arg>
116
 
        </group>
117
 
        <sbr/>
118
 
        <group>
119
 
          <arg choice="plain"><option>--approve-by-default</option
120
 
          ></arg>
121
 
          <sbr/>
122
 
          <arg choice="plain"><option>--deny-by-default</option></arg>
123
 
        </group>
124
 
        <sbr/>
125
 
        <group>
126
 
          <arg choice="plain"><option>--approval-delay
127
 
          <replaceable>TIME</replaceable></option></arg>
128
 
        </group>
129
 
        <sbr/>
130
 
        <group>
131
 
          <arg choice="plain"><option>--approval-duration
132
 
          <replaceable>TIME</replaceable></option></arg>
133
 
        </group>
134
 
        <sbr/>
135
 
        <group>
136
 
          <arg choice="plain"><option>--interval
137
 
          <replaceable>TIME</replaceable></option></arg>
138
 
          <arg choice="plain"><option>-i
139
 
          <replaceable>TIME</replaceable></option></arg>
140
 
        </group>
141
 
        <sbr/>
142
 
        <group>
143
 
          <arg choice="plain"><option>--host
144
 
          <replaceable>STRING</replaceable></option></arg>
145
 
          <arg choice="plain"><option>-H
146
 
          <replaceable>STRING</replaceable></option></arg>
147
 
        </group>
148
 
        <sbr/>
149
 
        <group>
150
 
          <arg choice="plain"><option>--secret
151
 
          <replaceable>FILENAME</replaceable></option></arg>
152
 
          <arg choice="plain"><option>-s
153
 
          <replaceable>FILENAME</replaceable></option></arg>
154
 
        </group>
155
 
        <sbr/>
156
 
        <group>
157
 
          <arg choice="plain"><option>--approve</option></arg>
158
 
          <arg choice="plain"><option>-A</option></arg>
159
 
          <sbr/>
160
 
          <arg choice="plain"><option>--deny</option></arg>
161
 
          <arg choice="plain"><option>-D</option></arg>
162
 
        </group>
 
56
      <group>
 
57
        <arg choice="plain"><option>--enable</option></arg>
 
58
        <arg choice="plain"><option>-e</option></arg>
 
59
        <sbr/>
 
60
        <arg choice="plain"><option>--disable</option></arg>
 
61
        <arg choice="plain"><option>-d</option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--bump-timeout</option></arg>
 
66
        <arg choice="plain"><option>-b</option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--start-checker</option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--stop-checker</option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <group>
 
78
        <arg choice="plain"><option>--remove</option></arg>
 
79
        <arg choice="plain"><option>-r</option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group>
 
83
        <arg choice="plain"><option>--checker
 
84
        <replaceable>COMMAND</replaceable></option></arg>
 
85
        <arg choice="plain"><option>-c
 
86
        <replaceable>COMMAND</replaceable></option></arg>
 
87
      </group>
 
88
      <sbr/>
 
89
      <group>
 
90
        <arg choice="plain"><option>--timeout
 
91
        <replaceable>TIME</replaceable></option></arg>
 
92
        <arg choice="plain"><option>-t
 
93
        <replaceable>TIME</replaceable></option></arg>
 
94
      </group>
 
95
      <sbr/>
 
96
      <group>
 
97
        <arg choice="plain"><option>--interval
 
98
        <replaceable>TIME</replaceable></option></arg>
 
99
        <arg choice="plain"><option>-i
 
100
        <replaceable>TIME</replaceable></option></arg>
 
101
      </group>
 
102
      <sbr/>
 
103
      <group>
 
104
        <arg choice="plain"><option>--host
 
105
        <replaceable>STRING</replaceable></option></arg>
 
106
        <arg choice="plain"><option>-H
 
107
        <replaceable>STRING</replaceable></option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--secret
 
112
        <replaceable>FILENAME</replaceable></option></arg>
 
113
        <arg choice="plain"><option>-s
 
114
        <replaceable>FILENAME</replaceable></option></arg>
 
115
      </group>
 
116
      <sbr/>
 
117
      <group>
 
118
        <arg choice="plain"><option>--approve</option></arg>
 
119
        <arg choice="plain"><option>-A</option></arg>
 
120
        <sbr/>
 
121
        <arg choice="plain"><option>--deny</option></arg>
 
122
        <arg choice="plain"><option>-D</option></arg>
163
123
      </group>
164
124
      <sbr/>
165
125
      <group choice="req">
173
133
    <cmdsynopsis>
174
134
      <command>&COMMANDNAME;</command>
175
135
      <group>
176
 
          <arg choice="plain"><option>--verbose</option></arg>
177
 
          <arg choice="plain"><option>-v</option></arg>
178
 
          <sbr/>
179
 
          <arg choice="plain"><option>--dump-json</option></arg>
180
 
          <arg choice="plain"><option>-j</option></arg>
 
136
        <arg choice="plain"><option>--verbose</option></arg>
 
137
        <arg choice="plain"><option>-v</option></arg>
181
138
      </group>
182
139
      <group>
183
140
        <arg rep='repeat' choice='plain'>
207
164
        <arg choice="plain"><option>-v</option></arg>
208
165
      </group>
209
166
    </cmdsynopsis>
210
 
    <cmdsynopsis>
211
 
      <command>&COMMANDNAME;</command>
212
 
      <arg choice="plain"><option>--check</option></arg>
213
 
    </cmdsynopsis>
214
167
  </refsynopsisdiv>
215
168
  
216
169
  <refsect1 id="description">
217
170
    <title>DESCRIPTION</title>
218
171
    <para>
219
 
      <command>&COMMANDNAME;</command> is a program to control or
220
 
      query the operation of the Mandos server
221
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
222
 
      >8</manvolnum></citerefentry>.
 
172
      <command>&COMMANDNAME;</command> is a program to control the
 
173
      operation of the Mandos server <citerefentry><refentrytitle
 
174
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
223
175
    </para>
224
176
    <para>
225
177
      This program can be used to change client settings, approve or
321
273
          <para>
322
274
            Set the <varname>checker</varname> option of the specified
323
275
            client(s); see <citerefentry><refentrytitle
324
 
            >mandos-clients.conf</refentrytitle><manvolnum
325
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
326
278
          </para>
327
279
        </listitem>
328
280
      </varlistentry>
336
288
          <para>
337
289
            Set the <varname>timeout</varname> option of the specified
338
290
            client(s); see <citerefentry><refentrytitle
339
 
            >mandos-clients.conf</refentrytitle><manvolnum
340
 
            >5</manvolnum></citerefentry>.
341
 
          </para>
342
 
        </listitem>
343
 
      </varlistentry>
344
 
 
345
 
      <varlistentry>
346
 
        <term><option>--extended-timeout
347
 
        <replaceable>TIME</replaceable></option></term>
348
 
        <listitem>
349
 
          <para>
350
 
            Set the <varname>extended_timeout</varname> option of the
351
 
            specified client(s); see <citerefentry><refentrytitle
352
 
            >mandos-clients.conf</refentrytitle><manvolnum
353
 
            >5</manvolnum></citerefentry>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
354
293
          </para>
355
294
        </listitem>
356
295
      </varlistentry>
362
301
        <replaceable>TIME</replaceable></option></term>
363
302
        <listitem>
364
303
          <para>
365
 
            Set the <varname>interval</varname> option of the
366
 
            specified client(s); see <citerefentry><refentrytitle
367
 
            >mandos-clients.conf</refentrytitle><manvolnum
368
 
            >5</manvolnum></citerefentry>.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
 
      
373
 
      <varlistentry>
374
 
        <term><option>--approve-by-default</option></term>
375
 
        <term><option>--deny-by-default</option></term>
376
 
        <listitem>
377
 
          <para>
378
 
            Set the <varname>approved_by_default</varname> option of
379
 
            the specified client(s) to <literal>True</literal> or
380
 
            <literal>False</literal>, respectively; see
381
 
            <citerefentry><refentrytitle
382
 
            >mandos-clients.conf</refentrytitle><manvolnum
383
 
            >5</manvolnum></citerefentry>.
384
 
          </para>
385
 
        </listitem>
386
 
      </varlistentry>
387
 
      
388
 
      <varlistentry>
389
 
        <term><option>--approval-delay
390
 
        <replaceable>TIME</replaceable></option></term>
391
 
        <listitem>
392
 
          <para>
393
 
            Set the <varname>approval_delay</varname> option of the
394
 
            specified client(s); see <citerefentry><refentrytitle
395
 
            >mandos-clients.conf</refentrytitle><manvolnum
396
 
            >5</manvolnum></citerefentry>.
397
 
          </para>
398
 
        </listitem>
399
 
      </varlistentry>
400
 
      
401
 
      <varlistentry>
402
 
        <term><option>--approval-duration
403
 
        <replaceable>TIME</replaceable></option></term>
404
 
        <listitem>
405
 
          <para>
406
 
            Set the <varname>approval_duration</varname> option of the
407
 
            specified client(s); see <citerefentry><refentrytitle
408
 
            >mandos-clients.conf</refentrytitle><manvolnum
409
 
            >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>.
410
308
          </para>
411
309
        </listitem>
412
310
      </varlistentry>
420
318
          <para>
421
319
            Set the <varname>host</varname> option of the specified
422
320
            client(s); see <citerefentry><refentrytitle
423
 
            >mandos-clients.conf</refentrytitle><manvolnum
424
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
425
323
          </para>
426
324
        </listitem>
427
325
      </varlistentry>
435
333
          <para>
436
334
            Set the <varname>secfile</varname> option of the specified
437
335
            client(s); see <citerefentry><refentrytitle
438
 
            >mandos-clients.conf</refentrytitle><manvolnum
439
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
440
338
          </para>
441
339
        </listitem>
442
340
      </varlistentry>
483
381
      </varlistentry>
484
382
      
485
383
      <varlistentry>
486
 
        <term><option>--dump-json</option></term>
487
 
        <term><option>-j</option></term>
488
 
        <listitem>
489
 
          <para>
490
 
            Dump client settings as JSON to standard output.
491
 
          </para>
492
 
        </listitem>
493
 
      </varlistentry>
494
 
      
495
 
      <varlistentry>
496
384
        <term><option>--is-enabled</option></term>
497
385
        <term><option>-V</option></term>
498
386
        <listitem>
503
391
        </listitem>
504
392
      </varlistentry>
505
393
      
506
 
      <varlistentry>
507
 
        <term><option>--check</option></term>
508
 
        <listitem>
509
 
          <para>
510
 
            Run self-tests.  This includes any unit tests, etc.
511
 
          </para>
512
 
        </listitem>
513
 
      </varlistentry>
514
 
      
515
394
    </variablelist>
516
395
  </refsect1>
517
396
  
533
412
    </para>
534
413
  </refsect1>
535
414
  
536
 
  <refsect1 id="bugs">
537
 
    <title>BUGS</title>
538
 
    <xi:include href="bugs.xml"/>
539
 
  </refsect1>
 
415
<!--   <refsect1 id="bugs"> -->
 
416
<!--     <title>BUGS</title> -->
 
417
<!--     <para> -->
 
418
<!--     </para> -->
 
419
<!--   </refsect1> -->
540
420
  
541
421
  <refsect1 id="example">
542
422
    <title>EXAMPLE</title>
543
423
    <informalexample>
544
424
      <para>
545
 
        To list all clients:
 
425
        List all clients with some of their settings:
546
426
      </para>
547
427
      <para>
548
428
        <userinput>&COMMANDNAME;</userinput>
549
429
      </para>
550
430
    </informalexample>
551
 
    
552
 
    <informalexample>
553
 
      <para>
554
 
        To list <emphasis>all</emphasis> settings for the clients
555
 
        named <quote>foo1.example.org</quote> and <quote
556
 
        >foo2.example.org</quote>:
557
 
      </para>
558
 
      <para>
559
 
 
560
 
<!-- do not wrap this line -->
561
 
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
562
 
 
563
 
      </para>
564
 
    </informalexample>
565
 
    
566
 
    <informalexample>
567
 
      <para>
568
 
        To enable all clients:
569
 
      </para>
570
 
      <para>
571
 
        <userinput>&COMMANDNAME; --enable --all</userinput>
572
 
      </para>
573
 
    </informalexample>
574
 
    
575
 
    <informalexample>
576
 
      <para>
577
 
        To change timeout and interval value for the clients
578
 
        named <quote>foo1.example.org</quote> and <quote
579
 
        >foo2.example.org</quote>:
580
 
      </para>
581
 
      <para>
582
 
 
583
 
<!-- do not wrap this line -->
584
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
585
 
 
586
 
      </para>
587
 
    </informalexample>
588
 
    
589
 
    <informalexample>
590
 
      <para>
591
 
        To approve all clients currently waiting for it:
592
 
      </para>
593
 
      <para>
594
 
        <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
 
595
441
      </para>
596
442
    </informalexample>
597
443
  </refsect1>
608
454
  <refsect1 id="see_also">
609
455
    <title>SEE ALSO</title>
610
456
    <para>
611
 
      <citerefentry><refentrytitle>intro</refentrytitle>
612
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
613
457
      <citerefentry><refentrytitle>mandos</refentrytitle>
614
458
      <manvolnum>8</manvolnum></citerefentry>,
615
459
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>