Update NEWS for 1.8.0pre3
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / bos_getrestart.pod
blob424634c43f84ff9d2363a06a98d67fc361970480
1 =head1 NAME
3 bos_getrestart - Displays the automatic restart times for server processes
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<bos getrestart> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-noauth>] [B<-localauth>] [B<-help>]
13 B<bos getr> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
14     [B<-l>] [B<-h>]
16 =for html
17 </div>
19 =head1 DESCRIPTION
21 The bos getrestart command displays two restart times from the
22 F</usr/afs/local/BosConfig> file on the server machine named by the
23 B<-server> argument:
25 =over 4
27 =item *
29 The I<general restart> time at which the BOS Server process automatically
30 restarts itself and all processes marked with status C<Run> in the
31 F<BosConfig> file. The default is Sunday at 4:00 a.m.
33 =item *
35 The I<binary restart> time at which the BOS Server automatically restarts
36 any process for which the time stamp on the binary file in the
37 F</usr/afs/bin> directory is later than the last restart time for the
38 process. The default is 5:00 a.m. Use the B<bos getdate> command to list a
39 binary file's timestamp, and the B<-long> flag to the B<bos status>
40 command to display a process's most recent restart time.
42 =back
44 Use the B<bos setrestart> command to set the restart times.
46 =head1 OPTIONS
48 =over 4
50 =item B<-server> <I<machine name>>
52 Indicates the server machine for which to display the restart
53 times. Identify the machine by IP address or its host name (either
54 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
56 =item B<-cell> <I<cell name>>
58 Names the cell in which to run the command. Do not combine this argument
59 with the B<-localauth> flag. For more details, see L<bos(8)>.
61 =item B<-noauth>
63 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
64 combine this flag with the B<-localauth> flag. For more details, see
65 L<bos(8)>.
67 =item B<-localauth>
69 Constructs a server ticket using a key from the local
70 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
71 The B<bos> command interpreter presents the
72 ticket to the BOS Server during mutual authentication. Do not combine this
73 flag with the B<-cell> or B<-noauth> options. For more details, see
74 L<bos(8)>.
76 =item B<-help>
78 Prints the online help for this command. All other valid options are
79 ignored.
81 =back
83 =head1 OUTPUT
85 The output consists of two lines:
87    Server <machine_name> restarts at <time>
88    Server <machine_name> restarts for new binaries at <time>
90 Possible values for <time> include:
92 =over 4
94 =item *
96 C<never>, indicating that the BOS Server never performs that type of
97 restart.
99 =item *
101 C<now>, indicating that the BOS Server performs that type of restart only
102 each time it restarts.
104 =item *
106 A specified day and time, indicating that the BOS Server performs that
107 type of restart once per week. Example: C<sun 4:00 am>.
109 =item *
111 A specified time, indicating that the BOS Server performs that type of
112 restart once per day. Examples: C<11:00 pm>, C<3:00 am>.
114 =back
116 =head1 EXAMPLES
118 The following example displays the restart times for the machine
119 C<db2.example.com>:
121    % bos getrestart db2.example.com
122    Server db2.example.com restarts at sun 4:00 am
123    Server db2.example.com restarts for new binaries at 2:15 am
125 In the following example, the issuer abbreviates the machine name
126 C<fs1.example.com> to C<fs1>, relying on the cell's name server to resolve the
127 name. The output echoes the abbreviated form.
129    % bos getrestart fs1
130    Server fs1 restarts at sat 5:00 am
131    Server fs1 restarts for new binaries at 11:30 pm
133 =head1 PRIVILEGE REQUIRED
135 None
137 =head1 SEE ALSO
139 L<BosConfig(5)>,
140 L<KeyFile(5)>,
141 L<KeyFileExt(5)>,
142 L<bos(8)>,
143 L<bos_getdate(8)>,
144 L<bos_setrestart(8)>,
145 L<bos_status(8)>
147 =head1 COPYRIGHT
149 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
151 This documentation is covered by the IBM Public License Version 1.0.  It was
152 converted from HTML to POD by software written by Chas Williams and Russ
153 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.