doc/man-pages/pod/bos_shutdown.pod

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