]>
Commit | Line | Data |
---|---|---|
f62cd5c0 | 1 | .TH MITCH 1 "22 Jan 2003" "MIT Athena" |
7cc696ad | 2 | \" RCSID: $Header$ |
3 | .SH NAME | |
f62cd5c0 | 4 | mitch \- examine and modify informtion about containers in Moira |
7cc696ad | 5 | .SH SYNOPSIS |
f62cd5c0 | 6 | .B mitch containername [options] |
7cc696ad | 7 | .SH DESCRIPTION |
f62cd5c0 | 8 | .I Mitch |
7cc696ad | 9 | is a tool for updating information about containers in Moira. It |
10 | supports all container modification commands and options to list, add, | |
11 | and remove machines to and from containers. | |
12 | ||
13 | If no options are specified, it will assume \fI-info\fR, which will | |
370c61a4 | 14 | result in all information about the specified container being displayed. |
7cc696ad | 15 | |
16 | .SH OPTIONS | |
17 | ||
18 | .IP \fB-info\ \fRor\ \fB-i\fR | |
19 | Display information about a container. This is the default mode if no | |
20 | other options are given. The output is similar to that of moira. | |
21 | ||
22 | .IP \fB-desc\ \fIdescription\ \fRor\ \fB-d\ \fIdescription\fR | |
23 | Update the description field for the specified container to \fIdescription\fR. | |
24 | .IP \fB-location\ \fIlocation\ \fRor\ \fB-l\ \fIlocation\fR | |
25 | Update the location field for the specified container to \fIlocation\fR. | |
26 | .IP \fB-contact\ \fIcontact\ \fRor\ \fB-c\ \fIcontact\fR | |
370c61a4 | 27 | Update the contact field for the specified container to \fIcontact\fR. |
7cc696ad | 28 | |
29 | .IP \fB-owner\ \fIowner\ \fRor\ \fB-O\ \fIowner\fR | |
30 | Set the owner of the specified container to \fIowner\fR. | |
31 | ||
32 | You may specify an owner explicitly, as user:username, list:listname, or | |
33 | kerberos:principal_name; or the type may be left off if the owner name | |
34 | is non ambiguous. | |
f62cd5c0 | 35 | .B Mitch |
370c61a4 | 36 | will try first as a user, and if that fails will try the owner as a |
7cc696ad | 37 | list. |
38 | ||
39 | .IP \fB-memacl\ \fImembership_acl\ \fRor\ \fB-MA\ \fImembership_acl\fR | |
40 | Set the mebership acl of the container; members of this acl will be | |
41 | allowed to add and remove members of the container, but not update any | |
42 | other characteristics. The membership acl is specified like a list | |
370c61a4 | 43 | member, except that it can never be a string. To return a container to |
7cc696ad | 44 | having default membership access control conditions, set the membership |
45 | acl to "NONE". | |
46 | ||
47 | .IP \fB-public\ \fR(\fB-P\fR)\ \fRor\ \fB-private\ \fR(\fB-NP\fR) | |
48 | Make the container public or private. (Anyone can add a machine to a | |
49 | public container.) | |
50 | ||
51 | .IP \fB-unformatted\ \fRor\ \fB-u\fR | |
52 | Display container information with each field on a seperate line, in the | |
53 | form "fieldname: value". | |
54 | .IP \fB-verbose\ \fRor\ \fB-v\fR | |
370c61a4 | 55 | Give more information. With this flag, mitch will display the |
7cc696ad | 56 | queries it is making to the moira server. |
57 | .IP \fB-noauth\ \fRor\ \fB-n\fR | |
58 | Do not attempt to perform Kerberos authentication with the Moira server. | |
59 | Most lookup operations should be still possible without tickets. | |
60 | .IP \fB-database\ \fIhost:port\ \fRor\ \fB-db\ \fIhost:port\fR | |
61 | Use the specified host and port to contact the Moira database instead of | |
62 | the default server. Both may be symbolic names or numbers. If the | |
63 | port is left off, the default Moira server port will be assumed. The | |
64 | database chosen will be the one specified on the command line, specified | |
65 | in the MOIRASERVER environment variable, the hesiod "moira" sloc entry, | |
66 | or the compiled in default, in that order or preference. | |
67 | ||
68 | .IP \fB-create\ \fRor\ \fB-C\fR | |
69 | This will create the specified container, with information provided by | |
70 | other options. | |
71 | .IP \fB-delete\ \fRor\ \fB-D\fR | |
72 | This will delete the specified container, if the container contains no | |
73 | machines. | |
74 | .IP \fB-rename\ \fInewname\ \fRor\ \fB-R\ \fInewname\fR | |
75 | This will rename the specified container to \fInewname\fR. | |
76 | ||
77 | .IP \fB-recursive\ \fRor\ \fB-r\fR | |
78 | When specified along with the | |
79 | \fB-listmach\fR | |
80 | or | |
81 | \fB-listsub\fR | |
82 | options, will provide a recursive listing. | |
83 | ||
84 | .IP \fB-listmach\ \fRor\ \fB-lm\fR | |
85 | This will list the machines that are members of the container. Use the | |
86 | \fB-r\fR | |
87 | flag for a recursive listing. | |
88 | .IP \fB-addmach\ \fIhostname\ \fRor\ \fB-am\ \fIhostname\fR | |
89 | This will add \fIhostname\fR to the specified container. | |
370c61a4 | 90 | .IP \fB-deletemach\ \fIhostname\ \fRor\ \fB-dm\ \fIhostname\fR |
7cc696ad | 91 | This will remove \fIhostname\fR from the specified container. |
92 | ||
93 | .IP \fB-listsub\ \fRor\ \fB-ls\fR | |
94 | This will list subcontainers of the specified container. Use the | |
95 | \fB-r\fR | |
96 | flag for a recursive listing. | |
97 | ||
98 | .SH AUTHORS | |
99 | Garry Zacheiss, MIT Information Systems. | |
100 | .SH SEE ALSO | |
101 | moira(1) | |
102 | ||
103 | .SH DIAGNOSTICS | |
104 | An exit status of 2 indicates a problem contacting the server. An exit | |
105 | status of 1 indicates that the arguments could not be parsed or some | |
106 | query to the moira server returned an error. An exit status of 0 | |
107 | indicates that all operations requested completed successfully. | |
108 | ||
109 | .SH NOTES | |
110 | The container name doesn't actually have to be the first argument, but | |
111 | if you put it anywhere else, it's easy to get the other arguments in the | |
112 | wrong order and do something other than what you intended. | |
113 |