doc/man-pages/pod8/bos.pod

   1 =head1 NAME
   2
   3 bos - Introduction to the bos command suite
   4
   5 =head1 DESCRIPTION
   6
   7 The commands in the B<bos> command suite are the administrative interface
   8 to the Basic OverSeer (BOS) Server, which runs on every file server
   9 machine to monitor the other server processes on it. If a process fails,
  10 the BOS Server can restart it automatically, taking into account
  11 interdependencies between it and other processes. The BOS Server frees
  12 system administrators from constantly monitoring the status of server
  13 machines and processes.
  14
  15 There are several categories of commands in the B<bos> command suite:
  16
  17 =over 4
  18
  19 =item *
  20
  21 Commands to administer server process binary files: B<bos getdate>, B<bos
  22 install>, B<bos prune>, and B<bos uninstall>.
  23
  24 =item *
  25
  26 Commands to maintain system configuration files: B<bos addhost>, B<bos
  27 addkey>, B<bos adduser>, B<bos listhosts>, B<bos listkeys>, B<bos
  28 listusers>, B<bos removehost>, B<bos removekey>, B<bos removeuser>, and
  29 B<bos setcellname>.
  30
  31 =item *
  32
  33 Commands to start and stop processes: B<bos create>, B<bos delete>, B<bos
  34 restart>, B<bos shutdown>, B<bos start>, B<bos startup>, and B<bos stop>.
  35
  36 =item *
  37
  38 Commands to set and verify server process and server machine status: B<bos
  39 getlog>, B<bos getrestart>, B<bos getrestricted>, B<bos setauth>,
  40 B<bos setrestart>, B<bos setrestricted> and B<bos status>.
  41
  42 =item *
  43
  44 A command to restore file system consistency: B<bos salvage>.
  45
  46 =item *
  47
  48 Commands to obtain help: B<bos apropos> and B<bos help>.
  49
  50 =back
  51
  52 The BOS Server and the B<bos> commands use and maintain the following
  53 configuration and log files:
  54
  55 =over 4
  56
  57 =item *
  58
  59 The F</usr/afs/etc/CellServDB> file lists the local cell's database server
  60 machines. These machines run the Authentication, Backup, Protection and
  61 Volume Location (VL) Server processes, which maintain databases of
  62 administrative information. The database server processes consult the file
  63 to learn about their peers, whereas the other server processes consult it
  64 to learn where to access database information as needed. To administer the
  65 F<CellServDB> file, use the following commands: B<bos addhost>, B<bos
  66 listhosts>, B<bos removehost>, and B<bos setcellname>.
  67
  68 =item *
  69
  70 The F</usr/afs/etc/KeyFile> file lists the server encryption keys that the
  71 server processes use to decrypt tickets presented by client processes and
  72 one another. To administer the F<KeyFile> file, use the following
  73 commands: B<bos addkey>, B<bos listkeys>, and B<bos removekey>.
  74
  75 =item *
  76
  77 The F</usr/afs/etc/KeyFileExt> file lists additional server encryption
  78 keys that the server processes can use to decrypt tickets presented by
  79 client processes and one another. These keys are strong encryption
  80 keys used by the rxkad-k5 extension; use L<asetkey(8)> to manage the
  81 F<KeyFileExt>.
  82
  83 =item *
  84
  85 The F</usr/afs/etc/ThisCell> file defines the cell to which the server
  86 machine belongs for the purposes of server-to-server communication.
  87 Administer it with the B<bos setcellname> command. There is also a
  88 F</usr/vice/etc/ThisCell> file that defines the machine's cell membership
  89 with respect to the AFS command suites and Cache Manager access to AFS
  90 data.
  91
  92 =item *
  93
  94 The F</usr/afs/etc/UserList> file lists the user name of each
  95 administrator authorized to issue privileged B<bos> and B<vos>
  96 commands. To administer the F<UserList> file, use the following commands:
  97 B<bos adduser>, B<bos listusers>, and B<bos removeuser>.
  98
  99 =item *
 100
 101 The F</usr/afs/local/BosConfig> file defines which AFS server processes
 102 run on the server machine, and whether the BOS Server restarts them
 103 automatically if they fail. It also defines when all processes restart
 104 automatically (by default once per week), when the BOS Server restarts
 105 processes that have new binary files (by default once per day), and
 106 whether the BOS Server will start in restricted mode. To
 107 administer the F<BosConfig> file, use the following commands: B<bos
 108 create>, B<bos delete>, B<bos getrestart>, B<bos getrestricted>, B<bos
 109 setrestart>, B<bos setrestricted>, B<bos start>, and B<bos stop>.
 110
 111 =item *
 112
 113 The F</usr/afs/log/BosLog> file records important operations the BOS
 114 Server performs and error conditions it encounters.
 115
 116 =back
 117
 118 For more details, see the reference page for each file.
 119
 120 =head1 OPTIONS
 121
 122 The following arguments and flags are available on many commands in the
 123 B<bos> suite. The reference page for each command also lists them, but
 124 they are described here in greater detail.
 125
 126 =over 4
 127
 128 =item B<-cell> <I<cell name>>
 129
 130 Names the cell in which to run the command. It is acceptable to abbreviate
 131 the cell name to the shortest form that distinguishes it from the other
 132 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
 133 the B<-cell> argument is omitted, the command interpreter determines the
 134 name of the local cell by reading the following in order:
 135
 136 =over 4
 137
 138 =item *
 139
 140 The value of the AFSCELL environment variable.
 141
 142 =item *
 143
 144 The local F</usr/vice/etc/ThisCell> file.
 145
 146 =back
 147
 148 Do not combine the B<-cell> and B<-localauth> options. A command on which
 149 the B<-localauth> flag is included always runs in the local cell (as
 150 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
 151 whereas a command on which the B<-cell> argument is included runs in the
 152 specified foreign cell.
 153
 154 =item B<-help>
 155
 156 Prints a command's online help message on the standard output stream. Do
 157 not combine this flag with any of the command's other options; when it is
 158 provided, the command interpreter ignores all other options, and only
 159 prints the help message.
 160
 161 =item B<-localauth>
 162
 163 Constructs a server ticket using the server encryption key with the
 164 highest key version number in the local F</usr/afs/etc/KeyFile> or
 165 F</usr/afs/etc/KeyFileExt> file. The
 166 B<bos> command interpreter presents the ticket, which never expires, to
 167 the BOS Server during mutual authentication.
 168
 169 Use this flag only when issuing a command on a server machine; client
 170 machines do not usually have a F</usr/afs/etc/KeyFile> or
 171 F</usr/afs/etc/KeyFileExt> file.  The issuer
 172 of a command that includes this flag must be logged on to the server
 173 machine as the local superuser C<root>. The flag is useful for commands
 174 invoked by an unattended application program, such as a process controlled
 175 by the UNIX B<cron> utility or by a cron entry in the machine's
 176 F</usr/afs/local/BosConfig> file. It is also useful if an administrator is
 177 unable to authenticate to AFS but is logged in as the local superuser
 178 C<root>.
 179
 180 Do not combine the B<-cell> and B<-localauth> options. A command on which
 181 the B<-localauth> flag is included always runs in the local cell (as
 182 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
 183 whereas a command on which the B<-cell> argument is included runs in the
 184 specified foreign cell. Also, do not combine the B<-localauth> and
 185 B<-noauth> flags.
 186
 187 =item B<-noauth>
 188
 189 Establishes an unauthenticated connection to the BOS Server, in which the
 190 BOS Server treats the issuer as the unprivileged user C<anonymous>. It is
 191 useful only when authorization checking is disabled on the server machine
 192 (during the installation of a file server machine or when the B<bos
 193 setauth> command has been used during other unusual circumstances). In
 194 normal circumstances, the BOS Server allows only privileged users to issue
 195 commands that change the status of a server or configuration file, and
 196 refuses to perform such an action even if the B<-noauth> flag is
 197 provided. Do not combine the B<-noauth> and B<-localauth> flags.
 198
 199 =item B<-server> <I<machine name>>
 200
 201 Indicates the AFS server machine on which to run the command.  Identify
 202 the machine by its IP address in dotted decimal format, its
 203 fully-qualified host name (for example, C<fs1.example.com>), or by an
 204 abbreviated form of its host name that distinguishes it from other
 205 machines. Successful use of an abbreviated form depends on the
 206 availability of a name service (such as the Domain Name Service or a local
 207 host table) at the time the command is issued.
 208
 209 For the commands that alter the administrative files shared by all server
 210 machines in the cell (the B<bos addhost>, B<bos addkey>, B<bos adduser>,
 211 B<bos removehost>, B<bos removekey>, and B<bos removeuser> commands), the
 212 appropriate machine depends on whether the cell uses the United States or
 213 international version of AFS:
 214
 215 =over 4
 216
 217 =item *
 218
 219 If the cell (as recommended) uses the Update Server to distribute the
 220 contents of the F</usr/afs/etc> directory, provide the name of the system
 221 control machine. After issuing the command, allow up to five minutes for
 222 the Update Server to distribute the changed file to the other AFS server
 223 machines in the cell. If the specified machine is not the system control
 224 machine but is running an B<upclient> process that refers to the system
 225 control machine, then the change will be overwritten when the process next
 226 brings over the relevant file from the system control machine.
 227
 228 =item *
 229
 230 Otherwise, repeatedly issue the command, naming each of the cell's server
 231 machines in turn. To avoid possible inconsistency problems, finish issuing
 232 the commands within a fairly short time.
 233
 234 =back
 235
 236 =back
 237
 238 =head1 PRIVILEGE REQUIRED
 239
 240 To issue any bos command that changes a configuration file or alters
 241 process status, the issuer must be listed in the F</usr/afs/etc/UserList>
 242 file on the server machine named by the B<-server>
 243 argument. Alternatively, if the B<-localauth> flag is included the issuer
 244 must be logged on as the local superuser C<root>.
 245
 246 To issue a bos command that only displays information (other than the
 247 B<bos listkeys> command), no privilege is required.
 248
 249 =head1 SEE ALSO
 250
 251 L<BosConfig(5)>,
 252 L<CellServDB(5)>,
 253 L<KeyFile(5)>,
 254 L<KeyFileExt(5)>,
 255 L<ThisCell(5)>,
 256 L<UserList(5)>,
 257 L<bos_addhost(8)>,
 258 L<bos_addkey(8)>,
 259 L<bos_adduser(8)>,
 260 L<bos_apropos(8)>,
 261 L<bos_create(8)>,
 262 L<bos_delete(8)>,
 263 L<bos_exec(8)>,
 264 L<bos_getdate(8)>,
 265 L<bos_getlog(8)>,
 266 L<bos_getrestart(8)>,
 267 L<bos_getrestricted(8)>,
 268 L<bos_help(8)>,
 269 L<bos_install(8)>,
 270 L<bos_listhosts(8)>,
 271 L<bos_listkeys(8)>,
 272 L<bos_listusers(8)>,
 273 L<bos_prune(8)>,
 274 L<bos_removehost(8)>,
 275 L<bos_removekey(8)>,
 276 L<bos_removeuser(8)>,
 277 L<bos_restart(8)>,
 278 L<bos_salvage(8)>,
 279 L<bos_setauth(8)>,
 280 L<bos_setcellname(8)>,
 281 L<bos_setrestart(8)>,
 282 L<bos_setrestricted(8)>,
 283 L<bos_shutdown(8)>,
 284 L<bos_start(8)>,
 285 L<bos_startup(8)>,
 286 L<bos_status(8)>,
 287 L<bos_stop(8)>,
 288 L<bos_uninstall(8)>
 289
 290 =head1 COPYRIGHT
 291
 292 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 293
 294 This documentation is covered by the IBM Public License Version 1.0.  It was
 295 converted from HTML to POD by software written by Chas Williams and Russ
 296 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.