doc/xml/AdminReference/sect1/vos_remsite.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="vos_remsite1">
   3   <refmeta>
   4     <refentrytitle>vos remsite</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>vos remsite</refname>
   9     <refpurpose>Removes a read-only site definition from a VLDB entry</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">vos remsite</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;
  14         <emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt; <emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;
  15         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>]
  16         [<emphasis role="bold">-help</emphasis>]</para>
  17
  18     <para><emphasis role="bold">vos rems</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-p</emphasis> &lt;<emphasis>partition name</emphasis>&gt;
  19         <emphasis role="bold">-i</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt; [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>]
  20         [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  21
  22   </refsect1>
  23   <refsect1>
  24     <title>Description</title>
  25     <para>The <emphasis role="bold">vos remsite</emphasis> command removes the read-only replication site
  26     specified by the <emphasis role="bold">-machine</emphasis> and <emphasis role="bold">-partition</emphasis> arguments from the Volume
  27     Location Database (VLDB) entry for the indicated volume, which is
  28     read/write.</para>
  29
  30     <para>This command is useful for removing read-only sites that were mistakenly
  31     created with the <emphasis role="bold">vos addsite</emphasis> command, before the <emphasis role="bold">vos release</emphasis> command
  32     actually releases them. If a read-only copy already exists at the site, it
  33     is not affected. However, if this read-only site was the last site housing
  34     any version of the volume, then the entire VLDB entry is removed, even if
  35     a copy of the read-only version still actually exists at the site. The VL
  36     Server does not correct the discrepancy until the <emphasis role="bold">vos syncserv</emphasis> and
  37     <emphasis role="bold">vos syncvldb</emphasis> commands are run.</para>
  38
  39   </refsect1>
  40   <refsect1>
  41     <title>Cautions</title>
  42     <para>Do not use this command as the standard way to remove a read-only volume,
  43     because it can create a discrepancy between the VLDB and the volumes on
  44     file server machines. Use the <emphasis role="bold">vos remove</emphasis> command instead.</para>
  45
  46   </refsect1>
  47   <refsect1>
  48     <title>Options</title>
  49     <variablelist>
  50       <varlistentry>
  51         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
  52         <listitem>
  53           <para>Specifies the file server machine portion of the site definition to
  54           remove. Provide the machine's IP address or its host name (either fully
  55           qualified or using an unambiguous abbreviation). For details, see
  56           <link linkend="vos1">vos(1)</link>.</para>
  57
  58         </listitem>
  59       </varlistentry>
  60       <varlistentry>
  61         <term><emphasis role="bold">-partition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
  62         <listitem>
  63           <para>Specifies the partition name portion of the site definition to
  64           remove. Provide the partition's complete name with preceding slash (for
  65           example, <computeroutput>/vicepa</computeroutput>) or use one of the three acceptable abbreviated
  66           forms. For details, see <link linkend="vos1">vos(1)</link>.</para>
  67
  68         </listitem>
  69       </varlistentry>
  70       <varlistentry>
  71         <term><emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or id</emphasis>&gt;</term>
  72         <listitem>
  73           <para>Specifies either the complete name or volume ID number of the read/write
  74           volume to remove.</para>
  75
  76         </listitem>
  77       </varlistentry>
  78       <varlistentry>
  79         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  80         <listitem>
  81           <para>Names the cell in which to run the command. Do not combine this argument
  82           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
  83
  84         </listitem>
  85       </varlistentry>
  86       <varlistentry>
  87         <term><emphasis role="bold">-noauth</emphasis></term>
  88         <listitem>
  89           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
  90           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
  91           <link linkend="vos1">vos(1)</link>.</para>
  92
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><emphasis role="bold">-localauth</emphasis></term>
  97         <listitem>
  98           <para>Constructs a server ticket using a key from the local
  99           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
 100           to the Volume Server and Volume Location Server during mutual
 101           authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
 102           <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
 103
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term><emphasis role="bold">-verbose</emphasis></term>
 108         <listitem>
 109           <para>Produces on the standard output stream a detailed trace of the command's
 110           execution. If this argument is omitted, only warnings and error messages
 111           appear.</para>
 112
 113         </listitem>
 114       </varlistentry>
 115       <varlistentry>
 116         <term><emphasis role="bold">-help</emphasis></term>
 117         <listitem>
 118           <para>Prints the online help for this command. All other valid options are
 119           ignored.</para>
 120
 121         </listitem>
 122       </varlistentry>
 123     </variablelist>
 124   </refsect1>
 125   <refsect1>
 126     <title>Examples</title>
 127     <para>The following command removes the mistakenly defined read-only site
 128     <replaceable>/viceph</replaceable> on the file server machine <computeroutput>fs5.abc.com</computeroutput> from the VLDB entry
 129     for the volume <computeroutput>root.cell</computeroutput>.</para>
 130
 131 <programlisting>
 132    % vos remsite -server fs5.abc.com -partition h -id root.cell
 133
 134 </programlisting>
 135     </refsect1>
 136     <refsect1>
 137       <title>Privilege Required</title>
 138       <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 139       machine specified with the <emphasis role="bold">-server</emphasis> argument and on each database server
 140       machine. If the <emphasis role="bold">-localauth</emphasis> flag is included, the issuer must instead be
 141       logged on to a server machine as the local superuser <computeroutput>root</computeroutput>.</para>
 142
 143     </refsect1>
 144     <refsect1>
 145       <title>See Also</title>
 146       <para><link linkend="vos1">vos(1)</link>,
 147       <link linkend="vos_delentry1">vos_delentry(1)</link>,
 148       <link linkend="vos_remove1">vos_remove(1)</link>,
 149       <link linkend="vos_zap1">vos_zap(1)</link></para>
 150
 151     </refsect1>
 152     <refsect1>
 153       <title>Copyright</title>
 154       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 155
 156       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 157       converted from HTML to POD by software written by Chas Williams and Russ
 158       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 159
 160     </refsect1>
 161   </refentry>