summaryrefslogtreecommitdiff
path: root/usr.sbin/afs/src/appl/bos/bos.8
blob: f462eba748b886cc875e1f8df6fcb4ff78960636 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
.\" Copyright (c) 2000 Kungliga Tekniska Högskolan
.\" $KTH: bos.8,v 1.4 2000/08/30 06:27:00 lha Exp $
.Dd Aug 29, 2000
.Dt bos 8
.Os Arla
.Sh NAME
.Nm bos
.Nd is the client part of the Basic overseer daemon that manage AFS server processes.
.Sh SYNOPSIS
.Nm bos
.Op Ar addhost | addkey | adduser | create
.Op Ar args
.Nm bos
.Op Ar delete | exec | getdate | getlog
.Op Ar args
.Nm bos
.Op Ar getrestart | install | listhosts | listkeys
.Op Ar args
.Nm bos
.Op Ar listusers | prune | removehost | removekey
.Op Ar args
.Nm bos
.Op Ar removeuser | restart | salvage | setauth
.Op Ar args
.Nm bos
.Op Ar setcellname | setrestart | shutdown | start
.Op Ar args
.Nm bos
.Op Ar stop | uninstall
.Op Ar args
.Sh DESCRIPTION
The
.Nm
utility is the client part of the Basic overseer daemon that manage
AFS server processes.
.Pp
.Pp
Most
.Nm
commands accept the following general arguments:
.Pp
.Bd -filled -offset indent -compact
.Op Fl cell Ar cellname
Specifies which AFS cell to use, if the default cell is not to be used.
.Pp
.Op Fl noauth
Specifies that
.Nm
should not try to authenticate the connection to the server.
This may be
useful with shell scripts, or if there is a problem with the AFS cell.
Note that the server will reject many commands if
.Fl noauth
is specified.
.Pp
.Op Fl localauth
Create a ticket using the AFS server key, that is, you don't need a token.
This will generally only work on AFS servers, and is very useful for
performing automatic tasks.
.Ed
.Pp
.Nm
has several subcommands:
.Pp
.Ic addhost
.Fl server Ar server
.Fl host Ar host
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Add a new
.Ar host
to the CellServDB on the
.Ar server Ns .
This makes the database server consider
.Ar host
as a peer and will use when they synchronize their databases (the
database servers) need to be restarted.
.Ed
.Pp
.Ic addkey
.Fl server Ar server
.Op Fl key Ar key
.Op Fl kvno Ar keyversionnumber
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Add a new afs-key to the KeyFile.
Add the ticket specified in
.Ar key
with
.Ar keyversionnumber
to the
.Ar server .
.Ed
.Pp
.Ic adduser
.Fl server Ar server
.Fl user Ar user
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Add a new user the the SuperUser file on the fileserver
.Ar server ,
thus giving that user the right to manage volumes and bosserver.
.Ed
.Pp
.Ic create
.Fl server Ar server
.Fl instance Ar serverprocessname
.Fl type Ar servertype
.Fl cmd Ar command
.Op Fl notifier Ar program
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Create a new service
.Ar instance
at the
.Ar server
of
.Ar type.
The instance will depending on type run the
.Ar command
command.
.Ed
.Pp
.Ic delete
.Fl server Ar server
.Fl instance Ar instance
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Delete the
.Ar instance
from the
.Ar server .
.Ed
.Pp
.Ic exec
.Bd -filled -offset indent -compact
.Fl server Ar server
.Fl cmd Ar command
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
Execute
.Ar command
on the server
.Ar server .
.Ed
.Pp
.Ic getdate
.Fl server Ar server
.Fl files Ar checkfiles
.Op Fl dir Ar dir
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Get dates for
.Ar checkfiles
in server-root directory (that can be specified with
.Ar dir
if that is needed) on
.Ar server.
.Ed
.Pp
.Ic getlog
.Fl server Ar server
.Fl file Ar logfile
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
List the content of the
.Ar logfile
that resides on the
.Ar server.
.Ed
.Pp
.Ic getrestart
.Fl server Ar server
.Op Fl dir Ar dest
.Op Fl cell Ar cellname
.Op Fl noauth
.Op Fl localauth
.Bd -filled -offset indent -compact
Get the restart time from
.Ar server.
.Ed
.Pp
.Ic install
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic listhosts
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic listkeys
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic listusers
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic prune
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic removehost
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic removekey
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic removeuser
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic restart
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic salvage
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic setauth
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic setcellname
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic setrestart
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic shutdown
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic start
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic stop
.Bd -filled -offset indent -compact
.Ed
.Pp
.Ic uninstall
.Bd -filled -offset indent -compact
.Ed
.Pp
.Sh SEE ALSO
.Xr fs 1 ,
.Xr pts 1 ,
.Xr arlad 8 ,
.Xr vos 8
.Sh BUGS
Quite a lot of commands are not implemented yet.