doc/man-pages/pod8/bos_setrestart.pod

   1 =head1 NAME
   2
   3 bos_setrestart - Sets when the BOS Server restarts processes
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos setrestart> S<<< B<-server> <I<machine name>> >>>
  11     S<<< B<-time> <I<time to restart server>> >>> [B<-general>] [B<-newbinary>]
  12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
  13
  14 B<bos setr> S<<< B<-s> <I<machine name>> >>> S<<< B<-t> <I<time to restart server>> >>>
  15     [B<-g>] [B<-ne>] S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<bos setrestart> command records in the F</usr/afs/local/BosConfig>
  23 file the times at which the BOS Server running on the server machine named
  24 by the B<-server> argument performs two types of restarts:
  25
  26 =over 4
  27
  28 =item *
  29
  30 A I<general restart>. The BOS Server will restart itself,
  31 and then any AFS process marked with the C<Run> status flag in the
  32 F<BosConfig> file (equivalent in effect to issuing the B<bos restart>
  33 command with the B<-bosserver> flag) at this time each week. By default,
  34 in a new bos installation, general restarts are disabled.
  35
  36 =item *
  37
  38 A I<binary restart>. By default, once per day the BOS Server restarts any
  39 currently running process for which the timestamp on the binary file in
  40 the F</usr/afs/bin> directory is later than the time the process last
  41 started or restarted. The default is 5:00 a.m. each day.
  42
  43 =back
  44
  45 =head1 CAUTIONS
  46
  47 Restarting a process makes it unavailable for a period of time. The B<fs>
  48 process has potentially the longest outage, depending on how many volumes
  49 the file server machine houses (the File Server and Volume Server reattach
  50 each volume when they restart). The default settings are designed to
  51 coincide with periods of low usage, so that the restarts disturb the
  52 smallest possible number of users.
  53
  54 If the setting specified with the B<-time> argument is within one hour of
  55 the current time, the BOS Server does not restart any processes until the
  56 next applicable opportunity (the next day for binary restarts, or the next
  57 week for general restarts).
  58
  59 The command changes only one type of restart setting at a time; issue the
  60 command twice to change both settings.
  61
  62 =head1 OPTIONS
  63
  64 =over 4
  65
  66 =item B<-server> <I<machine name>>
  67
  68 Indicates the server machine on which to set a new restart time.  Identify
  69 the machine by IP address or its host name (either fully-qualified or
  70 abbreviated unambiguously). For details, see L<bos(8)>.
  71
  72 =item B<-time> <I<time to restart server>>
  73
  74 Specifies the restart time. By convention the general restart is defined
  75 as weekly (specifies both a day and a time), and the binary restart is
  76 defined as daily (specifies only a time). However, it is acceptable to
  77 define a daily general restart or weekly binary restart.
  78
  79 There are four acceptable values for either type of restart setting:
  80
  81 =over 4
  82
  83 =item *
  84
  85 The string C<never>, which directs the BOS Server never to perform the
  86 indicated type of restart.
  87
  88 =item *
  89
  90 The string C<now>, which directs the BOS Server to perform the restart
  91 immediately and never again.
  92
  93 =item *
  94
  95 A time of day (the conventional type of value for the binary restart
  96 time). Separate the hours and minutes with a colon (I<hh:MM>), an use
  97 either 24-hour format, or a value in the range from C<1:00> through
  98 C<12:59> with the addition of C<am> or C<pm>. For example, both C<14:30>
  99 and C<"2:30 pm"> indicate 2:30 in the afternoon. Surround this parameter
 100 with double quotes (C<"">) if it contains a space.
 101
 102 =item *
 103
 104 A day of the week and time of day, separated by a space and surrounded
 105 with double quotes (C<"">). This is the conventional type of value for the
 106 general restart. For the day, provide either the whole name or the first
 107 three letters, all in lowercase letters (C<sunday> or C<sun>, C<thursday>
 108 or C<thu>, and so on).  For the time, use the same format as when
 109 specifying the time alone.
 110
 111 =back
 112
 113 If desired, precede a time or day and time definition with the string
 114 C<every> or C<at>. These words do not change the meaning, but possibly
 115 make the output of the B<bos getrestart> command easier to understand.
 116
 117 =item B<-general>
 118
 119 Sets the general restart time.
 120
 121 =item B<-newbinary>
 122
 123 Sets the binary restart time.
 124
 125 =item B<-cell> <I<cell name>>
 126
 127 Names the cell in which to run the command. Do not combine this argument
 128 with the B<-localauth> flag. For more details, see L<bos(8)>.
 129
 130 =item B<-noauth>
 131
 132 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 133 combine this flag with the B<-localauth> flag. For more details, see
 134 L<bos(8)>.
 135
 136 =item B<-localauth>
 137
 138 Constructs a server ticket using a key from the local
 139 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
 140 The B<bos> command interpreter presents the
 141 ticket to the BOS Server during mutual authentication. Do not combine this
 142 flag with the B<-cell> or B<-noauth> options. For more details, see
 143 L<bos(8)>.
 144
 145 =item B<-help>
 146
 147 Prints the online help for this command. All other valid options are
 148 ignored.
 149
 150 =back
 151
 152 =head1 EXAMPLES
 153
 154 The following command sets the general restart time on the machine
 155 C<fs4.example.com> to Saturday at 3:30 am.
 156
 157    % bos setrestart -server fs4.example.com -time "sat 3:30" -general
 158
 159 The following command sets the binary restart time on the machine
 160 C<fs6.example.com> to 11:45 pm.
 161
 162    % bos setrestart -server fs6.example.com -time 23:45 -newbinary
 163
 164 =head1 PRIVILEGE REQUIRED
 165
 166 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 167 machine named by the B<-server> argument, or must be logged onto a server
 168 machine as the local superuser C<root> if the B<-localauth> flag is
 169 included.
 170
 171 =head1 SEE ALSO
 172
 173 L<BosConfig(5)>,
 174 L<KeyFile(5)>,
 175 L<KeyFileExt(5)>,
 176 L<UserList(5)>,
 177 L<bos(8)>,
 178 L<bos_getrestart(8)>,
 179 L<bos_restart(8)>
 180
 181 =head1 COPYRIGHT
 182
 183 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 184
 185 This documentation is covered by the IBM Public License Version 1.0.  It was
 186 converted from HTML to POD by software written by Chas Williams and Russ
 187 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.