doc/man-pages/pod8/bos_setrestart.pod

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