afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf117.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf116.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf118.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRBOS_SETRESTART" HREF="auarf002.htm#ToC_131">bos setrestart</A></H2>
19 <A NAME="IDX4630"></A>
20 <A NAME="IDX4631"></A>
21 <A NAME="IDX4632"></A>
22 <A NAME="IDX4633"></A>
23 <A NAME="IDX4634"></A>
24 <A NAME="IDX4635"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Sets the date and time at which the BOS Server restarts processes
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>bos setrestart -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-time</B> &lt;<VAR>time&nbsp;to&nbsp;restart&nbsp;server</VAR>>  
29                [<B>-general</B>]   [<B>-newbinary</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
30                [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]  
31     
32 <B>bos setr -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-t</B> &lt;<VAR>time&nbsp;to&nbsp;restart&nbsp;server</VAR>>  [<B>-g</B>]  [<B>-ne</B>] 
33          [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-no</B>]  [<B>-l</B>]  [<B>-h</B>]
34 </PRE>
35 <P><STRONG>Description</STRONG>
36 <P>The <B>bos setrestart</B> command records in the
37 <B>/usr/afs/local/BosConfig</B> file the times at which the BOS Server
38 running on the server machine named by the <B>-server</B> argument
39 performs two types of restarts:
40 <UL>
41 <P><LI>A <I>general restart</I>. By default, once per week the BOS
42 Server restarts itself and then any AFS process marked with the <TT>Run</TT>
43 status flag in the <B>BosConfig</B> file (equivalent in effect to issuing
44 the <B>bos restart</B> command with the <B>-bosserver</B>
45 flag). The default setting is 4:00 a.m. each Sunday
46 morning.
47 <P><LI>A <I>binary restart</I>. By default, once per day the BOS
48 Server restarts any currently running process for which the timestamp on the
49 binary file in the <B>/usr/afs/bin</B> directory is later than the time
50 the process last started or restarted. The default is 5:00
51 a.m. each day.
52 </UL>
53 <P><STRONG>Cautions</STRONG>
54 <P>Restarting a process makes it unavailable for a period of time. The
55 <B>fs</B> process has potentially the longest outage, depending on how
56 many volumes the file server machine houses (the File Server and Volume Server
57 reattach each volume when they restart). The default settings are
58 designed to coincide with periods of low usage, so that the restarts disturb
59 the smallest possible number of users.
60 <P>If the setting specified with the <B>-time</B> argument is within one
61 hour of the current time, the BOS Server does not restart any processes until
62 the next applicable opportunity (the next day for binary restarts, or the next
63 week for general restarts).
64 <P>The command changes only one type of restart setting at a time; issue
65 the command twice to change both settings.
66 <P><STRONG>Options</STRONG>
67 <DL>
68 <P><DT><B>-server
69 </B><DD>Indicates the server machine on which to set a new restart time.
70 Identify the machine by IP address or its host name (either fully-qualified or
71 abbreviated unambiguously). For details, see the introductory reference
72 page for the <B>bos</B> command suite.
73 <P><DT><B>-time
74 </B><DD>Specifies the restart time. By convention the general restart is
75 defined as weekly (specifies both a day and a time), and the binary restart is
76 defined as daily (specifies only a time). However, it is acceptable to
77 define a daily general restart or weekly binary restart.
78 <P>There are four acceptable values for either type of restart setting: 
79 <UL>
80 <P><LI>The string <B>never</B>, which directs the BOS Server never to perform
81 the indicated type of restart.
82 <P><LI>The string <B>now</B>, which directs the BOS Server to perform the
83 restart immediately and never again.
84 <P><LI>A time of day (the conventional type of value for the binary restart
85 time). Separate the hours and minutes with a colon
86 (<I>hh</I>:<I>MM</I>), and use either 24-hour format, or a value
87 in the range from <B>1:00</B> through <B>12:59</B> with
88 the addition of <B>am</B> or <B>pm</B>. For example, both
89 <B>14:30</B> and <B>"2:30 pm"</B> indicate 2:30 in
90 the afternoon. Surround this parameter with double quotes (<B>"
91 "</B>) if it contains a space.
92 <P><LI>A day of the week and time of day, separated by a space and surrounded
93 with double quotes (<B>" "</B>). This is the conventional type of
94 value for the general restart. For the day, provide either the whole
95 name or the first three letters, all in lowercase letters (<B>sunday</B>
96 or <B>sun</B>, <B>thursday</B> or <B>thu</B>, and so on).
97 For the time, use the same format as when specifying the time alone.
98 </UL>
99 <P>If desired, precede a time or day and time definition with the string
100 <B>every</B> or <B>at</B>. These words do not change the
101 meaning, but possibly make the output of the <B>bos getrestart</B> command
102 easier to understand.
103 <P><DT><B><B>-general</B>
104 </B><DD>Sets the general restart time.
105 <P><DT><B><B>-newbinary</B>
106 </B><DD>Sets the binary restart time.
107 <P><DT><B><B>-cell</B>
108 </B><DD>Names the cell in which to run the command. Do not combine this
109 argument with the <B>-localauth</B> flag. For more details, see the
110 introductory <B>bos</B> reference page.
111 <P><DT><B><B>-noauth</B>
112 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
113 issuer. Do not combine this flag with the <B>-localauth</B>
114 flag. For more details, see the introductory <B>bos</B> reference
115 page.
116 <P><DT><B><B>-localauth</B>
117 </B><DD>Constructs a server ticket using a key from the local
118 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
119 interpreter presents the ticket to the BOS Server during mutual
120 authentication. Do not combine this flag with the <B>-cell</B> or
121 <B>-noauth</B> options. For more details, see the introductory
122 <B>bos</B> reference page.
123 <P><DT><B>-help
124 </B><DD>Prints the online help for this command. All other valid options
125 are ignored.
126 </DL>
127 <P><STRONG>Examples</STRONG>
128 <P>The following command sets the general restart time on the machine
129 <B>fs4.abc.com</B> to Saturday at 3:30 am.
130 <PRE>   % <B>bos setrestart -server fs4.abc.com -time "sat 3:30" -general</B>
131    
132 </PRE>
133 <P>The following command sets the binary restart time on the machine
134 <B>fs6.abc.com</B> to 11:45 pm.
135 <PRE>   % <B>bos setrestart -server fs6.abc.com -time 23:45 -newbinary</B>
136    
137 </PRE>
138 <P><STRONG>Privilege Required</STRONG>
139 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
140 the machine named by the <B>-server</B> argument, or must be logged onto a
141 server machine as the local superuser <B>root</B> if the
142 <B>-localauth</B> flag is included.
143 <P><STRONG>Related Information</STRONG>
144 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
145 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
146 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
147 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
148 <P><A HREF="auarf103.htm#HDRBOS_GETRESTART">bos getrestart</A>
149 <P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
150 <P>
151 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf116.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf118.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
152 <!-- Begin Footer Records  ========================================== -->
153 <P><HR><B> 
154 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
155 </B> 
156 <!-- End Footer Records  ============================================ -->
157 <A NAME="Bot_Of_Page"></A>
158 </BODY></HTML>