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 keyrec file yes no yes yes
49 KSK phase yes no yes no
50 ZSK phase yes no yes no
51 administrator no no yes no
52 directory no no yes no
53 logging level no no yes no
54 TTL value no no yes no
55 display flag no no yes no
56 phase start no no yes no
57 last KSK rollover no no yes no
58 last ZSK rollover no no yes no
59 zonesigner arguments no no yes no
60 The rollrec name field is often the same as its zonename, but this is
62 not necessarily the case. The rollrec name can contain spaces, while
63 the zonename can't. For this reason, lsroll displays the rollrec name
64 in quotes, even if the name contains no spaces. This is intended to
65 allow for easier parsing by other programs.
66
68 There are three types of options recognized by lsroll: record-
69 selection options, attribute-selection options, and output-format
70 options. Each type is described in the subsections below.
71 Record-selection Options
73 These options select the records that will be displayed by lsroll. By
74 default, all records will be displayed; selecting one or the other of
75 these options will restrict the records shown.
76 In order to simplify the lsroll code and keep it easily understandable,
78 these options are mutually exclusive.
79 -roll
81 List all "roll" records in the rollrec file.
82 -skip
84 List all "skip" records in the rollrec file.
85 Attribute-selection Options
87 These options select the attributes of the records that will be
88 displayed by lsroll.
89 -type
91 Include each rollrec record's type in the output. The type will be
92 either "roll" or "skip".
93 -zonename
95 The record's zonename is included in the output. The zonename is
96 distinct from the record's rollrec name, which is always included
97 in the output. While these two fields are often the same, they
98 need not be. In split-zone zones, the rollrec names must be
99 different, while the zonename field is the same.
100 -zonefile
102 The record's zonefile is included in the output. This field is
103 part of the default output.
104 -keyrec
106 The record's keyrec file is included in the output. This field is
107 part of the default output.
108 -kskphase
110 The record's KSK rollover phase are included in the output. If
111 this option is given with the -zskphase option, then the output
112 will follow the format described for the -phases option. This
113 field is part of the default output.
114 -zskphase
116 The record's ZSK rollover phase are included in the output. If
117 this option is given with the -kskphase option, then the output
118 will follow the format described for the -phases option. This
119 field is part of the default output.
120 -phases
122 The record's KSK and ZSK rollover phases are included in the
123 output. The listing is given with the KSK phase first, followed by
124 the ZSK phase.
125 Examples of output from this option are:
127 KSK phase ZSK phase output
129 0 0 0/0
130 3 0 3/0
131 0 5 0/5
132 -admin
134 The record's administrator value is included in the output. If an
135 administrator value is not included in a rollrec, then the value
136 "(defadmin)" will be given.
137 -directory
139 The name of the directory that holds the zone's files is included
140 in the output. If a zone directory is not included in a rollrec,
141 then the value "(defdir)" will be given.
142 -loglevel
144 The rollerd logging level for this zone. This value may be given
145 in the rollrec file in either the textual or numeric form. The
146 textual form of the logging level will be displayed, not the
147 numeric. If a logging level value is not included in a rollrec,
148 then the value "(deflog)" will be given. If an undefined logging
149 level value is included in a rollrec, then the value "(unknownlog)"
150 will be given.
151 -ttl
153 The record's TTL value is included in the output.
154 -display
156 The record's display flag, used by blinkenlights, is included in
157 the output.
158 -phstart
160 The record's rollover phase is included in the output. If no
161 rollover has yet been performed for this zone, an empty date is
162 given.
163 -lastksk
165 The record's last KSK rollover date is included in the output. If
166 no KSK rollover has yet been performed for this zone, an empty date
167 is given.
168 -lastzsk
170 The record's last ZSK rollover date is included in the output. If
171 no ZSK rollover has yet been performed for this zone, an empty date
172 is given.
173 -zsargs
175 The record's user-defined zonesigner arguments are included in the
176 output. If no arguments have been set for this zone, then the
177 value "(none)" is given.
178 Output-format Options
180 These options select the type of output that will be given by lsroll.
181 -count
183 Only a count of matching keyrecs in the rollrec file is given.
184 -headers
186 Display explanatory column headers.
187 -terse
189 Terse output is given. Only the record name and any other fields
190 specifically selected are included in the output.
191 -long
193 Long output is given. All record fields are included.
194 -help
196 Display a usage message.
197 -Version
199 Displays the version information for lsroll and the DNSSEC-Tools
200 package.
201
203 Copyright 2005-2011 SPARTA, Inc. All rights reserved. See the COPYING
204 file included with the DNSSEC-Tools package for details.
205
207 Wayne Morrison, tewok@users.sourceforge.net
208
210 blinkenlights(8), rollchk(8), rollinit(8), rollerd(8)
211 Net::DNS::SEC::Tools::rollrec.pm(3)
213 file-rollrec(5)
215perl v5.12.4 2011-10-12 LSROLL(1)