1REALMINIT(1) User Contributed Perl Documentation REALMINIT(1)
2
6 realminit - Create new realm records for a DNSSEC-Tools realms file.
7
9 realminit [options] <realm1> ... <realmN>
10
12 realminit creates new realm entries for a realms file. dtrealms
13 manages multiple distinct DNSSEC-Tools rollover environments running
14 simultaneously. Each rollover environment, called a realm, is defined
15 in a realms file. dtrealms uses this file to determine how to run the
16 rollover environment. This is useful for such things as managing very
17 large collections of zones, segregating customer zones, and software
18 tests.
19 The newly generated realm entries are written to standard output,
21 unless the -out option is specified.
22 A realms file contains a number of entries, one for each managed realm.
24 A realm entry has this format:
25 realm "example"
27 state "active"
28 configdir "/usr/realms/configs/example"
29 statedir "/usr/realms/states/example"
30 realmsdir "/usr/realms/realms-files/example"
31 rollrec "example.rrf"
32 administrator "bob@cat.example.com"
33 display "1"
34 manager "rollerd"
35 args "-display -loglevel phase"
36 Multiple realm entries may be created with a single execution of
38 realminit. Except for the entry's name field, the entries will be
39 exactly the same unless the '=' metacharacter is used in the command-
40 line options. If the values of the configdir, statedir, realmdir,
41 rollrec, administrator, args, or user options contain an '=', then it
42 will be replaced with the realm's name when building the entry. See
43 the EXAMPLES section for examples of how options are used by realminit.
44
46 realminit may be given the following options:
47 -active
49 This indicates that dtrealms should start the realm when dtrealms
50 starts. realms are active by default.
51 -administrator
53 This is the email address for the realm's administrator.
54 -args
56 This is a set of command-line arguments passed to the realm's
57 rollover manager when the realm is started.
58 -configdir
60 This is the realm's configuration directory. This will contain
61 such files as the DNSSEC-Tools configuration file for that realm.
62 -display
64 This indicates if the realm should be included in grandvizier
65 output.
66 -inactive
68 This indicates that dtrealms should not start the realm when
69 dtrealms starts.
70 -manager
72 This is the rollover manager for the realm. rollerd is the default
73 rollover manager, but other managers may be used.
74 -out output-file
76 The new realm entries will be appended to output-file. The file
77 will be created if it does not exist.
78 If this option is not given, the new rollrec entries will be
80 written to standard output.
81 -realmdir
83 This is the realm's data directory. This directory is expected to
84 contain the rollrec file, zone files, keyrec files, and key files
85 for the zones in that realm.
86 -rollrec
88 This is the path to the realm's rollrec file. This is used to
89 control rollover actions for the realm. If it is not an absolute
90 path, it will be assumed to be relative to the realmdir field.
91 -statedir
93 This is the realm's state directory. This will contain such files
94 as that realm's rollrec lock file and the rollerd communications
95 socket. If the statedir is not defined for a realm, then the
96 realm's configdir is used for that value.
97 -user
99 This is the user that the realm is executed as. (This is not yet
100 implemented in dtrealms.)
101 -help
103 Display a usage message.
104 -Version
106 Display version information for realminit and DNSSEC-Tools.
107
109 The following options should make clear how realminit deals with
110 options and the new realms. Example 1 will show the complete new realm
111 record. For the sake of brevity, the remaining examples will only show
112 the fields relevant to that example. Further examples will also use
113 short-hand forms of the option names.
114 Example 1. One realm, with -statedir
116 This example shows the realm generated by giving realminit a single
117 realm.
118 $ realminit -active -configdir /realms/confs/example -statedir /realms/states/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com -args "-loglevel phase -logfile logger" example
120 realm "example"
122 state "active"
123 configdir "/realms/confs/example"
124 statedir "/realms/states/example"
125 realmdir "/realms/realms/example"
126 rollrec "example.rrf"
127 administrator "bob@cat.example.com"
128 display "1"
129 manager "rollerd"
130 args "-loglevel phase -logfile logger"
131 Example 2. One realm, without -statedir
133 This example shows the realm generated by giving realminit a single
134 realm.
135 $ realminit -active -configdir /realms/confs/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com -args "-loglevel phase -logfile logger" example
137 realm "example"
139 state "active"
140 configdir "/realms/confs/example"
141 statedir "/realms/confs/example"
142 ...
143 Example 3. Two realms, without metacharacters
145 This example shows the realms generated by giving realminit two realms,
146 without using the special "=" metacharacter.
147 $ realminit -configdir /realms/confs/example -statedir /realms/states/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com example test
149 realm "example"
151 configdir "/realms/confs/example"
152 statedir "/realms/states/example"
153 realmdir "/realms/realms/example"
154 rollrec "example.rrf"
155 administrator "bob@cat.example.com"
156 ...
157 realm "test"
159 configdir "/realms/confs/example"
160 statedir "/realms/states/example"
161 realmdir "/realms/realms/example"
162 rollrec "example.rrf"
163 administrator "bob@cat.example.com"
164 ...
165 Example 4. Two realms, with metacharacters
167 This example shows the realms generated by giving realminit two realms,
168 and that uses the special "=" metacharacter.
169 $ realminit -configdir /realms/confs/= -statedir /realms/states/= -realmdir /realms/realms/= -rollrec =.rrf -admin bob@cat.=.com example test
171 realm "example"
173 configdir "/realms/confs/example"
174 statedir "/realms/states/example"
175 realmdir "/realms/realms/example"
176 rollrec "example.rrf"
177 administrator "bob@cat.example.com"
178 ...
179 realm "test"
181 configdir "/realms/confs/test"
182 statedir "/realms/states/test"
183 realmdir "/realms/realms/test"
184 rollrec "test.rrf"
185 administrator "bob@cat.test.com"
186 ...
187
189 Copyright 2012-2014 SPARTA, Inc. All rights reserved. See the COPYING
190 file included with the DNSSEC-Tools package for details.
191
193 Wayne Morrison, tewok@tislabs.com
194
196 lsrealm(1), dtrealms(8), realmchk(8)
197 Net::DNS::SEC::Tools::realm.pm(3),
199 file-realmrec.pm(5)
201perl v5.32.0 2020-07-27 REALMINIT(1)