doc/man-pages/pod1/cmdebug.pod

   1 =head1 NAME
   2
   3 cmdebug - Reports the status of a host Cache Manager
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<cmdebug> S<<< B<-servers> <I<machine>> >>> S<<< [B<-port> <I<IP port>>] >>>
  11     [B<-long>] [B<-refcounts>] [B<-callbacks>] [B<-ctime>] [B<-addrs>]
  12     [B<-cache>] [B<-cellservdb>] [B<-help>]
  13
  14 B<cmdebug> S<<< B<-s> <I<machine>> >>> S<<< [B<-p> <I<IP port>>] >>> [B<-l>] [B<-r>] [B<-cal>]
  15     [B<-ct>] [B<-a>] [B<-cac>] B<-ce>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<cmdebug> command displays information about the Cache Manager
  23 and client cache status on a local or remote AFS client machine.  By
  24 default, it displays all locked cache entries, but other information
  25 can be requested via various options.
  26
  27 =head1 CAUTIONS
  28
  29 The B<-ctime> option is only available with OpenAFS version 1.4.7 and
  30 later or version 1.5.28 or later.  This option can be used to gather
  31 information from any version of the Unix OpenAFS client, but can only
  32 query Windows clients running OpenAFS version 1.5.28 or later.
  33
  34 The B<-cellservdb> option is only available with OpenAFS version 1.4.7
  35 and later or version 1.5.31 or later.  This option can be used to gather
  36 information from any version of the Unix OpenAFS client, but can only
  37 query Windows clients running OpenAFS version 1.5.31 or later.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item B<-servers> <I<machine>>
  44
  45 Names the client machine for which to display Cache Manager status.
  46 Provide the machine's IP address in dotted decimal format, its fully
  47 qualified host name (for example, B<fs1.example.com>), or the shortest
  48 abbreviated form of its host name that distinguishes it from other
  49 machines. Successful use of an abbreviated form depends on the
  50 availability of a name resolution service (such as the Domain Name
  51 Service or a local host table) at the time the command is issued.
  52
  53 =item B<-port> <I<IP port>>
  54
  55 Identifies the port on which to contact the Cache Manager.  By default,
  56 the standard port 7001 is used, so this option is very rarely needed.
  57
  58 =item B<-long>
  59
  60 Reports on all lock statuses and all cache entries, rather than only
  61 locked cache entries.  Do not use this option with B<-refcounts>,
  62 B<-callbacks>, B<-addrs>, B<-cache>, or B<-cellservdb>.
  63
  64 =item B<-refcounts>
  65
  66 Reports only those cache entries with non-zero reference counts.  Do not
  67 use this option with B<-long>, B<-callbacks>, B<-addrs>, or B<-cache>.
  68
  69 =item B<-callbacks>
  70
  71 Reports only those cache entries with callbacks.  Do not use this option
  72 with B<-long>, B<-refcounts>, B<-addrs>, or B<-cache>.
  73
  74 =item B<-ctime>
  75
  76 Causes entry expiration times to be shown in human-readable format. Do
  77 not use this option with B<-addrs> or B<-cache>.
  78
  79 =item B<-addrs>
  80
  81 Rather than showing any cache entries, displays the interfaces the Cache
  82 Manager answers on, including their netmasks and MTUs.  This is useful for
  83 analyzing clients that are multihomed and identifying problems with
  84 netmasks or MTU settings.  Do not use this option with B<-long>,
  85 B<-refcounts>, B<-callbacks>, or B<-cache>.
  86
  87 =item B<-cache>
  88
  89 Rather than showing any cache entries, displays the cache configuration
  90 for the client machine.  The information displayed is essentially the
  91 information that can be configured via parameters to B<afsd>.  Do not use
  92 this option with B<-long>, B<-refcounts>, B<-callbacks>, or B<-addrs>.
  93
  94 =item B<-cellservdb>
  95
  96 Lists all known volume location database records in a
  97 CellServDB-compatible format. This includes all records in memory,
  98 including those from the CellServDB file, DNS SRV or AFSDB records, and
  99 the B<fs newcell> command. This option could be used to see if a client
 100 has the latest copy of the CellServDB file. Do not use this option
 101 with B<-long>, B<-refcounts>, B<-callbacks>, or B<-cache>.
 102
 103 =item B<-help>
 104
 105 Prints the online help for this command. All other valid options are
 106 ignored.
 107
 108 =back
 109
 110 =head1 EXAMPLES
 111
 112 Displays all of the locked cache entries on C<client1>:
 113
 114     % cmdebug client1
 115
 116 Displays the cache configuration for C<client1.example.com>:
 117
 118     % cmdebug client1.example.com -cache
 119
 120 Displays all cache entries for C<client2.example.com>:
 121
 122     % cmdebug client2.example.com -long
 123
 124 =head1 PRIVILEGE REQUIRED
 125
 126 None
 127
 128 =head1 SEE ALSO
 129
 130 L<afsd(8)>,
 131 L<CellServDB(5)>,
 132 L<fs_newcell(1)>
 133
 134 =head1 COPYRIGHT
 135
 136 Copyright 2005 Russ Allbery <rra@stanford.edu>
 137
 138 This documentation is covered by the IBM Public License Version 1.0.  This
 139 man page was written by Russ Allbery for OpenAFS.