doc/xml/AdminReference/sect1/cmdebug.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="cmdebug1">
   3   <refmeta>
   4     <refentrytitle>cmdebug</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>cmdebug</refname>
   9     <refpurpose>Reports the status of a host Cache Manager</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">cmdebug</emphasis> <emphasis role="bold">-servers</emphasis> &lt;<emphasis>machine</emphasis>&gt; [<emphasis role="bold">-port</emphasis> &lt;<emphasis>IP port</emphasis>&gt;]
  14         [<emphasis role="bold">-long</emphasis>] [<emphasis role="bold">-refcounts</emphasis>] [<emphasis role="bold">-callbacks</emphasis>] [<emphasis role="bold">-addrs</emphasis>] [<emphasis role="bold">-cache</emphasis>]</para>
  15
  16     <para><emphasis role="bold">cmdebug</emphasis> <emphasis role="bold">-s</emphasis> &lt;<emphasis>machine</emphasis>&gt; [<emphasis role="bold">-p</emphasis> &lt;<emphasis>IP port</emphasis>&gt;] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-r</emphasis>] [<emphasis role="bold">-c</emphasis>]
  17         [<emphasis role="bold">-a</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">cmdebug</emphasis> command displays information about the Cache Manager and
  23     client cache status on an AFS client machine.  By default, it displays all
  24     locked cache entries, but other information can be requested via various
  25     options.</para>
  26
  27   </refsect1>
  28   <refsect1>
  29     <title>Options</title>
  30     <variablelist>
  31       <varlistentry>
  32         <term><emphasis role="bold">-servers</emphasis> &lt;<emphasis>machine</emphasis>&gt;</term>
  33         <listitem>
  34           <para>Names the client machine for which to display Cache Manager status.
  35           Provide the machine's IP address in dotted decimal format, its fully
  36           qualified host name (for example, <emphasis role="bold">fs1.abc.com</emphasis>), or the shortest
  37           abbreviated form of its host name that distinguishes it from other
  38           machines. Successful use of an abbreviated form depends on the
  39           availability of a name resolution service (such as the Domain Name Service
  40           or a local host table) at the time the command is issued.</para>
  41
  42         </listitem>
  43       </varlistentry>
  44       <varlistentry>
  45         <term><emphasis role="bold">-port</emphasis> &lt;<emphasis>IP port</emphasis>&gt;</term>
  46         <listitem>
  47           <para>Identifies the port on which to contact the Cache Manager.  By default,
  48           the standard port 7001 is used, so this option is very rarely needed.</para>
  49
  50         </listitem>
  51       </varlistentry>
  52       <varlistentry>
  53         <term><emphasis role="bold">-long</emphasis></term>
  54         <listitem>
  55           <para>Reports on all lock statuses and all cache entries, rather than only
  56           locked cache entries.  Do not use this option with <emphasis role="bold">-refcounts</emphasis>,
  57           <emphasis role="bold">-callbacks</emphasis>, <emphasis role="bold">-addrs</emphasis>, or <emphasis role="bold">-cache</emphasis>.</para>
  58
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><emphasis role="bold">-refcounts</emphasis></term>
  63         <listitem>
  64           <para>Reports only those cache entries with non-zero reference counts.  Do not
  65           use this option with <emphasis role="bold">-long</emphasis>, <emphasis role="bold">-callbacks</emphasis>, <emphasis role="bold">-addrs</emphasis>, or <emphasis role="bold">-cache</emphasis>.</para>
  66
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term><emphasis role="bold">-callbacks</emphasis></term>
  71         <listitem>
  72           <para>Reports only those cache entries with callbacks.  Do not use this option
  73           with <emphasis role="bold">-long</emphasis>, <emphasis role="bold">-refcounts</emphasis>, <emphasis role="bold">-addrs</emphasis>, or <emphasis role="bold">-cache</emphasis>.</para>
  74
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term><emphasis role="bold">-addrs</emphasis></term>
  79         <listitem>
  80           <para>Rather than showing any cache entries, displays the interfaces the Cache
  81           Manager answers on, including their netmasks and MTUs.  This is useful for
  82           analyzing clients that are multihomed and identifying problems with
  83           netmasks or MTU settings.  Do not use this option with <emphasis role="bold">-long</emphasis>,
  84           <emphasis role="bold">-refcounts</emphasis>, <emphasis role="bold">-callbacks</emphasis>, or <emphasis role="bold">-cache</emphasis>.</para>
  85
  86         </listitem>
  87       </varlistentry>
  88       <varlistentry>
  89         <term><emphasis role="bold">-cache</emphasis></term>
  90         <listitem>
  91           <para>Rather than showing any cache entries, displays the cache configuration
  92           for the client machine.  The information displayed is essentially the
  93           information that can be configured via parameters to <emphasis role="bold">afsd</emphasis>.  Do not use
  94           this option with <emphasis role="bold">-long</emphasis>, <emphasis role="bold">-refcounts</emphasis>, <emphasis role="bold">-callbacks</emphasis>, or <emphasis role="bold">-addrs</emphasis>.</para>
  95
  96         </listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term><emphasis role="bold">-help</emphasis></term>
 100         <listitem>
 101           <para>Prints the online help for this command. All other valid options are
 102           ignored.</para>
 103
 104         </listitem>
 105       </varlistentry>
 106     </variablelist>
 107   </refsect1>
 108   <refsect1>
 109     <title>Examples</title>
 110     <para>Displays all of the locked cache entries on <computeroutput>client1</computeroutput>:</para>
 111
 112 <programlisting>
 113     % cmdebug client1
 114
 115 </programlisting>
 116       <para>Displays the cache configuration for <computeroutput>client1.abc.com</computeroutput>:</para>
 117
 118 <programlisting>
 119     % cmdebug client1.abc.com -cache
 120
 121 </programlisting>
 122         <para>Displays all cache entries for <computeroutput>client2.abc.com</computeroutput>:</para>
 123
 124 <programlisting>
 125     % cmdebug client2.abc.com -long
 126
 127 </programlisting>
 128         </refsect1>
 129         <refsect1>
 130           <title>Privilege Required</title>
 131           <para>None</para>
 132
 133         </refsect1>
 134         <refsect1>
 135           <title>See Also</title>
 136           <para><link linkend="afsd8">afsd(8)</link></para>
 137
 138         </refsect1>
 139         <refsect1>
 140           <title>Copyright</title>
 141           <para>Copyright 2005 Russ Allbery &lt;rra@stanford.edu&gt;</para>
 142
 143           <para>This documentation is covered by the IBM Public License Version 1.0.  This
 144           man page was written by Russ Allbery for OpenAFS.</para>
 145
 146         </refsect1>
 147       </refentry>