.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "BOS_STOP 8"
.TH BOS_STOP 8 2024-02-03 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_stop \- Stops a process after changing its status flag
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbos stop\fR \fB\-server\fR\ <\fImachine\ name\fR>
    \fB\-instance\fR\ <\fIserver\ process\ name\fR>+ [\fB\-wait\fR]
    [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR]
.PP
\&\fBbos sto\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-i\fR\ <\fIserver\ process\ name\fR>+
    [\fB\-w\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-n\fR] [\fB\-l\fR] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBbos stop\fR command sets the status flag for each process specified
with the \fB\-instance\fR argument to \f(CW\*(C`NotRun\*(C'\fR in the
\&\fI/etc/openafs/BosConfig\fR file on the server machine named by the
\&\fB\-server\fR argument, then stops it.
.PP
To stop a process without changing its \fIBosConfig\fR status flag, use the
\&\fBbos shutdown\fR command instead.
.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 stop processes. Identify the
machine by IP address or its host name (either fully-qualified or
abbreviated unambiguously). For details, see \fBbos\fR\|(8).
.IP "\fB\-instance\fR <\fIserver process name\fR>+" 4
.IX Item "-instance <server process name>+"
Names each process to stop. Use the process name assigned with the
\&\fB\-instance\fR argument to the \fBbos create\fR command. The output from the
\&\fBbos status\fR command lists the names.
.IP \fB\-wait\fR 4
.IX Item "-wait"
Delays the return of the command shell prompt until all processes actually
stop. If this argument is omitted, the prompt returns almost immediately
even if all processes are not stopped.
.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 BOS 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 example command stops the \fBupserver\fR and \fBvlserver\fR
processes on the machine \f(CW\*(C`fs7.example.com\*(C'\fR.
.PP
.Vb 1
\&   % bos stop \-server fs7.example.com \-instance upserver vlserver
.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_create\fR\|(8),
\&\fBbos_shutdown\fR\|(8),
\&\fBbos_status\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.