man8-editing-pass-20051213
[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 B<bos getrestart> B<-server> <I<machine name>> [B<-cell> <I<cell name>>]  
8     [B<-noauth>] [B<-localauth>] [B<-help>]
9
10 B<bos getr> B<-s> <I<machine name>> [B<-c> <I<cell name>>] [B<-n>]
11     [B<-l>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The bos getrestart command displays two restart times from the
16 F</usr/afs/local/BosConfig> file on the server machine named by the
17 B<-server> argument:
18
19 =over 4
20
21 =item *
22
23 The I<general restart> time at which the BOS Server process automatically
24 restarts itself and all processes marked with status C<Run> in the
25 F<BosConfig> file. The default is Sunday at 4:00 a.m.
26
27 =item *
28
29 The I<binary restart> time at which the BOS Server automatically restarts
30 any process for which the time stamp on the binary file in the
31 F</usr/afs/bin> directory is later than the last restart time for the
32 process. The default is 5:00 a.m. Use the B<bos getdate> command to list a
33 binary file's timestamp, and the B<-long> flag to the B<bos status>
34 command to display a process's most recent restart time.
35
36 =back
37
38 Use the B<bos setrestart> command to set the restart times.
39
40 =head1 OPTIONS
41
42 =over 4
43
44 =item B<-server> <I<machine name>>
45
46 Indicates the server machine for which to display the restart
47 times. Identify the machine by IP address or its host name (either
48 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
49
50 =item B<-cell> <I<cell name>>
51
52 Names the cell in which to run the command. Do not combine this argument
53 with the B<-localauth> flag. For more details, see L<bos(8)>.
54
55 =item B<-noauth>
56
57 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
58 combine this flag with the B<-localauth> flag. For more details, see
59 L<bos(8)>.
60
61 =item B<-localauth>
62
63 Constructs a server ticket using a key from the local
64 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
65 ticket to the BOS Server during mutual authentication. Do not combine this
66 flag with the B<-cell> or B<-noauth> options. For more details, see
67 L<bos(8)>.
68
69 =item B<-help>
70
71 Prints the online help for this command. All other valid options are
72 ignored.
73
74 =back
75
76 =head1 OUTPUT
77
78 The output consists of two lines:
79
80    Server <machine_name> restarts at <time>
81    Server <machine_name> restarts for new binaries at <time>
82
83 Possible values for <time> include:
84
85 =over 4
86
87 =item *
88
89 C<never>, indicating that the BOS Server never performs that type of
90 restart.
91
92 =item *
93
94 C<now>, indicating that the BOS Server performs that type of restart only
95 each time it restarts.
96
97 =item *
98
99 A specified day and time, indicating that the BOS Server performs that
100 type of restart once per week. Example: C<sun 4:00 am>.
101
102 =item *
103
104 A specified time, indicating that the BOS Server performs that type of
105 restart once per day. Examples: C<11:00 pm>, C<3:00 am>.
106
107 =back
108
109 =head1 EXAMPLES
110
111 The following example displays the restart times for the machine
112 C<db2.abc.com>:
113
114    % bos getrestart db2.abc.com
115    Server db2.abc.com restarts at sun 4:00 am
116    Server db2.abc.com restarts for new binaries at 2:15 am
117
118 In the following example, the issuer abbreviates the machine name
119 C<fs1.abc.com> to C<fs1>, relying on the cell's name server to resolve the
120 name. The output echoes the abbreviated form.
121
122    % bos getrestart fs1
123    Server fs1 restarts at sat 5:00 am
124    Server fs1 restarts for new binaries at 11:30 pm
125
126 =head1 PRIVILEGE REQUIRED
127
128 None
129
130 =head1 SEE ALSO
131
132 L<BosConfig(5)>,
133 L<KeyFile(5)>,
134 L<bos(8)>,
135 L<bos_getdate(8)>,
136 L<bos_setrestart(8)>,
137 L<bos_status(8)>
138
139 =head1 COPYRIGHT
140
141 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
142
143 This documentation is covered by the IBM Public License Version 1.0.  It was
144 converted from HTML to POD by software written by Chas Williams and Russ
145 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.