usr.sbin/ifmcstat/ifmcstat.8

   1 .\"     $KAME: ifmcstat.8,v 1.6 2002/10/31 04:23:43 suz Exp $
   2 .\"
   3 .\" Copyright (c) 2007-2009 Bruce Simpson.
   4 .\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the project nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd May 27, 2009
  34 .Dt IFMCSTAT 8
  35 .Os
  36 .Sh NAME
  37 .Nm ifmcstat
  38 .Nd dump multicast group management statistics per interface
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl i Ar interface
  42 .Op Fl f Ar address-family
  43 .Op Fl v
  44 .Op Fl K
  45 .Op Fl M Ar core
  46 .Op Fl N Ar system
  47 .\"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 command dumps multicast group information from the kernel.
  52 .Pp
  53 The following options are supported:
  54 .Bl -tag -width Fl
  55 .It Fl i Ar interface
  56 specifies the interface to be displayed.
  57 .Pp
  58 .It Fl f Ar address-family
  59 specifies the address family to be displayed;
  60 .Ar inet ,
  61 .Ar inet6
  62 and
  63 .Ar link
  64 are supported.
  65 .It Fl v
  66 specifies that link-layer memberships should be printed;
  67 they are suppressed by default.
  68 It may not be specified for
  69 .Fl f Ar link .
  70 Source lists for each group will also be printed.
  71 .Pp
  72 If specified twice, and
  73 .Xr kvm 3
  74 is in use, the control plane timers for each interface
  75 and the source list counters for each group
  76 will also be printed.
  77 .El
  78 .Pp
  79 The following options are only available if
  80 .Nm
  81 has been built with support for
  82 .Xr kvm 3 :
  83 .Bl -tag -width Fl
  84 .It Fl K
  85 attempts to use
  86 .Xr kvm 3
  87 to retrieve the multicast group information.
  88 .It Fl M Ar core
  89 extracts values associated with the name list from the specified core,
  90 instead of the default
  91 .Pa /dev/kmem .
  92 .It Fl N Ar system
  93 extracts the name list from the specified kernel instead of the
  94 default, which is the kernel image the system has booted from.
  95 .El
  96 .Sh IMPLEMENTATION NOTES
  97 .Nm
  98 will always print the embedded scope IDs of IPv6 multicast group
  99 memberships.
 100 This is because memberships are always scoped to an interface.
 101 .Pp
 102 When run with the
 103 .Fl v
 104 option,
 105 .Nm
 106 may print multicast MAC addresses twice if they are
 107 referenced by a layer 3 protocol.
 108 .Pp
 109 When run with
 110 .Xr kvm 3
 111 support,
 112 the names of all interfaces configured in the system will be
 113 printed in the first column of output, even if no multicast
 114 group memberships are present on those interfaces.
 115 The output may also be slightly different, as the kernel
 116 data structures are being traversed with minimal post-processing
 117 of the output.
 118 .Pp
 119 When built without
 120 .Xr kvm 3
 121 support, the information displayed by
 122 .Nm
 123 is more limited.
 124 This support is recommended for debugging purposes.
 125 It requires super-user privilege if used to inspect a running kernel.
 126 .Pp
 127 .Sh SEE ALSO
 128 .Xr netstat 1 ,
 129 .Xr getifaddrs 3 ,
 130 .Xr getifmaddrs 3 ,
 131 .Xr kvm 3