0e39068d12fbe61fcbfd37a025cc830af6015a4c
[dragonfly.git] / sbin / ifconfig / ifconfig.8
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.
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
29 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.124 2006/10/10 09:44:08 ru Exp $
30 .\" $DragonFly: src/sbin/ifconfig/ifconfig.8,v 1.25 2008/11/14 12:52:04 sephe Exp $
31
32 .\"
33 .Dd September 30, 2007
34 .Dt IFCONFIG 8
35 .Os
36 .Sh NAME
37 .Nm ifconfig
38 .Nd configure network interface parameters
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl L
42 .Op Fl k
43 .Op Fl m
44 .Ar interface
45 .Op Cm create
46 .Op Ar address_family
47 .Oo
48 .Ar address
49 .Op Ar dest_address
50 .Oc
51 .Op Ar parameters
52 .Nm
53 .Ar interface
54 .Cm destroy
55 .Nm
56 .Fl a
57 .Op Fl L
58 .Op Fl d
59 .Op Fl m
60 .Op Fl u
61 .Op Fl v
62 .Op Ar address_family
63 .Nm
64 .Fl l
65 .Op Fl d
66 .Op Fl u
67 .Op Ar address_family
68 .Nm
69 .Op Fl L
70 .Op Fl d
71 .Op Fl k
72 .Op Fl m
73 .Op Fl u
74 .Op Fl v
75 .Op Fl C
76 .Sh DESCRIPTION
77 The
78 .Nm
79 utility is used to assign an address
80 to a network interface and/or configure
81 network interface parameters.
82 The
83 .Nm
84 utility must be used at boot time to define the network address
85 of each interface present on a machine; it may also be used at
86 a later time to redefine an interface's address
87 or other operating parameters.
88 .Pp
89 The following options are available:
90 .Bl -tag -width indent
91 .It Ar address
92 For the
93 .Tn DARPA Ns -Internet
94 family,
95 the address is either a host name present in the host name data
96 base,
97 .Xr hosts 5 ,
98 or a
99 .Tn DARPA
100 Internet address expressed in the Internet standard
101 .Dq dot notation .
102 .Pp
103 It is also possible to use the CIDR notation (also known as the
104 slash notation) to include the netmask.
105 That is, one can specify an address like
106 .Li 192.168.0.1/16 .
107 .Pp
108 For
109 .Dq inet6
110 family, it is also possible to specify the prefix length using the slash
111 notation, like
112 .Li ::1/128 .
113 See the
114 .Cm prefixlen
115 parameter below for more information.
116 .\" For the Xerox Network Systems(tm) family,
117 .\" addresses are
118 .\" .Ar net:a.b.c.d.e.f ,
119 .\" where
120 .\" .Ar net
121 .\" is the assigned network number (in decimal),
122 .\" and each of the six bytes of the host number,
123 .\" .Ar a
124 .\" through
125 .\" .Ar f ,
126 .\" are specified in hexadecimal.
127 .\" The host number may be omitted on IEEE 802 protocol
128 .\" (Ethernet, FDDI, and Token Ring) interfaces,
129 .\" which use the hardware physical address,
130 .\" and on interfaces other than the first.
131 .\" For the
132 .\" .Tn ISO
133 .\" family, addresses are specified as a long hexadecimal string,
134 .\" as in the Xerox family.
135 .\" However, two consecutive dots imply a zero
136 .\" byte, and the dots are optional, if the user wishes to (carefully)
137 .\" count out long strings of digits in network byte order.
138 .Pp
139 The link-level
140 .Pq Dq link
141 address
142 is specified as a series of colon-separated hex digits.
143 This can be used to
144 e.g.\& set a new MAC address on an ethernet interface, though the
145 mechanism used is not ethernet-specific.
146 If the interface is already
147 up when this option is used, it will be briefly brought down and
148 then brought back up again in order to ensure that the receive
149 filter in the underlying ethernet hardware is properly reprogrammed.
150 .It Ar address_family
151 Specify the
152 address family
153 which affects interpretation of the remaining parameters.
154 Since an interface can receive transmissions in differing protocols
155 with different naming schemes, specifying the address family is recommended.
156 The address or protocol families currently
157 supported are
158 .Dq inet ,
159 .Dq inet6 ,
160 .Dq atalk ,
161 .Dq ipx ,
162 .\" .Dq iso ,
163 and
164 .Dq link .
165 .\" and
166 .\" .Dq ns .
167 The default is
168 .Dq inet .
169 .Dq ether
170 and
171 .Dq lladdr
172 are synonyms for
173 .Dq link .
174 .It Ar dest_address
175 Specify the address of the correspondent on the other end
176 of a point to point link.
177 .It Ar interface
178 This
179 parameter is a string of the form
180 .Dq name unit ,
181 for example,
182 .Dq Li ed0 .
183 .El
184 .Pp
185 The following parameters may be set with
186 .Nm :
187 .Bl -tag -width indent
188 .It Cm add
189 Another name for the
190 .Cm alias
191 parameter.
192 Introduced for compatibility
193 with
194 .Bsx .
195 .It Cm alias
196 Establish an additional network address for this interface.
197 This is sometimes useful when changing network numbers, and
198 one wishes to accept packets addressed to the old interface.
199 If the address is on the same subnet as the first network address
200 for this interface, a non-conflicting netmask must be given.
201 Usually
202 .Li 0xffffffff
203 is most appropriate.
204 .It Fl alias
205 Remove the network address specified.
206 This would be used if you incorrectly specified an alias, or it
207 was no longer needed.
208 If you have incorrectly set an NS address having the side effect
209 of specifying the host portion, removing all NS addresses will
210 allow you to respecify the host portion.
211 .It Cm anycast
212 (Inet6 only.)
213 Specify that the address configured is an anycast address.
214 Based on the current specification,
215 only routers may configure anycast addresses.
216 Anycast address will not be used as source address of any of outgoing
217 IPv6 packets.
218 .It Cm arp
219 Enable the use of the Address Resolution Protocol
220 .Pq Xr arp 4
221 in mapping
222 between network level addresses and link level addresses (default).
223 This is currently implemented for mapping between
224 .Tn DARPA
225 Internet
226 addresses and
227 .Tn IEEE
228 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
229 .It Fl arp
230 Disable the use of the Address Resolution Protocol
231 .Pq Xr arp 4 .
232 .It Cm staticarp
233 If the Address Resolution Protocol is enabled,
234 the host will only reply to requests for its addresses,
235 and will never send any requests.
236 .It Fl staticarp
237 If the Address Resolution Protocol is enabled,
238 the host will perform normally,
239 sending out requests and listening for replies.
240 .It Cm broadcast
241 (Inet only.)
242 Specify the address to use to represent broadcasts to the
243 network.
244 The default broadcast address is the address with a host part of all 1's.
245 .It Cm debug
246 Enable driver dependent debugging code; usually, this turns on
247 extra console error logging.
248 .It Fl debug
249 Disable driver dependent debugging code.
250 .It Cm promisc
251 Put interface into permanently promiscuous mode.
252 .It Fl promisc
253 Disable permanently promiscuous mode.
254 .It Cm delete
255 Another name for the
256 .Fl alias
257 parameter.
258 .It Cm down
259 Mark an interface
260 .Dq down .
261 When an interface is marked
262 .Dq down ,
263 the system will not attempt to
264 transmit messages through that interface.
265 If possible, the interface will be reset to disable reception as well.
266 This action does not automatically disable routes using the interface.
267 .It Cm eui64
268 (Inet6 only.)
269 Fill interface index
270 (lowermost 64bit of an IPv6 address)
271 automatically.
272 .It Cm ipdst
273 This is used to specify an Internet host who is willing to receive
274 IP packets encapsulating IPX packets bound for a remote network.
275 An apparent point to point link is constructed, and
276 the address specified will be taken as the IPX address and network
277 of the destination.
278 .It Cm media Ar type
279 If the driver supports the media selection system, set the media type
280 of the interface to
281 .Ar type .
282 Some interfaces support the mutually exclusive use of one of several
283 different physical media connectors.
284 For example, a 10Mbit/s Ethernet
285 interface might support the use of either
286 .Tn AUI
287 or twisted pair connectors.
288 Setting the media type to
289 .Cm 10base5/AUI
290 would change the currently active connector to the AUI port.
291 Setting it to
292 .Cm 10baseT/UTP
293 would activate twisted pair.
294 Refer to the interfaces' driver
295 specific documentation or man page for a complete list of the
296 available types.
297 .It Cm mediaopt Ar opts
298 If the driver supports the media selection system, set the specified
299 media options on the interface.
300 The
301 .Ar opts
302 argument
303 is a comma delimited list of options to apply to the interface.
304 Refer to the interfaces' driver specific man page for a complete
305 list of available options.
306 .It Fl mediaopt Ar opts
307 If the driver supports the media selection system, disable the
308 specified media options on the interface.
309 .It Cm mode Ar mode
310 If the driver supports the media selection system, set the specified
311 operating mode on the interface to
312 .Ar mode .
313 For IEEE 802.11 wireless interfaces that support multiple operating modes
314 this directive is used to select between 802.11a
315 .Pq Cm 11a ,
316 802.11b
317 .Pq Cm 11b ,
318 and 802.11g
319 .Pq Cm 11g
320 operating modes.
321 .It Cm name Ar name
322 Set the interface name to
323 .Ar name .
324 .It Cm rss
325 If the driver supports receive side scaling,
326 enable receive side scaling on the interface.
327 .It Fl rss
328 If the driver supports receive side scaling,
329 disable receive side scaling on the interface.
330 .It Cm rxcsum , txcsum
331 If the driver supports user-configurable checksum offloading,
332 enable receive (or transmit) checksum offloading on the interface.
333 Some drivers may not be able to enable these flags independently
334 of each other, so setting one may also set the other.
335 The driver will offload as much checksum work as it can reliably
336 support, the exact level of offloading varies between drivers.
337 .It Fl rxcsum , txcsum
338 If the driver supports user-configurable checksum offloading,
339 disable receive (or transmit) checksum offloading on the interface.
340 These settings may not always be independent of each other.
341 .It Cm vlanmtu , vlanhwtag
342 If the driver offers user-configurable VLAN support, enable
343 reception of extended frames or tag processing in hardware,
344 respectively.
345 Note that this must be issued on a physical interface associated with
346 .Xr vlan 4 ,
347 not on a
348 .Xr vlan 4
349 interface itself.
350 .It Fl vlanmtu , vlanhwtag
351 If the driver offers user-configurable VLAN support, disable
352 reception of extended frames or tag processing in hardware,
353 respectively.
354 .It Cm pollcpu Ar cpu
355 Turn on
356 .Xr polling 4
357 feature and disable interrupts on the interface,
358 if the driver supports this mode and
359 .Ar cpu
360 supports
361 .Xr polling 4 .
362 Driver will be polled by
363 .Ar cpu .
364 .It Cm polling
365 Turn on
366 .Xr polling 4
367 feature and disable interrupts on the interface, if the driver supports
368 this mode.
369 .It Fl polling
370 Turn off
371 .Xr polling 4
372 feature and enable interrupt mode on the interface.
373 .It Cm create
374 Create the specified network pseudo-device.
375 If the interface is given without a unit number, try to create a new
376 device with an arbitrary unit number.
377 If creation of an arbitrary device is successful, the new device name is
378 printed to standard output unless the interface is renamed or destroyed
379 in the same
380 .Nm
381 invocation.
382 .It Cm destroy
383 Destroy the specified network pseudo-device.
384 .It Cm plumb
385 Another name for the
386 .Cm create
387 parameter.
388 Included for
389 .Tn Solaris
390 compatibility.
391 .It Cm unplumb
392 Another name for the
393 .Cm destroy
394 parameter.
395 Included for
396 .Tn Solaris
397 compatibility.
398 .It Cm metric Ar n
399 Set the routing metric of the interface to
400 .Ar n ,
401 default 0.
402 The routing metric is used by the routing protocol
403 .Pq Xr routed 8 .
404 Higher metrics have the effect of making a route
405 less favorable; metrics are counted as additional hops
406 to the destination network or host.
407 .It Cm mtu Ar n
408 Set the maximum transmission unit of the interface to
409 .Ar n ,
410 default is interface specific.
411 The MTU is used to limit the size of packets that are transmitted on an
412 interface.
413 Not all interfaces support setting the MTU, and some interfaces have
414 range restrictions.
415 .It Cm netmask Ar mask
416 .\" (Inet and ISO.)
417 (Inet only.)
418 Specify how much of the address to reserve for subdividing
419 networks into sub-networks.
420 The mask includes the network part of the local address
421 and the subnet part, which is taken from the host field of the address.
422 The mask can be specified as a single hexadecimal number
423 with a leading
424 .Ql 0x ,
425 with a dot-notation Internet address,
426 or with a pseudo-network name listed in the network table
427 .Xr networks 5 .
428 The mask contains 1's for the bit positions in the 32-bit address
429 which are to be used for the network and subnet parts,
430 and 0's for the host part.
431 The mask should contain at least the standard network portion,
432 and the subnet field should be contiguous with the network
433 portion.
434 .Pp
435 The netmask can also be specified in CIDR notation after the address.
436 See the
437 .Ar address
438 option above for more information.
439 .It Cm autoconf
440 (Inet6 only.)
441 Enable autoconfiguration.
442 .It Fl autoconf
443 Disable autoconfiguration.
444 .It Cm pltime Ar n
445 (Inet6 only.)
446 Set preferred lifetime for the address.
447 .It Cm vltime Ar n
448 (Inet6 only.)
449 Set valid lifetime for the address.
450 .It Cm prefixlen Ar len
451 (Inet6 only.)
452 Specify that
453 .Ar len
454 bits are reserved for subdividing networks into sub-networks.
455 The
456 .Ar len
457 must be integer, and for syntactical reason it must be between 0 to 128.
458 It is almost always 64 under the current IPv6 assignment rule.
459 If the parameter is omitted, 64 is used.
460 .Pp
461 The prefix can also be specified using the slash notation after the address.
462 See the
463 .Ar address
464 option above for more information.
465 .It Cm deprecated
466 (Inet6 only.)
467 Set the IPv6 deprecated address bit.
468 .It Fl deprecated
469 (Inet6 only.)
470 Clear the IPv6 deprecated address bit.
471 .It Cm tentative
472 (Inet6 only.)
473 Set the IPv6 tentative address bit.
474 .It Fl tentative
475 (Inet6 only.)
476 Clear the IPv6 tentative address bit.
477 .\" see
478 .\" Xr eon 5 .
479 .\" .It Cm nsellength Ar n
480 .\" .Pf ( Tn ISO
481 .\" only)
482 .\" This specifies a trailing number of bytes for a received
483 .\" .Tn NSAP
484 .\" used for local identification, the remaining leading part of which is
485 .\" taken to be the
486 .\" .Tn NET
487 .\" (Network Entity Title).
488 .\" The default value is 1, which is conformant to US
489 .\" .Tn GOSIP .
490 .\" When an ISO address is set in an ifconfig command,
491 .\" it is really the
492 .\" .Tn NSAP
493 .\" which is being specified.
494 .\" For example, in
495 .\" .Tn US GOSIP ,
496 .\" 20 hex digits should be
497 .\" specified in the
498 .\" .Tn ISO NSAP
499 .\" to be assigned to the interface.
500 .\" There is some evidence that a number different from 1 may be useful
501 .\" for
502 .\" .Tn AFI
503 .\" 37 type addresses.
504 .It Cm range Ar netrange
505 Under appletalk, set the interface to respond to a
506 .Ar netrange
507 of the form
508 .Ar startnet Ns - Ns Ar endnet .
509 Appletalk uses this scheme instead of
510 netmasks though
511 .Dx
512 implements it internally as a set of netmasks.
513 .It Cm remove
514 Another name for the
515 .Fl alias
516 parameter.
517 Introduced for compatibility
518 with
519 .Bsx .
520 .It Cm phase
521 The argument following this specifies the version (phase) of the
522 Appletalk network attached to the interface.
523 Values of 1 or 2 are permitted.
524 .Sm off
525 .It Cm link Op Cm 0 No - Cm 2
526 .Sm on
527 Enable special processing of the link level of the interface.
528 These three options are interface specific in actual effect, however,
529 they are in general used to select special modes of operation.
530 An example
531 of this is to enable SLIP compression, or to select the connector type
532 for some Ethernet cards.
533 Refer to the man page for the specific driver
534 for more information.
535 .Sm off
536 .It Fl link Op Cm 0 No - Cm 2
537 .Sm on
538 Disable special processing at the link level with the specified interface.
539 .It Cm compress
540 Another name for the
541 .Cm link0
542 parameter.
543 .It Cm normal
544 Another name for the
545 .Fl link0
546 parameter.
547 .It Cm noicmp
548 Another name for the
549 .Cm link1
550 parameter.
551 .It Cm monitor
552 Put the interface in monitor mode.
553 No packets are transmitted, and received packets are discarded after
554 .Xr bpf 4
555 processing.
556 .It Fl monitor
557 Take the interface out of monitor mode.
558 .It Cm up
559 Mark an interface
560 .Dq up .
561 This may be used to enable an interface after an
562 .Dq Nm Cm down .
563 It happens automatically when setting the first address on an interface.
564 If the interface was reset when previously marked down,
565 the hardware will be re-initialized.
566 .El
567 .Pp
568 The following parameters are specific to IEEE 802.11 wireless interfaces:
569 .Bl -tag -width indent
570 .It Cm apbridge
571 When operating as an access point, pass packets between
572 wireless clients directly (default).
573 To instead let them pass up through the
574 system and be forwarded using some other mechanism, use
575 .Fl apbridge .
576 Disabling the internal bridging
577 is useful when traffic is to be processed with
578 packet filtering.
579 .It Cm authmode Ar mode
580 Set the desired authentication mode in infrastructure mode.
581 Not all adaptors support all modes.
582 The set of
583 valid modes is
584 .Cm none , open , shared
585 (shared key),
586 .Cm 8021x
587 (IEEE 802.1x),
588 and
589 .Cm wpa
590 (IEEE WPA/WPA2/802.11i).
591 The
592 .Cm 8021x
593 and
594 .Cm wpa
595 modes are only useful when using an authentication service
596 (a supplicant for client operation or an authenticator when
597 operating as an access point).
598 Modes are case insensitive.
599 .It Cm bintval Ar interval
600 Set the interval at which beacon frames are sent when operating in
601 ad-hoc or ap mode.
602 The
603 .Ar interval
604 parameter is specified in TU's (1024 usecs).
605 By default beacon frames are transmitted every 100 TU's.
606 .It Cm bmissthreshold Ar count
607 Set the number of consecutive missed beacons at which the station
608 will attempt to roam (i.e. search for a new access point).
609 The
610 .Ar count
611 parameter is must be in the range 1 to 255;
612 though the upper bound may be reduced according to device capabilities..
613 The default threshold is 7 consecutive missed beacons;
614 but this may be overridden by the device driver.
615 Another name for the
616 .Cm bmissthreshold
617 parameter is
618 .Cm bmiss .
619 .It Cm bssid Ar address
620 Specify the MAC address of the access point to use when operating
621 as a station in a BSS network.
622 This overrides any automatic selection done by the system.
623 To disable a previously selected access point, supply
624 .Cm any , none ,
625 or
626 .Cm -
627 for the address.
628 This option is useful when more than one access point uses the same SSID.
629 Another name for the
630 .Cm bssid
631 parameter is
632 .Cm ap .
633 .It Cm burst
634 Enable packet bursting.
635 Packet bursting is a transmission technique whereby the wireless
636 medium is acquired once to send multiple frames and the interframe
637 spacing is reduced.
638 This technique can significantly increase throughput by reducing
639 transmission overhead.
640 Packet bursting is supported by the 802.11e QoS specification
641 and some devices that do not support QoS may still be capable.
642 By default packet bursting is enabled if a device is capable
643 of doing it.
644 To disable packet bursting, use
645 .Fl burst .
646 .It Cm chanlist Ar channels
647 Set the desired channels to use when scanning for access
648 points, neighbors in an IBSS network, or looking for unoccupied
649 channels when operating as an access point.
650 The set of channels is specified as a comma-separated list with
651 each element in the list representing either a single channel number or a range
652 of the form
653 .Dq Li a-b .
654 Channel numbers must be in the range 1 to 255 and be permissible
655 according to the operating characteristics of the device.
656 .It Cm channel Ar number
657 Set a single desired channel.
658 Channels range from 1 to 255, but the exact selection available
659 depends on the region your adaptor was manufactured for.
660 Setting
661 the channel to
662 .Li 0 ,
663 .Cm any ,
664 or
665 .Cm -
666 will give you the default for your adaptor.
667 Some
668 adaptors ignore this setting unless you are in ad-hoc mode.
669 Alternatively the frequency, in megahertz, may be specified
670 instead of the channel number.
671 .It Cm deftxkey Ar index
672 Set the default key to use for transmission.
673 Typically this is only set when using WEP encryption.
674 The
675 .Cm weptxkey
676 is an alias for this request; it is provided for backwards compatibility.
677 .It Cm dtimperiod Ar period
678 Set the
679 DTIM
680 period for transmitting buffered multicast data frames when
681 operating in ap mode.
682 The
683 .Ar period
684 specifies the number of beacon intervals between DTIM
685 and must be in the range 1 to 15.
686 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
687 .It Cm fragthreshold Ar length
688 Set the threshold for which transmitted frames are broken into fragments.
689 The
690 .Ar length
691 argument is the frame size in bytes and must be in the range 256 to 2346.
692 Setting
693 .Ar length
694 to
695 .Li 2346 ,
696 .Cm any ,
697 or
698 .Cm -
699 disables transmit fragmentation.
700 Not all adaptors honor the fragmentation threshold.
701 .It Cm hidessid
702 When operating as an access point, do not broadcast the SSID
703 in beacon frames or respond to probe request frames unless
704 they are directed to the ap (i.e., they include the ap's SSID).
705 By default, the SSID is included in beacon frames and
706 undirected probe request frames are answered.
707 To re-enable the broadcast of the SSID etc., use
708 .Fl hidessid .
709 .It Cm list active
710 Display the list of channels available for use taking into account
711 any restrictions set with the
712 .Cm chanlist
713 directive.
714 See the description of
715 .Cm list chan
716 for more information.
717 .It Cm list caps
718 Display the adaptor's capabilities, including the operating
719 modes supported.
720 .It Cm list chan
721 Display the list of channels available for use.
722 Channels are shown with their IEEE channel number, equivalent
723 frequency, and usage modes.
724 Channels identified as
725 .Ql 11g
726 are also usable in
727 .Ql 11b
728 mode.
729 Channels identified as
730 .Ql 11a Turbo
731 may be used only for Atheros' Static Turbo mode
732 specified with
733 .Cm mediaopt turbo ) .
734 Channels marked with a
735 .Ql *
736 have a regulatory constraint that they be passively scanned.
737 This means a station is not permitted to transmit on the channel until
738 it identifies the channel is being used for 802.11 communication;
739 typically by hearing a beacon frame from an access point operating
740 on the channel.
741 .Cm list freq
742 is another way of requesting this information.
743 .It Cm list mac
744 Display the current MAC Access Control List state.
745 Each address is prefixed with a character that indicates the
746 current policy applied to it:
747 .Ql +
748 indicates the address is allowed access,
749 .Ql -
750 indicates the address is denied access,
751 .Ql *
752 indicates the address is present but the current policy open
753 (so the ACL is not consulted).
754 .It Cm list scan
755 Display the access points and/or ad-hoc neighbors
756 located in the vicinity.
757 The
758 .Fl v
759 flag may be used to display long SSIDs.
760 This information may be updated automatically by the adaptor
761 and/or with a
762 .Cm scan
763 request.
764 .Cm list ap
765 is another way of requesting this information.
766 .It Cm list sta
767 When operating as an access point display the stations that are
768 currently associated.
769 When operating in ad-hoc mode display stations identified as
770 neighbors in the IBSS.
771 .It Cm list wme
772 Display the current parameters to use when operating in WME mode.
773 When WME mode is enabled for an adaptor this information will be
774 displayed with the regular status; this command is mostly useful
775 for examining parameters when WME mode is disabled.
776 See the description of the
777 .Cm wme
778 directive for information on the various parameters.
779 .It Cm mcastrate Ar rate
780 Set the rate for transmitting multicast/broadcast frames.
781 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
782 This rate should be valid for the current operating conditions;
783 if an invalid rate is specified drivers are free to chose an
784 appropriate rate.
785 .It Cm powersave
786 Enable powersave operation.
787 When operating as a client, the station will conserve power by
788 periodically turning off the radio and listening for
789 messages from the access point telling it there are packets waiting.
790 The station must then retrieve the packets.
791 When operating as an access point, the station must honor power
792 save operation of associated clients.
793 Not all devices support power save operation, either as a client
794 or as an access point.
795 Use
796 .Fl powersave
797 to disable powersave operation.
798 .It Cm powersavemode Ar mode
799 Set powersave mode.
800 The set of valid modes is
801 .Cm off
802 (same as
803 .Fl powersave ) ,
804 .Cm on
805 (same as
806 .Cm powersave ) ,
807 and
808 .Cm cam
809 (same as
810 .Cm powersave ) .
811 .It Cm powersavesleep Ar sleep
812 Set the desired max powersave sleep time in TU's (1024 usecs).
813 By default the max powersave sleep time is 100 TU's.
814 .It Cm protmode Ar technique
815 For interfaces operating in 802.11g, use the specified
816 .Ar technique
817 for protecting OFDM frames in a mixed 11b/11g network.
818 The set of valid techniques is
819 .Cm off , cts
820 (CTS to self),
821 and
822 .Cm rtscts
823 (RTS/CTS).
824 Technique names are case insensitive.
825 .It Cm pureg
826 When operating as an access point in 802.11g mode allow only
827 11g-capable stations to associate (11b-only stations are not
828 permitted to associate).
829 To allow both 11g and 11b-only stations to associate, use
830 .Fl pureg .
831 .It Cm roaming Ar mode
832 When operating as a station, control how the system will
833 behave when communication with the current access point
834 is broken.
835 The
836 .Ar mode
837 argument may be one of
838 .Cm device
839 (leave it to the hardware device to decide),
840 .Cm auto
841 (handle either in the device or the operating system\[em]as appropriate),
842 .Cm manual
843 (do nothing until explicitly instructed).
844 By default, the device is left to handle this if it is
845 capable; otherwise, the operating system will automatically
846 attempt to reestablish communication.
847 Manual mode is mostly useful when an application wants to
848 control the selection of an access point.
849 .It Cm ratectl Ar algorithm
850 Set the TX rate control algorithm.
851 The set of valid
852 .Ar algorithm
853 is
854 .Cm onoe
855 (Onoe TX rate control algorithm),
856 .Cm sample
857 (Sample TX rate control algorithm)
858 and
859 .Cm amrr
860 (AMRR TX rate control algorithm).
861 .Ar Algorithm
862 names are case sensitive.
863 .It Cm rtsthreshold Ar length
864 Set the threshold for which
865 transmitted frames are preceded by transmission of an
866 RTS
867 control frame.
868 The
869 .Ar length
870 argument
871 is the frame size in bytes and must be in the range 1 to 2346.
872 Setting
873 .Ar length
874 to
875 .Li 2346 ,
876 .Cm any ,
877 or
878 .Cm -
879 disables transmission of RTS frames.
880 Not all adaptors support setting the RTS threshold.
881 .It Cm ssid Ar ssid
882 Set the desired Service Set Identifier (aka network name).
883 The SSID is a string up to 32 characters
884 in length and may be specified as either a normal string or in
885 hexadecimal when preceded by
886 .Ql 0x .
887 Additionally, the SSID may be cleared by setting it to
888 .Ql - .
889 .It Cm scan
890 Initiate a scan of neighboring stations, wait for it to complete, and
891 display all stations found.
892 Only the super-user can initiate a scan.
893 Depending on the capabilities of the APs, the following
894 flags can be included in the output:
895 .Bl -tag -width 3n
896 .It Li A
897 Channel Agility.
898 Indicates that the station support channel hopping as described by the
899 IEEE 802.11b specification.
900 .It Li B
901 Packet Binary Convolution Code (PBCC).
902 A modulation alternative to the standard OFDM method.
903 .It Li C
904 Pollreq
905 .It Li c
906 Pollable
907 .It Li D
908 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
909 Multiplexing (DSSS-OFDM).
910 Indicates the the station supports DSSS-OFDM modulation.
911 .It Li E
912 Extended Service Set (ESS).
913 Indicates that the station is part of an infrastructure network
914 (in contrast to an IBSS/ad-hoc network).
915 .It Li I
916 IBSS/ad-hoc network.
917 Indicates that the station is part of an ad-hoc network
918 (in contrast to an ESS network).
919 .It Li P
920 Privacy.
921 Data confidentiality is required for all data frames
922 exchanged within the BSS.
923 This means that this BSS requires the station to
924 use cryptographic means such as WEP, TKIP or AES-CCMP to
925 encrypt/decrypt data frames being exchanged with others.
926 .It Li R
927 Robust Security Network (RSN).
928 Indicates that the station supports the IEEE 802.11i authentication
929 and key management protocol.
930 .It Li S
931 Short Preamble.
932 Indicates that the network is using short preambles (defined
933 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
934 56 bit sync field in contrast to a 128 bit field used in long
935 preamble mode).
936 .It Li s
937 Short slot time.
938 Indicates that the network is using a short slot time.
939 .El
940 .Pp
941 The
942 .Cm list scan
943 request can be used to show recent scan results without
944 initiating a new scan.
945 .Pp
946 The
947 .Fl v
948 flag may be used to prevent the shortening of long SSIDs.
949 .It Cm stationname Ar name
950 Set the name of this station.
951 It appears that the station name is not really part of the IEEE 802.11
952 protocol though all interfaces seem to support it.
953 As such it only
954 seems to be meaningful to identical or virtually identical equipment.
955 Setting the station name is identical in syntax to setting the SSID.
956 .It Cm txpower Ar power
957 Set the power used to transmit frames.
958 The
959 .Ar power
960 argument
961 is a unitless value in the range 0 to 100 that is interpreted
962 by drivers to derive a device-specific value.
963 Out of range values are truncated.
964 Typically only a few discreet power settings are available and
965 the driver will use the setting closest to the specified value.
966 Not all adaptors support changing the transmit power.
967 .It Cm wepmode Ar mode
968 Set the desired WEP mode.
969 Not all adaptors support all modes.
970 The set of valid modes is
971 .Cm off , on ,
972 and
973 .Cm mixed .
974 The
975 .Cm mixed
976 mode explicitly tells the adaptor to allow association with access
977 points which allow both encrypted and unencrypted traffic.
978 On these adaptors,
979 .Cm on
980 means that the access point must only allow encrypted connections.
981 On other adaptors,
982 .Cm on
983 is generally another name for
984 .Cm mixed .
985 Modes are case insensitive.
986 .It Cm weptxkey Ar index
987 Set the WEP key to be used for transmission.
988 This is the same as setting the default transmission key with
989 .Cm deftxkey .
990 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
991 Set the selected WEP key.
992 If an
993 .Ar index
994 is not given, key 1 is set.
995 A WEP key will be either 5 or 13
996 characters (40 or 104 bits) depending of the local network and the
997 capabilities of the adaptor.
998 It may be specified either as a plain
999 string or as a string of hexadecimal digits preceded by
1000 .Ql 0x .
1001 For maximum portability, hex keys are recommended;
1002 the mapping of text keys to WEP encryption is usually driver-specific.
1003 In particular, the
1004 .Tn Windows
1005 drivers do this mapping differently to
1006 .Dx .
1007 A key may be cleared by setting it to
1008 .Ql - .
1009 If WEP is supported then there are at least four keys.
1010 Some adaptors support more than four keys.
1011 If that is the case, then the first four keys
1012 (1-4) will be the standard temporary keys and any others will be adaptor
1013 specific keys such as permanent keys stored in NVRAM.
1014 .It Cm wme
1015 Enable Wireless Multimedia Extensions (WME) support, if available,
1016 for the specified interface.
1017 WME is a subset of the IEEE 802.11e standard to support the
1018 efficient communication of realtime and multimedia data.
1019 To disable WME support, use
1020 .Fl wme .
1021 .Pp
1022 The following parameters are meaningful only when WME support is in use.
1023 Parameters are specified per-AC (Access Category) and
1024 split into those that are used by a station when acting
1025 as an access point and those for client stations in the BSS.
1026 The latter are received from the access point and may not be changed
1027 (at the station).
1028 The following Access Categories are recognized:
1029 .Pp
1030 .Bl -tag -width ".Cm AC_BK" -compact
1031 .It Cm AC_BE
1032 (or
1033 .Cm BE )
1034 best effort delivery,
1035 .It Cm AC_BK
1036 (or
1037 .Cm BK )
1038 background traffic,
1039 .It Cm AC_VI
1040 (or
1041 .Cm VI )
1042 video traffic,
1043 .It Cm AC_VO
1044 (or
1045 .Cm VO )
1046 voice traffic.
1047 .El
1048 .Pp
1049 AC parameters are case-insensitive.
1050 Traffic classification is done in the operating system using the
1051 vlan priority associated with data frames or the
1052 ToS (Type of Service) indication in IP-encapsulated frames.
1053 If neither information is present, traffic is assigned to the
1054 Best Effort (BE) category.
1055 .Bl -tag -width indent
1056 .It Cm ack Ar ac
1057 Set the ACK policy for QoS transmissions by the local station;
1058 this controls whether or not data frames transmitted by a station
1059 require an ACK response from the receiving station.
1060 To disable waiting for an ACK use
1061 .Fl ack .
1062 This parameter is applied only to the local station.
1063 .It Cm acm Ar ac
1064 Enable the Admission Control Mandatory (ACM) mechanism
1065 for transmissions by the local station.
1066 To disable the ACM use
1067 .Fl acm .
1068 On stations in a BSS this parameter is read-only and indicates
1069 the setting received from the access point.
1070 NB: ACM is not supported right now.
1071 .It Cm aifs Ar ac Ar count
1072 Set the Arbitration Inter Frame Spacing (AIFS)
1073 channel access parameter to use for transmissions
1074 by the local station.
1075 On stations in a BSS this parameter is read-only and indicates
1076 the setting received from the access point.
1077 .It Cm cwmin Ar ac Ar count
1078 Set the CWmin channel access parameter to use for transmissions
1079 by the local station.
1080 On stations in a BSS this parameter is read-only and indicates
1081 the setting received from the access point.
1082 .It Cm cwmax Ar ac Ar count
1083 Set the CWmax channel access parameter to use for transmissions
1084 by the local station.
1085 On stations in a BSS this parameter is read-only and indicates
1086 the setting received from the access point.
1087 .It Cm txoplimit Ar ac Ar limit
1088 Set the Transmission Opportunity Limit channel access parameter
1089 to use for transmissions by the local station.
1090 This parameter defines an interval of time when a WME station
1091 has the right to initiate transmissions onto the wireless medium.
1092 On stations in a BSS this parameter is read-only and indicates
1093 the setting received from the access point.
1094 .It Cm bss:aifs Ar ac Ar count
1095 Set the AIFS channel access parameter to send to stations in a BSS.
1096 This parameter is meaningful only when operating in ap mode.
1097 .It Cm bss:cwmin Ar ac Ar count
1098 Set the CWmin channel access parameter to send to stations in a BSS.
1099 This parameter is meaningful only when operating in ap mode.
1100 .It Cm bss:cwmax Ar ac Ar count
1101 Set the CWmax channel access parameter to send to stations in a BSS.
1102 This parameter is meaningful only when operating in ap mode.
1103 .It Cm bss:txoplimit Ar ac Ar limit
1104 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1105 This parameter is meaningful only when operating in ap mode.
1106 .El
1107 .El
1108 .Pp
1109 The following parameters support an optional access control list
1110 feature available with some adaptors when operating in ap mode; see
1111 .Xr wlan_acl 4 .
1112 This facility allows an access point to accept/deny association
1113 requests based on the MAC address of the station.
1114 Note that this feature does not significantly enhance security
1115 as MAC address spoofing is easy to do.
1116 .Bl -tag -width indent
1117 .It Cm mac:add Ar address
1118 Add the specified MAC address to the database.
1119 Depending on the policy setting association requests from the
1120 specified station will be allowed or denied.
1121 .It Cm mac:allow
1122 Set the ACL policy to permit association only by
1123 stations registered in the database.
1124 .It Cm mac:del Ar address
1125 Delete the specified MAC address from the database.
1126 .It Cm mac:deny
1127 Set the ACL policy to deny association only by
1128 stations registered in the database.
1129 .It Cm mac:kick Ar address
1130 Force the specified station to be deauthenticated.
1131 This typically is done to block a station after updating the
1132 address database.
1133 .It Cm mac:open
1134 Set the ACL policy to allow all stations to associate.
1135 .It Cm mac:flush
1136 Delete all entries in the database.
1137 .El
1138 .Pp
1139 The following parameters are for compatibility with other systems:
1140 .Bl -tag -width indent
1141 .It Cm nwid Ar ssid
1142 Another name for the
1143 .Cm ssid
1144 parameter.
1145 Included for
1146 .Nx
1147 compatibility.
1148 .It Cm station Ar name
1149 Another name for the
1150 .Cm stationname
1151 parameter.
1152 Included for
1153 .Bsx
1154 compatibility.
1155 .It Cm wep
1156 Another way of saying
1157 .Cm wepmode on .
1158 Included for
1159 .Bsx
1160 compatibility.
1161 .It Fl wep
1162 Another way of saying
1163 .Cm wepmode off .
1164 Included for
1165 .Bsx
1166 compatibility.
1167 .It Cm nwkey key
1168 Another way of saying:
1169 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1170 Included for
1171 .Nx
1172 compatibility.
1173 .It Cm nwkey Xo
1174 .Sm off
1175 .Ar n : k1 , k2 , k3 , k4
1176 .Sm on
1177 .Xc
1178 Another way of saying
1179 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1180 Included for
1181 .Nx
1182 compatibility.
1183 .It Fl nwkey
1184 Another way of saying
1185 .Cm wepmode off .
1186 Included for
1187 .Nx
1188 compatibility.
1189 .El
1190 .Pp
1191 The following parameters are specific to bridge interfaces:
1192 .Bl -tag -width indent
1193 .It Cm addm Ar interface
1194 Add the interface named by
1195 .Ar interface
1196 as a member of the bridge.
1197 The interface is put into promiscuous mode
1198 so that it can receive every packet sent on the network.
1199 .It Cm deletem Ar interface
1200 Remove the interface named by
1201 .Ar interface
1202 from the bridge.
1203 Promiscuous mode is disabled on the interface when
1204 it is removed from the bridge.
1205 .It Cm maxaddr Ar size
1206 Set the size of the bridge address cache to
1207 .Ar size .
1208 The default is 100 entries.
1209 .It Cm timeout Ar seconds
1210 Set the timeout of address cache entries to
1211 .Ar seconds
1212 seconds.
1213 If
1214 .Ar seconds
1215 is zero, then address cache entries will not be expired.
1216 The default is 1200 seconds.
1217 .It Cm addr
1218 Display the addresses that have been learned by the bridge.
1219 .It Cm static Ar interface-name Ar address
1220 Add a static entry into the address cache pointing to
1221 .Ar interface-name .
1222 Static entries are never aged out of the cache or re-placed, even if the
1223 address is seen on a different interface.
1224 .It Cm deladdr Ar address
1225 Delete
1226 .Ar address
1227 from the address cache.
1228 .It Cm flush
1229 Delete all dynamically-learned addresses from the address cache.
1230 .It Cm flushall
1231 Delete all addresses, including static addresses, from the address cache.
1232 .It Cm discover Ar interface
1233 Mark an interface as a
1234 .Dq discovering
1235 interface.
1236 When the bridge has no address cache entry
1237 (either dynamic or static)
1238 for the destination address of a packet,
1239 the bridge will forward the packet to all
1240 member interfaces marked as
1241 .Dq discovering .
1242 This is the default for all interfaces added to a bridge.
1243 .It Fl discover Ar interface
1244 Clear the
1245 .Dq discovering
1246 attribute on a member interface.
1247 For packets without the
1248 .Dq discovering
1249 attribute, the only packets forwarded on the interface are broadcast
1250 or multicast packets and packets for which the destination address
1251 is known to be on the interface's segment.
1252 .It Cm learn Ar interface
1253 Mark an interface as a
1254 .Dq learning
1255 interface.
1256 When a packet arrives on such an interface, the source
1257 address of the packet is entered into the address cache as being a
1258 destination address on the interface's segment.
1259 This is the default for all interfaces added to a bridge.
1260 .It Fl learn Ar interface
1261 Clear the
1262 .Dq learning
1263 attribute on a member interface.
1264 .It Cm span Ar interface
1265 Add the interface named by
1266 .Ar interface
1267 as a span port on the bridge.
1268 Span ports transmit a copy of every frame received by the bridge.
1269 This is most useful for snooping a bridged network passively on
1270 another host connected to one of the span ports of the bridge.
1271 .It Fl span Ar interface
1272 Delete the interface named by
1273 .Ar interface
1274 from the list of span ports of the bridge.
1275 .It Cm stp Ar interface
1276 Enable Spanning Tree protocol on
1277 .Ar interface .
1278 The
1279 .Xr bridge 4
1280 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1281 Spanning Tree is used to detect and remove loops in a network topology.
1282 .It Fl stp Ar interface
1283 Disable Spanning Tree protocol on
1284 .Ar interface .
1285 This is the default for all interfaces added to a bridge.
1286 .It Cm maxage Ar seconds
1287 Set the time that a Spanning Tree protocol configuration is valid.
1288 The default is 20 seconds.
1289 The minimum is 1 second and the maximum is 255 seconds.
1290 .It Cm fwddelay Ar seconds
1291 Set the time that must pass before an interface begins forwarding
1292 packets when Spanning Tree is enabled.
1293 The default is 15 seconds.
1294 The minimum is 1 second and the maximum is 255 seconds.
1295 .It Cm hellotime Ar seconds
1296 Set the time between broadcasting of Spanning Tree protocol
1297 configuration messages.
1298 The default is 2 seconds.
1299 The minimum is 1 second and the maximum is 255 seconds.
1300 .It Cm priority Ar value
1301 Set the bridge priority for Spanning Tree.
1302 The default is 32768.
1303 The minimum is 0 and the maximum is 65536.
1304 .It Cm ifpriority Ar interface Ar value
1305 Set the Spanning Tree priority of
1306 .Ar interface
1307 to
1308 .Ar value .
1309 The default is 128.
1310 The minimum is 0 and the maximum is 255.
1311 .It Cm ifpathcost Ar interface Ar value
1312 Set the Spanning Tree path cost of
1313 .Ar interface
1314 to
1315 .Ar value .
1316 The default is 55.
1317 The minimum is 0 and the maximum is 65535.
1318 .El
1319 .Pp
1320 The following parameters are specific to IP tunnel interfaces,
1321 .Xr gif 4 :
1322 .Bl -tag -width indent
1323 .It Cm tunnel Ar src_addr dest_addr
1324 Configure the physical source and destination address for IP tunnel
1325 interfaces.
1326 The arguments
1327 .Ar src_addr
1328 and
1329 .Ar dest_addr
1330 are interpreted as the outer source/destination for the encapsulating
1331 IPv4/IPv6 header.
1332 .It Fl tunnel
1333 Unconfigure the physical source and destination address for IP tunnel
1334 interfaces previously configured with
1335 .Cm tunnel .
1336 .It Cm deletetunnel
1337 Another name for the
1338 .Fl tunnel
1339 parameter.
1340 .El
1341 .Pp
1342 The following parameters are specific to
1343 .Xr vlan 4
1344 interfaces:
1345 .Bl -tag -width indent
1346 .It Cm vlan Ar vlan_tag
1347 Set the VLAN tag value to
1348 .Ar vlan_tag .
1349 This value is a 16-bit number which is used to create an 802.1Q
1350 VLAN header for packets sent from the
1351 .Xr vlan 4
1352 interface.
1353 Note that
1354 .Cm vlan
1355 and
1356 .Cm vlandev
1357 must both be set at the same time.
1358 .It Cm vlandev Ar iface
1359 Associate the physical interface
1360 .Ar iface
1361 with a
1362 .Xr vlan 4
1363 interface.
1364 Packets transmitted through the
1365 .Xr vlan 4
1366 interface will be
1367 diverted to the specified physical interface
1368 .Ar iface
1369 with 802.1Q VLAN encapsulation.
1370 Packets with 802.1Q encapsulation received
1371 by the parent interface with the correct VLAN tag will be diverted to
1372 the associated
1373 .Xr vlan 4
1374 pseudo-interface.
1375 The
1376 .Xr vlan 4
1377 interface is assigned a
1378 copy of the parent interface's flags and the parent's ethernet address.
1379 The
1380 .Cm vlandev
1381 and
1382 .Cm vlan
1383 must both be set at the same time.
1384 If the
1385 .Xr vlan 4
1386 interface already has
1387 a physical interface associated with it, this command will fail.
1388 To
1389 change the association to another physical interface, the existing
1390 association must be cleared first.
1391 .Pp
1392 Note: if the hardware tagging capability
1393 is set on the parent interface, the
1394 .Xr vlan 4
1395 pseudo
1396 interface's behavior changes:
1397 the
1398 .Xr vlan 4
1399 interface recognizes that the
1400 parent interface supports insertion and extraction of VLAN tags on its
1401 own (usually in firmware) and that it should pass packets to and from
1402 the parent unaltered.
1403 .It Fl vlandev Op Ar iface
1404 If the driver is a
1405 .Xr vlan 4
1406 pseudo device, disassociate the parent interface from it.
1407 This breaks the link between the
1408 .Xr vlan 4
1409 interface and its parent,
1410 clears its VLAN tag, flags and its link address and shuts the interface down.
1411 The
1412 .Ar iface
1413 argument is useless and hence deprecated.
1414 .El
1415 .Pp
1416 The following parameters are specific to
1417 .Xr carp 4
1418 interfaces:
1419 .Bl -tag -width indent
1420 .It Cm advbase Ar seconds
1421 Specifies the base of the advertisement interval in seconds.
1422 The acceptable values are 1 to 255.
1423 The default value is 1.
1424 .\" The default value is
1425 .\" .Dv CARP_DFLTINTV .
1426 .It Cm advskew Ar interval
1427 Specifies the skew to add to the base advertisement interval to
1428 make one host advertise slower than another host.
1429 It is specified in 1/256 of seconds.
1430 The acceptable values are 1 to 254.
1431 The default value is 0.
1432 .It Cm pass Ar phrase
1433 Set the authentication key to
1434 .Ar phrase .
1435 .It Cm vhid Ar n
1436 Set the virtual host ID.
1437 This is a required setting.
1438 Acceptable values are 1 to 255.
1439 .El
1440 .Pp
1441 The
1442 .Nm
1443 utility displays the current configuration for a network interface
1444 when no optional parameters are supplied.
1445 If a protocol family is specified,
1446 .Nm
1447 will report only the details specific to that protocol family.
1448 .Pp
1449 If the
1450 .Fl m
1451 flag is passed before an interface name,
1452 .Nm
1453 will display the capability list and all
1454 of the supported media for the specified interface.
1455 If
1456 .Fl L
1457 flag is supplied, address lifetime is displayed for IPv6 addresses,
1458 as time offset string.
1459 .Pp
1460 Optionally, the
1461 .Fl a
1462 flag may be used instead of an interface name.
1463 This flag instructs
1464 .Nm
1465 to display information about all interfaces in the system.
1466 The
1467 .Fl d
1468 flag limits this to interfaces that are down, and
1469 .Fl u
1470 limits this to interfaces that are up.
1471 When no arguments are given,
1472 .Fl a
1473 is implied.
1474 .Pp
1475 The
1476 .Fl l
1477 flag may be used to list all available interfaces on the system, with
1478 no other additional information.
1479 Use of this flag is mutually exclusive
1480 with all other flags and commands, except for
1481 .Fl d
1482 (only list interfaces that are down)
1483 and
1484 .Fl u
1485 (only list interfaces that are up).
1486 .Pp
1487 The
1488 .Fl v
1489 flag may be used to get more verbose status for an interface.
1490 .Pp
1491 The
1492 .Fl C
1493 flag may be used to list all of the interface cloners available on
1494 the system, with no additional information.
1495 Use of this flag is mutually exclusive with all other flags and commands.
1496 .Pp
1497 The
1498 .Fl k
1499 flag causes keying information for the interface, if available, to be
1500 printed.
1501 For example, the values of 802.11 WEP keys will be printed, if accessible to
1502 the current user.
1503 This information is not printed by default, as it may be considered
1504 sensitive.
1505 .Pp
1506 Only the super-user may modify the configuration of a network interface.
1507 .Sh DIAGNOSTICS
1508 Messages indicating the specified interface does not exist, the
1509 requested address is unknown, or the user is not privileged and
1510 tried to alter an interface's configuration.
1511 .Sh SEE ALSO
1512 .Xr netstat 1 ,
1513 .Xr carp 4 ,
1514 .Xr ifmedia 4 ,
1515 .Xr netintro 4 ,
1516 .Xr polling 4 ,
1517 .Xr vlan 4 ,
1518 .\" .Xr eon 5 ,
1519 .Xr rc 8 ,
1520 .Xr routed 8 ,
1521 .Xr sysctl 8
1522 .Sh HISTORY
1523 The
1524 .Nm
1525 utility appeared in
1526 .Bx 4.2 .
1527 .Sh BUGS
1528 Basic IPv6 node operation requires a link-local address on each
1529 interface configured for IPv6.
1530 Normally, such an address is automatically configured by the
1531 kernel on each interface added to the system; this behaviour may
1532 be disabled by setting the sysctl MIB variable
1533 .Va net.inet6.ip6.auto_linklocal
1534 to 0.
1535 .Pp
1536 If you delete such an address using
1537 .Nm ,
1538 the kernel may act very odd.
1539 Do this at your own risk.