doc/man-pages/pod8/bos_shutdown.pod

   1 =head1 NAME
   2
   3 bos_shutdown - Stops a process without changing its status flag
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos shutdown> S<<< B<-server> <I<machine name>> >>>
  11     S<<< [B<-instance> <I<instances>>+] >>> [B<-wait>] S<<< [B<-cell> <I<cell name>>] >>>
  12     [B<-noauth>] [B<-localauth>] [B<-help>]
  13
  14 B<bos sh> S<<< B<-s> <I<machine name>> >>> S<<< [B<-i> <I<instances>>+] >>> [B<-w>]
  15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<bos shutdown> command stops, on the server machine named by the
  23 B<-server> argument, either
  24
  25 =over 4
  26
  27 =item *
  28
  29 All of the currently running AFS server processes, except the BOS Server.
  30
  31 =item *
  32
  33 Only the processes specified by the B<-instance> argument.
  34
  35 =back
  36
  37 This command does not change a process's status flag in the
  38 F</usr/afs/local/BosConfig> file, but only in the BOS Server's memory. To
  39 stop a process and change its F<BosConfig> status flag, use the B<bos
  40 stop> command instead.
  41
  42 Once stopped with this command, a process does not run again until an
  43 administrator starts it by using the B<bos start>, B<bos startup>, or
  44 B<bos restart> command, or until the BOS Server restarts (assuming that
  45 the process's F<BosConfig> status flag is C<Run>).
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<-server> <I<machine name>>
  52
  53 Indicates the server machine on which to stop processes. Identify the
  54 machine by IP address or its host name (either fully-qualified or
  55 abbreviated unambiguously). For details, see L<bos(8)>.
  56
  57 =item B<-instance> <I<instances>>+
  58
  59 Names each process to stop. Use the process name assigned with the
  60 B<-instance> argument to the B<bos create> command. The output from the
  61 B<bos status> command lists the names. Omit this argument to stop all
  62 processes other than the BOS Server.
  63
  64 =item B<-wait>
  65
  66 Delays the return of the command shell prompt until all processes actually
  67 stop. If this argument is omitted, the prompt returns almost immediately
  68 even if all processes are not stopped.
  69
  70 =item B<-cell> <I<cell name>>
  71
  72 Names the cell in which to run the command. Do not combine this argument
  73 with the B<-localauth> flag. For more details, see L<bos(8)>.
  74
  75 =item B<-noauth>
  76
  77 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  78 combine this flag with the B<-localauth> flag. For more details, see
  79 L<bos(8)>.
  80
  81 =item B<-localauth>
  82
  83 Constructs a server ticket using a key from the local
  84 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
  85 ticket to the BOS Server during mutual authentication. Do not combine this
  86 flag with the B<-cell> or B<-noauth> options. For more details, see
  87 L<bos(8)>.
  88
  89 =item B<-help>
  90
  91 Prints the online help for this command. All other valid options are
  92 ignored.
  93
  94 =back
  95
  96 =head1 EXAMPLES
  97
  98 The following command stops all processes other than the BOS Server on the
  99 machine C<fs3.example.com>.
 100
 101    % bos shutdown fs3.example.com
 102
 103 The following command stops the C<upserver> process (server portion of the
 104 Update Server) on the machine C<fs5.example.com>.
 105
 106    % bos shutdown -server fs5.example.com -instance upserver
 107
 108 =head1 PRIVILEGE REQUIRED
 109
 110 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 111 machine named by the B<-server> argument, or must be logged onto a server
 112 machine as the local superuser C<root> if the B<-localauth> flag is
 113 included.
 114
 115 =head1 SEE ALSO
 116
 117 L<BosConfig(5)>,
 118 L<KeyFile(5)>,
 119 L<UserList(5)>,
 120 L<bos(8)>,
 121 L<bos_create(8)>,
 122 L<bos_restart(8)>,
 123 L<bos_start(8)>,
 124 L<bos_startup(8)>,
 125 L<bos_status(8)>
 126
 127 =head1 COPYRIGHT
 128
 129 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 130
 131 This documentation is covered by the IBM Public License Version 1.0.  It was
 132 converted from HTML to POD by software written by Chas Williams and Russ
 133 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.