3 bos_create - Defines a new process in the BosConfig file and starts it
10 B<bos create> S<<< B<-server> <I<machine name>> >>>
11 S<<< B<-instance> <I<server process name>> >>> S<<< B<-type> <I<server type>> >>>
12 S<<< B<-cmd> <I<command lines>>+ >>> S<<< [B<-notifier> <I<notifier program>>] >>>
13 S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
15 B<bos c> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>> >>>
16 S<<< B<-t> <I<server type>> >>> S<<< B<-cm> <I<command lines>>+ >>>
17 S<<< [B<-not> <I<notifier program>>] >>> S<<< [B<-ce> <I<cell name>>] >>> [B<-noa>]
25 The B<bos create> command creates a server process entry in the
26 F</usr/afs/local/BosConfig> file on the server machine named by the
27 B<-server> argument, sets the process's status to C<Run> in the
28 F<BosConfig> file and in memory, and starts the process.
30 A server process's entry in the F<BosConfig> file defines its name, its
31 type, the command that initializes it, and optionally, the name of a
32 notifier program that runs when the process terminates.
38 =item B<-server> <I<machine name>>
40 Indicates the server machine on which to define and start the new
41 process. Identify the machine by IP address or its host name (either
42 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
44 =item B<-instance> <I<server process name>>
46 Names the process to define and start. Any name is acceptable, but for the
47 sake of simplicity it is best to use the last element of the process's
48 binary file pathname (or the instance type for B<fs> and B<dafs>), and to
49 use the same name on every server machine. The conventional names, as used
50 in all AFS documentation, are:
56 The Backup Server process.
60 The process that combines the Demand Attach File Server, Volume Server,
61 Salvageserver and Salvager processes (B<fileserver>, B<volserver>,
62 B<salvageserver>, and B<salvager>).
66 The process that combines the File Server, Volume Server, and Salvager
67 processes (B<fileserver>, B<volserver>, and B<salvager>).
71 The Authentication Server process.
75 The Protection Server process.
79 The controller process for the Network Time Protocol Daemon (obsolete).
83 The client portion of the Update Server process that retrieves binary
84 files from the F</usr/afs/bin> directory of the binary distribution
85 machine for this machine's CPU/operating system type. (The name of the
86 binary is B<upclient>, but the C<bin> suffix distinguishes this process
91 The client portion of the Update Server process that retrieves
92 configuration files from the F</usr/afs/etc> directory of the system
93 control machine. (The name of the binary is B<upclient>, but the C<etc>
94 suffix distinguishes this process from C<upclientbin>.)
98 The server portion of the Update Server process.
102 The Volume Location (VL) Server process.
106 =item B<-type> <I<server type>>
108 Specifies the process's type. The acceptable values are:
114 Use this value for cron-type processes that the BOS Server starts only at
115 a defined daily or weekly time, rather than whenever it detects that the
116 process has terminated. AFS does not define any such processes by default,
117 but makes this value available for administrator use. Define the time for
118 command execution as part of the B<-cmd> argument to the B<bos create>
123 Use this value only for the dafs process, which combines the File Server,
124 Volume Server, Salvageserver, and Salvager processes in order to operate
125 as a Demand Attach File Server. If one of the component processes
126 terminates, the BOS Server shuts down and restarts the process in the
131 Use this value only for the fs process, which combines the File Server,
132 Volume Server and Salvager processes. If one of the component processes
133 terminates, the BOS Server shuts down and restarts the processes in the
138 Use this value for all processes listed as acceptable values to the
139 B<-instance> argument, except for the B<fs> and B<dafs> processes.
140 There are no interdependencies between simple processes, so the
141 BOS Server can stop and start them independently as necessary.
145 =item B<-cmd> <I<command lines>>+
147 Specifies each command the BOS Server runs to start the process. Specify
148 no more than six commands (which can include the command's options, in
149 which case the entire string is surrounded by double quotes); any
150 additional commands are ignored.
152 For a simple process, provide the complete pathname of the process's
153 binary file on the local disk (for example, F</usr/afs/bin/ptserver> for
154 the Protection Server). If including any of the initialization command's
155 options, surround the entire command in double quotes (C<"">). The
156 B<upclient> process has a required argument, and the commands for all
157 other processes take optional arguments.
159 For the fs process, provide the complete pathname of the local disk binary
160 file for each of the component processes: B<fileserver>, B<volserver>, and
161 B<salvager>, in that order. The standard binary directory is
162 F</usr/afs/bin>. If including any of an initialization command's options,
163 surround the entire command in double quotes (C<"">).
165 For a cron process, provide two parameters:
171 The complete local disk pathname of either an executable file or a command
172 from one of the AFS suites (complete with all of the necessary
173 arguments). Surround this parameter with double quotes (C<"">) if it
178 A specification of when the BOS Server executes the file or command
179 indicated by the first parameter. There are three acceptable values:
185 The string C<now>, which directs the BOS Server to execute the file or
186 command immediately and only once. It is usually simpler to issue the
187 command directly or issue the B<bos exec> command.
191 A time of day. The BOS Server executes the file or command daily at the
192 indicated time. Separate the hours and minutes with a colon (I<hh:MM>),
193 and use either 24-hour format, or a value in the range from C<1:00>
194 through C<12:59> with the addition of C<am> or C<pm>. For example, both
195 C<14:30> and C<"2:30 pm"> indicate 2:30 in the afternoon. Surround this
196 parameter with double quotes (C<"">) if it contains a space.
200 A day of the week and time of day, separated by a space and surrounded
201 with double quotes (C<"">). The BOS Server executes the file or command
202 weekly at the indicated day and time. For the day, provide either the
203 whole name or the first three letters, all in lowercase letters (C<sunday>
204 or C<sun>, C<thursday> or C<thu>, and so on). For the time, use the same
205 format as when specifying the time alone.
211 =item B<-notifier> <I<notifier program>>
213 Specifies the complete pathname on the local disk of a program that the
214 BOS Server invokes when the process terminates. The AFS distribution does
215 not include any notifier programs, but this argument is available for
216 administrator use. See L<NOTES>.
218 =item B<-cell> <I<cell name>>
220 Names the cell in which to run the command. Do not combine this argument
221 with the B<-localauth> flag. For more details, see L<bos(8)>.
225 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
226 combine this flag with the B<-localauth> flag. For more details, see
231 Constructs a server ticket using a key from the local
232 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
233 ticket to the BOS Server during mutual authentication. Do not combine this
234 flag with the B<-cell> or B<-noauth> options. For more details, see
239 Prints the online help for this command. All other valid options are
246 The following command defines and starts the simple process
247 C<kaserver> on the machine C<fs3.abc.com>:
249 % bos create -server fs3.abc.com -instance kaserver -type simple \
250 -cmd /usr/afs/bin/kaserver
252 The following command defines and starts the simple process C<upclientbin>
253 on the machine C<fs4.abc.com>. It references C<fs1.abc.com> as the source
254 for updates to binary files, checking for changes to the F</usr/afs/bin>
255 directory every 120 seconds.
257 % bos create -server fs4.abc.com -instance upclientbin -type simple \
258 -cmd "/usr/afs/bin/upclient fs1.abc.com -clear -t 120 \
261 The following command creates the fs process fs on the machine
262 C<fs4.abc.com>. Type the command on a single line.
264 % bos create -server fs4.abc.com -instance fs -type fs \
265 -cmd /usr/afs/bin/fileserver /usr/afs/bin/volserver \
266 /usr/afs/bin/salvager
268 The following command creates the dafs process dafs on the machine
269 C<fs4.abc.com>. Type the command on a single line.
271 % bos create -server fs4.abc.com -instance dafs -type dafs \
272 -cmd /usr/afs/bin/fileserver /usr/afs/bin/volserver \
273 /usr/afs/bin/salvageserver /usr/afs/bin/salvager
275 The following command creates a cron process called C<userbackup> on the
276 machine C<fs5.abc.com>, so that the BOS Server issues the indicated B<vos
277 backupsys> command each day at 3:00 a.m. (the command creates a backup
278 version of every volume in the file system whose name begins with
279 C<user>). Note that the issuer provides the complete pathname to the
280 B<vos> command, includes the B<-localauth> flag on it, and types the
281 entire B<bos create> command on one line.
283 % bos create -server fs5.abc.com -instance userbackup -type cron \
284 -cmd "/usr/afs/bin/vos backupsys -prefix user -localauth" 03:00
286 =head1 PRIVILEGE REQUIRED
288 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
289 machine named by the B<-server> argument, or must be logged onto a server
290 machine as the local superuser C<root> if the B<-localauth> flag is
295 If the B<-notifier> argument is included when this command is used to
296 define and start a process, the BOS Server invokes the indicated
297 I<notifier program> when the process exits. The intended use of a notifier
298 program is to inform administrators when a process exits unexpectedly, but
299 it can be used to perform any appropriate actions. The following
300 paragraphs describe the bnode and bnode_proc structures in which the
301 BOS Server records information about the exiting process.
303 The BOS Server constructs and sends on the standard output stream one
304 bnode and one bnode_proc structure for each exiting process associated
305 with the notifier program. It brackets each structure with appropriate
306 C<BEGIN> and C<END> statements (C<BEGIN bnode> and C<END bnode>, C<BEGIN
307 bnode_proc> and C<END bnode_proc>), which immediately follow the preceding
308 newline character with no intervening spaces or other characters. If the
309 notifier program does not need information from a structure, it can scan
310 ahead in the input stream for the C<END> statement.
312 In general, each field in a structure is a string of ASCII text terminated
313 by the newline character. The format of the information within a structure
314 possibly varies slightly depending on the type of process associated with
315 the notifier program.
317 The C code for the bnode and bnode_proc structures follows. Note that the
318 structures sent by the BOS Server do not necessarily include all of the
319 fields described here, because some are used only for internal record
320 keeping. The notifier process must robustly handle the absence of expected
321 fields, as well as the presence of unexpected fields, on the standard
324 For proper performance, the notifier program must continue processing the
325 input stream until it detects the end-of-file (EOF). The BOS Server closes
326 the standard input file descriptor to the notifier process when it has
327 completed delivery of the data, and it is the responsibility of the
328 notifier process to terminate properly.
330 struct bnode contents:
333 struct bnode *next; /* next pointer in top-level's list */
334 char *name; /* instance name */
335 long nextTimeout; /* next time this guy should be awakened */
336 long period; /* period between calls */
337 long rsTime; /* time we started counting restarts */
338 long rsCount; /* count of restarts since rsTime */
339 struct bnode_type *type; /* type object */
340 struct bnode_ops *ops; /* functions implementing bnode class */
341 long procStartTime; /* last time a process was started */
342 long procStarts; /* number of process starts */
343 long lastAnyExit; /* last time a process exited for any reason */
344 long lastErrorExit; /* last time a process exited unexpectedly */
345 long errorCode; /* last exit return code */
346 long errorSignal; /* last proc terminating signal */
347 char *lastErrorName; /* name of proc that failed last */
348 short refCount; /* reference count */
349 short flags; /* random flags */
350 char goal; /* 1=running or 0=not running */
351 char fileGoal; /* same, but to be stored in file */
354 Format of struct bnode explosion:
356 printf("name: %s\n",tp->name);
357 printf("rsTime: %ld\n", tp->rsTime);
358 printf("rsCount: %ld\n", tp->rsCount);
359 printf("procStartTime: %ld\n", tp->procStartTime);
360 printf("procStarts: %ld\n", tp->procStarts);
361 printf("lastAnyExit: %ld\n", tp->lastAnyExit);
362 printf("lastErrorExit: %ld\n", tp->lastErrorExit);
363 printf("errorCode: %ld\n", tp->errorCode);
364 printf("errorSignal: %ld\n", tp->errorSignal);
365 printf("lastErrorName: %s\n", tp->lastErrorName);
366 printf("goal: %d\n", tp->goal);
368 struct bnode_proc contents:
371 struct bnode_proc *next; /* next guy in top-level's list */
372 struct bnode *bnode; /* bnode creating this process */
373 char *comLine; /* command line used to start this process */
374 char *coreName; /* optional core file component name */
375 long pid; /* pid if created */
376 long lastExit; /* last termination code */
377 long lastSignal; /* last signal that killed this guy */
378 long flags; /* flags giving process state */
381 Format of struct bnode_proc explosion:
383 printf("comLine: %s\n", tp->comLine);
384 printf("coreName: %s\n", tp->coreName);
385 printf("pid: %ld\n", tp->pid);
386 printf("lastExit: %ld\n", tp->lastExit);
387 printf("lastSignal: %ld\n", tp->lastSignal);
409 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
411 This documentation is covered by the IBM Public License Version 1.0. It was
412 converted from HTML to POD by software written by Chas Williams and Russ
413 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.