type, the command that initializes it, and optionally, the name of a
notifier program that runs when the process terminates.
+=head1 CAUTIONS
+
+A server process entry of type B<fs> as described below will not work with
+a demand-attach File Server, and a server process entry of type B<dafs>
+for a demand-attach File Server will not work with a traditional File
+Server. When switching from one File Server implementation to another,
+remove the existing server process entry and create a new one. See
+L</EXAMPLES> below for an example of switching from a traditional File
+Server to a demand-attach File Server.
+
=head1 OPTIONS
=over 4
Names the process to define and start. Any name is acceptable, but for the
sake of simplicity it is best to use the last element of the process's
-binary file pathname, and to use the same name on every server
-machine. The conventional names, as used in all AFS documentation, are:
+binary file pathname (or the instance type for B<fs> and B<dafs>), and to
+use the same name on every server machine. The conventional names, as used
+in all AFS documentation, are:
=over 4
The Backup Server process.
+=item dafs
+
+The process that combines the Demand Attach File Server, Volume Server,
+Salvageserver and Salvager processes (B<dafileserver>, B<davolserver>,
+B<salvageserver>, and B<dasalvager>).
+
=item fs
The process that combines the File Server, Volume Server, and Salvager
=item runntp
-The controller process for the Network Time Protocol Daemon.
+The controller process for the Network Time Protocol Daemon (obsolete).
=item upclientbin
=item dafs
-Use this value only for the dafs process, which combines the
-File Server, Volume Server, Salvageserver, and Salvager processes in
-order to operate as a Demand Attach File Server. If one of the
-component processes terminates, the BOS Server shuts down
-and restarts the process in the appropriate order.
+Use this value only for the dafs process, which combines the File Server,
+Volume Server, Salvage Server, and Salvager processes in order to operate
+as a Demand Attach File Server. If one of the component processes
+terminates, the BOS Server shuts down and restarts the process in the
+appropriate order.
=item fs
=item simple
Use this value for all processes listed as acceptable values to the
-B<-instance> argument, except for the B<fs> process. There are no
-interdependencies between simple processes, so the BOS Server can stop and
-start them independently as necessary.
+B<-instance> argument, except for the B<fs> and B<dafs> processes.
+There are no interdependencies between simple processes, so the
+BOS Server can stop and start them independently as necessary.
=back
B<upclient> process has a required argument, and the commands for all
other processes take optional arguments.
-For the fs process, provide the complete pathname of the local disk binary
-file for each of the component processes: B<fileserver>, B<volserver>, and
-B<salvager>, in that order. The standard binary directory is
-F</usr/afs/bin>. If including any of an initialization command's options,
-surround the entire command in double quotes (C<"">).
+For the B<fs> process, provide the complete pathname of the local disk
+binary file for each of the component processes: B<fileserver>,
+B<volserver>, and B<salvager>, in that order. The standard binary
+directory is F</usr/afs/bin>. If including any of an initialization
+command's options, surround the entire command in double quotes (C<"">).
+
+For the B<dafs> process, provide the complete pathname of the local disk
+binary file for each of the component processes: B<dafileserver>,
+B<davolserver>, B<salvageserver>, and B<dasalvager>, in that order. The
+standard binary directory is F</usr/afs/bin>. If including any of an
+initialization command's options, surround the entire command in double
+quotes (C<"">).
For a cron process, provide two parameters:
Specifies the complete pathname on the local disk of a program that the
BOS Server invokes when the process terminates. The AFS distribution does
not include any notifier programs, but this argument is available for
-administrator use. See L<NOTES>.
+administrator use. See L</NOTES>.
=item B<-cell> <I<cell name>>
=head1 EXAMPLES
The following command defines and starts the simple process
-C<kaserver> on the machine C<fs3.abc.com>:
+C<ptserver> on the machine C<fs3.abc.com>:
- % bos create -server fs3.abc.com -instance kaserver -type simple \
- -cmd /usr/afs/bin/kaserver
+ % bos create -server fs3.abc.com -instance ptserver -type simple \
+ -cmd /usr/afs/bin/ptserver
The following command defines and starts the simple process C<upclientbin>
on the machine C<fs4.abc.com>. It references C<fs1.abc.com> as the source
-cmd "/usr/afs/bin/upclient fs1.abc.com -clear -t 120 \
/usr/afs/bin"
-The following command creates the fs process fs on the machine
-C<fs4.abc.com>. Type the command on a single line.
+The following command creates the B<fs> process C<fs> on the machine
+C<fs4.abc.com> (a traditional File Server with associated processes). Type
+the command on a single line.
% bos create -server fs4.abc.com -instance fs -type fs \
-cmd /usr/afs/bin/fileserver /usr/afs/bin/volserver \
/usr/afs/bin/salvager
+The following command creates the B<dafs> process C<dafs> on the machine
+C<fs4.abc.com> (a demand-attach File Server with associated processes).
+Type the command on a single line.
+
+ % bos create -server fs4.abc.com -instance dafs -type dafs \
+ -cmd /usr/afs/bin/dafileserver \
+ /usr/afs/bin/davolserver \
+ /usr/afs/bin/salvageserver /usr/afs/bin/dasalvager
+
The following command creates a cron process called C<userbackup> on the
machine C<fs5.abc.com>, so that the BOS Server issues the indicated B<vos
backupsys> command each day at 3:00 a.m. (the command creates a backup
% bos create -server fs5.abc.com -instance userbackup -type cron \
-cmd "/usr/afs/bin/vos backupsys -prefix user -localauth" 03:00
+To switch from a traditional File Server to a demand-attach File Server,
+run:
+
+ % bos status localhost -instance fs -long
+
+to see the current B<fileserver> and B<volserver> flags for an existing
+traditional File Server configuration. (Substitute the C<dafs> instance
+for an existing demand-attach File Server.) Then, run:
+
+ % bos stop localhost fs -localauth
+ % bos delete localhost fs -localauth
+ % bos create localhost dafs dafs \
+ "/usr/afs/bin/dafileserver <fileserver-flags>" \
+ "/usr/afs/bin/davolserver <volserver-flags>" \
+ /usr/afs/bin/salvageserver /usr/afs/bin/dasalvager
+
+replacing <fileserver-flags> and <volserver-flags> with the flags from the
+previous configuration. This will stop the traditional File Server and
+start a demand-attach File Server. The binaries at the paths provided must
+already be updated to binaries built with demand-attach enabled.
+
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine as the local superuser C<root> if the B<-localauth> flag is
included.
+The B<bos create> command cannot be run against servers which are in
+restricted mode.
+
=head1 NOTES
If the B<-notifier> argument is included when this command is used to
L<UserList(5)>,
L<bos(8)>,
L<buserver(8)>,
+L<dafileserver(8)>,
+L<dasalvager(8)>,
+L<davolserver(8)>,
L<fileserver(8)>,
L<kaserver(8)>,
L<ptserver(8)>,
L<salvager(8)>,
+L<salvageserver(8)>,
L<upclient(8)>,
L<upserver(8)>,
L<vlserver(8)>,
git://git.openafs.org / openafs.git / blobdiff