xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect8 / bos_getrestart.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="bos_getrestart8">
3   <refmeta>
4     <refentrytitle>bos getrestart</refentrytitle>
5     <manvolnum>8</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>bos getrestart</refname>
9     <refpurpose>Displays the automatic restart times for server processes</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">bos getrestart</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
14         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
15
16     <para><emphasis role="bold">bos getr</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>]
17         [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
18
19   </refsect1>
20   <refsect1>
21     <title>Description</title>
22     <para>The bos getrestart command displays two restart times from the
23     <replaceable>/usr/afs/local/BosConfig</replaceable> file on the server machine named by the
24     <emphasis role="bold">-server</emphasis> argument:</para>
25
26     <itemizedlist>
27       <listitem>
28         <para>The <emphasis>general restart</emphasis> time at which the BOS Server process automatically
29         restarts itself and all processes marked with status <computeroutput>Run</computeroutput> in the
30         <replaceable>BosConfig</replaceable> file. The default is Sunday at 4:00 a.m.</para>
31
32       </listitem>
33       <listitem>
34         <para>The <emphasis>binary restart</emphasis> time at which the BOS Server automatically restarts
35         any process for which the time stamp on the binary file in the
36         <replaceable>/usr/afs/bin</replaceable> directory is later than the last restart time for the
37         process. The default is 5:00 a.m. Use the <emphasis role="bold">bos getdate</emphasis> command to list a
38         binary file's timestamp, and the <emphasis role="bold">-long</emphasis> flag to the <emphasis role="bold">bos status</emphasis>
39         command to display a process's most recent restart time.</para>
40
41       </listitem>
42     </itemizedlist>
43     <para>Use the <emphasis role="bold">bos setrestart</emphasis> command to set the restart times.</para>
44
45   </refsect1>
46   <refsect1>
47     <title>Options</title>
48     <variablelist>
49       <varlistentry>
50         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
51         <listitem>
52           <para>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 <link linkend="bos8">bos(8)</link>.</para>
55
56         </listitem>
57       </varlistentry>
58       <varlistentry>
59         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
60         <listitem>
61           <para>Names the cell in which to run the command. Do not combine this argument
62           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
63
64         </listitem>
65       </varlistentry>
66       <varlistentry>
67         <term><emphasis role="bold">-noauth</emphasis></term>
68         <listitem>
69           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
70           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
71           <link linkend="bos8">bos(8)</link>.</para>
72
73         </listitem>
74       </varlistentry>
75       <varlistentry>
76         <term><emphasis role="bold">-localauth</emphasis></term>
77         <listitem>
78           <para>Constructs a server ticket using a key from the local
79           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
80           ticket to the BOS Server during mutual authentication. Do not combine this
81           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
82           <link linkend="bos8">bos(8)</link>.</para>
83
84         </listitem>
85       </varlistentry>
86       <varlistentry>
87         <term><emphasis role="bold">-help</emphasis></term>
88         <listitem>
89           <para>Prints the online help for this command. All other valid options are
90           ignored.</para>
91
92         </listitem>
93       </varlistentry>
94     </variablelist>
95   </refsect1>
96   <refsect1>
97     <title>Output</title>
98     <para>The output consists of two lines:</para>
99
100 <programlisting>
101    Server &amp;lt;machine_name&amp;gt; restarts at &amp;lt;time&amp;gt;
102    Server &amp;lt;machine_name&amp;gt; restarts for new binaries at &amp;lt;time&amp;gt;
103
104 </programlisting>
105       <para>Possible values for &lt;time&gt; include:</para>
106
107       <itemizedlist>
108         <listitem>
109           <para><computeroutput>never</computeroutput>, indicating that the BOS Server never performs that type of
110           restart.</para>
111
112         </listitem>
113         <listitem>
114           <para><computeroutput>now</computeroutput>, indicating that the BOS Server performs that type of restart only
115           each time it restarts.</para>
116
117         </listitem>
118         <listitem>
119           <para>A specified day and time, indicating that the BOS Server performs that
120           type of restart once per week. Example: <computeroutput>sun 4:00 am</computeroutput>.</para>
121
122         </listitem>
123         <listitem>
124           <para>A specified time, indicating that the BOS Server performs that type of
125           restart once per day. Examples: <computeroutput>11:00 pm</computeroutput>, <computeroutput>3:00 am</computeroutput>.</para>
126
127         </listitem>
128       </itemizedlist>
129     </refsect1>
130     <refsect1>
131       <title>Examples</title>
132       <para>The following example displays the restart times for the machine
133       <computeroutput>db2.abc.com</computeroutput>:</para>
134
135 <programlisting>
136    % bos getrestart db2.abc.com
137    Server db2.abc.com restarts at sun 4:00 am
138    Server db2.abc.com restarts for new binaries at 2:15 am
139
140 </programlisting>
141         <para>In the following example, the issuer abbreviates the machine name
142         <computeroutput>fs1.abc.com</computeroutput> to <computeroutput>fs1</computeroutput>, relying on the cell's name server to resolve the
143         name. The output echoes the abbreviated form.</para>
144
145 <programlisting>
146    % bos getrestart fs1
147    Server fs1 restarts at sat 5:00 am
148    Server fs1 restarts for new binaries at 11:30 pm
149
150 </programlisting>
151         </refsect1>
152         <refsect1>
153           <title>Privilege Required</title>
154           <para>None</para>
155
156         </refsect1>
157         <refsect1>
158           <title>See Also</title>
159           <para><link linkend="BosConfig5">BosConfig(5)</link>,
160           <link linkend="KeyFile5">KeyFile(5)</link>,
161           <link linkend="bos8">bos(8)</link>,
162           <link linkend="bos_getdate8">bos_getdate(8)</link>,
163           <link linkend="bos_setrestart8">bos_setrestart(8)</link>,
164           <link linkend="bos_status8">bos_status(8)</link></para>
165
166         </refsect1>
167         <refsect1>
168           <title>Copyright</title>
169           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
170
171           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
172           converted from HTML to POD by software written by Chas Williams and Russ
173           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
174
175         </refsect1>
176       </refentry>