doc/xml/AdminReference/sect8/bos_setcellname.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_setcellname8">
   3   <refmeta>
   4     <refentrytitle>bos setcellname</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos setcellname</refname>
   9     <refpurpose>Sets the cell's name in ThisCell and CellServDB</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos setcellname</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-name</emphasis> &lt;<emphasis>cell name</emphasis>&gt;
  14         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">bos setc</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-n</emphasis> &lt;<emphasis>cell name</emphasis>&gt;
  17         [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [-h]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">bos setcellname</emphasis> command establishes the cell's name and makes the
  23     server machine named by the <emphasis role="bold">-server</emphasis> argument a member of it, by
  24     recording the value of the <emphasis role="bold">-name</emphasis> argument in two files which it creates
  25     on the local disk:</para>
  26
  27     <itemizedlist>
  28       <listitem>
  29         <para><replaceable>/usr/afs/etc/ThisCell</replaceable></para>
  30
  31       </listitem>
  32       <listitem>
  33         <para><replaceable>/usr/afs/etc/CellServDB</replaceable>. The cell name appears on the first line in the
  34         file, preceded by the required <computeroutput>&gt;</computeroutput> symbol.  The machine name
  35         specified with the <emphasis role="bold">-server</emphasis> argument appears on the second line along
  36         with its IP address as obtained from the cell's naming service. The
  37         machine is thus designated as the cell's first database server machine.</para>
  38
  39       </listitem>
  40     </itemizedlist>
  41   </refsect1>
  42   <refsect1>
  43     <title>Cautions</title>
  44     <para>Issue this command only when the installing the cell's first AFS server
  45     machine. The <emphasis>IBM AFS Quick Beginnings</emphasis> explains how to copy over the
  46     <replaceable>ThisCell</replaceable> and <replaceable>CellServDB</replaceable> files from this or another appropriate
  47     machine during installation of additional server machines.</para>
  48
  49     <para>Be sure to choose a satisfactory cell name when issuing this command,
  50     because changing a cell's name is very complicated; for one thing, it
  51     requires changing every password in the Authentication Database.  Consult
  52     the <emphasis>IBM AFS Administration Guide</emphasis> for advice on choosing a cell name.</para>
  53
  54   </refsect1>
  55   <refsect1>
  56     <title>Options</title>
  57     <variablelist>
  58       <varlistentry>
  59         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  60         <listitem>
  61           <para>Indicates the server machine on which to set the cell name in the
  62           <replaceable>ThisCell</replaceable> and <replaceable>CellServDB</replaceable> file. It is always the first machine
  63           installed in a cell. Identify the machine by IP address or its host name
  64           (either fully-qualified or abbreviated unambiguously).  For details, see
  65           <link linkend="bos8">bos(8)</link>.</para>
  66
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><emphasis role="bold">-name</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  71         <listitem>
  72           <para>Defines the cell name, using standard Internet domain name format (the
  73           actual domain name is usually appropriate). Examples are <computeroutput>abc.com</computeroutput> for
  74           the ABC Corporation and <computeroutput>stateu.edu</computeroutput> for the State University. It must
  75           match the value of the <emphasis role="bold">-cell</emphasis> argument, if that is provided.</para>
  76
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  81         <listitem>
  82           <para>Names the cell in which to run the command. Do not combine this argument
  83           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
  84
  85         </listitem>
  86       </varlistentry>
  87       <varlistentry>
  88         <term><emphasis role="bold">-noauth</emphasis></term>
  89         <listitem>
  90           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  91           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  92           <link linkend="bos8">bos(8)</link>.</para>
  93
  94         </listitem>
  95       </varlistentry>
  96       <varlistentry>
  97         <term><emphasis role="bold">-localauth</emphasis></term>
  98         <listitem>
  99           <para>Constructs a server ticket using a key from the local
 100           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
 101           ticket to the BOS Server during mutual authentication. Do not combine this
 102           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
 103           <link linkend="bos8">bos(8)</link>.</para>
 104
 105         </listitem>
 106       </varlistentry>
 107       <varlistentry>
 108         <term><emphasis role="bold">-help</emphasis></term>
 109         <listitem>
 110           <para>Prints the online help for this command. All other valid options are
 111           ignored.</para>
 112
 113         </listitem>
 114       </varlistentry>
 115     </variablelist>
 116   </refsect1>
 117   <refsect1>
 118     <title>Examples</title>
 119     <para>The following command defines the cell name <computeroutput>abc.com</computeroutput> in the <replaceable>ThisCell</replaceable>
 120     and <replaceable>CellServDB</replaceable> files on the machine <computeroutput>fs1.abc.com</computeroutput> as it is installed
 121     as the cell's first server machine.</para>
 122
 123 <programlisting>
 124    % bos setcellname -server fs1.abc.com -name abc.com
 125
 126 </programlisting>
 127     </refsect1>
 128     <refsect1>
 129       <title>Privilege Required</title>
 130       <para>Authorization checking is normally turned off during installation, which
 131       is the only recommended time to use this command; in this case no
 132       privilege is required. If authorization checking is turned on, the issuer
 133       must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the machine named
 134       by the <emphasis role="bold">-server</emphasis> argument, or must be logged in as the local superuser
 135       <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is included.</para>
 136
 137     </refsect1>
 138     <refsect1>
 139       <title>See Also</title>
 140       <para><link linkend="CellServDB5">CellServDB(5)</link>,
 141       <link linkend="KeyFile5">KeyFile(5)</link>,
 142       <link linkend="ThisCell5">ThisCell(5)</link>,
 143       <link linkend="UserList5">UserList(5)</link>,
 144       <link linkend="bos8">bos(8)</link></para>
 145
 146       <para><emphasis>IBM AFS Quick Beginnings</emphasis></para>
 147
 148       <para><emphasis>IBM AFS Administration Guide</emphasis></para>
 149
 150     </refsect1>
 151     <refsect1>
 152       <title>Copyright</title>
 153       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 154
 155       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 156       converted from HTML to POD by software written by Chas Williams and Russ
 157       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 158
 159     </refsect1>
 160   </refentry>