doc/xml/AdminReference/sect8/bos_getlog.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_getlog8">
   3   <refmeta>
   4     <refentrytitle>bos getlog</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos getlog</refname>
   9     <refpurpose>Prints a server process's log file</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos getlog</emphasis> <emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-file</emphasis> &lt;<emphasis>log file to examine</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 getl</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine name</emphasis>&gt; <emphasis role="bold">-f</emphasis> &lt;<emphasis>log file to examine</emphasis>&gt;
  17         [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">bos getlog</emphasis> command displays on the standard output stream the
  23     specified log file from the machine named by the <emphasis role="bold">-server</emphasis> argument. The
  24     BOS Server fetches the log file from the <replaceable>/usr/afs/logs</replaceable> directory unless
  25     an alternate pathname is provided as part of the <emphasis role="bold">-file</emphasis> argument.</para>
  26
  27   </refsect1>
  28   <refsect1>
  29     <title>Cautions</title>
  30     <para>Log files can grow quite large, especially for the database server
  31     processes. To keep them to a manageable size, periodically either use the
  32     UNIX <emphasis role="bold">rm</emphasis> command to truncate each log file, or use the <emphasis role="bold">bos restart</emphasis>
  33     command to restart each process.</para>
  34
  35     <para>It can take up to five minutes after the file is removed or process
  36     restarted for the space occupied by a log file to become available.</para>
  37
  38   </refsect1>
  39   <refsect1>
  40     <title>Options</title>
  41     <variablelist>
  42       <varlistentry>
  43         <term><emphasis role="bold">-server</emphasis> &lt;<emphasis>machine name</emphasis>&gt;</term>
  44         <listitem>
  45           <para>Indicates the server machine from which to retrieve the log file.
  46           Identify the machine by IP address or its host name (either
  47           fully-qualified or abbreviated unambiguously). For details, see <link linkend="bos8">bos(8)</link>.</para>
  48
  49         </listitem>
  50       </varlistentry>
  51       <varlistentry>
  52         <term><emphasis role="bold">-file</emphasis> &lt;<emphasis>log file to examine</emphasis>&gt;</term>
  53         <listitem>
  54           <para>Names the log file to display. If a filename only is provided, the BOS
  55           Server fetches the log file from the <replaceable>/usr/afs/logs</replaceable> directory; the
  56           standard values are:</para>
  57
  58           <variablelist>
  59             <varlistentry>
  60               <term><replaceable>AuthLog</replaceable></term>
  61               <listitem>
  62                 <para>The Authentication Server (<emphasis role="bold">kaserver</emphasis>) log file.</para>
  63
  64               </listitem>
  65             </varlistentry>
  66             <varlistentry>
  67               <term><replaceable>BackupLog</replaceable></term>
  68               <listitem>
  69                 <para>The Backup Server (<emphasis role="bold">buserver</emphasis>) log file.</para>
  70
  71               </listitem>
  72             </varlistentry>
  73             <varlistentry>
  74               <term><replaceable>BosLog</replaceable></term>
  75               <listitem>
  76                 <para>The BOS Server (<emphasis role="bold">bosserver</emphasis>) log file.</para>
  77
  78               </listitem>
  79             </varlistentry>
  80             <varlistentry>
  81               <term><replaceable>FileLog</replaceable></term>
  82               <listitem>
  83                 <para>The File Server (<emphasis role="bold">fileserver</emphasis>) log file.</para>
  84
  85               </listitem>
  86             </varlistentry>
  87             <varlistentry>
  88               <term><replaceable>SalvageLog</replaceable></term>
  89               <listitem>
  90                 <para>The Salvager (<emphasis role="bold">salvager</emphasis>) log file.</para>
  91
  92               </listitem>
  93             </varlistentry>
  94             <varlistentry>
  95               <term><replaceable>VLLog</replaceable></term>
  96               <listitem>
  97                 <para>The Volume Location (VL) Server (<emphasis role="bold">vlserver</emphasis>) log file.</para>
  98
  99               </listitem>
 100             </varlistentry>
 101             <varlistentry>
 102               <term><replaceable>VolserLog</replaceable></term>
 103               <listitem>
 104                 <para>The Volume Server (<emphasis role="bold">volserver</emphasis>) log file.</para>
 105
 106               </listitem>
 107             </varlistentry>
 108           </variablelist>
 109           <para>If a pathname and filename are provided, the log file is retrieved from
 110           the indicated directory. Partial pathnames are interpreted relative to the
 111           <replaceable>/usr/afs/logs</replaceable> directory.</para>
 112
 113         </listitem>
 114       </varlistentry>
 115       <varlistentry>
 116         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
 117         <listitem>
 118           <para>Names the cell in which to run the command. Do not combine this argument
 119           with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="bos8">bos(8)</link>.</para>
 120
 121         </listitem>
 122       </varlistentry>
 123       <varlistentry>
 124         <term><emphasis role="bold">-noauth</emphasis></term>
 125         <listitem>
 126           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
 127           combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
 128           <link linkend="bos8">bos(8)</link>.</para>
 129
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><emphasis role="bold">-localauth</emphasis></term>
 134         <listitem>
 135           <para>Constructs a server ticket using a key from the local
 136           <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">bos</emphasis> command interpreter presents the
 137           ticket to the BOS Server during mutual authentication. Do not combine this
 138           flag with the <emphasis role="bold">-cell</emphasis> or <emphasis role="bold">-noauth</emphasis> options. For more details, see
 139           <link linkend="bos8">bos(8)</link>.</para>
 140
 141         </listitem>
 142       </varlistentry>
 143       <varlistentry>
 144         <term><emphasis role="bold">-help</emphasis></term>
 145         <listitem>
 146           <para>Prints the online help for this command. All other valid options are
 147           ignored.</para>
 148
 149         </listitem>
 150       </varlistentry>
 151     </variablelist>
 152   </refsect1>
 153   <refsect1>
 154     <title>Output</title>
 155     <para>The output is preceded by the line</para>
 156
 157 <programlisting>
 158    Fetching log file '&amp;lt;filename&amp;gt;'...
 159
 160 </programlisting>
 161       <para>The remainder of the output depends on the particular log file.</para>
 162
 163     </refsect1>
 164     <refsect1>
 165       <title>Examples</title>
 166       <para>The following example displays the FileLog file from the machine
 167       <computeroutput>fs3.abc.com</computeroutput>:</para>
 168
 169 <programlisting>
 170    % bos getlog -server fs3.abc.com -file FileLog
 171    Fetching log file 'FileLog'...
 172    Sun Nov 8 04:00:34 1998 File server starting
 173    Sun Nov 8 04:00:39 1998 Partition /vicepa:  attached 21 volumes;
 174                            0 volumes not attached
 175    Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40
 176                            1998
 177    Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c)
 178                            failed for host 28cf37c0.22811
 179
 180 </programlisting>
 181       </refsect1>
 182       <refsect1>
 183         <title>Privilege Required</title>
 184         <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
 185         machine named by the <emphasis role="bold">-server</emphasis> argument, or must be logged onto a server
 186         machine as the local superuser <computeroutput>root</computeroutput> if the <emphasis role="bold">-localauth</emphasis> flag is
 187         included.</para>
 188
 189       </refsect1>
 190       <refsect1>
 191         <title>See Also</title>
 192         <para><link linkend="bos8">bos(8)</link></para>
 193
 194       </refsect1>
 195       <refsect1>
 196         <title>Copyright</title>
 197         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 198
 199         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 200         converted from HTML to POD by software written by Chas Williams and Russ
 201         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 202
 203       </refsect1>
 204     </refentry>