1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
4 .\" Subject to the following obligations and disclaimer of warranty, use and
5 .\" redistribution of this software, in source or object code forms, with or
6 .\" without modifications are expressly permitted by Whistle Communications;
7 .\" provided, however, that:
8 .\" 1. Any and all reproductions of the source or object code must include the
9 .\" copyright notice above and the following disclaimer of warranties; and
10 .\" 2. No rights are granted, in any manner or form, to use Whistle
11 .\" Communications, Inc. trademarks, including the mark "WHISTLE
12 .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as
13 .\" such appears in the above copyright notice or in the software.
15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
35 .\" $FreeBSD: src/share/man/man4/ng_iface.4,v 1.13.2.1 2001/12/21 09:00:51 ru Exp $
36 .\" $DragonFly: src/share/man/man4/ng_iface.4,v 1.4 2008/05/02 02:05:05 swildner Exp $
37 .\" $Whistle: ng_iface.8,v 1.5 1999/01/25 23:46:26 archie Exp $
44 .Nd interface netgraph node type
46 .In netgraph/iface/ng_iface.h
50 node is both a netgraph node and a system networking interface. When an
52 node is created, a new interface appears which is accessible via
55 node interfaces are named
59 When a node is shutdown, the corresponding interface is removed
60 and the interface name becomes available for reuse by future
62 nodes; new nodes always take the first unused interface.
63 The node itself is assigned the same name as its interface, unless the name
64 already exists, in which case the node remains unnamed.
68 node has a single hook corresponding to each supported protocol.
69 Packets transmitted via the interface flow out the corresponding
70 protocol-specific hook.
71 Similarly, packets received on a hook appear on the interface as
72 packets received into the corresponding protocol stack.
73 The currently supported protocols are IP, IPv6, AppleTalk, IPX, ATM,
78 node be configured as a point-to-point interface or a broadcast interface.
79 The configuration can only be changed when the interface is down.
80 The default mode is point-to-point.
83 nodes support the Berkeley Packet Filter (BPF).
85 This node type supports the following hooks:
86 .Bl -tag -width foobar
88 Transmission and reception of IP packets.
90 Transmission and reception of IPv6 packets.
92 Transmission and reception of AppleTalk packets.
94 Transmission and reception of IPX packets.
96 Transmission and reception of ATM packets.
98 Transmission and reception of NATM packets.
100 Transmission and reception of NS packets.
103 This node type supports the generic control messages, plus the following:
105 .It Dv NGM_IFACE_GET_IFNAME
106 Returns the name of the interface corresponding to this node in a
107 .Dv "struct ng_iface_ifname" :
108 .Bd -literal -offset 4n
109 struct ng_iface_ifname {
110 char ngif_name[NG_IFACE_IFACE_NAME_MAX + 1];
113 .It Dv NGM_IFACE_POINT2POINT
114 Set the interface to point-to-point mode.
115 The interface must not currently be up.
116 .It Dv NGM_IFACE_BROADCAST
117 Set the interface to broadcast mode.
118 The interface must not currently be up.
119 .It Dv NGM_CISCO_GET_IPADDR
120 This message is defined by the
127 This node shuts down upon receipt of a
129 control message. The associated interface is removed and becomes available
134 Unlike most other node types, an
138 go away when all hooks have been disconnected; rather, and explicit
140 control message is required.
150 node type was implemented in
153 .An Archie Cobbs Aq archie@FreeBSD.org