doc/html/AdminReference/auarf240.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="auarf239.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="auarf241.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="HDRUPCLIENT" HREF="auarf002.htm#ToC_254">upclient</A></H2>
  19 <A NAME="IDX5496"></A>
  20 <A NAME="IDX5497"></A>
  21 <A NAME="IDX5498"></A>
  22 <A NAME="IDX5499"></A>
  23 <A NAME="IDX5500"></A>
  24 <A NAME="IDX5501"></A>
  25 <P><STRONG>Purpose</STRONG>
  26 <P>Initializes the client portion of the Update Server
  27 <P><STRONG>Synopsis</STRONG>
  28 <PRE><B>upclient</B> &lt;<VAR>hostname</VAR>>  [<B>-crypt</B>]  [<B>-clear</B>]  [<B>-t </B>&lt;<VAR>retry&nbsp;time</VAR>>]
  29          [<B>-verbose</B>]<SUP>*</SUP>  &lt;<VAR>dir</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>upclient</B> command initializes the client portion of the
  35 Update Server. In the conventional configuration, its binary file is
  36 located in the <B>/usr/afs/bin</B> directory on a file server
  37 machine.
  38 <P>The <B>upclient</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>upclient</B> process periodically checks that all files in each
  45 local directory named by the <VAR>dir</VAR> argument match the files in the
  46 corresponding directory on the source machine named by the
  47 <VAR>hostname</VAR>argument. If a file does not match, the
  48 <B>upclient</B> process requests the source copy from the
  49 <B>upserver</B> process running on the source machine.
  50 <P>By default, the <B>upclient</B> process in the United States edition of
  51 AFS requests that the <B>upserver</B> process encrypt the data before
  52 transferring it, whereas in the international edition it requests unencrypted
  53 transfer. If using the United States edition, use the <B>-clear</B>
  54 flag to request unencrypted transfer if appropriate. (The
  55 <B>-crypt</B> flag explicitly sets the default in the United States
  56 edition, and is not available in the international edition.)
  57 <P>In the conventional configuration, separate instances of the
  58 <B>upclient</B> process request data from the <B>/usr/afs/bin</B> and
  59 <B>/usr/afs/etc</B> directories, except on machines for which the system
  60 control machine is also the binary distribution machine for the machine's
  61 system type. The conventional names for the separate instances are
  62 <B>upclientbin</B> and <B>upclientetc</B> respectively.
  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>hostname</VAR>
  77 </B><DD>Names either the cell's system control machine (if the requested
  78 directory is <B>/usr/afs/etc</B>), or the binary distribution machine for
  79 the local machine's CPU and operating system type (if the requested
  80 directory is <B>/usr/afs/bin</B>).
  81 <P><DT><B>-crypt
  82 </B><DD>Requests the transfer of data from the <B>upserver</B> process in
  83 encrypted form. With the United States edition of AFS, use this flag to
  84 set the default explicitly. Provide this flag or the <B>-crypt</B>
  85 flag, but not both.
  86 <TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT" VALIGN="TOP">This flag is not available in the international edition of AFS.
  87 </TD></TR></TABLE>
  88 <P><DT><B>-clear
  89 </B><DD>Requests transfer of data from the <B>upserver</B> process in
  90 unencrypted form. Use this flag to change from the default for the
  91 United States edition of AFS. Provide this flag or the
  92 <B>-crypt</B> flag, but not both.
  93 <P><DT><B>-t
  94 </B><DD>Specifies how often to check for changes in each specified directory, as a
  95 number of seconds. If this argument is omitted, the default is 300 (5
  96 minutes). This argument determines the maximum amount of time it takes
  97 for a change made on the source machine to propagate to this machine.
  98 <P><DT><B>-verbose
  99 </B><DD>Writes a trace of the <B>upclient</B> process's operations on the
 100 standard output stream, which usually corresponds to the machine
 101 console. Provide one, two, or three instances of the flag; each
 102 additional instance generates increasingly numerous and detailed
 103 messages.
 104 <P><DT><B><VAR>dir</VAR>
 105 </B><DD>Names each directory to check for modified files. The conventional
 106 choices are the following:
 107 <UL>
 108 <P><LI><B>/usr/afs/bin</B>, in which case the recommended name for the
 109 process (assigned with the <B>-instance</B> argument to the <B>bos
 110 create</B> command) is <B>upclientbin</B>. The <VAR>hostname</VAR>
 111 is the binary distribution machine for the local machine's system
 112 type. Use the <B>-clear</B> flag be used for the
 113 <B>/usr/afs/bin</B> directory, since binaries are not particularly
 114 sensitive and encrypting them can take a long time.
 115 <P><LI><B>/usr/afs/etc</B>, in which case the recommended name for the
 116 process (assigned with the <B>-instance</B> argument to the <B>bos
 117 create</B> command) is <B>upclientetc</B>. The <VAR>hostname</VAR>
 118 is the cell's system control machine. Use the <B>-crypt</B>
 119 flag for the <B>/usr/afs/etc</B> directory, since it contains the
 120 <B>KeyFile</B> file and other data vital to cell security.
 121 <P>As a reminder, do not use the Update Server to transfer the contents of the
 122 <B>/usr/afs/etc</B> directory if using the international edition of
 123 AFS.
 124 </UL>
 125 <P><DT><B>-help
 126 </B><DD>Prints the online help for this command. All other valid options
 127 are ignored.
 128 </DL>
 129 <P><STRONG>Examples</STRONG>
 130 <P>The following <B>bos create</B> command creates an
 131 <B>upclientbin</B> process on the machine
 132 <B>fs4.abc.com</B> that refers to the machine
 133 <B>fs1.abc.com</B> as the source for the
 134 <B>/usr/afs/bin</B> directory (thus <B>fs1.abc.com</B>
 135 is the binary distribution machine for machines of
 136 <B>fs4.abc.com</B>'s type). The files in the
 137 <B>/usr/afs/bin</B> directory are distributed every 120 seconds.
 138 The command requests transfer in unencrypted form.
 139 <PRE>   % <B>bos create  -server fs4.abc.com -instance upclientbin -type simple</B>   \
 140                  <B>-cmd "/usr/afs/bin/upclient fs1.abc.com -clear</B>  \
 141                  <B>-t 120 /usr/afs/bin"</B>
 142
 143 </PRE>
 144 <P><STRONG>Privilege Required</STRONG>
 145 <P>The issuer must be logged in as the superuser <B>root</B> on a file
 146 server machine to issue the command at a command shell prompt. It is
 147 conventional instead to create and start the process by issuing the <B>bos
 148 create</B> command.
 149 <P><STRONG>Related Information</STRONG>
 150 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
 151 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
 152 <P><A HREF="auarf241.htm#HDRUPSERVER">upserver</A>
 153 <P>
 154 <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="auarf239.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="auarf241.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>
 155 <!-- Begin Footer Records  ========================================== -->
 156 <P><HR><B>
 157 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 158 </B>
 159 <!-- End Footer Records  ============================================ -->
 160 <A NAME="Bot_Of_Page"></A>
 161 </BODY></HTML>