src/WINNT/doc/install/Documentation/en_US/html/CmdRef/auarf111.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
   8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf110.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="auarf112.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_REMOVEKEY" HREF="auarf002.htm#ToC_125">bos removekey</A></H2>
  19 <A NAME="IDX4593"></A>
  20 <A NAME="IDX4594"></A>
  21 <A NAME="IDX4595"></A>
  22 <A NAME="IDX4596"></A>
  23 <A NAME="IDX4597"></A>
  24 <P><STRONG>Purpose</STRONG>
  25 <P>Removes a server encryption key from the <B>/usr/afs/etc/KeyFile</B>
  26 file
  27 <P><STRONG>Synopsis</STRONG>
  28 <PRE><B>bos removekey -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-kvno</B> &lt;<VAR>key&nbsp;version&nbsp;number</VAR>><SUP>+</SUP>
  29               [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
  30
  31 <B>bos removek -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-k</B> &lt;<VAR>key&nbsp;version&nbsp;number</VAR>><SUP>+</SUP>
  32             [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
  33 </PRE>
  34 <P><STRONG>Description</STRONG>
  35 <P>The <B>bos removekey</B> command removes each specified encryption key
  36 from the <B>/usr/afs/etc/KeyFile</B> file on the machine named by the
  37 <B>-server</B> argument. Use the <B>-kvno</B> argument to
  38 identify each key by its key version number; use the <B>bos
  39 listkeys</B> command to display the key version numbers.
  40 <P><STRONG>Cautions</STRONG>
  41 <P>Before removing a obsolete key, verify that the cell&#39;s maximum ticket
  42 lifetime has passed since the current key was defined using the <B>kas
  43 setpassword</B> and <B>bos addkey</B> commands. This ensures that
  44 no clients still possess tickets encrypted with the obsolete key.
  45 <P><STRONG>Options</STRONG>
  46 <DL>
  47 <P><DT><B><B>-server</B>
  48 </B><DD>Indicates the server machine on which to change the
  49 <B>/usr/afs/etc/KeyFile</B> file. Identify the machine by IP
  50 address or its host name (either fully-qualified or abbreviated
  51 unambiguously). For details, see the introductory reference page for
  52 the <B>bos</B> command suite.
  53 <P>In cells that run the United States edition of AFS and use the Update
  54 Server to distribute the contents of the <B>/usr/afs/etc</B> directory, it
  55 is conventional to specify only the system control machine as a value for the
  56 <B>-server</B> argument. In cells that run the international
  57 version of AFS, repeat the command for each file server machine. For
  58 further discussion, see the introductory reference page for the <B>bos</B>
  59 command suite.
  60 <P><DT><B><B>-kvno</B>
  61 </B><DD>Specifies the key version number of each key to remove.
  62 <P><DT><B><B>-cell</B>
  63 </B><DD>Names the cell in which to run the command. Do not combine this
  64 argument with the <B>-localauth</B> flag. For more details, see the
  65 introductory <B>bos</B> reference page.
  66 <P><DT><B><B>-noauth</B>
  67 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
  68 issuer. Do not combine this flag with the <B>-localauth</B>
  69 flag. For more details, see the introductory <B>bos</B> reference
  70 page.
  71 <P><DT><B><B>-localauth</B>
  72 </B><DD>Constructs a server ticket using a key from the local
  73 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
  74 interpreter presents the ticket to the BOS Server during mutual
  75 authentication. Do not combine this flag with the <B>-cell</B> or
  76 <B>-noauth</B> options. For more details, see the introductory
  77 <B>bos</B> reference page.
  78 <P><DT><B>-help
  79 </B><DD>Prints the online help for this command. All other valid options
  80 are ignored.
  81 </DL>
  82 <P><STRONG>Examples</STRONG>
  83 <P>The following command removes the keys with key version numbers 5 and 6
  84 from the <B>KeyFile</B> file on the system control machine
  85 <B>fs1.abc.com</B>.
  86 <PRE>   % <B>bos removekey -server fs1.abc.com -kvno 5 6</B>
  87
  88 </PRE>
  89 <P><STRONG>Privilege Required</STRONG>
  90 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
  91 the machine named by the <B>-server</B> argument, or must be logged onto a
  92 server machine as the local superuser <B>root</B> if the
  93 <B>-localauth</B> flag is included.
  94 <P><STRONG>Related Information</STRONG>
  95 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
  96 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
  97 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
  98 <P><A HREF="auarf095.htm#HDRBOS_ADDKEY">bos addkey</A>
  99 <P><A HREF="auarf107.htm#HDRBOS_LISTKEYS">bos listkeys</A>
 100 <P>
 101 <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="auarf110.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="auarf112.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>
 102 <!-- Begin Footer Records  ========================================== -->
 103 <P><HR><B>
 104 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 105 </B>
 106 <!-- End Footer Records  ============================================ -->
 107 <A NAME="Bot_Of_Page"></A>
 108 </BODY></HTML>