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

NAME

6       grandvizier - DNSSEC-Tools dtrealms GUI
7

SYNOPSIS

9         grandvizier <realms-file>
10

DESCRIPTION

12       THIS NEEDS MAJOR EDITTING!!!
13
14       Warning:  This is an early prototype.  Consider it to be beta quality,
15       if not alpha.
16
17       grandvizier is a GUI tool for use with monitoring and controlling the
18       DNSSEC-Tools dtrealms program.  It displays information on the current
19       state of the realms dtrealms is managing.  The user may control some
20       aspects of dtrealms's execution using grandvizier menu commands.
21
22       grandvizier creates a window in which to display information about each
23       realms.  (These realms are those in dtrealms's current realms file.)
24       For each realm, it displays the realm name and the count of zones in
25       each of these four states:  normal, ZSK rollover, KSK rollover, and KSK
26       phase 6 wait state.  As the rollover status of the zones in each realm
27       changes, grandvizier will update its display for that realm.  Inactive
28       realms, realms listed in the realms file but which are not in currently
29       being run, are displayed but have no useful information to display.
30
31       The user may also hide realms from the display.  These realms, if in
32       the active state, will continue to execute; however, their information
33       will not be displayed.  Display state for each realm will persist
34       across grandvizier executions.
35
36       Menu commands are available for some control over dtrealms.  Display
37       and execution options for grandvizier are also available through menu
38       commands.  More information about the menu commands is available in the
39       MENU COMMANDS section.
40
41       grandvizier is only intended to be started by dtrealms, not directly by
42       a user.  There are two ways to have dtrealms start grandvizier.  First,
43       realmctl may be given the -display option.  Second, the -display option
44       may be given on dtrealms' command line.
45

OPTIONS

47       grandvizier takes the following options:
48
49       -display
50           Tells dtrealms to execute grandvizier as a child process.
51
52       -maxrealms
53           Tells grandvizier how many realms to display.
54
55       -Version
56           Displays the version information for grandvizier and the DNSSEC-
57           Tools package.
58
59       -help
60           Displays a usage message and exits.
61

SCREEN LAYOUT

63       The grandvizier window is laid out as a series of "stripes".  The top
64       stripe contains status information about dtrealms, the second stripe
65       contains column headers, and the bulk of the window consists of realm
66       stripes.  The list below provides more detail on the contents of each
67       stripe.
68
69       See the ROW COLORS section for a discussion of the colors used for the
70       zone stripes.
71
72dtrealms information stripe
73
74           The information stripe contains five pieces of information:
75           dtrealms's current realms file, the count of rolling zones, the
76           count of stopped zones, the count of zones to be displayed, and the
77           amount of time dtrealms waits between processing its queue.
78           Coincidentally, that last datum is also the amount of time between
79           grandvizier screen updates.
80
81       •   column headers stripe
82
83           This stripe contains the column headers for the columns of each
84           realm stripe.
85
86       •   realm stripes
87
88           Each realm managed by dtrealms (i.e., every realm in the current
89           realms file) will have a realm stripe which describes that realm's
90           current state.  The stripe is divided into two sections:  realm
91           identification and the realm's zone counts.
92
93           The realm identification section contains the name of the realm and
94           the realm's rollrec file.
95
96           The realm's zone counts section contains the number of zones in
97           normal state, ZSK rollover, KSK rollover, and KSK phase 6 wait
98           state.
99
100           See the ROW COLORS section for a discussion of the colors used for
101           the realm stripes.
102

ROW COLORS

104       The default grandvizier configuration displays each realm in its own
105       row with a rotating set of colors.  The rows alternate with blue, red,
106       and green, as defined in the X11 rgb.txt file.  Row coloring can be
107       turned off (and on) with configuration options and menu commands.
108
110       A number of menu commands are available to control the behavior of
111       grandvizier and to send commands to dtrealms.  These commands are
112       discusses in this section.
113
114   File Menu
115       The commands in this menu are basic GUI commands.
116
117       •   Halt Dtrealms
118
119           dtrealms's execution is halted immediately.  As a result,
120           grandvizier's execution will also be halted.
121
122       •   Quit
123
124           grandvizier will stop execution.
125
126   Options Menu
127       The commands in this menu control the appearance and behavior of
128       grandvizier.
129
130       •   Row Colors (toggle)
131
132           This menu item is a toggle to turn on or off the coloring of realm
133           stripes.  If row coloring is turned off, realm stripes will all be
134           the same color.  If row coloring is turned on, realm stripes will
135           be displayed in varying colors.  See the ROW COLORS section for a
136           discussion of row coloring.
137
138       •   Inactive Realms Display (toggle)
139
140           This menu item is a toggle to turn on or off the display of
141           inactive realms.  If display is turned off, realm stripes for
142           inactive realms will not be displayed.  If display is turned on,
143           realm stripes for all realms will be displayed.
144
145       •   Modification Commands (toggle)
146
147           In some situations, it may be desirable to turn off grandvizier'
148           ability to send commands to dtrealms.  This menu item is a toggle
149           to turn on or off this ability.
150
151       •   Font Size
152
153           This menu item allows selection of font size of text displayed in
154           the main window.
155
156           Normally, changing the font size causes the window to grow and
157           shrink as required.  However, on Mac OS X there seems to be a
158           problem when the size selected increases the window size to be
159           greater than will fit on the screen.  If the font size is
160           subsequently reduced, the window size does not shrink in response.
161
162       •   Realms to Display
163
164           This menu item allows selection of the number of realms to be
165           displayed in the main window.
166
167   General Control Menu
168       The commands in this menu are GUI interfaces for the realmctl commands
169       related to general realm management.
170
171       •   Stop Selected Realm
172
173           The selected realm will be moved to the inactive state.  This only
174           has an effect on active realms.
175
176           A realm may be selected by clicking on its realm stripe.  If this
177           command is selected without a realm having been selected, a dialog
178           box is displayed from which a currently active realm may be chosen.
179
180       •   Stop All Realms
181
182           All realms will be moved to the inactive state.  This has no effect
183           on currently inactive realms.
184
185       •   Restart Selected Inactive Realm
186
187           The selected realm will be moved from the inactive state to the
188           active state.  The realm will enter the active state at the same
189           point from which it entered the inactive state.  This only has an
190           effect on inactive realms.
191
192           A realm may be selected by clicking on its realm stripe.  If this
193           command is selected without a realm having been selected, a dialog
194           box is displayed from which a currently inactive realm may be
195           chosen.
196
197       •   Restart All Stopped Realms
198
199           All realms will be moved from the inactive state to the roll state.
200           The realms will enter the roll state at the same point from which
201           they entered the inactive state.  This has no effect on currently
202           active realms.
203
204       •   DS Published for All Zones in Selected Realm
205
206           This command is used to indicate that all the zones in KSK rollover
207           phase 6 in the selected realm have new DS records published by
208           their parents.  It moves all these realms from KSK phase 6 to KSK
209           phase 7.  There is no effect on realms not in KSK rollover phase 6.
210
211   Display Menu
212       The commands in this menu provide control over what is being displayed.
213
214       The realmstripe commands allow all, some, or none of the realm stripes
215       to be displayed.  Undisplayed active realms will continue to be active,
216       but they will do so without the grandvizier window indicating this.
217
218       •   Realm Selection
219
220           A dialog box is displayed that holds a list of the realms currently
221           managed by dtrealms.  The user may select which realms should be
222           displayed by clicking on the realm's checkbox.  Realms with a
223           selected checkbox will be displayed; realms without a selected
224           checkbox will not be displayed.
225
226       •   Refresh Display
227
228           Refresh the grandvizier display.  The display will automatically
229           refresh after a certain number of updates; this command forces it
230           to happen immediately upon invocation.
231
232   Help Menu
233       The commands in this menu provide assistance to the user.
234
235       •   Help
236
237           Display a window containing help information.
238

CONFIGURATION FILE

240       Several aspects of grandvizier' behavior may be controlled from
241       configuration files.  Configuration value may be specified in the
242       DNSSEC Tools configuration file or in a more specific rc.grandvizier.
243       The system-wide grandvizier configuration file is in the DNSSEC-Tools
244       configuration directory and is named grandvizier.conf.  Multiple
245       rc.grandvizier files may exist on a system, but only the one in the
246       directory in which grandvizier is executed is used.
247
248       The following are the available configuration values:
249
250           colors              Turn on/off use of colors on realm stripes.
251           fontsize            The size of the font in the output window.
252           inactivecolor       The background color used for inactive zones.
253           maxrealms           The number of realms to display.
254           modify              Turn on/off execution of dtrealms modification commands.
255           showinactive        Turn on/off display of inactive zones.
256
257       The rc.grandvizier file is only searched for in the directory in which
258       grandvizier is executed.  The potential problems inherent in this may
259       cause these grandvizier-specific configuration files to be removed in
260       the future.
261
262       This file is in the "field value" format, where field specifies the
263       output aspect and value defines the value for that field.  The
264       following are the recognized fields:
265
266       Empty lines and comments are ignored.  Comment lines are lines that
267       start with an octothorpe ('#').
268
269       Spaces are not allowed in the configuration values.
270
271       Choose your inactivecolors carefully.  The only foreground color used
272       is black, so your background colors must work well with black.
273

REQUIREMENTS

275       grandvizier is implemented in Perl/Tk, so both Perl and Perl/Tk must be
276       installed on your system.
277

WARNINGS

279       grandvizier has several potential problems that must be taken into
280       account.
281
282       development environment
283           grandvizier was developed and tested on a single-user system
284           running X11 using a relatively small number of zones.  While it
285           works fine in this environment, it has not been run on a system
286           with many users or in a situation where the system console hasn't
287           been in use by the grandvizier user.
288
290       Copyright 2012-2013 SPARTA, Inc.  All rights reserved.  See the COPYING
291       file included with the DNSSEC-Tools package for details.
292

AUTHOR

294       Wayne Morrison, tewok@tislabs.com
295

SEE ALSO

297       dtrealms(8), realmctl(8), rollerd(8)
298
299       Net::DNS::SEC::Tools::realm(5)
300
301
302
303perl v5.34.0                      2022-01-20                    GRANDVIZIER(1)
Impressum