1LSREALM(1) User Contributed Perl Documentation LSREALM(1)
2
6 lsrealm - List the realms in a DNSSEC-Tools realm file
7
9 lsrealm [options] <realm-files>
10
12 This script lists the contents of the specified realm files. All realm
13 files are loaded before the output is displayed. If any realms have
14 duplicated names, whether within one file or across multiple files, the
15 later realm will be the one whose data are displayed.
16 The output displayed for each realm in a realm file depends on the
18 selected records, the selected attributes, and the selected output
19 format. Each option in these option groups is described in detail in
20 the next section. The three base output formats are described here.
21 The -terse option indicates that a minimal amount of output is desired;
23 the -long option indicates that a great deal of output is desired. The
24 record-selection and attribute-selection options may be used in
25 conjunction with -terse to display exactly the set of realm fields
26 needed.
27 The default output format is that used when neither -terse nor -long is
29 given, and is a middle ground between terse and long output.
30 The table below shows the fields displayed for each output format.
32 realm field default terse long
34 ------------- ------- ----- ----
35 realm name yes yes yes
36 state yes no yes
37 config directory no no yes
38 realm directory no no yes
39 rollrec file no no yes
40 administrator no no yes
41 directory no no yes
42 display flag no no yes
43 manager no no yes
44 manager arguments no no yes
45 user no no yes
46
48 There are three types of options recognized by lsrealm: record-
49 selection options, attribute-selection options, and output-format
50 options. Each type is described in the subsections below.
51 Record-selection Options
53 These options select the records that will be displayed by lsrealm. By
54 default, all records will be displayed; selecting one or the other of
55 these options will restrict the records shown.
56 These options are mutually exclusive.
58 -active
60 List all active records in the realm file.
61 -inactive
63 List all inactive records in the realm file.
64 Attribute-selection Options
66 These options select the attributes of the records that will be
67 displayed by lsrealm.
68 -admin
70 The record's administrator value is included in the output. If an
71 administrator value is not included in a realm, then the value
72 "(defadmin)" will be given.
73 -args
75 The record's user-defined arguments for the realm's rollover
76 manager.
77 -configdir
79 The record's configuration directory is included in the output.
80 This value will be the filename only, unless the -fullpaths option
81 is given. In that case, the full pathname will be printed.
82 -display
84 The record's display flag, used by grandvizier is included in the
85 output.
86 -manager
88 The record's manager field, indicating which rollover manager is
89 used for the realm.. The default is rollerd, but individual
90 installations may use other managers.
91 -realmdir
93 The record's realm directory is included in the output. This value
94 will be the filename only, unless the -fullpaths option is given.
95 In that case, the full pathname will be printed.
96 -rollrec
98 The record's rollrec file is included in the output. This value
99 will be the filename only, unless the -fullpaths option is given.
100 In that case, the full pathname will be printed.
101 -state
103 Include each realm record's state in the output. The state will be
104 either "active" or "inactive". This field is part of the default
105 output.
106 -user
108 The record's user field, which is the user the realm's manager will
109 be executed with. This field is not yet implemented.
110 Output-format Options
112 These options select the type of output that will be given by lsrealm.
113 -count
115 Only a count of matching realms in the realm file is given.
116 -fullpaths
118 Display pathname data as the full pathname given in the realm file.
119 If this option is not specified, only the filename itself will be
120 displayed.
121 -headers
123 Display explanatory column headers.
124 -terse
126 Terse output is given. Only the record name and any other fields
127 specifically selected are included in the output.
128 -long
130 Long output is given. All record fields are included.
131 -help
133 Display a usage message.
134 -Version
136 Displays the version information for lsrealm and the DNSSEC-Tools
137 package.
138
140 Copyright 2012-2014 SPARTA, Inc. All rights reserved. See the COPYING
141 file included with the DNSSEC-Tools package for details.
142
144 Wayne Morrison, tewok@tislabs.com
145
147 dtrealms(8), grandvizier(8), realminit(8)
148 Net::DNS::SEC::Tools::realm.pm(3)
150 file-realm(5)
152perl v5.32.1 2021-01-26 LSREALM(1)