1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
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.20 2007/08/16 20:03:55 dillon Exp $
38 .Nd configure network interface parameters
79 utility is used to assign an address
80 to a network interface and/or configure
81 network interface parameters.
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.
89 The following options are available:
90 .Bl -tag -width indent
93 .Tn DARPA Ns -Internet
95 the address is either a host name present in the host name data
100 Internet address expressed in the Internet standard
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
110 family, it is also possible to specify the prefix length using the slash
115 parameter below for more information.
116 .\" For the Xerox Network Systems(tm) family,
118 .\" .Ar net:a.b.c.d.e.f ,
121 .\" is the assigned network number (in decimal),
122 .\" and each of the six bytes of the host number,
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.
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.
142 is specified as a series of colon-separated hex digits.
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
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
175 Specify the address of the correspondent on the other end
176 of a point to point link.
179 parameter is a string of the form
185 The following parameters may be set with
187 .Bl -tag -width indent
192 Introduced for compatibility
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.
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.
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
219 Enable the use of the Address Resolution Protocol
222 between network level addresses and link level addresses (default).
223 This is currently implemented for mapping between
228 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
230 Disable the use of the Address Resolution Protocol
234 Specify the address to use to represent broadcasts to the
236 The default broadcast address is the address with a host part of all 1's.
238 Enable driver dependent debugging code; usually, this turns on
239 extra console error logging.
241 Disable driver dependent debugging code.
243 Put interface into permanently promiscuous mode.
245 Disable permanently promiscuous mode.
253 When an interface is marked
255 the system will not attempt to
256 transmit messages through that interface.
257 If possible, the interface will be reset to disable reception as well.
258 This action does not automatically disable routes using the interface.
262 (lowermost 64bit of an IPv6 address)
265 This is used to specify an Internet host who is willing to receive
266 IP packets encapsulating IPX packets bound for a remote network.
267 An apparent point to point link is constructed, and
268 the address specified will be taken as the IPX address and network
271 If the driver supports the media selection system, set the media type
274 Some interfaces support the mutually exclusive use of one of several
275 different physical media connectors.
276 For example, a 10Mbit/s Ethernet
277 interface might support the use of either
279 or twisted pair connectors.
280 Setting the media type to
282 would change the currently active connector to the AUI port.
285 would activate twisted pair.
286 Refer to the interfaces' driver
287 specific documentation or man page for a complete list of the
289 .It Cm mediaopt Ar opts
290 If the driver supports the media selection system, set the specified
291 media options on the interface.
295 is a comma delimited list of options to apply to the interface.
296 Refer to the interfaces' driver specific man page for a complete
297 list of available options.
298 .It Fl mediaopt Ar opts
299 If the driver supports the media selection system, disable the
300 specified media options on the interface.
302 If the driver supports the media selection system, set the specified
303 operating mode on the interface to
305 For IEEE 802.11 wireless interfaces that support multiple operating modes
306 this directive is used to select between 802.11a
314 Set the interface name to
316 .It Cm rxcsum , txcsum
317 If the driver supports user-configurable checksum offloading,
318 enable receive (or transmit) checksum offloading on the interface.
319 Some drivers may not be able to enable these flags independently
320 of each other, so setting one may also set the other.
321 The driver will offload as much checksum work as it can reliably
322 support, the exact level of offloading varies between drivers.
323 .It Fl rxcsum , txcsum
324 If the driver supports user-configurable checksum offloading,
325 disable receive (or transmit) checksum offloading on the interface.
326 These settings may not always be independent of each other.
327 .It Cm vlanmtu , vlanhwtag
328 If the driver offers user-configurable VLAN support, enable
329 reception of extended frames or tag processing in hardware,
331 Note that this must be issued on a physical interface associated with
336 .It Fl vlanmtu , vlanhwtag
337 If the driver offers user-configurable VLAN support, disable
338 reception of extended frames or tag processing in hardware,
343 feature and disable interrupts on the interface, if the driver supports
348 feature and enable interrupt mode on the interface.
350 Create the specified network pseudo-device.
351 If the interface is given without a unit number, try to create a new
352 device with an arbitrary unit number.
353 If creation of an arbitrary device is successful, the new device name is
354 printed to standard output unless the interface is renamed or destroyed
359 Destroy the specified network pseudo-device.
375 Set the routing metric of the interface to
378 The routing metric is used by the routing protocol
380 Higher metrics have the effect of making a route
381 less favorable; metrics are counted as additional hops
382 to the destination network or host.
384 Set the maximum transmission unit of the interface to
386 default is interface specific.
387 The MTU is used to limit the size of packets that are transmitted on an
389 Not all interfaces support setting the MTU, and some interfaces have
391 .It Cm netmask Ar mask
394 Specify how much of the address to reserve for subdividing
395 networks into sub-networks.
396 The mask includes the network part of the local address
397 and the subnet part, which is taken from the host field of the address.
398 The mask can be specified as a single hexadecimal number
401 with a dot-notation Internet address,
402 or with a pseudo-network name listed in the network table
404 The mask contains 1's for the bit positions in the 32-bit address
405 which are to be used for the network and subnet parts,
406 and 0's for the host part.
407 The mask should contain at least the standard network portion,
408 and the subnet field should be contiguous with the network
411 The netmask can also be specified in CIDR notation after the address.
414 option above for more information.
417 Enable autoconfiguration.
419 Disable autoconfiguration.
422 Set preferred lifetime for the address.
425 Set valid lifetime for the address.
426 .It Cm prefixlen Ar len
430 bits are reserved for subdividing networks into sub-networks.
433 must be integer, and for syntactical reason it must be between 0 to 128.
434 It is almost always 64 under the current IPv6 assignment rule.
435 If the parameter is omitted, 64 is used.
437 The prefix can also be specified using the slash notation after the address.
440 option above for more information.
443 Set the IPv6 deprecated address bit.
446 Clear the IPv6 deprecated address bit.
449 Set the IPv6 tentative address bit.
452 Clear the IPv6 tentative address bit.
455 .\" .It Cm nsellength Ar n
458 .\" This specifies a trailing number of bytes for a received
460 .\" used for local identification, the remaining leading part of which is
463 .\" (Network Entity Title).
464 .\" The default value is 1, which is conformant to US
466 .\" When an ISO address is set in an ifconfig command,
469 .\" which is being specified.
472 .\" 20 hex digits should be
475 .\" to be assigned to the interface.
476 .\" There is some evidence that a number different from 1 may be useful
479 .\" 37 type addresses.
480 .It Cm range Ar netrange
481 Under appletalk, set the interface to respond to a
484 .Ar startnet Ns - Ns Ar endnet .
485 Appletalk uses this scheme instead of
488 implements it internally as a set of netmasks.
493 Introduced for compatibility
497 The argument following this specifies the version (phase) of the
498 Appletalk network attached to the interface.
499 Values of 1 or 2 are permitted.
501 .It Cm link Op Cm 0 No - Cm 2
503 Enable special processing of the link level of the interface.
504 These three options are interface specific in actual effect, however,
505 they are in general used to select special modes of operation.
507 of this is to enable SLIP compression, or to select the connector type
508 for some Ethernet cards.
509 Refer to the man page for the specific driver
510 for more information.
512 .It Fl link Op Cm 0 No - Cm 2
514 Disable special processing at the link level with the specified interface.
528 Put the interface in monitor mode.
529 No packets are transmitted, and received packets are discarded after
533 Take the interface out of monitor mode.
537 This may be used to enable an interface after an
539 It happens automatically when setting the first address on an interface.
540 If the interface was reset when previously marked down,
541 the hardware will be re-initialized.
544 The following parameters are specific to IEEE 802.11 wireless interfaces:
545 .Bl -tag -width indent
547 When operating as an access point, pass packets between
548 wireless clients directly (default).
549 To instead let them pass up through the
550 system and be forwarded using some other mechanism, use
552 Disabling the internal bridging
553 is useful when traffic is to be processed with
555 .It Cm authmode Ar mode
556 Set the desired authentication mode in infrastructure mode.
557 Not all adaptors support all modes.
560 .Cm none , open , shared
566 (IEEE WPA/WPA2/802.11i).
571 modes are only useful when using an authentication service
572 (a supplicant for client operation or an authenticator when
573 operating as an access point).
574 Modes are case insensitive.
575 .It Cm bintval Ar interval
576 Set the interval at which beacon frames are sent when operating in
580 parameter is specified in TU's (1024 usecs).
581 By default beacon frames are transmitted every 100 TU's.
582 .It Cm bmissthreshold Ar count
583 Set the number of consecutive missed beacons at which the station
584 will attempt to roam (i.e. search for a new access point).
587 parameter is must be in the range 1 to 255;
588 though the upper bound may be reduced according to device capabilities..
589 The default threshold is 7 consecutive missed beacons;
590 but this may be overridden by the device driver.
595 .It Cm bssid Ar address
596 Specify the MAC address of the access point to use when operating
597 as a station in a BSS network.
598 This overrides any automatic selection done by the system.
599 To disable a previously selected access point, supply
604 This option is useful when more than one access point uses the same SSID.
610 Enable packet bursting.
611 Packet bursting is a transmission technique whereby the wireless
612 medium is acquired once to send multiple frames and the interframe
614 This technique can significantly increase throughput by reducing
615 transmission overhead.
616 Packet bursting is supported by the 802.11e QoS specification
617 and some devices that do not support QoS may still be capable.
618 By default packet bursting is enabled if a device is capable
620 To disable packet bursting, use
622 .It Cm chanlist Ar channels
623 Set the desired channels to use when scanning for access
624 points, neighbors in an IBSS network, or looking for unoccupied
625 channels when operating as an access point.
626 The set of channels is specified as a comma-separated list with
627 each element in the list representing either a single channel number or a range
630 Channel numbers must be in the range 1 to 255 and be permissible
631 according to the operating characteristics of the device.
632 .It Cm channel Ar number
633 Set a single desired channel.
634 Channels range from 1 to 255, but the exact selection available
635 depends on the region your adaptor was manufactured for.
642 will give you the default for your adaptor.
644 adaptors ignore this setting unless you are in ad-hoc mode.
645 Alternatively the frequency, in megahertz, may be specified
646 instead of the channel number.
647 .It Cm deftxkey Ar index
648 Set the default key to use for transmission.
649 Typically this is only set when using WEP encryption.
652 is an alias for this request; it is provided for backwards compatibility.
653 .It Cm dtimperiod Ar period
656 period for transmitting buffered multicast data frames when
657 operating in ap mode.
660 specifies the number of beacon intervals between DTIM
661 and must be in the range 1 to 15.
662 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
663 .It Cm fragthreshold Ar length
664 Set the threshold for which transmitted frames are broken into fragments.
667 argument is the frame size in bytes and must be in the range 256 to 2346.
675 disables transmit fragmentation.
676 Not all adaptors honor the fragmentation threshold.
678 When operating as an access point, do not broadcast the SSID
679 in beacon frames or respond to probe request frames unless
680 they are directed to the ap (i.e., they include the ap's SSID).
681 By default, the SSID is included in beacon frames and
682 undirected probe request frames are answered.
683 To re-enable the broadcast of the SSID etc., use
686 Display the list of channels available for use taking into account
687 any restrictions set with the
690 See the description of
692 for more information.
694 Display the adaptor's capabilities, including the operating
697 Display the list of channels available for use.
698 Channels are shown with their IEEE channel number, equivalent
699 frequency, and usage modes.
700 Channels identified as
705 Channels identified as
707 may be used only for Atheros' Static Turbo mode
709 .Cm mediaopt turbo ) .
710 Channels marked with a
712 have a regulatory constraint that they be passively scanned.
713 This means a station is not permitted to transmit on the channel until
714 it identifies the channel is being used for 802.11 communication;
715 typically by hearing a beacon frame from an access point operating
718 is another way of requesting this information.
720 Display the current MAC Access Control List state.
721 Each address is prefixed with a character that indicates the
722 current policy applied to it:
724 indicates the address is allowed access,
726 indicates the address is denied access,
728 indicates the address is present but the current policy open
729 (so the ACL is not consulted).
731 Display the access points and/or ad-hoc neighbors
732 located in the vicinity.
735 flag may be used to display long SSIDs.
736 This information may be updated automatically by the adaptor
741 is another way of requesting this information.
743 When operating as an access point display the stations that are
744 currently associated.
745 When operating in ad-hoc mode display stations identified as
746 neighbors in the IBSS.
748 Display the current parameters to use when operating in WME mode.
749 When WME mode is enabled for an adaptor this information will be
750 displayed with the regular status; this command is mostly useful
751 for examining parameters when WME mode is disabled.
752 See the description of the
754 directive for information on the various parameters.
755 .It Cm mcastrate Ar rate
756 Set the rate for transmitting multicast/broadcast frames.
757 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
758 This rate should be valid for the current operating conditions;
759 if an invalid rate is specified drivers are free to chose an
762 Enable powersave operation.
763 When operating as a client, the station will conserve power by
764 periodically turning off the radio and listening for
765 messages from the access point telling it there are packets waiting.
766 The station must then retrieve the packets.
767 When operating as an access point, the station must honor power
768 save operation of associated clients.
769 Not all devices support power save operation, either as a client
770 or as an access point.
773 to disable powersave operation.
774 .It Cm powersavemode Ar mode
776 The set of valid modes is
787 .It Cm powersavesleep Ar sleep
788 Set the desired max powersave sleep time in TU's (1024 usecs).
789 By default the max powersave sleep time is 100 TU's.
790 .It Cm protmode Ar technique
791 For interfaces operating in 802.11g, use the specified
793 for protecting OFDM frames in a mixed 11b/11g network.
794 The set of valid techniques is
800 Technique names are case insensitive.
802 When operating as an access point in 802.11g mode allow only
803 11g-capable stations to associate (11b-only stations are not
804 permitted to associate).
805 To allow both 11g and 11b-only stations to associate, use
807 .It Cm roaming Ar mode
808 When operating as a station, control how the system will
809 behave when communication with the current access point
813 argument may be one of
815 (leave it to the hardware device to decide),
817 (handle either in the device or the operating system\[em]as appropriate),
819 (do nothing until explicitly instructed).
820 By default, the device is left to handle this if it is
821 capable; otherwise, the operating system will automatically
822 attempt to reestablish communication.
823 Manual mode is mostly useful when an application wants to
824 control the selection of an access point.
825 .It Cm ratectl Ar algorithm
826 Set the TX rate control algorithm.
831 (Onoe TX rate control algorithm),
833 (Sample TX rate control algorithm)
836 (AMRR TX rate control algorithm).
838 names are case sensitive.
839 .It Cm rtsthreshold Ar length
840 Set the threshold for which
841 transmitted frames are preceded by transmission of an
847 is the frame size in bytes and must be in the range 1 to 2346.
855 disables transmission of RTS frames.
856 Not all adaptors support setting the RTS threshold.
858 Set the desired Service Set Identifier (aka network name).
859 The SSID is a string up to 32 characters
860 in length and may be specified as either a normal string or in
861 hexadecimal when preceded by
863 Additionally, the SSID may be cleared by setting it to
866 Initiate a scan of neighboring stations, wait for it to complete, and
867 display all stations found.
868 Only the super-user can initiate a scan.
869 Depending on the capabilities of the APs, the following
870 flags can be included in the output:
874 Indicates that the station support channel hopping as described by the
875 IEEE 802.11b specification.
877 Packet Binary Convolution Code (PBCC).
878 A modulation alternative to the standard OFDM method.
884 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
885 Multiplexing (DSSS-OFDM).
886 Indicates the the station supports DSSS-OFDM modulation.
888 Extended Service Set (ESS).
889 Indicates that the station is part of an infrastructure network
890 (in contrast to an IBSS/ad-hoc network).
893 Indicates that the station is part of an ad-hoc network
894 (in contrast to an ESS network).
897 Data confidentiality is required for all data frames
898 exchanged within the BSS.
899 This means that this BSS requires the station to
900 use cryptographic means such as WEP, TKIP or AES-CCMP to
901 encrypt/decrypt data frames being exchanged with others.
903 Robust Security Network (RSN).
904 Indicates that the station supports the IEEE 802.11i authentication
905 and key management protocol.
908 Indicates that the network is using short preambles (defined
909 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
910 56 bit sync field in contrast to a 128 bit field used in long
914 Indicates that the network is using a short slot time.
919 request can be used to show recent scan results without
920 initiating a new scan.
924 flag may be used to prevent the shortening of long SSIDs.
925 .It Cm stationname Ar name
926 Set the name of this station.
927 It appears that the station name is not really part of the IEEE 802.11
928 protocol though all interfaces seem to support it.
930 seems to be meaningful to identical or virtually identical equipment.
931 Setting the station name is identical in syntax to setting the SSID.
932 .It Cm txpower Ar power
933 Set the power used to transmit frames.
937 is a unitless value in the range 0 to 100 that is interpreted
938 by drivers to derive a device-specific value.
939 Out of range values are truncated.
940 Typically only a few discreet power settings are available and
941 the driver will use the setting closest to the specified value.
942 Not all adaptors support changing the transmit power.
943 .It Cm wepmode Ar mode
944 Set the desired WEP mode.
945 Not all adaptors support all modes.
946 The set of valid modes is
952 mode explicitly tells the adaptor to allow association with access
953 points which allow both encrypted and unencrypted traffic.
956 means that the access point must only allow encrypted connections.
959 is generally another name for
961 Modes are case insensitive.
962 .It Cm weptxkey Ar index
963 Set the WEP key to be used for transmission.
964 This is the same as setting the default transmission key with
966 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
967 Set the selected WEP key.
970 is not given, key 1 is set.
971 A WEP key will be either 5 or 13
972 characters (40 or 104 bits) depending of the local network and the
973 capabilities of the adaptor.
974 It may be specified either as a plain
975 string or as a string of hexadecimal digits preceded by
977 For maximum portability, hex keys are recommended;
978 the mapping of text keys to WEP encryption is usually driver-specific.
981 drivers do this mapping differently to
983 A key may be cleared by setting it to
985 If WEP is supported then there are at least four keys.
986 Some adaptors support more than four keys.
987 If that is the case, then the first four keys
988 (1-4) will be the standard temporary keys and any others will be adaptor
989 specific keys such as permanent keys stored in NVRAM.
991 Enable Wireless Multimedia Extensions (WME) support, if available,
992 for the specified interface.
993 WME is a subset of the IEEE 802.11e standard to support the
994 efficient communication of realtime and multimedia data.
995 To disable WME support, use
998 The following parameters are meaningful only when WME support is in use.
999 Parameters are specified per-AC (Access Category) and
1000 split into those that are used by a station when acting
1001 as an access point and those for client stations in the BSS.
1002 The latter are received from the access point and may not be changed
1004 The following Access Categories are recognized:
1006 .Bl -tag -width ".Cm AC_BK" -compact
1010 best effort delivery,
1025 AC parameters are case-insensitive.
1026 Traffic classification is done in the operating system using the
1027 vlan priority associated with data frames or the
1028 ToS (Type of Service) indication in IP-encapsulated frames.
1029 If neither information is present, traffic is assigned to the
1030 Best Effort (BE) category.
1031 .Bl -tag -width indent
1033 Set the ACK policy for QoS transmissions by the local station;
1034 this controls whether or not data frames transmitted by a station
1035 require an ACK response from the receiving station.
1036 To disable waiting for an ACK use
1038 This parameter is applied only to the local station.
1040 Enable the Admission Control Mandatory (ACM) mechanism
1041 for transmissions by the local station.
1042 To disable the ACM use
1044 On stations in a BSS this parameter is read-only and indicates
1045 the setting received from the access point.
1046 NB: ACM is not supported right now.
1047 .It Cm aifs Ar ac Ar count
1048 Set the Arbitration Inter Frame Spacing (AIFS)
1049 channel access parameter to use for transmissions
1050 by the local station.
1051 On stations in a BSS this parameter is read-only and indicates
1052 the setting received from the access point.
1053 .It Cm cwmin Ar ac Ar count
1054 Set the CWmin channel access parameter to use for transmissions
1055 by the local station.
1056 On stations in a BSS this parameter is read-only and indicates
1057 the setting received from the access point.
1058 .It Cm cwmax Ar ac Ar count
1059 Set the CWmax channel access parameter to use for transmissions
1060 by the local station.
1061 On stations in a BSS this parameter is read-only and indicates
1062 the setting received from the access point.
1063 .It Cm txoplimit Ar ac Ar limit
1064 Set the Transmission Opportunity Limit channel access parameter
1065 to use for transmissions by the local station.
1066 This parameter defines an interval of time when a WME station
1067 has the right to initiate transmissions onto the wireless medium.
1068 On stations in a BSS this parameter is read-only and indicates
1069 the setting received from the access point.
1070 .It Cm bss:aifs Ar ac Ar count
1071 Set the AIFS channel access parameter to send to stations in a BSS.
1072 This parameter is meaningful only when operating in ap mode.
1073 .It Cm bss:cwmin Ar ac Ar count
1074 Set the CWmin channel access parameter to send to stations in a BSS.
1075 This parameter is meaningful only when operating in ap mode.
1076 .It Cm bss:cwmax Ar ac Ar count
1077 Set the CWmax channel access parameter to send to stations in a BSS.
1078 This parameter is meaningful only when operating in ap mode.
1079 .It Cm bss:txoplimit Ar ac Ar limit
1080 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1081 This parameter is meaningful only when operating in ap mode.
1085 The following parameters support an optional access control list
1086 feature available with some adaptors when operating in ap mode; see
1088 This facility allows an access point to accept/deny association
1089 requests based on the MAC address of the station.
1090 Note that this feature does not significantly enhance security
1091 as MAC address spoofing is easy to do.
1092 .Bl -tag -width indent
1093 .It Cm mac:add Ar address
1094 Add the specified MAC address to the database.
1095 Depending on the policy setting association requests from the
1096 specified station will be allowed or denied.
1098 Set the ACL policy to permit association only by
1099 stations registered in the database.
1100 .It Cm mac:del Ar address
1101 Delete the specified MAC address from the database.
1103 Set the ACL policy to deny association only by
1104 stations registered in the database.
1105 .It Cm mac:kick Ar address
1106 Force the specified station to be deauthenticated.
1107 This typically is done to block a station after updating the
1110 Set the ACL policy to allow all stations to associate.
1112 Delete all entries in the database.
1115 The following parameters are for compatibility with other systems:
1116 .Bl -tag -width indent
1118 Another name for the
1124 .It Cm station Ar name
1125 Another name for the
1132 Another way of saying
1138 Another way of saying
1144 Another way of saying:
1145 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1151 .Ar n : k1 , k2 , k3 , k4
1154 Another way of saying
1155 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1160 Another way of saying
1167 The following parameters are specific to bridge interfaces:
1168 .Bl -tag -width indent
1169 .It Cm addm Ar interface
1170 Add the interface named by
1172 as a member of the bridge.
1173 The interface is put into promiscuous mode
1174 so that it can receive every packet sent on the network.
1175 .It Cm deletem Ar interface
1176 Remove the interface named by
1179 Promiscuous mode is disabled on the interface when
1180 it is removed from the bridge.
1181 .It Cm maxaddr Ar size
1182 Set the size of the bridge address cache to
1184 The default is 100 entries.
1185 .It Cm timeout Ar seconds
1186 Set the timeout of address cache entries to
1191 is zero, then address cache entries will not be expired.
1192 The default is 240 seconds.
1194 Display the addresses that have been learned by the bridge.
1195 .It Cm static Ar interface-name Ar address
1196 Add a static entry into the address cache pointing to
1197 .Ar interface-name .
1198 Static entries are never aged out of the cache or re-placed, even if the
1199 address is seen on a different interface.
1200 .It Cm deladdr Ar address
1203 from the address cache.
1205 Delete all dynamically-learned addresses from the address cache.
1207 Delete all addresses, including static addresses, from the address cache.
1208 .It Cm discover Ar interface
1209 Mark an interface as a
1212 When the bridge has no address cache entry
1213 (either dynamic or static)
1214 for the destination address of a packet,
1215 the bridge will forward the packet to all
1216 member interfaces marked as
1218 This is the default for all interfaces added to a bridge.
1219 .It Fl discover Ar interface
1222 attribute on a member interface.
1223 For packets without the
1225 attribute, the only packets forwarded on the interface are broadcast
1226 or multicast packets and packets for which the destination address
1227 is known to be on the interface's segment.
1228 .It Cm learn Ar interface
1229 Mark an interface as a
1232 When a packet arrives on such an interface, the source
1233 address of the packet is entered into the address cache as being a
1234 destination address on the interface's segment.
1235 This is the default for all interfaces added to a bridge.
1236 .It Fl learn Ar interface
1239 attribute on a member interface.
1240 .It Cm span Ar interface
1241 Add the interface named by
1243 as a span port on the bridge.
1244 Span ports transmit a copy of every frame received by the bridge.
1245 This is most useful for snooping a bridged network passively on
1246 another host connected to one of the span ports of the bridge.
1247 .It Fl span Ar interface
1248 Delete the interface named by
1250 from the list of span ports of the bridge.
1251 .It Cm stp Ar interface
1252 Enable Spanning Tree protocol on
1256 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1257 Spanning Tree is used to detect and remove loops in a network topology.
1258 .It Fl stp Ar interface
1259 Disable Spanning Tree protocol on
1261 This is the default for all interfaces added to a bridge.
1262 .It Cm maxage Ar seconds
1263 Set the time that a Spanning Tree protocol configuration is valid.
1264 The default is 20 seconds.
1265 The minimum is 1 second and the maximum is 255 seconds.
1266 .It Cm fwddelay Ar seconds
1267 Set the time that must pass before an interface begins forwarding
1268 packets when Spanning Tree is enabled.
1269 The default is 15 seconds.
1270 The minimum is 1 second and the maximum is 255 seconds.
1271 .It Cm hellotime Ar seconds
1272 Set the time between broadcasting of Spanning Tree protocol
1273 configuration messages.
1274 The default is 2 seconds.
1275 The minimum is 1 second and the maximum is 255 seconds.
1276 .It Cm priority Ar value
1277 Set the bridge priority for Spanning Tree.
1278 The default is 32768.
1279 The minimum is 0 and the maximum is 65536.
1280 .It Cm ifpriority Ar interface Ar value
1281 Set the Spanning Tree priority of
1286 The minimum is 0 and the maximum is 255.
1287 .It Cm ifpathcost Ar interface Ar value
1288 Set the Spanning Tree path cost of
1293 The minimum is 0 and the maximum is 65535.
1296 The following parameters are specific to IP tunnel interfaces,
1298 .Bl -tag -width indent
1299 .It Cm tunnel Ar src_addr dest_addr
1300 Configure the physical source and destination address for IP tunnel
1306 are interpreted as the outer source/destination for the encapsulating
1309 Unconfigure the physical source and destination address for IP tunnel
1310 interfaces previously configured with
1313 Another name for the
1318 The following parameters are specific to
1321 .Bl -tag -width indent
1322 .It Cm vlan Ar vlan_tag
1323 Set the VLAN tag value to
1325 This value is a 16-bit number which is used to create an 802.1Q
1326 VLAN header for packets sent from the
1333 must both be set at the same time.
1334 .It Cm vlandev Ar iface
1335 Associate the physical interface
1340 Packets transmitted through the
1343 diverted to the specified physical interface
1345 with 802.1Q VLAN encapsulation.
1346 Packets with 802.1Q encapsulation received
1347 by the parent interface with the correct VLAN tag will be diverted to
1353 interface is assigned a
1354 copy of the parent interface's flags and the parent's ethernet address.
1359 must both be set at the same time.
1362 interface already has
1363 a physical interface associated with it, this command will fail.
1365 change the association to another physical interface, the existing
1366 association must be cleared first.
1368 Note: if the hardware tagging capability
1369 is set on the parent interface, the
1372 interface's behavior changes:
1375 interface recognizes that the
1376 parent interface supports insertion and extraction of VLAN tags on its
1377 own (usually in firmware) and that it should pass packets to and from
1378 the parent unaltered.
1379 .It Fl vlandev Op Ar iface
1382 pseudo device, disassociate the parent interface from it.
1383 This breaks the link between the
1385 interface and its parent,
1386 clears its VLAN tag, flags and its link address and shuts the interface down.
1389 argument is useless and hence deprecated.
1392 The following parameters are specific to
1395 .Bl -tag -width indent
1396 .It Cm advbase Ar seconds
1397 Specifies the base of the advertisement interval in seconds.
1398 The acceptable values are 1 to 255.
1399 The default value is 1.
1400 .\" The default value is
1401 .\" .Dv CARP_DFLTINTV .
1402 .It Cm advskew Ar interval
1403 Specifies the skew to add to the base advertisement interval to
1404 make one host advertise slower than another host.
1405 It is specified in 1/256 of seconds.
1406 The acceptable values are 1 to 254.
1407 The default value is 0.
1408 .It Cm pass Ar phrase
1409 Set the authentication key to
1412 Set the virtual host ID.
1413 This is a required setting.
1414 Acceptable values are 1 to 255.
1419 utility displays the current configuration for a network interface
1420 when no optional parameters are supplied.
1421 If a protocol family is specified,
1423 will report only the details specific to that protocol family.
1427 flag is passed before an interface name,
1429 will display the capability list and all
1430 of the supported media for the specified interface.
1433 flag is supplied, address lifetime is displayed for IPv6 addresses,
1434 as time offset string.
1438 flag may be used instead of an interface name.
1441 to display information about all interfaces in the system.
1444 flag limits this to interfaces that are down, and
1446 limits this to interfaces that are up.
1447 When no arguments are given,
1453 flag may be used to list all available interfaces on the system, with
1454 no other additional information.
1455 Use of this flag is mutually exclusive
1456 with all other flags and commands, except for
1458 (only list interfaces that are down)
1461 (only list interfaces that are up).
1465 flag may be used to get more verbose status for an interface.
1469 flag may be used to list all of the interface cloners available on
1470 the system, with no additional information.
1471 Use of this flag is mutually exclusive with all other flags and commands.
1475 flag causes keying information for the interface, if available, to be
1477 For example, the values of 802.11 WEP keys will be printed, if accessible to
1479 This information is not printed by default, as it may be considered
1482 Only the super-user may modify the configuration of a network interface.
1484 Messages indicating the specified interface does not exist, the
1485 requested address is unknown, or the user is not privileged and
1486 tried to alter an interface's configuration.
1504 Basic IPv6 node operation requires a link-local address on each
1505 interface configured for IPv6.
1506 Normally, such an address is automatically configured by the
1507 kernel on each interface added to the system; this behaviour may
1508 be disabled by setting the sysctl MIB variable
1509 .Va net.inet6.ip6.auto_linklocal
1512 If you delete such an address using
1514 the kernel may act very odd.
1515 Do this at your own risk.
projects / dragonfly.git / blob