initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf118.htm
diff --git a/doc/html/AdminReference/auarf118.htm b/doc/html/AdminReference/auarf118.htm
new file mode 100644 (file)
index 0000000..6dac75a
--- /dev/null
@@ -0,0 +1,122 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<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="auarf117.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="auarf119.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> 
+<P>
+<H2><A NAME="HDRBOS_SHUTDOWN" HREF="auarf002.htm#ToC_132">bos shutdown</A></H2>
+<A NAME="IDX4636"></A>
+<A NAME="IDX4637"></A>
+<A NAME="IDX4638"></A>
+<A NAME="IDX4639"></A>
+<A NAME="IDX4640"></A>
+<A NAME="IDX4641"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Stops a process without changing its status flag in the
+<B>/usr/afs/local/BosConfig</B> file
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>bos shutdown -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-instance</B> &lt;<VAR>instances</VAR>><SUP>+</SUP>]  [<B>-wait</B>]  
+             [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
+    
+<B>bos sh -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-i</B> &lt;<VAR>instances</VAR>><SUP>+</SUP>]  [<B>-w</B>]  
+       [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>bos shutdown</B> command stops, on the server machine named by
+the <B>-server</B> argument, either 
+<UL>
+<P><LI>All of the currently running AFS server processes, except the BOS Server
+<P><LI>Only the processes specified by the <B>-instance</B> argument
+</UL>
+<P>This command does not change a process's status flag in the
+<B>/usr/afs/local/BosConfig</B> file, but only in the BOS Server's
+memory. To stop a process and change its <B>BosConfig</B> status
+flag, use the <B>bos stop</B> command instead.
+<P>Once stopped with this command, a process does not run again until an
+administrator starts it by using the <B>bos start</B>, <B>bos
+startup</B>, or <B>bos restart</B> command, or until the BOS Server
+restarts (assuming that the process's <B>BosConfig</B> status flag is
+<TT>Run</TT>).
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B><B>-server</B>
+</B><DD>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 the introductory reference
+page for the <B>bos</B> command suite.
+<P><DT><B><B>-instance</B>
+</B><DD>Names each process to stop. Use the process name assigned with the
+<B>-instance</B> argument to the <B>bos create</B> command. The
+output from the <B>bos status</B> command lists the names. Omit
+this argument to stop all processes other than the BOS Server.
+<P><DT><B><B>-wait</B>
+</B><DD>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.
+<P><DT><B><B>-cell</B>
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>bos</B> reference page.
+<P><DT><B><B>-noauth</B>
+</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
+issuer. Do not combine this flag with the <B>-localauth</B>
+flag. For more details, see the introductory <B>bos</B> reference
+page.
+<P><DT><B><B>-localauth</B>
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
+interpreter presents the ticket to the BOS Server during mutual
+authentication. Do not combine this flag with the <B>-cell</B> or
+<B>-noauth</B> options. For more details, see the introductory
+<B>bos</B> reference page.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>The following command stops all processes other than the BOS Server on the
+machine <B>fs3.abc.com</B>.
+<PRE>   % <B>bos shutdown fs3.abc.com</B>
+   
+</PRE>
+<P>The following command stops the <B>upserver</B> process (server portion
+of the Update Server) on the machine
+<B>fs5.abc.com</B>.
+<PRE>   % <B>bos shutdown -server fs5.abc.com -instance upserver</B>
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+the machine named by the <B>-server</B> argument, or must be logged onto a
+server machine as the local superuser <B>root</B> if the
+<B>-localauth</B> flag is included.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
+<P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
+<P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
+<P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
+<P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
+<P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
+<P><A HREF="auarf119.htm#HDRBOS_START">bos start</A>
+<P><A HREF="auarf120.htm#HDRBOS_STARTUP">bos startup</A>
+<P><A HREF="auarf121.htm#HDRBOS_STATUS">bos status</A>
+<P>
+<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="auarf117.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="auarf119.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> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>