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