pam-afs-new-features-20010907
[openafs.git] / doc / html / AdminReference / auarf118.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="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> 
17 <P>
18 <H2><A NAME="HDRBOS_SHUTDOWN" HREF="auarf002.htm#ToC_132">bos shutdown</A></H2>
19 <A NAME="IDX4636"></A>
20 <A NAME="IDX4637"></A>
21 <A NAME="IDX4638"></A>
22 <A NAME="IDX4639"></A>
23 <A NAME="IDX4640"></A>
24 <A NAME="IDX4641"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Stops a process without changing its status flag in the
27 <B>/usr/afs/local/BosConfig</B> file
28 <P><STRONG>Synopsis</STRONG>
29 <PRE><B>bos shutdown -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-instance</B> &lt;<VAR>instances</VAR>><SUP>+</SUP>]  [<B>-wait</B>]  
30              [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
31     
32 <B>bos sh -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-i</B> &lt;<VAR>instances</VAR>><SUP>+</SUP>]  [<B>-w</B>]  
33        [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
34 </PRE>
35 <P><STRONG>Description</STRONG>
36 <P>The <B>bos shutdown</B> command stops, on the server machine named by
37 the <B>-server</B> argument, either 
38 <UL>
39 <P><LI>All of the currently running AFS server processes, except the BOS Server
40 <P><LI>Only the processes specified by the <B>-instance</B> argument
41 </UL>
42 <P>This command does not change a process's status flag in the
43 <B>/usr/afs/local/BosConfig</B> file, but only in the BOS Server's
44 memory. To stop a process and change its <B>BosConfig</B> status
45 flag, use the <B>bos stop</B> command instead.
46 <P>Once stopped with this command, a process does not run again until an
47 administrator starts it by using the <B>bos start</B>, <B>bos
48 startup</B>, or <B>bos restart</B> command, or until the BOS Server
49 restarts (assuming that the process's <B>BosConfig</B> status flag is
50 <TT>Run</TT>).
51 <P><STRONG>Options</STRONG>
52 <DL>
53 <P><DT><B><B>-server</B>
54 </B><DD>Indicates the server machine on which to stop processes. Identify
55 the machine by IP address or its host name (either fully-qualified or
56 abbreviated unambiguously). For details, see the introductory reference
57 page for the <B>bos</B> command suite.
58 <P><DT><B><B>-instance</B>
59 </B><DD>Names each process to stop. Use the process name assigned with the
60 <B>-instance</B> argument to the <B>bos create</B> command. The
61 output from the <B>bos status</B> command lists the names. Omit
62 this argument to stop all processes other than the BOS Server.
63 <P><DT><B><B>-wait</B>
64 </B><DD>Delays the return of the command shell prompt until all processes actually
65 stop. If this argument is omitted, the prompt returns almost
66 immediately even if all processes are not stopped.
67 <P><DT><B><B>-cell</B>
68 </B><DD>Names the cell in which to run the command. Do not combine this
69 argument with the <B>-localauth</B> flag. For more details, see the
70 introductory <B>bos</B> reference page.
71 <P><DT><B><B>-noauth</B>
72 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
73 issuer. Do not combine this flag with the <B>-localauth</B>
74 flag. For more details, see the introductory <B>bos</B> reference
75 page.
76 <P><DT><B><B>-localauth</B>
77 </B><DD>Constructs a server ticket using a key from the local
78 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
79 interpreter presents the ticket to the BOS Server during mutual
80 authentication. Do not combine this flag with the <B>-cell</B> or
81 <B>-noauth</B> options. For more details, see the introductory
82 <B>bos</B> reference page.
83 <P><DT><B>-help
84 </B><DD>Prints the online help for this command. All other valid options
85 are ignored.
86 </DL>
87 <P><STRONG>Examples</STRONG>
88 <P>The following command stops all processes other than the BOS Server on the
89 machine <B>fs3.abc.com</B>.
90 <PRE>   % <B>bos shutdown fs3.abc.com</B>
91    
92 </PRE>
93 <P>The following command stops the <B>upserver</B> process (server portion
94 of the Update Server) on the machine
95 <B>fs5.abc.com</B>.
96 <PRE>   % <B>bos shutdown -server fs5.abc.com -instance upserver</B>
97    
98 </PRE>
99 <P><STRONG>Privilege Required</STRONG>
100 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
101 the machine named by the <B>-server</B> argument, or must be logged onto a
102 server machine as the local superuser <B>root</B> if the
103 <B>-localauth</B> flag is included.
104 <P><STRONG>Related Information</STRONG>
105 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
106 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
107 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
108 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
109 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
110 <P><A HREF="auarf113.htm#HDRBOS_RESTART">bos restart</A>
111 <P><A HREF="auarf119.htm#HDRBOS_START">bos start</A>
112 <P><A HREF="auarf120.htm#HDRBOS_STARTUP">bos startup</A>
113 <P><A HREF="auarf121.htm#HDRBOS_STATUS">bos status</A>
114 <P>
115 <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> 
116 <!-- Begin Footer Records  ========================================== -->
117 <P><HR><B> 
118 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
119 </B> 
120 <!-- End Footer Records  ============================================ -->
121 <A NAME="Bot_Of_Page"></A>
122 </BODY></HTML>