]> andersk Git - moira.git/blob - clients/mmoira/helpfile
c9d8045ef47fa49279dcd6d988e3c34ef6202568
[moira.git] / clients / mmoira / helpfile
1 $Header$
2 *no_more_help
3 Sorry, no further help is available.
4 *show_user
5 This will display information about a user in the database.  The user
6 may or may not have an active account.
7
8 Users may be retrieved in four ways:
9 + by login name (may use wildcards)
10 + by Unix UID (must match exactly)
11 + by first and/or last names (may use wildcards)
12 + by class (please do not specify a class with too many people in it)
13
14 Fill in the desired field(s), click on "OK", and moira will retrieve
15 any matching users.  Moira will look to see which field(s) you
16 filled in, and perform one of the for retrievals mentioned above.
17 *add_user
18 Specify all of the information to add a new user to the database.  The
19 user need not have an active user account.
20
21 + specify a login name of 3 to 8 characters, or the special value
22   "create unique login" to have moira choose one for you
23 + specify a number for the UID, or the special value "create unique UID"
24   to have moira choose one for you.
25 + Moira has a set of standard capitalization rules it uses on users'
26   real names.  If you attempt to enter names capitalized differently,
27   Moira will complain.  You may override this, but if you do so, the
28   register program may not work for that user.
29 + the ID number will be one-way encrypted before being stored in the
30   database.  If you wish to enter the encrypted ID directly, enclose
31   it in double-quotes.
32 + to create a fully active user account, enter a user here as status
33   "Registerable", then use the "register" option on the "user" menu to
34   complete the user account.
35 *register_user
36 This will turn an entry for a user in the database to a fully
37 functioning account.  The user may be selected in two ways:
38
39 + specify the real name of the user (with wildcards allowed) in the
40   first name and last name fields.  This must match only one user in
41   the database.
42 + specify the unix UID of the desired user.
43
44 Be sure to fill in a login name which is not in use.  The suggested
45 name is
46   first initial, middle initial, first six characters of last name
47 but must be eight or fewer characters long.
48 *select_user
49 Specify the login name of the user to be modified.  Wildcards may
50 be used, but your specification must match exactly one user.
51 *mod_user
52 Change any fields desired, then click on "OK" to modify the user
53 entry.  You may even change the login name.
54
55 + You may change the UID to the special value "create unique UID"
56   to have moira choose another one for you.
57 + Moira has a set of standard capitalization rules it uses on users'
58   real names.  If you attempt to enter names capitalized differently,
59   Moira will complain.  You may override this, but if you do so, the
60   register program may not work for that user.
61 + the ID number will be one-way encrypted before being stored in the
62   database.  To enter an already encrypted ID, type double-quotes (")
63   around it.
64 + If you are just changing the account status, in the future remember
65   that the "deactivate" choice of the "user" menu is a quick way to
66   set the status to "3 - Deleted".
67 *deactivate_user
68 Specify the login name of the user to be deactivated.
69
70 Deactivating a user makes their account no longer usable.  They will
71 show up with an account status of "3 - Marked for Deletion".  However,
72 all of their information will still be in the database so that the
73 account can be turned back on if necessary.  Since they are still in
74 the database, their login name and UID may not be re-used.  You may
75 wish to make the user's group list no longer active and deny access to
76 their locker at the same time.
77
78 At some point in the future, deactivated accounts should be expunged,
79 either in bulk or with the "expunge" option of the "user" menu.
80 *expunge_user
81 Specify the login name of the user to be expunged.
82
83 This will remove the user's record from the Moira database (but not
84 from Kerberos).  Once this is done, the login name and UID may be
85 reused.  It is a good idea to leave users in the deactivated state for
86 a while before expunging them so that the name and ID are not reused
87 right away, and the account can be reactivated if necessary.
88
89 At Project Athena, we have decided that expunging individual accounts
90 is a bad idea, so any account which has ever been active may not be
91 expunged this way.  These accounts must be removed in bulk by the
92 Moira administrator.
93 *show_finger
94 Specify a login name to select a user whose finger information will be
95 displayed.  This information will exist for users whose accounts are
96 not yet active, as it is loaded at the same time as the users
97 themselves.
98 *select_finger
99 Specify the login name of the user whose finger information is to be
100 modified.  Wildcards may be used, but your specification must match
101 exactly one user.
102 *mod_finger
103 Enter the new information about the user.  This information will
104 appear where the finger program can see it.  
105
106 You may set your name as it appears to other users to anything you
107 want.  Please keep it something resembling your real name.  Our
108 operations staff can find out the real name of the owner of an
109 account.
110
111 The rest of the information is optional, and is initialized to
112 information from the administration.  If you do not want this
113 information to appear for you, type spaces over it.  Please do not
114 enter incorrect information.
115
116 Note that commas (,) and colons (:) are not allowed in these
117 responses.  This is due to how the information is manipulated later.
118 We suggest that you use a semicolon (;) to separate parts of your
119 address.
120 *select_pobox
121 Enter the login name of a user to see what that user's P. O. Box or
122 mail forwarding is set to.
123 *set_pobox
124 This allows you to set where a user receives their mail.  Specify the
125 login name to select a user.
126
127 + If the type is POP, then the user will receive their mail on a post
128   office (POP) server.  Select one of the POP servers listed below.
129 + If the type is SMTP, then the user will have their mail forwarded
130   somewhere else.  Type the destination address in the "SMTP Address"
131   field.
132 + If the type is NONE, the user will be unable to receive mail.  This
133   is the same as deleting the P. O. Box.
134
135 Note that if the user has had their mail forwarded, and wants to
136 receive it locally again, you should not use this form; select the
137 "reset" option from the "pobox" menu to select the same POP server
138 that they previously used.
139
140 To add new POP servers to the list, add them as POP servers in the
141 servers submenu of the updates menu.
142 *reset_pobox
143 This option will change a user's mail setting to receiving on a local
144 POP server.  The server chosen will be the same one that the user has
145 used in the past.  If the user is already receiving their mail
146 locally, or has never had a POP box, then you will get an error.  Use
147 the "set" option of the "pobox" menu for more general mail
148 manipulation.
149 *del_pobox
150 If you delete a user's P. O. Box, they will not be able to receive
151 mail.  This normally should not be done.  To go ahead and delete a
152 users mailbox, enter their login name.
153 *show_krbmap
154 This will display user to kerberos principal mappings.  You may
155 specify the mappings to be displayed by entering a login name, a
156 principal name, or both.  Either field may contain wildcards.
157 *add_krbmap
158 This will add a new user to kerberos mapping to the database.  You
159 must fill in both fields, entering a login name and a kerberos
160 principal.
161
162 Note that the principal is case sensitive, and should be entered with
163 the realm in uppercase.  If the principal name contains a periods or
164 at-signs other than as separators between the name, instance and
165 realm, be sure to escape them with backslashes (\).
166 *del_krbmap
167 This will remove a mapping from the database.  You must fill in both
168 fields, exactly matching an existing kerberos mapping.
169
170 Note that the principal is case sensitive, and should be entered with
171 the realm in uppercase.  If the principal name contains a periods or
172 at-signs other than as separators between the name, instance and
173 realm, be sure to escape them with backslashes (\).
174 *show_list
175 This will show you the information about one or more lists in the
176 database.  Wildcards may be used in the name.
177 *show_ace_use
178 This will show you every object in the database that can be
179 administered by a particular entity.  This includes lists,
180 filesystems, services, quotas, queries, and zephyr controls.  The
181 entity specified can be just a user, and kerberos principal, or a
182 moira list.  Note that the name of the entity cannot have wildcards.
183
184 If you specify to search recursively, for every list of which the
185 named entity is a member, items that list owns will also be displayed.
186 Note that this can take a long time, so please only use it if
187 necessary.
188 *add_list
189 This will add a new list to the database.  The name can be any string
190 up to 32 characters long, but cannot contain uppercase letters or
191 punctuation characters other than hyphen, underscore, and period.  
192
193 The flags control attributes of the list: if the list is inactive
194 (active flag is false), no services other than moira will know about
195 the list; if the list is public (public flag is true), anyone may add
196 or remove themselves from the list; if the list is hidden (hidden flag
197 is true), no one other than the list owners may get information from
198 moira about the list (but be aware that often list information is
199 available from other sources, so this is not secure); if the maillist
200 flag is true, you will be able to send email to the list (lists get
201 automatically promoted to maillists if they are members of maillists);
202 if the group flag is true, the list will be a unix file access group.
203 Only if the list is a group is the Unix GID field valid.  This field
204 may contain an integer or the string "create unique GID", in which
205 case Moira will assign a number.
206
207 The owner can be a user, a kerberos principal, or any list.  A list
208 may own itself, in which case each member of the list is an
209 administrator of that list.  Finally, the description field can
210 contain anything you like.
211 *select_list
212 Enter the name of a list to modify.  Wildcards may be used
213 in the name, but only the first matching name will be used.
214 *del_list
215 Enter the name of a list to delete.  Wildcards may be used
216 in the name, but only the first matching name will be used.
217 *mod_list
218 You may edit any of the information about the list.  The name can be
219 any string up to 32 characters long, but cannot contain uppercase
220 letters or punctuation characters other than hyphen, underscore, and
221 period.
222
223 The flags control attributes of the list: if the list is inactive
224 (active flag is false), no services other than moira will know about
225 the list; if the list is public (public flag is true), anyone may add
226 or remove themselves from the list; if the list is hidden (hidden flag
227 is true), no one other than the list owners may get information from
228 moira about the list (but be aware that often list information is
229 available from other sources, so this is not secure); if the maillist
230 flag is true, you will be able to send email to the list (lists get
231 automatically promoted to maillists if they are members of maillists);
232 if the group flag is true, the list will be a unix file access group.
233 Only if the list is a group is the Unix GID field valid.  This field
234 may contain an integer or the string "create unique GID", in which
235 case Moira will assign a number.
236
237 The owner can be a user, a kerberos principal, or any list.  A list
238 may own itself, in which case each member of the list is an
239 administrator of that list.  Finally, the description field can
240 contain anything you like.
241 *show_members
242 You may list the members of a list, or the lists to which a member
243 belongs.  Please fill out EITHER the list name OR the member type and
244 name, but not both.
245
246 If you tell it to search recursively, when retrieving the members of a
247 list it will also find the members of any other lists which are
248 members of the list in question.
249 *add_member
250 This will allow you to add a new member to a list.  Enter the name of
251 the list, and the type and name of the member.  Do not use wildcards
252 in either of the names.
253 *del_member
254 This will allow you to remove an existing member from a list.  Enter
255 the name of the list, and the type and name of the member.  Do not use
256 wildcards in either of the names.
257 *del_all_member
258 This will allow you to remove a particular member from all lists that
259 member belongs to.  You may specify any type of member, but must
260 exactly match that member without wildcards.
261
262 This program can prompt you for each deletion, or simply do them all.
263 *del_mem_confirm
264 If you answer yes, this member will be deleted from the named list.
265 Answer no to avoid the deletion.  In either case, you will continue to
266 be prompted with the other lists the member belongs to.
267 *authors
268 This moira client was written by Mark Rosenstein and Andy Oakland of
269 MIT Information Systems/Distributed Computing and Network Services
270 (formerly Project Athena).
271
272 The best way to reach someone with questions or comments about this
273 program is to email to moira@mit.edu.
274 *about_moira
275 Moira is a system configuration manager for distributed systems.  This
276 program is the user interface part of the system, and allows you to
277 manipulate everything moira knows about.
278
279 The top menu bar lists the kinds of things moira knows about, and
280 clicking the mouse on one of them will display a menu of operations
281 supported for that kind of object.  Some of these menus have submenus
282 for related objects.
283
284 When you select a menu item, a form will be displayed.  Fill out any
285 desired parts of the form:
286  + put the correct value in any text fields
287  + click on the appropriate choice in keyword fields
288  + click on the value to toggle booleans between True and False
289  + typing TAB will forward you to the next field
290 When you are done, click the mouse on "OK".  The form will disappear,
291 and if you are retrieving information from the database, the results
292 will be displayed in the window underneath the form.  Clicking on
293 "Apply" will perform the operation, but leave the form up on the
294 screen.  If you click on "Cancel", the form will disappear without
295 doing anything.  Each form has a help message specific to that form
296 that you can see by clicking the mouse on "Help".
297 *add_new_value
298 This will allow you to add a new keyword which can be specified for
299 the field in the previous form.  Moira type fields are checked against
300 a list of legal values, but this list itself can easily be changed.
301 However, this should not be done lightly.  Be sure you know what you
302 are doing and really want this new value before adding it.
303
304 To have a keyword value removed, ask the Moira system administrator.
305 *wildcards
306 Wildcards are allowed in most fields when looking things up in the
307 database.  Asterisk "*" will match zero or more characters, so that
308 "Rose*" will match "Rose", "Rosen", "Rosenberg" or "Rosenstein".
309
310 Be careful about using wildcards where your query will match too much
311 data in the database.  You probably do not want to retrieve 1000
312 items, and doing so will cause the server to take a long time and
313 possibly require more resources than are available.
314 *mouse
315 You may also retrieve or modify objects by using the mouse to click on
316 them where they appear in the log window.  Regular mouse clicks will
317 do selections as they do in most X applications.  But if you hold down
318 SHIFT and click the first mouse button, it will retrieve the
319 referenced object.  And if you hold down SHIFT and click the second
320 mouse button, it will pull up the window to modify the referenced
321 object.  If you click the mouse on something the program doesn't
322 recognize as an object, it will beep at you.
323
324 For example, when you show information about a filesystem, a paragraph
325 is added to the log that starts with "Filesystem: foo".  If you click
326 on the name (foo in the example), it will reference that filesystem
327 again.  The paragraph about the filesystem also mentions a machine, a
328 user (the owner), a group (the owners), and another user (who last
329 modified the info).  You can click on any of these names to select the
330 object being referred to.
331 *keyboard
332 There are keyboard accelerators for many of the mouse actions.
333
334 For choosing items from the menubar, if you hold down META and type the
335 letter which is underlined in each word, you will select that menu.
336 Then typing the letter underlined in any of the items in the menu will
337 select that item.
338
339 When you are filling out a form, ENTER will advance you to the next
340 field if there is more than one field in the form.  If there is only
341 one field, ENTER is equivalent to clicking on OK.  META-ENTER or
342 SHIFT-ENTER is the same as clicking on OK.  ^C in a form is the same
343 as clicking on CANCEL.  Meta-? is the same as clicking on HELP.
344 *bugs
345 Please report bugs in this program by sending email to:
346                      bug-moira@mit.edu 
347 Please be sure to mention what kind of computer you were running it
348 on, and any other necessary information so that we can repeat the bug
349 before we fix it.
350 *save_log
351 Enter a file name here, and the current contents of the log file will
352 be written out to that file.
353 *fixcase
354 It is important that names in the Moira database all follow the same
355 capitalization style so that the register program can find users.  So
356 even though for a few names it may not look right, we strongly suggest
357 that you follow what this program suggests.
358 *confirm_del_all
359 If you answer yes, this member will be deleted from the named list.
360 Answer no to avoid the deletion.  In either case, you will continue to
361 be prompted with the other lists the member belongs to.
362 *show_filsys
363 This will display information about a filesystem.  The filesystem may
364 be of any protocol type and may be a filesystem group or multiple
365 filesystem entry as well.
366
367 Filesystems may be retrieved in any of five ways:
368 + by the name of the filesystem (may use wildcards)
369 + by the name of the fileserver (machine) (must match exactly)
370 + by the actual partition of an NFS server (specify machine and
371   partition, both must match exactly)
372 + by the owning group of the filesystem (must match exactly)
373 + by the pathname of the locker on the fileserver
374
375 Fill in the desired field(s), click on "OK", and moira will retrieve
376 any matching filesystems.  Moira will look to see which field(s) you
377 filled in, and perform one of the for retrievals mentioned above.
378 *add_filsys
379 Specify all of the information to add a new filesystem to the
380 database.  The name, type, owner, owners and lockertype are mandatory
381 fields.  The other fields may have to be filled in depending on what
382 the type is.
383
384 + For type AFS filesystems, the machine/cell field contains the AFS
385   cell name.  The remote name is the path to the volume mountpoint in
386   AFS.
387 + For type ERR filesystems, only the comment field is actually used.
388   The contents of the comment field will be displayed as an error
389   message when someone tries to attach this filesystem.
390 + No other fields are necessary for type FSGROUP or MUL filesystems.
391   Use the operations on the filesystem group submenu to manipulate
392   the membership of these types.
393 + For type NFS filesystems, the machine field names the fileserver,
394   and the remote name is the path of the directory on the fileserver.
395 *select_filsys
396 Specify the name of a filesystem to be modified.  Wildcards may be
397 used, but your specification must match exactly one filesystem.
398 *mod_filsys
399 Change any fields desired, then click on "OK" to modify the filesystem
400 entry.  You may even change the name of the filesystem.  The name,
401 type, owner, owners and lockertype are mandatory fields.  The other
402 fields may have to be filled in depending on what the type is.
403
404 + For type AFS filesystems, the machine/cell field contains the AFS
405   cell name.  The remote name is the path to the volume mountpoint in
406   AFS.
407 + For type ERR filesystems, only the comment field is actually used.
408   The contents of the comment field will be displayed as an error
409   message when someone tries to attach this filesystem.  The other
410   fields may be left so that when the filesystem is re-enabled, you
411   only have to change the type and comment.
412 + No other fields are necessary for type FSGROUP or MUL filesystems.
413   Use the operations on the filesystem group submenu to manipulate
414   the membership of these types.
415 + For type NFS filesystems, the machine field names the fileserver,
416   and the remote name is the path of the directory on the fileserver.
417 *del_filsys
418 Enter the name of a filesystem to delete.  Wildcards may be used in
419 the name, but only the first matching name will be used.
420 *show_fsgroup
421 This will display information about a filesystem group, multiple
422 filesystem, or any other type of filesystem.  You may use wildcards in
423 the name you specify.
424 *add_fsgroup
425 This enables you to add additional filesystems to a filesystem group
426 or multiple filesystem.  Enter the name of the group, and the
427 filesystem to be added.  Since the order of membership in these groups
428 is important, you must also indicate where to insert the filesystem by
429 indicating whether the new one should be first or which one it should
430 follow.  This sorted list will be displayed only after you have indicated
431 the name of the group to be modified.
432 *order_fsgroup
433 This enables you to change the order in which the members of a
434 filesystem group or multiple filesystem are listed.  First enter the
435 name of the group.  This must match the name of an existing filesystem
436 group or type multiple filesystem.  If it does, the next two fields
437 will have the possible choices filled in for you.
438
439 Now select which filesystem you want to reorder, then indicate which
440 filesystem it should follow.
441 *del_fsgroup
442 First enter the name of the filesystem group or multiple filesystem to
443 be modified.  This must match the name of an existing filesystem group
444 or type multiple filesystem.  If it does, the next field will now show
445 the current members of the group.  Select which one you want to remove
446 from the group.
447 *show_fs_alias
448 This will show you filesystem alias mappings.  Enter either the real
449 name of the filesystem or the alias name, and all matching pairs will
450 be displayed.
451 *add_fs_alias
452 This will let you create a new filesystem alias.  Enter the real name
453 of the filesystem, and the alternate name (alias) you want to be able
454 to use.
455 *del_fs_alias
456 This will let you delete an existing filesystem alias.  Enter the real
457 name of the filesystem, and the alternate name (alias) you want to
458 remove.
459 *show_nfs
460 This will show you information about NFS server partitions.  You must
461 fill in the name of the server, and optionally the name of the
462 partition (i.e. /u1/lockers), or leave the partition blank to see all
463 partitions on a server.
464 *add_nfs
465 This will let you add information about a new NFS server partition to
466 the database.  The machine (server) name will be canonicalized; if
467 you want to enter a string literally, enclose it in double-quotes.
468 The group quota flag must be set correctly for Moira to correctly
469 assign quotas to lockers on that partition.  The size and allocation
470 fields are used by Moira to automatically locate new lockers.  The
471 allocation field is updated whenever the quota on a locker on that
472 partition is changed.
473 *select_nfs
474 Name a NFS server and partition (i.e. /u1/lockers) to modify.  The
475 machine (server) name will be canonicalized; if you want to enter a
476 string literally, enclose it in double-quotes.
477 *mod_nfs
478 Change any fields desired, then click on "OK" to modify the NFS
479 partition information.  The machine (server) name will be
480 canonicalized; if you want to enter a string literally, enclose it in
481 double-quotes.  The group quota flag must be set correctly for Moira
482 to correctly assign quotas to lockers on that partition.  The size and
483 allocation fields are used by Moira to automatically locate new
484 lockers.  The allocation field is updated whenever the quota on a
485 locker on that partition is changed.
486 *del_nfs
487 Name a NFS server and partition (i.e. /u1/lockers) to delete.  The
488 machine (server) name will be canonicalized; if you want to enter a
489 string literally, enclose it in double-quotes.
490 *show_quota
491 This will show filesystem quotas.  If you only fill in the name of the
492 filesystem, then all quotas on that filesystem will be displayed.  If
493 you only fill in the user or group, then all quotas applying to that
494 user or group will be displayed.  If you fill on both, then only
495 matching quotas will be displayed.
496
497 Note that quotas on AFS filesystems are of type ANY and will not match
498 User or Group quotas.
499 *add_quota
500 First enter the name of the filesystem.  The program will then
501 indicate whether this filesystem should have a type ANY quota (i.e. it
502 is in AFS), a type GROUP quota (i.e. it is in NFS on a group quota
503 partition), or type USER (anything else).
504
505 If this is a user or group quota, you will have to fill in the name of
506 the user or group.  Finally, enter the actual quota value in Kilobytes.
507 *mod_quota
508 [First enter the name of the filesystem.  The program will then
509 indicate whether this filesystem should have a type ANY quota (i.e. it
510 is in AFS), a type GROUP quota (i.e. it is in NFS on a group quota
511 partition), or type USER (anything else).]
512
513 THIS DOES NOT WORK.  For now, you have to set the quota type by hand.
514
515 If this is a user or group quota, you will have to fill in the name of
516 the user or group.  Finally, enter the new quota value in Kilobytes.
517 *del_quota
518 [First enter the name of the filesystem.  The program will then
519 indicate whether this filesystem should have a type ANY quota (i.e. it
520 is in AFS), a type GROUP quota (i.e. it is in NFS on a group quota
521 partition), or type USER (anything else).]
522
523 THIS DOES NOT WORK.  For now, you have to set the quota type by hand.
524
525 If this is a user or group quota, you will have to fill in the name of
526 the user or group.
527 *set_dquota
528 Use this to set the default quota.  The default quota is the quota
529 that is automatically assigned to new users' home directories when the
530 register, and is the default value for other new locker creations as
531 well.  The value should be specified in Kilobytes.
532 *show_machine
533 This will show you the information about one or more machines (hosts)
534 in the database.  Wildcards may be used in the name.  If no wildcards
535 are used, the name you type will be canonicalized by the domain name
536 system before being looked up in the database.  To bypass this
537 canonicalization, put the name inside a pair of double-quotes.  All
538 machine name comparisons are case-insensitive.
539 *add_machine
540 This will add a new machine (host) to the database.  The name you type
541 will be canonicalized by the domain name system.  To bypass this
542 canonicalization, put the name inside a pair of double-quotes.  Each
543 machine must be of one of the defined types.
544
545 Note that type "AFS" is used with pseudo-machines that are used as AFS
546 cell name indicators.
547 *select_machine
548 Enter the name of the machine (host) to modify.  Wildcards may be used
549 in the name.  If no wildcards are used, the name you type will be
550 canonicalized by the domain name system before being looked up in the
551 database.  To bypass this canonicalization, put the name inside a pair
552 of double-quotes.  All machine name comparisons are case-insensitive.
553 *mod_machine
554 You may change the name and/or type of the machine.  The name you type
555 will be canonicalized by the domain name system.  To bypass this
556 canonicalization, put the name inside a pair of double-quotes.  Each
557 machine must be of one of the defined types.
558
559 Note that type "AFS" is used with pseudo-machines that are used as AFS
560 cell name indicators.
561 *del_machine
562 Specify the hostname to delete a machine from the Moira database.  The
563 name you type will be canonicalized before it is used.  To enter a
564 literal string, enclose it in double-quotes.
565 *show_cluster
566 This will show you the information about one or more clusters in the
567 database.  Wildcards may be used in the name.
568 *add_cluster
569 This will add a new cluster to the database.  Choose a name containing
570 letters, numbers, and underscore.  Current Athena convention is
571 building number (preceded by "M" if it doesn't start with a letter),
572 optional descriptor such as "staff" or "test", a hyphen, and then the
573 platform designation such as "vs" or "dmu".  The description and
574 location fields are optional.
575 *select_cluster
576 Enter the name of a cluster to modify.  Wildcards may be used in the
577 name, although only the first match found will be modified.
578 *mod_cluster
579 You may change any information about the cluster, including its name.
580 When you have the information they way you want it, click on "OK" to
581 commit the changes.
582 *del_cluster
583 Specify the name of the cluster to delete.
584 *mcmap
585 This will show machine to cluster mappings.  This mapping is not
586 one-to-one, as a machine may be in multiple clusters and clusters
587 generally contain more than one machine.
588
589 Enter either a machine name or a cluster name to see the matching
590 memberships.  You may use wildcards with either.
591 *add_mcmap
592 This will add a machine to a cluster.  Note that a machine may be in
593 multiple clusters.  The machine name you type will be canonicalized by
594 the domain name system before being stored in the database.  To bypass
595 this canonicalization, put the name inside a pair of double-quotes.
596 *del_mcmap
597 This will remove a machine from a cluster.  The machine name you type
598 will be canonicalized by the domain name system before being stored in
599 the database.  To bypass this canonicalization, put the name inside a
600 pair of double-quotes.
601 *show_cldata
602 This will show the data associated with a cluster.  You must enter a
603 clustername, which may include wildcards.  The label is optional, and
604 it too may contain wildcards.  If no label is specified, all data
605 associated with the cluster will be displayed.
606 *add_cldata
607 This will add additional data to a cluster.  You must fill in all of
608 the fields.  Enter a valid cluster name.  The label may be any string,
609 but is generally one of "syslib", "lpr", or "zephyr".  The data also
610 may be anything, but is generally a filesystem name, printer name, or
611 zephyr server name.
612 *del_cldata
613 This will remove data from a cluster.  Enter a valid cluster name.
614 You must fill in each of the fields, although if you use a wildcard
615 for the value, it will remove all data with the specified label from
616 that cluster.
617 *show_printer
618 This will show you information about one or more printers in the
619 database.  Wildcards may be used in the name.
620 *add_printer
621 This will add a new printer to the database.  The printer must have a
622 unique name up to 32 characters long.  Enter the name of the print
623 spooler as the spooling host.  This hostname will be canonicalized
624 before it is stored in the database.  To enter a literal string,
625 enclose it in double-quotes.  The spool directory is the directory on
626 the print spooler for that printer.  The remote name is the name of
627 the printer on the print spooler.  The quota server is another
628 canonicalized hostname, this time of the machine that handles
629 accounting for this printer.  To disable accounting, leave the quota
630 server field blank.  If authentication is true, all print requests for
631 this printer must be kerberos authenticated.  The price entered here
632 (in cents) is for informational purposes only; the quota server gets
633 the actual price from another source.
634 *select_printer
635 Enter the name of a printer to modify.  While you may use wildcards
636 here, you will only get a chance to modify the first printer matched.
637 *mod_printer
638 Change any desired fields, then click on "OK" to commit the changes.
639
640 The printer must have a unique name up to 32 characters long.  Enter
641 the name of the print spooler as the spooling host.  This hostname
642 will be canonicalized before it is stored in the database.  To enter a
643 literal string, enclose it in double-quotes.  The spool directory is
644 the directory on the print spooler for that printer.  The remote name
645 is the name of the printer on the print spooler.  The quota server is
646 another canonicalized hostname, this time of the machine that handles
647 accounting for this printer.  To disable accounting, leave the quota
648 server field blank.  If authentication is true, all print requests for
649 this printer must be kerberos authenticated.  The price entered here
650 (in cents) is for informational purposes only; the quota server gets
651 the actual price from another source.
652 *del_printer
653 Specify the name of a printer to delete.
654 *show_zephyr
655 Enter the name of a zephyr class to see the restrictions in place on
656 that class.  You may use wildcards.
657 *add_zephyr
658 Enter the necessary information to set up access controls on a class
659 of zephyr messages.  For each privilege, you can set a user, a single
660 kerberos principal, an access list, or nothing.  The privileges are:
661  + XMT: the ability to transmit a zephyr message of this class
662  + SUB: the ability to subscribe to messages of this class
663  + IWS: the ability to subscribe to the wildcard instance of this class
664  + IUI: the ability to use only the instance UID identity???
665 *select_zephyr
666 Enter a zephyr class whose restrictions you wish to modify or delete.
667 *mod_zephyr
668 Update the restrictions for this zephyr class.  When you are done,
669 click on "OK" to commit the changes.  For each privilege, you can set
670 a user, a single kerberos principal, an access list, or nothing.  The
671 privileges are:
672  + XMT: the ability to transmit a zephyr message of this class
673  + SUB: the ability to subscribe to messages of this class
674  + IWS: the ability to subscribe to the wildcard instance of this class
675  + IUI: the ability to use only the instance UID identity???
676 *dcm_enable
677 Use this switch to enable or disable DCM updates.  If this is not
678 enabled, the DCM will quit shortly after it starts.  When this is
679 enabled, there are still many other reasons (such as the existence of
680 the file /etc/nodcm) why it might not run.
681 *trigger_dcm
682 Use this to start a DCM pass now instead of waiting until the next
683 scheduled run.  Do not do this unless you understand all of the
684 implications of an unscheduled DCM run.
685 *show_service
686 This will show you the configuration of a DCM service to be updated.
687 The name may contain wildcards.
688 *add_service
689 Specify the information to add a new service to the Moira database.
690 Note that these services are used for two purposes: those which the
691 DCM updates, and those present just for a hesiod SLOC entry.
692
693 The interval is the minimum time between attempted updates.  The
694 destination file is where the DCM will leave the datafile on hosts
695 being updated.  The script will be run on each host being updated
696 after copying the datafile to its destination.  The service must be
697 enabled for the DCM to update it.  Services existing just for the
698 hesiod SLOC info should be left disabled.  The owner fields are
699 currently ignored.
700
701 If the type is UNIQUE, each host to be updated with this service will
702 be treated individually, and some of them may be updated
703 simultaneously.  If the type is REPLICAT(ED), only one instance of the
704 service will be updated at a time, and if any of them fail no further
705 updates for that service will occur until this is reset.
706 *select_service
707 Specify the name of the service to be affected (depending on the menu
708 item you selected, this could mean modifying, deleting, reseting
709 errors, or resetting the complete state).
710 *mod_service
711 Change any fields desired, then click on "OK" to commit the changes.
712 Note that these services are used for two purposes: those which the
713 DCM updates, and those present just for a hesiod SLOC entry.
714
715 The interval is the minimum time between attempted updates.  The
716 destination file is where the DCM will leave the datafile on hosts
717 being updated.  The script will be run on each host being updated
718 after copying the datafile to its destination.  The service must be
719 enabled for the DCM to update it.  Services existing just for the
720 hesiod SLOC info should be left disabled.  The owner fields are
721 currently ignored.
722
723 If the type is UNIQUE, each host to be updated with this service will
724 be treated individually, and some of them may be updated
725 simultaneously.  If the type is REPLICAT(ED), only one instance of the
726 service will be updated at a time, and if any of them fail no further
727 updates for that service will occur until this is reset.
728 *show_host
729 This will show the configuration of a DCM host/service tuple.  Enter
730 the service and/or host name.  Either of both of them may contain
731 wildcards.
732 *add_host
733 Specify the information to add a new host/service tuple to the Moira
734 database.  Note that these entries are actually used for two purposes:
735 to indicate what the DCM should update, and to create a hesiod SLOC
736 entry.
737
738 The service name should be the name of an existing service.  The host
739 name must be the name of a known host.  This host name will be
740 canonicalized before it is stored in the database.  To enter a literal
741 string, enclose it in double-quotes.  Enable the host if you actually
742 want it to recieve DCM updates.  The three values are used in a
743 service-specific way.  Values 1 and 2 are integers and value 3 is a
744 string.
745 *select_host
746 Specify the host/service tuple to be affected (depending on the menu
747 item you selected, this could mean modifying, deleting, reseting
748 errors, or resetting the complete state).
749 *mod_host
750 Change any fields desired, then click on "OK" to commit the changes.
751 Note that these entries are actually used for two purposes: to
752 indicate what the DCM should update, and to create a hesiod SLOC
753 entry.
754
755 The service name should be the name of an existing service.  The host
756 name must be the name of a known host.  This host name will be
757 canonicalized before it is stored in the database.  To enter a literal
758 string, enclose it in double-quotes.  Enable the host if you actually
759 want it to recieve DCM updates.  The three values are used in a
760 service-specific way.  Values 1 and 2 are integers and value 3 is a
761 string.
762 *show_value
763 This will show the value of a Moira configuration variable.  This is
764 intended primarily for the moira system administrator and others
765 familiar with moira's operation.  Wildcards are not allowed in the
766 variable name.
767
768 Variables of possible interest are uid and gid, which are the next ID
769 numbers to be assigned.
770 *show_alias
771 This will show a raw alias entry from the Moira database.  Besides the
772 obvious use for altername names for things, aliases are used to store
773 valid keywords for various fields, variable typing information, and
774 random string variables.
775
776 To see keywords for a field, enter the name of the keyword, and use
777 type TYPE.  To see the type associated with a value, select TYPEDATA.
778 To see a string variable, use type VALUE.  Tye AFSPATH contains
779 information for turning a lockername and locker type into the
780 appropriate mountpoint for the locker.  The remaining types are just
781 for alias names.
This page took 0.090487 seconds and 3 git commands to generate.