1LSROLL(1) User Contributed Perl Documentation LSROLL(1)
2
6 lsroll - List the rollrecs in a DNSSEC-Tools rollrec file
7
9 lsroll [options] <rollrec-files>
10
12 This script lists the contents of the specified rollrec files. All
13 rollrec files are loaded before the output is displayed. If any
14 rollrecs have duplicated names, whether within one file or across
15 multiple files, the later rollrec will be the one whose data are
16 displayed.
17
19 The output displayed for each zone in a rollrec file depends on the
20 selected records, the selected attributes, and the selected output
21 format. Each option in these option groups is described in detail in
22 the next section. The three base output formats, along with the
23 default -skip format, are described here.
24 The -terse option indicates that a minimal amount of output is desired;
26 the -long option indicates that a great deal of output is desired. The
27 record-selection and attribute-selection options may be used in
28 conjunction with -terse to display exactly the set of rollrec fields
29 needed.
30 The default output format is that used when neither -terse nor -long is
32 given, and is a middle ground between terse and long output.
33 If the -skip option is given, then the default output format is a
35 little more restricted than the normal default. Some rollrec fields
36 don't make sense in the context of a skip records, and so are given as
37 "---". These fields are the KSK rollover phase, the ZSK rollover
38 phase, the TTL value, and the phase start.
39 The table below shows the fields displayed for each output format.
41 rollrec field default terse long skip
43 ------------- ------- ----- ---- ----
44 rollrec name yes yes yes yes
45 rollrec type no no yes no
46 zonename no no yes yes
47 zone file yes no yes yes
48 zonegroup no no yes no
49 keyrec file yes no yes yes
50 KSK phase yes no yes no
51 ZSK phase yes no yes no
52 administrator no no yes no
53 directory no no yes no
54 logging level no no yes no
55 TTL value no no yes no
56 display flag no no yes no
57 phase start no no yes no
58 last KSK rollover no no yes no
59 last ZSK rollover no no yes no
60 zonesigner arguments no no yes no
61 The rollrec name field is often the same as its zonename, but this is
63 not necessarily the case. The rollrec name can contain spaces, while
64 the zonename can't. For this reason, lsroll displays the rollrec name
65 in quotes, even if the name contains no spaces. This is intended to
66 allow for easier parsing by other programs.
67 If the -info option is given, then the special info rollrec record will
69 be displayed. If the rollrec file has this informational record,
70 notated by having the name info rollrec, then the contents of the <info
71 rollrec> record will be printed. If multiple rollrec files are given
72 on the command line, then the info rollrec records for each file will
73 be prefixed with the rollrec file's name.
74
76 There are three types of options recognized by lsroll: record-
77 selection options, attribute-selection options, and output-format
78 options. Each type is described in the subsections below.
79 Record-selection Options
81 These options select the records that will be displayed by lsroll. By
82 default, all records will be displayed; selecting one or the other of
83 these options will restrict the records shown.
84 In order to simplify the lsroll code and keep it easily understandable,
86 these options are mutually exclusive.
87 -roll
89 List all "roll" records in the rollrec file.
90 -skip
92 List all "skip" records in the rollrec file.
93 -info
95 List all the fields in the rollrec file's "info" record.
96 Attribute-selection Options
98 These options select the attributes of the records that will be
99 displayed by lsroll.
100 -type
102 Include each rollrec record's type in the output. The type will be
103 either "roll" or "skip".
104 -zonename
106 The record's zonename is included in the output. The zonename is
107 distinct from the record's rollrec name, which is always included
108 in the output. While these two fields are often the same, they
109 need not be. In split-zone zones, the rollrec names must be
110 different, while the zonename field is the same.
111 -zonefile
113 The record's zonefile is included in the output. This field is
114 part of the default output.
115 -zg The record's zonegroup is included in the output, enclosed in
117 double quotes. If a rollrec entry does not contain a zonegroup,
118 then the value "" is given. If a record's zonegroup contains
119 leading or trailing whitespace, it will be deleted from the output.
120 -keyrec
122 The record's keyrec file is included in the output. This field is
123 part of the default output.
124 -kskphase
126 The record's KSK rollover phase are included in the output. If
127 this option is given with the -zskphase option, then the output
128 will follow the format described for the -phases option. This
129 field is part of the default output.
130 -zskphase
132 The record's ZSK rollover phase are included in the output. If
133 this option is given with the -kskphase option, then the output
134 will follow the format described for the -phases option. This
135 field is part of the default output.
136 -phases
138 The record's KSK and ZSK rollover phases are included in the
139 output. The listing is given with the KSK phase first, followed by
140 the ZSK phase.
141 Examples of output from this option are:
143 KSK phase ZSK phase output
145 0 0 0/0
146 3 0 3/0
147 0 5 0/5
148 -admin
150 The record's administrator value is included in the output. If an
151 administrator value is not included in a rollrec, then the value
152 "(defadmin)" will be given.
153 -directory
155 The name of the directory that holds the zone's files is included
156 in the output. If a zone directory is not included in a rollrec,
157 then the value "(defdir)" will be given.
158 -loglevel
160 The rollerd logging level for this zone. This value may be given
161 in the rollrec file in either the textual or numeric form. The
162 textual form of the logging level will be displayed, not the
163 numeric. If a logging level value is not included in a rollrec,
164 then the value "(deflog)" will be given. If an undefined logging
165 level value is included in a rollrec, then the value "(unknownlog)"
166 will be given.
167 -ttl
169 The record's TTL value is included in the output.
170 -display
172 The record's display flag, used by blinkenlights, is included in
173 the output.
174 -phstart
176 The record's rollover phase is included in the output. If no
177 rollover has yet been performed for this zone, an empty date is
178 given.
179 -lastksk
181 The record's last KSK rollover date is included in the output. If
182 no KSK rollover has yet been performed for this zone, an empty date
183 is given.
184 -lastzsk
186 The record's last ZSK rollover date is included in the output. If
187 no ZSK rollover has yet been performed for this zone, an empty date
188 is given.
189 -zsargs
191 The record's user-defined zonesigner arguments are included in the
192 output. If no arguments have been set for this zone, then the
193 value "(none)" is given.
194 -zonegroup
196 The zonegroups defined in the rollrec are listed, enclosed in
197 double quotes. All other rollrec fields are ignored. If the -long
198 option is specified, then each zonegroup name will be accompanied
199 by the number of rollrec entries in that zonegroup.
200 Output-format Options
202 These options select the type of output that will be given by lsroll.
203 -count
205 Only a count of matching keyrecs in the rollrec file is given.
206 -headers
208 Display explanatory column headers.
209 -terse
211 Terse output is given. Only the record name and any other fields
212 specifically selected are included in the output.
213 -long
215 Long output is given. All record fields are included.
216 -help
218 Display a usage message.
219 -Version
221 Displays the version information for lsroll and the DNSSEC-Tools
222 package.
223
225 Copyright 2005-2014 SPARTA, Inc. All rights reserved. See the COPYING
226 file included with the DNSSEC-Tools package for details.
227
229 Wayne Morrison, tewok@tislabs.com
230
232 blinkenlights(8), rollchk(8), rollinit(8), rollerd(8)
233 Net::DNS::SEC::Tools::rollrec.pm(3)
235 file-rollrec(5)
237perl v5.32.1 2021-01-26 LSROLL(1)