realmctl(1)

1REALMCTL(1)           User Contributed Perl Documentation          REALMCTL(1)
2
3
4

NAME

6       realmctl - Send commands to the DNSSEC-Tools realms daemon
7

SYNOPSIS

9         realmctl [options]
10

DESCRIPTION

12       The realmctl command sends commands to dtrealms, the DNSSEC-Tools
13       realms daemon.  In most cases, dtrealms will send a response to
14       realmctl.  realmctl will print a success or failure message, as
15       appropriate.  Only one option may be specified on a command line.
16

OPTIONS

18       The following options are handled by realmctl.
19
20       -allstart
21           Starts all suspended realms.
22
23       -allstop
24           Stops all running realms.
25
26       -cmd -- realm cmd args
27       -command -- realm cmd args
28           Sends a command to the specified realm.  The command given as cmd
29           will be sent to the rollerd running in realm realm.
30
31           The double-dash given above is critical for proper argument parsing
32           of the command line.
33
34           All command-line arguments, as args above, following the realm name
35           and command name will be sent as the command.
36
37           Whatever output the command gives will be returned to realmctl,
38           which will then print that output.  The command's return code will
39           be appended to the command's output.  No attempt will be made to
40           analyze the output for success or failure.
41
42           For example, this command will tell the realm giant-isp to stop
43           rollover of zone bob.example.com:
44
45              $ realmctl -command -- giant-isp rollctl -skipzone bob.example.com
46
47           Warning:  This is an inherently dangerous command.  When choosing a
48           user under which the realm and rollover commands will be executed,
49           be aware that this problem exists.  realmctl may be modified in the
50           future to restrict the commands that may be executed with this
51           option.
52
53       -display
54           Starts the realms status GUI.
55
56       -halt [now]
57           Cleanly halts dtrealms execution.
58
59       -logfile logfile
60           Sets the dtrealms log file to logfile.  This must be a valid
61           logging file, meaning that if logfile already exists, it must be a
62           regular file.  The only exceptions to this are if logfile is
63           /dev/stdout or /dev/tty.
64
65       -loglevel loglevel
66           Sets the dtrealms logging level to loglevel.  This must be one of
67           the valid logging levels defined in realmmgr.pm(3).
68
69           If a logging level is not specified, then the list of valid levels
70           will be printed and realmctl will exit.  The list is given in both
71           text and numeric forms.
72
73       -logtz logtz
74           Sets the dtrealms logging timezone to loglevel.  This must be
75           either gmt (for Greenwich Mean Time or local (for the host's local
76           time.)
77
78       -nodisplay
79           Stops the realms status GUI.
80
81       -realmstatus
82           Gets the current status of all the realms from dtrealms.  For each
83           realm, the name, execution status, and zone counts are printed.
84           The zone counts are, in order, the number of zones in normal state,
85           the number of zones in ZSK rollover, the number of zones in KSK
86           rollover, and the number of zones waiting in KSK phase 6.  The zone
87           counts are determined by sending the realm's rollover manager an
88           information request.  Therefore, if the zone is inactive, the zone
89           counts are not included.
90
91           Example:
92
93               dev     active     normal: 18   ZSK: 3   KSK: 1   KSK phase 6: 0
94               test-r  inactive
95               money   active     normal: 10   ZSK: 0   KSK: 0   KSK phase 6: 1
96
97       -shutdown
98           Synonym for -halt.
99
100       -startrealm realm
101           Starts the suspended realm named by realm.  Multiple realms can be
102           specified on the command line.  For instance, this command will
103           send the startrealm command to dtrealms for three realms.
104
105               $ realmctl -startrealm testing production customers
106
107       -status
108           Has dtrealms write several of its operational parameters to its log
109           file.  The parameters are also reported to realmctl, which prints
110           them to the screen.
111
112       -stoprealm realm
113           Stops the realm named by realm.  Multiple realms can be specified
114           on the command line.  For instance, this command will send the
115           stoprealm command to dtrealms for two realms.
116
117               $ realmctl -stoprealm big-isp-3 misc-customers
118
119       -Version
120           Displays the version information for realmctl and the DNSSEC-Tools
121           package.
122
123       -quiet
124           Prevents output from being given.  Both error and non-error output
125           is stopped.
126
127       -help
128           Displays a usage message.
129

EXIT CODES

131       realmctl may give the following exit codes:
132
133       0 - Successful execution
134       1 - Error sending the command to dtrealms.
135       2 - Missing realm argument.
136       3 - Too many command options specified.
137       4 - Missing argument for -cmd or -command.
138       5 - No option specified.
139       200 - dtrealms is not running.
140       201 - Configuration file checks failed.
141

COPYRIGHT

143       Copyright 2012-2014 SPARTA, Inc.  All rights reserved.  See the COPYING
144       file included with the DNSSEC-Tools package for details.
145

AUTHOR

147       Wayne Morrison, tewok@tislabs.com
148