man-page-fileserver-update-20080311
[openafs.git] / doc / man-pages / pod8 / bos_getrestart.pod
1 =head1 NAME
2
3 bos_getrestart - Displays the automatic restart times for server processes
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos getrestart> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-noauth>] [B<-localauth>] [B<-help>]
12
13 B<bos getr> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
14     [B<-l>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
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:
24
25 =over 4
26
27 =item *
28
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.
32
33 =item *
34
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.
41
42 =back
43
44 Use the B<bos setrestart> command to set the restart times.
45
46 =head1 OPTIONS
47
48 =over 4
49
50 =item B<-server> <I<machine name>>
51
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)>.
55
56 =item B<-cell> <I<cell name>>
57
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)>.
60
61 =item B<-noauth>
62
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)>.
66
67 =item B<-localauth>
68
69 Constructs a server ticket using a key from the local
70 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
71 ticket to the BOS Server during mutual authentication. Do not combine this
72 flag with the B<-cell> or B<-noauth> options. For more details, see
73 L<bos(8)>.
74
75 =item B<-help>
76
77 Prints the online help for this command. All other valid options are
78 ignored.
79
80 =back
81
82 =head1 OUTPUT
83
84 The output consists of two lines:
85
86    Server <machine_name> restarts at <time>
87    Server <machine_name> restarts for new binaries at <time>
88
89 Possible values for <time> include:
90
91 =over 4
92
93 =item *
94
95 C<never>, indicating that the BOS Server never performs that type of
96 restart.
97
98 =item *
99
100 C<now>, indicating that the BOS Server performs that type of restart only
101 each time it restarts.
102
103 =item *
104
105 A specified day and time, indicating that the BOS Server performs that
106 type of restart once per week. Example: C<sun 4:00 am>.
107
108 =item *
109
110 A specified time, indicating that the BOS Server performs that type of
111 restart once per day. Examples: C<11:00 pm>, C<3:00 am>.
112
113 =back
114
115 =head1 EXAMPLES
116
117 The following example displays the restart times for the machine
118 C<db2.abc.com>:
119
120    % bos getrestart db2.abc.com
121    Server db2.abc.com restarts at sun 4:00 am
122    Server db2.abc.com restarts for new binaries at 2:15 am
123
124 In the following example, the issuer abbreviates the machine name
125 C<fs1.abc.com> to C<fs1>, relying on the cell's name server to resolve the
126 name. The output echoes the abbreviated form.
127
128    % bos getrestart fs1
129    Server fs1 restarts at sat 5:00 am
130    Server fs1 restarts for new binaries at 11:30 pm
131
132 =head1 PRIVILEGE REQUIRED
133
134 None
135
136 =head1 SEE ALSO
137
138 L<BosConfig(5)>,
139 L<KeyFile(5)>,
140 L<bos(8)>,
141 L<bos_getdate(8)>,
142 L<bos_setrestart(8)>,
143 L<bos_status(8)>
144
145 =head1 COPYRIGHT
146
147 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
148
149 This documentation is covered by the IBM Public License Version 1.0.  It was
150 converted from HTML to POD by software written by Chas Williams and Russ
151 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.