source: trunk/third/moira/man/stella.1 @ 25198

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