pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / bos_getrestart.pod
1 =head1 NAME
2
3 bos getrestart - Displays the automatic restart times for server processes
4
5 =head1 SYNOPSIS
6
7 bos getrestart B<-server> I<machine name>  [B<-cell> I<cell name>]
8 [B<-noauth>]  [B<-localauth>]  [B<-help>]
9
10 bos getr B<-s> I<machine name>  [B<-c> I<cell name>]  [B<-n>]  [B<-l>]  [B<-h>]
11
12 =head1 DESCRIPTION
13
14 The C<bos getrestart> command displays two restart times from the
15 B</usr/afs/local/BosConfig> file on the server machine named by the
16 B<-server> argument:
17
18 =over
19
20 =item *
21
22 The I<general restart time> at which the BOS Server process
23 automatically restarts itself and all processes marked with status
24 Run in the B<BosConfig> file. The default is Sunday at 4:00 a.m.
25
26 =item *
27
28 The binary restart time at which the BOS Server automatically
29 restarts any process for which the time stamp on the binary file
30 in the B</usr/afs/bin> directory is later than the last restart time
31 for the process. The default is 5:00 a.m. Use the C<bos getdate>
32 command to list a binary file's timestamp, and the B<-long> flag to
33 the C<bos status> command to display a process's most recent restart
34 time.
35
36 =back
37
38 Use the C<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
48 (either fully-qualified or abbreviated unambiguously). For
49 details, see the introductory reference page for the C<bos>
50 command suite.
51
52 =item B<-cell> I<cell name>
53
54 Names the cell in which to run the command. Do not combine this
55 argument with the B<-localauth> flag. For more details, see the
56 introductory L<bos(1)> reference page.
57
58 =item B<-noauth>
59
60 Assigns the unprivileged identity B<anonymous> to the issuer. Do
61 not combine this flag with the B<-localauth> flag. For more
62 details, see the introductory L<bos(1)> reference page.
63
64 =item B<-localauth>
65
66 Constructs a server ticket using a key from the local
67 B</usr/afs/etc/KeyFile> file. The C<bos> command interpreter presents
68 the ticket to the BOS Server during mutual authentication. Do
69 not combine this flag with the B<-cell> or B<-noauth> options. For
70 more details, see the introductory L<bos(1)> reference page.
71
72 =item B<-help>
73
74 Prints the online help for this command. All other valid
75 options are ignored.
76
77 =back
78
79 =head1 OUTPUT
80
81 The output consists of two lines:
82
83 Server I<machine_name> restarts at I<time>
84
85 Server I<machine_name> restarts for new binaries at I<time>
86
87 Possible values for I<time> include:
88
89 =over
90
91 =item *
92
93 C<never>, indicating that the BOS Server never performs that type of
94 restart
95
96 =item *
97
98 C<now>, indicating that the BOS Server performs that type of restart
99 only each time it restarts
100
101 =item *
102
103 A specified day and time, indicating that the BOS Server performs
104 that type of restart once per week. Example: C<sun 4:00 am>.
105
106 =item *
107
108 A specified time, indicating that the BOS Server performs that
109 type of restart once per day. Examples: C<11:00 pm>, C<3:00 am>.
110
111 =back
112
113 =head1 EXAMPLES
114
115 The following example displays the restart times for the machine
116 B<db2.abc.com>:
117
118     bos getrestart db2.abc.com
119    Server db2.abc.com restarts at sun 4:00 am
120    Server db2.abc.com restarts for new binaries at 2:15 am
121
122 In the following example, the issuer abbreviates the machine name
123 B<fs1.abc.com> to B<fs1>, relying on the cell's name server to resolve the
124 name. The output echoes the abbreviated form.
125
126     bos getrestart fs1
127    Server fs1 restarts at sat 5:00 am
128    Server fs1 restarts for new binaries at 11:30 pm
129
130 =head1 PRIVILEGE REQUIRED
131
132 None
133
134 =head1 COPYRIGHT
135
136 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
137
138 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
139 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
140 Stanford Linear Accelerator Center, a department of Stanford University.
141
142 =head1 SEE ALSO
143
144 L<BosConfig(1)>,
145 L<KeyFile(1)>,
146 L<bos(1)>,
147 L<bos_getdate(1)>,
148 L<bos_setrestart(1)>,
149 L<bos_status(1)>
150
151 =cut