=head1 NAME bos - Introduction to the bos command suite =head1 DESCRIPTION The commands in the B command suite are the administrative interface to the Basic OverSeer (BOS) Server, which runs on every file server machine to monitor the other server processes on it. If a process fails, the BOS Server can restart it automatically, taking into account interdependencies between it and other processes. The BOS Server frees system administrators from constantly monitoring the status of server machines and processes. There are several categories of commands in the B command suite: =over 4 =item * Commands to administer server process binary files: B, B, B, and B. =item * Commands to maintain system configuration files: B, B, B, B, B, B, B, B, B, and B. =item * Commands to start and stop processes: B, B, B, B, B, B, and B. =item * Commands to set and verify server process and server machine status: B, B, B, B, B, B and B. =item * A command to restore file system consistency: B. =item * Commands to obtain help: B and B. =item * A command to display the OpenAFS command suite version: B. =back The BOS Server and the B commands use and maintain the following configuration and log files: =over 4 =item * The F file lists the local cell's database server machines. These machines run the Authentication, Backup, Protection and Volume Location (VL) Server processes, which maintain databases of administrative information. The database server processes consult the file to learn about their peers, whereas the other server processes consult it to learn where to access database information as needed. To administer the F file, use the following commands: B, B, B, and B. =item * The F file lists the server encryption keys that the server processes use to decrypt tickets presented by client processes and one another. To administer the F file, use the following commands: B, B, and B. =item * The F file lists additional server encryption keys that the server processes can use to decrypt tickets presented by client processes and one another. These keys are strong encryption keys used by the rxkad-k5 extension; use L to manage the F. =item * The F file defines the cell to which the server machine belongs for the purposes of server-to-server communication. Administer it with the B command. There is also a F file that defines the machine's cell membership with respect to the AFS command suites and Cache Manager access to AFS data. =item * The F file lists the user name of each administrator authorized to issue privileged B and B commands. To administer the F file, use the following commands: B, B, and B. =item * The F file defines which AFS server processes run on the server machine, and whether the BOS Server restarts them automatically if they fail. It also defines when all processes restart automatically (by default once per week), when the BOS Server restarts processes that have new binary files (by default once per day), and whether the BOS Server will start in restricted mode. To administer the F file, use the following commands: B, B, B, B, B, B, B, and B. =item * The F file records important operations the BOS Server performs and error conditions it encounters. =back For more details, see the reference page for each file. =head1 OPTIONS The following arguments and flags are available on many commands in the B suite. The reference page for each command also lists them, but they are described here in greater detail. =over 4 =item B<-cell> > Names the cell in which to run the command. It is acceptable to abbreviate the cell name to the shortest form that distinguishes it from the other entries in the F file on the local machine. If the B<-cell> argument is omitted, the command interpreter determines the name of the local cell by reading the following in order: =over 4 =item * The value of the AFSCELL environment variable. =item * The local F file. =back Do not combine the B<-cell> and B<-localauth> options. A command on which the B<-localauth> flag is included always runs in the local cell (as defined in the server machine's local F file), whereas a command on which the B<-cell> argument is included runs in the specified foreign cell. =item B<-help> Prints a command's online help message on the standard output stream. Do not combine this flag with any of the command's other options; when it is provided, the command interpreter ignores all other options, and only prints the help message. =item B<-localauth> Constructs a server ticket using the server encryption key with the highest key version number in the local F or F file. The B command interpreter presents the ticket, which never expires, to the BOS Server during mutual authentication. Use this flag only when issuing a command on a server machine; client machines do not usually have a F or F file. The issuer of a command that includes this flag must be logged on to the server machine as the local superuser C. The flag is useful for commands invoked by an unattended application program, such as a process controlled by the UNIX B utility or by a cron entry in the machine's F file. It is also useful if an administrator is unable to authenticate to AFS but is logged in as the local superuser C. Do not combine the B<-cell> and B<-localauth> options. A command on which the B<-localauth> flag is included always runs in the local cell (as defined in the server machine's local F file), whereas a command on which the B<-cell> argument is included runs in the specified foreign cell. Also, do not combine the B<-localauth> and B<-noauth> flags. =item B<-noauth> Establishes an unauthenticated connection to the BOS Server, in which the BOS Server treats the issuer as the unprivileged user C. It is useful only when authorization checking is disabled on the server machine (during the installation of a file server machine or when the B command has been used during other unusual circumstances). In normal circumstances, the BOS Server allows only privileged users to issue commands that change the status of a server or configuration file, and refuses to perform such an action even if the B<-noauth> flag is provided. Do not combine the B<-noauth> and B<-localauth> flags. =item B<-server> > Indicates the AFS server machine on which to run the command. Identify the machine by its IP address in dotted decimal format, its fully-qualified host name (for example, C), or by an abbreviated form of its host name that distinguishes it from other machines. Successful use of an abbreviated form depends on the availability of a name service (such as the Domain Name Service or a local host table) at the time the command is issued. For the commands that alter the administrative files shared by all server machines in the cell (the B, B, B, B, B, and B commands), the appropriate machine depends on whether the cell uses the United States or international version of AFS: =over 4 =item * If the cell (as recommended) uses the Update Server to distribute the contents of the F directory, provide the name of the system control machine. After issuing the command, allow up to five minutes for the Update Server to distribute the changed file to the other AFS server machines in the cell. If the specified machine is not the system control machine but is running an B process that refers to the system control machine, then the change will be overwritten when the process next brings over the relevant file from the system control machine. =item * Otherwise, repeatedly issue the command, naming each of the cell's server machines in turn. To avoid possible inconsistency problems, finish issuing the commands within a fairly short time. =back =back =head1 PRIVILEGE REQUIRED To issue any bos command that changes a configuration file or alters process status, the issuer must be listed in the F file on the server machine named by the B<-server> argument. Alternatively, if the B<-localauth> flag is included the issuer must be logged on as the local superuser C. To issue a bos command that only displays information (other than the B command), no privilege is required. =head1 SEE ALSO L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.