]> andersk Git - moira.git/blob - man/stella.1
Document flags for adding and removing machines from containers.
[moira.git] / man / stella.1
1 .TH STELLA 1 "10 Feb 2000" "MIT Athena"
2 \" RCSID: $Header$
3 .SH NAME
4 stella \- examine and modify information about hosts in Moira
5 .SH SYNOPSIS
6 .B stella hostname [options]
7 .SH DESCRIPTION
8 .I Stella
9 is a tool for updating information about hosts in Moira. It supports
10 all host modification commands and a few options to change cluster
11 mapping.
12
13 If no options are specified, it will assume \fI-info\fR, which will
14 result in all information about the specified host being displayed.
15
16 .SH OPTIONS
17
18 .IP \fB-info\ \fRor\ \fB-i\fR
19 Display information about a host. This is the default mode if no other
20 options are given. The output is similar to that of moira.
21
22 .IP \fB-addalias\ \fIaliasname\ \fRor\ \fB-a\ \fIaliasname\fR
23 This will add \fIaliasname\fR as an alias for the given host. This
24 option can be specified multiple times with different alias names
25 on the same command line.
26 .IP \fB-deletealias\ \fIaliasname\ \fRor\ \fB-d\ \fIaliasname\fR
27 This will remove the alias \fIaliasname\fR for the given host. This
28 option can be specified multiple times with different alias names
29 on the same command line.
30
31 .IP \fB-listmap\ \fRor\ \fB-lm\fR
32 This will list cluster mappings for the specified host; that is,
33 the clusters to which the host belongs.
34 .IP \fB-addmap\ \fIcluster\ \fRor\ \fB-am\ \fIcluster\fR
35 This will add the specified host to \fIcluster\fR.
36 .IP \fB-deletemap\ \fIcluster\ \fRor\ \fB-dm\ \fIcluster\fR
37 This will delete the specified host from \fIcluster\fR.
38
39 .IP \fB-listcontainer\ \fRor\ \fB-lcn\fR
40 This will list the Active Directory container membership for the 
41 specified host.  Unlike clusters, a machine may only belong to a 
42 single container.
43 .IP \fB-addcontainer\ \fIcontainer\ \fRor\ \fB-acn\ \fIcontainer\fR
44 This will add the specified host to \fIcontainer\fR.
45 .IP \fB-deletecontainer\ \fIcontainer\fRor \ \fB-dcn\ \fIcontainer\fR
46 This will delete the specified host from \fIcontainer\fR. 
47
48 .IP \fB-vendor\ \fIvendor\ \fRor\ \fB-V\ \fIvendor\fR
49 Update the vendor field for the specified host to \fIvendor\fR.
50 .IP \fB-model\ \fImodel\ \fRor\ \fB-M\ \fImodel\fR
51 Update the model field for the specified host to \fImodel\fR.
52 .IP \fB-os\ \fIos\ \fRor\ \fB-o\ \fIos\fR
53 Update the OS field for the specified host to \fIos\fR.
54 .IP \fB-location\ \fIlocation\ \fRor\ \fB-L\ \fIlocation\fR
55 Update the location field for the specified host to \fIlocation\fR.
56
57 .IP \fB-address\ \fIaddress\ \fRor\ \fB-A\ \fIaddress\fR
58 Change the address of the given host to \fIaddress\fR.
59 .IP \fB-network\ \fInetwork\ \fRor\ \fB-N\ \fInetwork\fR
60 Change the network for the given host to \fInetwork\fR.
61
62 .IP \fB-opcmt\ \fIop_cmt\ \fRor\ \fB-oc\ \fIop_cmt\fR
63 Set the operational comment for the specified host to \fIop_cmt\fR.
64 .IP \fB-admcmt\ \fIadm_cmt\ \fRor\ \fB-ac\ \fIadm_cmt\fR
65 Set the administrative comment for the specified host to \fIadm_cmt\fR.
66
67 .IP \fB-contact\ \fIcontact\ \fRor\ \fB-c\ \fIcontact\fR
68 Update the contact information for the given host to \fIcontact\fR.
69 .IP \fB-billingcontact\ \fIcontact\ \fRor\ \fB-bc\ \fIcontact\fR
70 Update the billing contact information for the given host to \fIcontact\fR.
71 .IP \fB-status\ \fIstatus\ \fRor\ \fB-S\ \fIstatus\fR
72 Set the status of the specified host to \fIstatus\fR.
73
74 .IP \fB-owner\ \fIowner\ \fRor\ \fB-O\ \fIowner\fR
75 Set the owner of the specified host to \fIowner\fR.
76
77 You may specify an owner explicitly, as user:username, list:listname,
78 or kerberos:principal_name; or the type may be
79 left off if the owner name is non ambiguous.
80 .B Stella
81 will try first as a user, and if that fails will try the member as a
82 list.
83
84 .IP \fB-unformatted\ \fRor\ \fB-u\fR
85 Display host information with each field on a seperate line, in the 
86 form "fieldname: value".
87 .IP \fB-verbose\ \fRor\ \fB-v\fR
88 Give more information.  With this flag, stella will display the
89 queries it is making to the moira server.
90 .IP \fB-noauth\ \fRor\ \fB-n\fR
91 Do not attempt to perform Kerberos authentication with the Moira server.
92 Most lookup operations should be still possible without tickets.
93 .IP \fB-database\ \fIhost:port\ \fRor\ \fB-db\ \fIhost:port\fR
94 Use the specified host and port to contact the Moira database instead of
95 the default server.  Both may be symbolic names or numbers.  If the
96 port is left off, the default Moira server port will be assumed.  The
97 database chosen will be the one specified on the command line, specified
98 in the MOIRASERVER environment variable, the hesiod "moira" sloc entry,
99 or the compiled in default, in that order or preference.
100
101 .IP \fB-create\ \fRor\ \fB-C\fR
102 This will create the specified host, with information provided by other
103 options. By default, the host will be owned by NONE and will be active.
104 .IP \fB-delete\ \fRor\ \fB-D\fR
105 This will delete the specified host, if the status field is already set
106 to Deleted (3).
107 .IP \fB-rename\ \fInewname\ \fRor\ \fB-R\ \fInewname\fR
108 This will rename the given host to \fInewname\fR.
109
110 .SH AUTHORS
111 Nickolai Zeldovich.
112 .SH SEE ALSO
113 moira(1)
114
115 .SH DIAGNOSTICS
116 An exit status of 2 indicates a problem contacting the server. An exit
117 status of 1 indicates that the arguments could not be parsed or some
118 query to the moira server returned an error. An exit status of 0
119 indicates that all operations requested completed successfully.
120
121 .SH NOTES
122 The hostname doesn't actually have to be the first argument, but if
123 you put it anywhere else, it's easy to get the other arguments in the
124 wrong order and do something other than what you intended.
125
This page took 0.053325 seconds and 5 git commands to generate.