added button GIF's to the HTML docs
[openafs.git] / doc / html / AdminReference / auarf241.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="auarf240.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="auarf242.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="HDRUPSERVER" HREF="auarf002.htm#ToC_255">upserver</A></H2>
19 <A NAME="IDX5502"></A>
20 <A NAME="IDX5503"></A>
21 <A NAME="IDX5504"></A>
22 <A NAME="IDX5505"></A>
23 <A NAME="IDX5506"></A>
24 <A NAME="IDX5507"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Initializes the server portion of the Update Server
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>upserver</B> [&lt;<VAR>directory</VAR>><SUP>+</SUP>]  [<B>-crypt</B> &lt;<VAR>directory</VAR>><SUP>+</SUP>]  [<B>-clear</B> &lt;<VAR>directory</VAR>><SUP>+</SUP>]
29          [<B>-auth</B> &lt;<VAR>directory</VAR>><SUP>+</SUP>]  [<B>-help</B>]
30 </PRE>
31 <P>This command does not use the syntax conventions of the AFS command
32 suites. Provide the command name and all option names in full.
33 <P><STRONG>Description</STRONG>
34 <P>The <B>upserver</B> command initializes the server portion of the
35 Update Server (the <B>upserver</B> process). In the conventional
36 configuration, its binary file is located in the <B>/usr/afs/bin</B>
37 directory on a file server machine.
38 <P>The <B>upserver</B> command is not normally issued at the command shell
39 prompt but rather placed into a file server machine's
40 <B>/usr/afs/local/BosConfig</B> file with the <B>bos create</B>
41 command. If it is ever issued at the command shell prompt, the issuer
42 must be logged onto a database server machine as the local superuser
43 <B>root</B>.
44 <P>The <B>upserver</B> command specifies which of the directories on the
45 local disk are eligible for distribution in response to requests from the
46 client portion of the Update Server (the <B>upclient</B> process) running
47 on other machines. If no directories are specified, the
48 <B>upserver</B> process distributes the contents of any directory on its
49 local disk.
50 <P>The <B>upserver</B> process can distribute a directory's contents
51 in encrypted or unencrypted form. By default, it does not use
52 encryption unless an <B>upclient</B> process requests it (this default is
53 equivalent to setting the <B>-clear</B> flag). When the
54 <B>-crypt</B> flag is provided, the <B>upserver</B> process only
55 fulfills requests for encrypted transfer.
56 <P>For the United States edition of AFS, using the <B>-crypt</B> flag
57 guarantees that the <B>upserver</B> process transfers a directory's
58 contents only in encrypted form. For the international edition, using
59 the <B>-crypt</B> flag completely blocks data transfer, because the
60 international edition of the <B>upclient</B> process cannot request
61 encrypted transfer (the <B>upclient</B> initialization command does not
62 include the <B>-crypt</B> flag).
63 <P>The <B>upclient</B> and <B>upserver</B> processes always mutually
64 authenticate, whether or not the data they pass is encrypted; they use
65 the key with the highest key version number in the
66 <B>/usr/afs/etc/KeyFile</B> file to construct a server ticket for mutual
67 authentication.
68 <P><STRONG>Cautions</STRONG>
69 <P>Do not use the Update Server to distribute the contents of the
70 <B>/usr/afs/etc</B> directory if using the international edition of
71 AFS. The contents of this directory are sensitive and the international
72 edition of AFS does not include the encryption routines necessary for
73 encrypting files before transfer across the network.
74 <P><STRONG>Options</STRONG>
75 <DL>
76 <P><DT><B><VAR>directory</VAR>
77 </B><DD>Names each directory to distribute in unencrypted form (because they
78 appear before the first <B>-crypt</B> or <B>-clear</B> flag on the
79 command line). If this argument is omitted, all directories on the
80 machine's local disk are eligible for distribution.
81 <P><DT><B>-crypt
82 </B><DD>Precedes a list of one or more directories that the <B>upserver</B>
83 process distributes only in encrypted form.
84 <P><DT><B>-clear
85 </B><DD>Precedes a list of one or more directories that the <B>upserver</B>
86 process distributes in unencrypted form unless the <B>upclient</B> process
87 requests them in encrypted form. Use this argument only if a list of
88 directories headed by the <B>-crypt</B> flag precedes it on the command
89 line.
90 <P><DT><B>-auth
91 </B><DD>Precedes a list of one or more directories which the <B>upserver</B>
92 process distributes using a form of encryption that is intermediate in
93 complexity and security between the unencrypted and encrypted levels set by
94 the <B>-clear</B> and <B>-crypt</B> arguments. Do not use this
95 argument, because the <B>upclient</B> process does not have a
96 corresponding argument that it can use to request data transfer at this
97 level.
98 <P><DT><B>-help
99 </B><DD>Prints the online help for this command. All other valid options
100 are ignored.
101 </DL>
102 <P><STRONG>Examples</STRONG>
103 <P>The following example <B>bos create</B> command defines and starts an
104 <B>upserver</B> process on the host machine
105 <B>fs1.abc.com</B>. The last parameter (enclosed in
106 quotes) instructs the <B>upserver</B> process to distribute the contents
107 of the <B>/usr/afs/bin</B> directory in unencrypted form and the contents
108 of the <B>/usr/afs/etc</B> directory in encrypted form.
109 <PRE>   % <B>bos create  -server fs1.abc.com -instance upserver -type simple</B>   \
110                  <B>-cmd "/usr/afs/bin/upserver /usr/afs/bin -crypt /usr/afs/etc"</B>
111 </PRE>
112 <P><STRONG>Privilege Required</STRONG>
113 <P>The issuer must be logged in as the superuser <B>root</B> on a file
114 server machine to issue the command at a command shell prompt. It is
115 conventional instead to create and start the process by issuing the <B>bos
116 create</B> command.
117 <P><STRONG>Related Information</STRONG>
118 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
119 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
120 <P><A HREF="auarf240.htm#HDRUPCLIENT">upclient</A>
121 <P>
122 <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="auarf240.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="auarf242.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> 
123 <!-- Begin Footer Records  ========================================== -->
124 <P><HR><B> 
125 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
126 </B> 
127 <!-- End Footer Records  ============================================ -->
128 <A NAME="Bot_Of_Page"></A>
129 </BODY></HTML>