.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "BOS_SETRESTART 8"
.TH BOS_SETRESTART 8 "2021-01-14" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
bos_setrestart \- Sets when the BOS Server restarts processes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBbos setrestart\fR \fB\-server\fR\ <\fImachine\ name\fR>
    \fB\-time\fR\ <\fItime\ to\ restart\ server\fR> [\fB\-general\fR] [\fB\-newbinary\fR]
    [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR]
.PP
\&\fBbos setr\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-t\fR\ <\fItime\ to\ restart\ server\fR>
    [\fB\-g\fR] [\fB\-ne\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-no\fR] [\fB\-l\fR] [\fB\-h\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBbos setrestart\fR command records in the \fI/etc/openafs/BosConfig\fR
file the times at which the \s-1BOS\s0 Server running on the server machine named
by the \fB\-server\fR argument performs two types of restarts:
.IP "\(bu" 4
A \fIgeneral restart\fR. The \s-1BOS\s0 Server will restart itself,
and then any \s-1AFS\s0 process marked with the \f(CW\*(C`Run\*(C'\fR status flag in the
\&\fIBosConfig\fR file (equivalent in effect to issuing the \fBbos restart\fR
command with the \fB\-bosserver\fR flag) at this time each week. By default,
in a new bos installation, general restarts are disabled.
.IP "\(bu" 4
A \fIbinary restart\fR. By default, once per day the \s-1BOS\s0 Server restarts any
currently running process for which the timestamp on the binary file in
the \fI/usr/lib/openafs\fR directory is later than the time the process last
started or restarted. The default is 5:00 a.m. each day.
.SH "CAUTIONS"
.IX Header "CAUTIONS"
Restarting a process makes it unavailable for a period of time. The \fBfs\fR
process has potentially the longest outage, depending on how many volumes
the file server machine houses (the File Server and Volume Server reattach
each volume when they restart). The default settings are designed to
coincide with periods of low usage, so that the restarts disturb the
smallest possible number of users.
.PP
If the setting specified with the \fB\-time\fR argument is within one hour of
the current time, the \s-1BOS\s0 Server does not restart any processes until the
next applicable opportunity (the next day for binary restarts, or the next
week for general restarts).
.PP
The command changes only one type of restart setting at a time; issue the
command twice to change both settings.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-server\fR <\fImachine name\fR>" 4
.IX Item "-server <machine name>"
Indicates the server machine on which to set a new restart time.  Identify
the machine by \s-1IP\s0 address or its host name (either fully-qualified or
abbreviated unambiguously). For details, see \fBbos\fR\|(8).
.IP "\fB\-time\fR <\fItime to restart server\fR>" 4
.IX Item "-time <time to restart server>"
Specifies the restart time. By convention the general restart is defined
as weekly (specifies both a day and a time), and the binary restart is
defined as daily (specifies only a time). However, it is acceptable to
define a daily general restart or weekly binary restart.
.Sp
There are four acceptable values for either type of restart setting:
.RS 4
.IP "\(bu" 4
The string \f(CW\*(C`never\*(C'\fR, which directs the \s-1BOS\s0 Server never to perform the
indicated type of restart.
.IP "\(bu" 4
The string \f(CW\*(C`now\*(C'\fR, which directs the \s-1BOS\s0 Server to perform the restart
immediately and never again.
.IP "\(bu" 4
A time of day (the conventional type of value for the binary restart
time). Separate the hours and minutes with a colon (\fIhh:MM\fR), an use
either 24\-hour format, or a value in the range from \f(CW\*(C`1:00\*(C'\fR through
\&\f(CW\*(C`12:59\*(C'\fR with the addition of \f(CW\*(C`am\*(C'\fR or \f(CW\*(C`pm\*(C'\fR. For example, both \f(CW\*(C`14:30\*(C'\fR
and \f(CW"2:30 pm"\fR indicate 2:30 in the afternoon. Surround this parameter
with double quotes (\f(CW""\fR) if it contains a space.
.IP "\(bu" 4
A day of the week and time of day, separated by a space and surrounded
with double quotes (\f(CW""\fR). This is the conventional type of value for the
general restart. For the day, provide either the whole name or the first
three letters, all in lowercase letters (\f(CW\*(C`sunday\*(C'\fR or \f(CW\*(C`sun\*(C'\fR, \f(CW\*(C`thursday\*(C'\fR
or \f(CW\*(C`thu\*(C'\fR, and so on).  For the time, use the same format as when
specifying the time alone.
.RE
.RS 4
.Sp
If desired, precede a time or day and time definition with the string
\&\f(CW\*(C`every\*(C'\fR or \f(CW\*(C`at\*(C'\fR. These words do not change the meaning, but possibly
make the output of the \fBbos getrestart\fR command easier to understand.
.RE
.IP "\fB\-general\fR" 4
.IX Item "-general"
Sets the general restart time.
.IP "\fB\-newbinary\fR" 4
.IX Item "-newbinary"
Sets the binary restart time.
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8).
.IP "\fB\-noauth\fR" 4
.IX Item "-noauth"
Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not
combine this flag with the \fB\-localauth\fR flag. For more details, see
\&\fBbos\fR\|(8).
.IP "\fB\-localauth\fR" 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR or \fI/etc/openafs/server/KeyFileExt\fR file.
The \fBbos\fR command interpreter presents the
ticket to the \s-1BOS\s0 Server during mutual authentication. Do not combine this
flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see
\&\fBbos\fR\|(8).
.IP "\fB\-help\fR" 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following command sets the general restart time on the machine
\&\f(CW\*(C`fs4.example.com\*(C'\fR to Saturday at 3:30 am.
.PP
.Vb 1
\&   % bos setrestart \-server fs4.example.com \-time "sat 3:30" \-general
.Ve
.PP
The following command sets the binary restart time on the machine
\&\f(CW\*(C`fs6.example.com\*(C'\fR to 11:45 pm.
.PP
.Vb 1
\&   % bos setrestart \-server fs6.example.com \-time 23:45 \-newbinary
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the
machine named by the \fB\-server\fR argument, or must be logged onto a server
machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is
included.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBBosConfig\fR\|(5),
\&\fBKeyFile\fR\|(5),
\&\fBKeyFileExt\fR\|(5),
\&\fBUserList\fR\|(5),
\&\fBbos\fR\|(8),
\&\fBbos_getrestart\fR\|(8),
\&\fBbos_restart\fR\|(8)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\s-1IBM\s0 Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  It was
converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.