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 49The 50.Nm 51command dumps multicast group information from the kernel. 52.Pp 53The following options are supported: 54.Bl -tag -width Fl 55.It Fl i Ar interface 56specifies the interface to be displayed. 57.It Fl f Ar address-family 58specifies the address family to be displayed; 59.Ar inet , 60.Ar inet6 61and 62.Ar link 63are supported. 64.It Fl v 65specifies that link-layer memberships should be printed; 66they are suppressed by default. 67It may not be specified for 68.Fl f Ar link . 69Source lists for each group will also be printed. 70.Pp 71If specified twice, and 72.Xr kvm 3 73is in use, the control plane timers for each interface 74and the source list counters for each group 75will also be printed. 76.El 77.Pp 78The following options are only available if 79.Nm 80has been built with support for 81.Xr kvm 3 : 82.Bl -tag -width Fl 83.It Fl K 84attempts to use 85.Xr kvm 3 86to retrieve the multicast group information. 87.It Fl M Ar core 88extracts values associated with the name list from the specified core, 89instead of the default 90.Pa /dev/kmem . 91.It Fl N Ar system 92extracts the name list from the specified kernel instead of the 93default, which is the kernel image the system has booted from. 94.El 95.Sh IMPLEMENTATION NOTES 96.Nm 97will always print the embedded scope IDs of IPv6 multicast group 98memberships. 99This is because memberships are always scoped to an interface. 100.Pp 101When run with the 102.Fl v 103option, 104.Nm 105may print multicast MAC addresses twice if they are 106referenced by a layer 3 protocol. 107.Pp 108When run with 109.Xr kvm 3 110support, 111the names of all interfaces configured in the system will be 112printed in the first column of output, even if no multicast 113group memberships are present on those interfaces. 114The output may also be slightly different, as the kernel 115data structures are being traversed with minimal post-processing 116of the output. 117.Pp 118When built without 119.Xr kvm 3 120support, the information displayed by 121.Nm 122is more limited. 123This support is recommended for debugging purposes. 124It requires super-user privilege if used to inspect a running kernel. 125.Sh SEE ALSO 126.Xr netstat 1 , 127.Xr getifaddrs 3 , 128.Xr getifmaddrs 3 , 129.Xr kvm 3 130