Bring in the IWI driver from FreeBSD and merge in ALTQ support.
[dragonfly.git] / sbin / ifconfig / ifconfig.8
CommitLineData
984263bc
MD
1.\" Copyright (c) 1983, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
984263bc
MD
12.\" 4. Neither the name of the University nor the names of its contributors
13.\" may be used to endorse or promote products derived from this software
14.\" without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
b50e4759
MD
29.\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.85 2004/07/27 09:51:49 yar Exp $
30.\" $DragonFly: src/sbin/ifconfig/ifconfig.8,v 1.5 2005/03/06 05:01:59 dillon Exp $
984263bc 31.\"
b50e4759 32.Dd July 26, 2004
984263bc
MD
33.Dt IFCONFIG 8
34.Os
35.Sh NAME
36.Nm ifconfig
37.Nd configure network interface parameters
38.Sh SYNOPSIS
39.Nm
40.Op Fl L
41.Op Fl m
42.Ar interface
43.Op Cm create
44.Op Ar address_family
45.Oo
46.Ar address
47.Op Ar dest_address
48.Oc
49.Op Ar parameters
50.Nm
51.Ar interface
52.Cm destroy
53.Nm
54.Fl a
55.Op Fl L
56.Op Fl d
57.Op Fl m
58.Op Fl u
59.Op Ar address_family
60.Nm
61.Fl l
62.Op Fl d
63.Op Fl u
64.Op Ar address_family
65.Nm
66.Op Fl L
67.Op Fl d
68.Op Fl m
69.Op Fl u
70.Op Fl C
71.Sh DESCRIPTION
72The
73.Nm
74utility is used to assign an address
75to a network interface and/or configure
76network interface parameters.
77The
78.Nm
79utility must be used at boot time to define the network address
80of each interface present on a machine; it may also be used at
81a later time to redefine an interface's address
82or other operating parameters.
83.Pp
84The following options are available:
85.Bl -tag -width indent
86.It Ar address
87For the
88.Tn DARPA Ns -Internet
89family,
90the address is either a host name present in the host name data
91base,
92.Xr hosts 5 ,
93or a
94.Tn DARPA
95Internet address expressed in the Internet standard
96.Dq dot notation .
97.Pp
98It is also possible to use the CIDR notation (also known as the
99slash notation) to include the netmask.
100That is, one can specify an address like
101.Li 192.168.0.1/16 .
102.Pp
103For
104.Dq inet6
105family, it is also possible to specify the prefix length using the slash
106notation, like
107.Li ::1/128 .
108See the
109.Cm prefixlen
110parameter below for more information.
111.\" For the Xerox Network Systems(tm) family,
112.\" addresses are
113.\" .Ar net:a.b.c.d.e.f ,
114.\" where
115.\" .Ar net
116.\" is the assigned network number (in decimal),
117.\" and each of the six bytes of the host number,
118.\" .Ar a
119.\" through
120.\" .Ar f ,
121.\" are specified in hexadecimal.
122.\" The host number may be omitted on IEEE 802 protocol
123.\" (Ethernet, FDDI, and Token Ring) interfaces,
124.\" which use the hardware physical address,
125.\" and on interfaces other than the first.
126.\" For the
127.\" .Tn ISO
128.\" family, addresses are specified as a long hexadecimal string,
129.\" as in the Xerox family.
130.\" However, two consecutive dots imply a zero
131.\" byte, and the dots are optional, if the user wishes to (carefully)
132.\" count out long strings of digits in network byte order.
133.Pp
134The link-level
135.Pq Dq link
136address
137is specified as a series of colon-separated hex digits.
138This can be used to
b50e4759 139e.g.\& set a new MAC address on an ethernet interface, though the
984263bc
MD
140mechanism used is not ethernet-specific.
141If the interface is already
142up when this option is used, it will be briefly brought down and
143then brought back up again in order to ensure that the receive
144filter in the underlying ethernet hardware is properly reprogrammed.
145.It Ar address_family
146Specify the
147address family
148which affects interpretation of the remaining parameters.
149Since an interface can receive transmissions in differing protocols
150with different naming schemes, specifying the address family is recommended.
151The address or protocol families currently
152supported are
153.Dq inet ,
154.Dq inet6 ,
155.Dq atalk ,
156.Dq ipx ,
157.\" .Dq iso ,
158and
159.Dq link .
160.\" and
161.\" .Dq ns .
162The default is
163.Dq inet .
164.Dq ether
165and
166.Dq lladdr
167are synonyms for
168.Dq link .
169.It Ar dest_address
170Specify the address of the correspondent on the other end
171of a point to point link.
172.It Ar interface
173This
174parameter is a string of the form
175.Dq name unit ,
176for example,
177.Dq Li ed0 .
178.El
179.Pp
180The following parameters may be set with
181.Nm :
182.Bl -tag -width indent
183.It Cm add
184Another name for the
185.Cm alias
186parameter.
187Introduced for compatibility
188with
189.Bsx .
190.It Cm alias
191Establish an additional network address for this interface.
192This is sometimes useful when changing network numbers, and
193one wishes to accept packets addressed to the old interface.
194If the address is on the same subnet as the first network address
195for this interface, a non-conflicting netmask must be given.
196Usually
197.Li 0xffffffff
198is most appropriate.
199.It Fl alias
b50e4759 200Remove the network address specified.
984263bc
MD
201This would be used if you incorrectly specified an alias, or it
202was no longer needed.
203If you have incorrectly set an NS address having the side effect
204of specifying the host portion, removing all NS addresses will
205allow you to respecify the host portion.
206.It Cm anycast
207(Inet6 only.)
208Specify that the address configured is an anycast address.
209Based on the current specification,
210only routers may configure anycast addresses.
211Anycast address will not be used as source address of any of outgoing
212IPv6 packets.
213.It Cm arp
214Enable the use of the Address Resolution Protocol
215.Pq Xr arp 4
216in mapping
217between network level addresses and link level addresses (default).
218This is currently implemented for mapping between
219.Tn DARPA
220Internet
221addresses and
222.Tn IEEE
223802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
224.It Fl arp
225Disable the use of the Address Resolution Protocol
226.Pq Xr arp 4 .
227.It Cm broadcast
228(Inet only.)
229Specify the address to use to represent broadcasts to the
230network.
231The default broadcast address is the address with a host part of all 1's.
232.It Cm debug
233Enable driver dependent debugging code; usually, this turns on
234extra console error logging.
235.It Fl debug
236Disable driver dependent debugging code.
237.It Cm promisc
238Put interface into permanently promiscuous mode.
239.It Fl promisc
240Disable permanently promiscuous mode.
241.It Cm delete
242Another name for the
243.Fl alias
244parameter.
245.It Cm down
246Mark an interface
247.Dq down .
248When an interface is marked
249.Dq down ,
250the system will not attempt to
251transmit messages through that interface.
252If possible, the interface will be reset to disable reception as well.
253This action does not automatically disable routes using the interface.
254.It Cm eui64
255(Inet6 only.)
256Fill interface index
257(lowermost 64bit of an IPv6 address)
258automatically.
259.\" .It Cm ipdst
260.\" This is used to specify an Internet host who is willing to receive
261.\" ip packets encapsulating NS packets bound for a remote network.
262.\" An apparent point to point link is constructed, and
263.\" the address specified will be taken as the NS address and network
264.\" of the destination.
265.\" IP encapsulation of
266.\" .Tn CLNP
267.\" packets is done differently.
b50e4759
MD
268 .It Cm maclabel Ar label
269 If Mandatory Access Control support is enabled in the kernel,
270 set the MAC label to
271 .Ar label .
272.\" (see
273.\" .Xr maclabel 7 ) .
984263bc
MD
274.It Cm media Ar type
275If the driver supports the media selection system, set the media type
276of the interface to
277.Ar type .
278Some interfaces support the mutually exclusive use of one of several
279different physical media connectors.
280For example, a 10Mb/s Ethernet
281interface might support the use of either
282.Tn AUI
283or twisted pair connectors.
284Setting the media type to
b50e4759 285.Dq Li 10base5/AUI
984263bc
MD
286would change the currently active connector to the AUI port.
287Setting it to
b50e4759 288.Dq Li 10baseT/UTP
984263bc
MD
289would activate twisted pair.
290Refer to the interfaces' driver
291specific documentation or man page for a complete list of the
292available types.
293.It Cm mediaopt Ar opts
294If the driver supports the media selection system, set the specified
295media options on the interface.
296The
297.Ar opts
298argument
299is a comma delimited list of options to apply to the interface.
300Refer to the interfaces' driver specific man page for a complete
301list of available options.
302.It Fl mediaopt Ar opts
303If the driver supports the media selection system, disable the
304specified media options on the interface.
b50e4759
MD
305.It Cm mode Ar mode
306If the driver supports the media selection system, set the specified
307operating mode on the interface to
308.Ar mode .
309For IEEE 802.11 wireless interfaces that support multiple operating modes
310this directive is used to select between 802.11a
311.Pq Dq Li 11a ,
312802.11b
313.Pq Dq Li 11b ,
314and 802.11g
315.Pq Dq Li 11g
316operating modes.
317.It Cm name Ar name
318Set the interface name to
319.Ar name .
320.It Cm rxcsum , txcsum
321If the driver supports user-configurable checksum offloading,
322enable receive (or transmit) checksum offloading on the interface.
323Some drivers may not be able to enable these flags independently
324of each other, so setting one may also set the other.
325The driver will offload as much checksum work as it can reliably
326support, the exact level of offloading varies between drivers.
327.\".It Fl rxcsum , Fl txcsum
328.\"If the driver supports user-configurable checksum offloading,
329.\"disable receive (or transmit) checksum offloading on the interface.
330.\"These settings may not always be independent of each other.
331.\".It Cm polling
332.\"If the driver has user-configurable
333.\".Xr polling 4
334.\"support, select the polling mode on the interface.
335.\".It Fl polling
336.\"If the driver has user-configurable
337.\".Xr polling 4
338.\"support, select the interrupt mode on the interface.
984263bc
MD
339.It Cm tunnel Ar src_addr dest_addr
340(IP tunnel devices only.)
341Configure the physical source and destination address for IP tunnel
342interfaces
343.Pq Xr gif 4 .
344The arguments
345.Ar src_addr
346and
347.Ar dest_addr
348are interpreted as the outer source/destination for the encapsulating
349IPv4/IPv6 header.
350.It Cm deletetunnel
351Unconfigure the physical source and destination address for IP tunnel
352interfaces previously configured with
353.Cm tunnel .
354.It Cm create
355Create the specified network pseudo-device.
356If the interface is given without a unit number, try to create a new
357device with an arbitrary unit number.
358If creation of an arbitrary device is successful, the new device name is
359printed to standard output.
360.It Cm destroy
361Destroy the specified network pseudo-device.
362.It Cm plumb
363Another name for the
364.Cm create
365parameter.
366Included for
367.Tn Solaris
368compatibility.
369.It Cm unplumb
370Another name for the
371.Cm destroy
372parameter.
373Included for
374.Tn Solaris
375compatibility.
376.It Cm vlan Ar vlan_tag
b50e4759
MD
377If the interface is a
378.Xr vlan 4
379pseudo interface, set the VLAN tag value
984263bc
MD
380to
381.Ar vlan_tag .
382This value is a 16-bit number which is used to create an 802.1Q
b50e4759
MD
383VLAN header for packets sent from the
384.Xr vlan 4
385interface.
984263bc
MD
386Note that
387.Cm vlan
388and
389.Cm vlandev
390must both be set at the same time.
391.It Cm vlandev Ar iface
b50e4759
MD
392If the interface is a
393.Xr vlan 4
394pseudo device, associate physical interface
984263bc
MD
395.Ar iface
396with it.
b50e4759
MD
397Packets transmitted through the
398.Xr vlan 4
399interface will be
984263bc
MD
400diverted to the specified physical interface
401.Ar iface
b50e4759 402with 802.1Q VLAN encapsulation.
984263bc 403Packets with 802.1Q encapsulation received
b50e4759
MD
404by the parent interface with the correct VLAN tag will be diverted to
405the associated
406.Xr vlan 4
407pseudo-interface.
408The
409.Xr vlan 4
410interface is assigned a
984263bc
MD
411copy of the parent interface's flags and the parent's ethernet address.
412The
413.Cm vlandev
414and
415.Cm vlan
416must both be set at the same time.
b50e4759
MD
417If the
418.Xr vlan 4
419interface already has
984263bc
MD
420a physical interface associated with it, this command will fail.
421To
422change the association to another physical interface, the existing
423association must be cleared first.
424.Pp
b50e4759
MD
425Note: if the hardware tagging capability
426is set on the parent interface, the
427.Xr vlan 4
428pseudo
429interface's behavior changes:
430the
431.Xr vlan 4
432interface recognizes that the
433parent interface supports insertion and extraction of VLAN tags on its
984263bc
MD
434own (usually in firmware) and that it should pass packets to and from
435the parent unaltered.
436.It Fl vlandev Ar iface
b50e4759
MD
437If the driver is a
438.Xr vlan 4
439pseudo device, disassociate the physical interface
984263bc
MD
440.Ar iface
441from it.
b50e4759
MD
442This breaks the link between the
443.Xr vlan 4
444interface and its parent,
445clears its VLAN tag, flags and its link address and shuts the interface down.
446.It Cm vlanmtu , vlanhwtag
447If the driver offers user-configurable VLAN support, enable
448reception of extended frames or tag processing in hardware,
449respectively.
450Note that this must be issued on a physical interface associated with
451.Xr vlan 4 ,
452not on a
453.Xr vlan 4
454interface itself.
455.It Fl vlanmtu , Fl vlanhwtag
456If the driver offers user-configurable VLAN support, disable
457reception of extended frames or tag processing in hardware,
458respectively.
984263bc
MD
459.It Cm metric Ar n
460Set the routing metric of the interface to
461.Ar n ,
462default 0.
463The routing metric is used by the routing protocol
464.Pq Xr routed 8 .
465Higher metrics have the effect of making a route
466less favorable; metrics are counted as addition hops
467to the destination network or host.
468.It Cm mtu Ar n
469Set the maximum transmission unit of the interface to
470.Ar n ,
471default is interface specific.
472The MTU is used to limit the size of packets that are transmitted on an
473interface.
474Not all interfaces support setting the MTU, and some interfaces have
475range restrictions.
476.It Cm netmask Ar mask
477.\" (Inet and ISO.)
478(Inet only.)
479Specify how much of the address to reserve for subdividing
480networks into sub-networks.
481The mask includes the network part of the local address
482and the subnet part, which is taken from the host field of the address.
483The mask can be specified as a single hexadecimal number
484with a leading
485.Ql 0x ,
486with a dot-notation Internet address,
487or with a pseudo-network name listed in the network table
488.Xr networks 5 .
489The mask contains 1's for the bit positions in the 32-bit address
490which are to be used for the network and subnet parts,
491and 0's for the host part.
492The mask should contain at least the standard network portion,
493and the subnet field should be contiguous with the network
494portion.
495.Pp
496The netmask can also be specified in CIDR notation after the address.
497See the
498.Ar address
499option above for more information.
500.It Cm prefixlen Ar len
501(Inet6 only.)
502Specify that
503.Ar len
504bits are reserved for subdividing networks into sub-networks.
505The
506.Ar len
507must be integer, and for syntactical reason it must be between 0 to 128.
508It is almost always 64 under the current IPv6 assignment rule.
509If the parameter is omitted, 64 is used.
510.Pp
511The prefix can also be specified using the slash notation after the address.
512See the
513.Ar address
514option above for more information.
515.\" see
516.\" Xr eon 5 .
517.\" .It Cm nsellength Ar n
518.\" .Pf ( Tn ISO
519.\" only)
520.\" This specifies a trailing number of bytes for a received
521.\" .Tn NSAP
522.\" used for local identification, the remaining leading part of which is
523.\" taken to be the
524.\" .Tn NET
525.\" (Network Entity Title).
526.\" The default value is 1, which is conformant to US
527.\" .Tn GOSIP .
528.\" When an ISO address is set in an ifconfig command,
529.\" it is really the
530.\" .Tn NSAP
531.\" which is being specified.
532.\" For example, in
533.\" .Tn US GOSIP ,
534.\" 20 hex digits should be
535.\" specified in the
536.\" .Tn ISO NSAP
537.\" to be assigned to the interface.
538.\" There is some evidence that a number different from 1 may be useful
539.\" for
540.\" .Tn AFI
541.\" 37 type addresses.
542.It Cm range Ar netrange
543Under appletalk, set the interface to respond to a
544.Ar netrange
545of the form
546.Ar startnet Ns - Ns Ar endnet .
547Appletalk uses this scheme instead of
548netmasks though
b50e4759 549.Fx
984263bc
MD
550implements it internally as a set of netmasks.
551.It Cm remove
552Another name for the
553.Fl alias
554parameter.
555Introduced for compatibility
556with
557.Bsx .
558.It Cm phase
559The argument following this specifies the version (phase) of the
560Appletalk network attached to the interface.
561Values of 1 or 2 are permitted.
562.Sm off
563.It Cm link Op Cm 0 No - Cm 2
564.Sm on
565Enable special processing of the link level of the interface.
566These three options are interface specific in actual effect, however,
567they are in general used to select special modes of operation.
568An example
569of this is to enable SLIP compression, or to select the connector type
570for some Ethernet cards.
571Refer to the man page for the specific driver
572for more information.
573.Sm off
574.It Fl link Op Cm 0 No - Cm 2
575.Sm on
576Disable special processing at the link level with the specified interface.
b50e4759
MD
577.\".It Cm monitor
578.\"Put the interface in monitor mode.
579.\"No packets are transmitted, and received packets are discarded after
580.\".Xr bpf 4
581.\"processing.
582.\".It Fl monitor
583.\"Take the interface out of monitor mode.
984263bc
MD
584.It Cm up
585Mark an interface
586.Dq up .
587This may be used to enable an interface after an
588.Dq Nm Cm down .
589It happens automatically when setting the first address on an interface.
590If the interface was reset when previously marked down,
591the hardware will be re-initialized.
592.It Cm ssid Ar ssid
593For IEEE 802.11 wireless interfaces, set the desired Service Set
594Identifier (aka network name).
595The SSID is a string up to 32 characters
596in length and may be specified as either a normal string or in
597hexadecimal when proceeded by
598.Ql 0x .
599Additionally, the SSID may be cleared by setting it to
600.Ql - .
601.It Cm nwid Ar ssid
602Another name for the
603.Cm ssid
604parameter.
605Included for
606.Nx
607compatibility.
608.It Cm stationname Ar name
609For IEEE 802.11 wireless interfaces, set the name of this station.
610It appears that the station name is not really part of the IEEE 802.11
611protocol though all interfaces seem to support it.
612As such it only
613seems to be meaningful to identical or virtually identical equipment.
614Setting the station name is identical in syntax to setting the SSID.
615.It Cm station Ar name
616Another name for the
617.Cm stationname
618parameter.
619Included for
620.Bsx
621compatibility.
622.It Cm channel Ar number
623For IEEE 802.11 wireless interfaces, set the desired channel.
624Channels range from 1 to 14, but the exact selection available
625depends on the region your adaptor was manufactured for.
626Setting
627the channel to 0 will give you the default for your adaptor.
628Many
629adaptors ignore this setting unless you are in ad-hoc mode.
630.It Cm authmode Ar mode
631For IEEE 802.11 wireless interfaces, set the desired authentication mode
632in infrastructure mode.
633Not all adaptors support all modes.
634The set of
635valid modes is
b50e4759
MD
636.Dq Li none ,
637.Dq Li open ,
984263bc 638and
b50e4759 639.Dq Li shared .
984263bc
MD
640Modes are case insensitive.
641.It Cm powersave
642For IEEE 802.11 wireless interfaces, enable powersave mode.
643.It Fl powersave
644For IEEE 802.11 wireless interfaces, disable powersave mode.
645.It Cm powersavesleep Ar sleep
646For IEEE 802.11 wireless interfaces, set the desired max powersave sleep
647time in milliseconds.
b50e4759
MD
648.It Cm protmode Ar technique
649For IEEE 802.11 wireless interfaces operating in 11g, use the specified
650.Ar technique
651for protecting OFDM frames in a mixed 11b/11g network.
652The set of valid techniques is
653.Dq Li off ,
654.Dq Li cts
655(CTS to self),
656and
657.Dq Li rtscts
658(RTS/CTS).
659Technique names are case insensitive.
660.It Cm rtsthreshold Ar length
661For IEEE 802.11 wireless interfaces, set the threshold for which
662transmitted frames are preceded by transmission of an
663RTS
664control frame.
665The
666.Ar length
667argument
668is the frame size in bytes and must be in the range 1 to 2312.
669Not all adaptors support setting the RTS threshold.
670.It Cm txpower Ar power
671For IEEE 802.11 wireless interfaces, set the power used to transmit frames.
672The
673.Ar power
674argument
675is a unitless value in the range 0 to 100 that is interpreted
676by drivers to derive a device-specific value.
677Out of range values are truncated.
678Typically only a few discreet power settings are available and
679the driver will use the setting closest to the specified value.
680Not all adaptors support changing the transmit power.
984263bc
MD
681.It Cm wepmode Ar mode
682For IEEE 802.11 wireless interfaces, set the desired WEP mode.
683Not all adaptors support all modes.
684The set of valid modes is
b50e4759
MD
685.Dq Li off ,
686.Dq Li on ,
984263bc 687and
b50e4759
MD
688.Dq Li mixed .
689The
690.Dq Li mixed
984263bc
MD
691mode explicitly tells the adaptor to allow association with access
692points which allow both encrypted and unencrypted traffic.
693On these adaptors,
b50e4759 694.Dq Li on
984263bc
MD
695means that the access point must only allow encrypted connections.
696On other adaptors,
b50e4759 697.Dq Li on
984263bc 698is generally another name for
b50e4759 699.Dq Li mixed .
984263bc
MD
700Modes are case insensitive.
701.It Cm weptxkey Ar index
702For IEEE 802.11 wireless interfaces, set the WEP key to be used for
703transmission.
704.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
705For IEEE 802.11 wireless interfaces, set the selected WEP key.
706If an
707.Ar index
708is not given, key 1 is set.
709A WEP key will be either 5 or 13
710characters (40 or 104 bits) depending of the local network and the
711capabilities of the adaptor.
712It may be specified either as a plain
713string or as a string of hexadecimal digits proceeded by
714.Ql 0x .
715For maximum portability, hex keys are recommended;
716the mapping of text keys to WEP encryption is usually driver-specific.
717In particular, the
718.Tn Windows
719drivers do this mapping differently to
b50e4759 720.Fx .
984263bc
MD
721A key may be cleared by setting it to
722.Ql - .
723If WEP is supported then there are at least four keys.
724Some adaptors support more than four keys.
725If that is the case, then the first four keys
726(1-4) will be the standard temporary keys and any others will be adaptor
727specific keys such as permanent keys stored in NVRAM.
728.It Cm wep
729Another way of saying
730.Cm wepmode on .
731Included for
732.Bsx
733compatibility.
734.It Fl wep
735Another way of saying
736.Cm wepmode off .
737Included for
738.Bsx
739compatibility.
740.It Cm nwkey key
741Another way of saying:
742.Pp
743.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
744.Pp
745Included for
746.Nx
747compatibility.
748.It Cm nwkey Xo
749.Sm off
750.Ar n : k1 , k2 , k3 , k4
751.Sm on
752.Xc
753Another way of saying
754.Pp
755.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
756.Pp
757Included for
758.Nx
759compatibility.
760.It Fl nwkey
761Another way of saying
762.Cm wepmode off .
763.Pp
764Included for
765.Nx
766compatibility.
767.El
768.Pp
769The
770.Nm
771utility displays the current configuration for a network interface
772when no optional parameters are supplied.
773If a protocol family is specified,
774.Nm
775will report only the details specific to that protocol family.
776.Pp
777If the driver does supports the media selection system, the supported
778media list will be included in the output.
779.Pp
780If the
781.Fl m
782flag is passed before an interface name,
783.Nm
b50e4759 784will display the capability list and all
984263bc
MD
785of the supported media for the specified interface.
786If
787.Fl L
788flag is supplied, address lifetime is displayed for IPv6 addresses,
789as time offset string.
790.Pp
791Optionally, the
792.Fl a
793flag may be used instead of an interface name.
794This flag instructs
795.Nm
796to display information about all interfaces in the system.
797The
798.Fl d
799flag limits this to interfaces that are down, and
800.Fl u
801limits this to interfaces that are up.
802When no arguments are given,
803.Fl a
804is implied.
805.Pp
806The
807.Fl l
808flag may be used to list all available interfaces on the system, with
809no other additional information.
810Use of this flag is mutually exclusive
811with all other flags and commands, except for
812.Fl d
813(only list interfaces that are down)
814and
815.Fl u
816(only list interfaces that are up).
817.Pp
818The
819.Fl C
820flag may be used to list all of the interface cloners available on
821the system, with no additional information.
822Use of this flag is mutually exclusive with all other flags and commands.
823.Pp
824Only the super-user may modify the configuration of a network interface.
825.Sh NOTES
826The media selection system is relatively new and only some drivers support
827it (or have need for it).
828.Sh DIAGNOSTICS
829Messages indicating the specified interface does not exist, the
830requested address is unknown, or the user is not privileged and
831tried to alter an interface's configuration.
832.Sh BUGS
b50e4759
MD
833Basic IPv6 node operation requires a link-local address on each
834interface configured for IPv6.
835Normally, such an address is automatically configured by the
836kernel on each interface added to the system; this behaviour may
837be disabled by setting the sysctl MIB variable
838.Va net.inet6.ip6.auto_linklocal
839to 0.
840.Pp
841If you delete such an address using
842.Nm ,
843the kernel may act very oddly.
844Do this at your own risk.
984263bc
MD
845.Sh SEE ALSO
846.Xr netstat 1 ,
847.Xr netintro 4 ,
b50e4759 848.Xr vlan 4 ,
984263bc
MD
849.\" .Xr eon 5 ,
850.Xr rc 8 ,
b50e4759
MD
851.Xr routed 8 ,
852.Xr sysctl 8
984263bc
MD
853.Sh HISTORY
854The
855.Nm
856utility appeared in
857.Bx 4.2 .