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.19 2007/04/09 21:20:37 swildner Exp $
37 .Nd configure network interface parameters
78 utility is used to assign an address
79 to a network interface and/or configure
80 network interface parameters.
83 utility must be used at boot time to define the network address
84 of each interface present on a machine; it may also be used at
85 a later time to redefine an interface's address
86 or other operating parameters.
88 The following options are available:
89 .Bl -tag -width indent
92 .Tn DARPA Ns -Internet
94 the address is either a host name present in the host name data
99 Internet address expressed in the Internet standard
102 It is also possible to use the CIDR notation (also known as the
103 slash notation) to include the netmask.
104 That is, one can specify an address like
109 family, it is also possible to specify the prefix length using the slash
114 parameter below for more information.
115 .\" For the Xerox Network Systems(tm) family,
117 .\" .Ar net:a.b.c.d.e.f ,
120 .\" is the assigned network number (in decimal),
121 .\" and each of the six bytes of the host number,
125 .\" are specified in hexadecimal.
126 .\" The host number may be omitted on IEEE 802 protocol
127 .\" (Ethernet, FDDI, and Token Ring) interfaces,
128 .\" which use the hardware physical address,
129 .\" and on interfaces other than the first.
132 .\" family, addresses are specified as a long hexadecimal string,
133 .\" as in the Xerox family.
134 .\" However, two consecutive dots imply a zero
135 .\" byte, and the dots are optional, if the user wishes to (carefully)
136 .\" count out long strings of digits in network byte order.
141 is specified as a series of colon-separated hex digits.
143 e.g.\& set a new MAC address on an ethernet interface, though the
144 mechanism used is not ethernet-specific.
145 If the interface is already
146 up when this option is used, it will be briefly brought down and
147 then brought back up again in order to ensure that the receive
148 filter in the underlying ethernet hardware is properly reprogrammed.
149 .It Ar address_family
152 which affects interpretation of the remaining parameters.
153 Since an interface can receive transmissions in differing protocols
154 with different naming schemes, specifying the address family is recommended.
155 The address or protocol families currently
174 Specify the address of the correspondent on the other end
175 of a point to point link.
178 parameter is a string of the form
184 The following parameters may be set with
186 .Bl -tag -width indent
191 Introduced for compatibility
195 Establish an additional network address for this interface.
196 This is sometimes useful when changing network numbers, and
197 one wishes to accept packets addressed to the old interface.
198 If the address is on the same subnet as the first network address
199 for this interface, a non-conflicting netmask must be given.
204 Remove the network address specified.
205 This would be used if you incorrectly specified an alias, or it
206 was no longer needed.
207 If you have incorrectly set an NS address having the side effect
208 of specifying the host portion, removing all NS addresses will
209 allow you to respecify the host portion.
212 Specify that the address configured is an anycast address.
213 Based on the current specification,
214 only routers may configure anycast addresses.
215 Anycast address will not be used as source address of any of outgoing
218 Enable the use of the Address Resolution Protocol
221 between network level addresses and link level addresses (default).
222 This is currently implemented for mapping between
227 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
229 Disable the use of the Address Resolution Protocol
233 Specify the address to use to represent broadcasts to the
235 The default broadcast address is the address with a host part of all 1's.
237 Enable driver dependent debugging code; usually, this turns on
238 extra console error logging.
240 Disable driver dependent debugging code.
242 Put interface into permanently promiscuous mode.
244 Disable permanently promiscuous mode.
252 When an interface is marked
254 the system will not attempt to
255 transmit messages through that interface.
256 If possible, the interface will be reset to disable reception as well.
257 This action does not automatically disable routes using the interface.
261 (lowermost 64bit of an IPv6 address)
264 This is used to specify an Internet host who is willing to receive
265 IP packets encapsulating IPX packets bound for a remote network.
266 An apparent point to point link is constructed, and
267 the address specified will be taken as the IPX address and network
270 If the driver supports the media selection system, set the media type
273 Some interfaces support the mutually exclusive use of one of several
274 different physical media connectors.
275 For example, a 10Mbit/s Ethernet
276 interface might support the use of either
278 or twisted pair connectors.
279 Setting the media type to
281 would change the currently active connector to the AUI port.
284 would activate twisted pair.
285 Refer to the interfaces' driver
286 specific documentation or man page for a complete list of the
288 .It Cm mediaopt Ar opts
289 If the driver supports the media selection system, set the specified
290 media options on the interface.
294 is a comma delimited list of options to apply to the interface.
295 Refer to the interfaces' driver specific man page for a complete
296 list of available options.
297 .It Fl mediaopt Ar opts
298 If the driver supports the media selection system, disable the
299 specified media options on the interface.
301 If the driver supports the media selection system, set the specified
302 operating mode on the interface to
304 For IEEE 802.11 wireless interfaces that support multiple operating modes
305 this directive is used to select between 802.11a
313 Set the interface name to
315 .It Cm rxcsum , txcsum
316 If the driver supports user-configurable checksum offloading,
317 enable receive (or transmit) checksum offloading on the interface.
318 Some drivers may not be able to enable these flags independently
319 of each other, so setting one may also set the other.
320 The driver will offload as much checksum work as it can reliably
321 support, the exact level of offloading varies between drivers.
322 .It Fl rxcsum , txcsum
323 If the driver supports user-configurable checksum offloading,
324 disable receive (or transmit) checksum offloading on the interface.
325 These settings may not always be independent of each other.
326 .It Cm vlanmtu , vlanhwtag
327 If the driver offers user-configurable VLAN support, enable
328 reception of extended frames or tag processing in hardware,
330 Note that this must be issued on a physical interface associated with
335 .It Fl vlanmtu , vlanhwtag
336 If the driver offers user-configurable VLAN support, disable
337 reception of extended frames or tag processing in hardware,
342 feature and disable interrupts on the interface, if the driver supports
347 feature and enable interrupt mode on the interface.
349 Create the specified network pseudo-device.
350 If the interface is given without a unit number, try to create a new
351 device with an arbitrary unit number.
352 If creation of an arbitrary device is successful, the new device name is
353 printed to standard output unless the interface is renamed or destroyed
358 Destroy the specified network pseudo-device.
374 Set the routing metric of the interface to
377 The routing metric is used by the routing protocol
379 Higher metrics have the effect of making a route
380 less favorable; metrics are counted as additional hops
381 to the destination network or host.
383 Set the maximum transmission unit of the interface to
385 default is interface specific.
386 The MTU is used to limit the size of packets that are transmitted on an
388 Not all interfaces support setting the MTU, and some interfaces have
390 .It Cm netmask Ar mask
393 Specify how much of the address to reserve for subdividing
394 networks into sub-networks.
395 The mask includes the network part of the local address
396 and the subnet part, which is taken from the host field of the address.
397 The mask can be specified as a single hexadecimal number
400 with a dot-notation Internet address,
401 or with a pseudo-network name listed in the network table
403 The mask contains 1's for the bit positions in the 32-bit address
404 which are to be used for the network and subnet parts,
405 and 0's for the host part.
406 The mask should contain at least the standard network portion,
407 and the subnet field should be contiguous with the network
410 The netmask can also be specified in CIDR notation after the address.
413 option above for more information.
416 Enable autoconfiguration.
418 Disable autoconfiguration.
421 Set preferred lifetime for the address.
424 Set valid lifetime for the address.
425 .It Cm prefixlen Ar len
429 bits are reserved for subdividing networks into sub-networks.
432 must be integer, and for syntactical reason it must be between 0 to 128.
433 It is almost always 64 under the current IPv6 assignment rule.
434 If the parameter is omitted, 64 is used.
436 The prefix can also be specified using the slash notation after the address.
439 option above for more information.
442 Set the IPv6 deprecated address bit.
445 Clear the IPv6 deprecated address bit.
448 Set the IPv6 tentative address bit.
451 Clear the IPv6 tentative address bit.
454 .\" .It Cm nsellength Ar n
457 .\" This specifies a trailing number of bytes for a received
459 .\" used for local identification, the remaining leading part of which is
462 .\" (Network Entity Title).
463 .\" The default value is 1, which is conformant to US
465 .\" When an ISO address is set in an ifconfig command,
468 .\" which is being specified.
471 .\" 20 hex digits should be
474 .\" to be assigned to the interface.
475 .\" There is some evidence that a number different from 1 may be useful
478 .\" 37 type addresses.
479 .It Cm range Ar netrange
480 Under appletalk, set the interface to respond to a
483 .Ar startnet Ns - Ns Ar endnet .
484 Appletalk uses this scheme instead of
487 implements it internally as a set of netmasks.
492 Introduced for compatibility
496 The argument following this specifies the version (phase) of the
497 Appletalk network attached to the interface.
498 Values of 1 or 2 are permitted.
500 .It Cm link Op Cm 0 No - Cm 2
502 Enable special processing of the link level of the interface.
503 These three options are interface specific in actual effect, however,
504 they are in general used to select special modes of operation.
506 of this is to enable SLIP compression, or to select the connector type
507 for some Ethernet cards.
508 Refer to the man page for the specific driver
509 for more information.
511 .It Fl link Op Cm 0 No - Cm 2
513 Disable special processing at the link level with the specified interface.
527 Put the interface in monitor mode.
528 No packets are transmitted, and received packets are discarded after
532 Take the interface out of monitor mode.
536 This may be used to enable an interface after an
538 It happens automatically when setting the first address on an interface.
539 If the interface was reset when previously marked down,
540 the hardware will be re-initialized.
543 The following parameters are specific to IEEE 802.11 wireless interfaces:
544 .Bl -tag -width indent
546 When operating as an access point, pass packets between
547 wireless clients directly (default).
548 To instead let them pass up through the
549 system and be forwarded using some other mechanism, use
551 Disabling the internal bridging
552 is useful when traffic is to be processed with
554 .It Cm authmode Ar mode
555 Set the desired authentication mode in infrastructure mode.
556 Not all adaptors support all modes.
559 .Cm none , open , shared
565 (IEEE WPA/WPA2/802.11i).
570 modes are only useful when using an authentication service
571 (a supplicant for client operation or an authenticator when
572 operating as an access point).
573 Modes are case insensitive.
574 .It Cm bintval Ar interval
575 Set the interval at which beacon frames are sent when operating in
579 parameter is specified in TU's (1024 usecs).
580 By default beacon frames are transmitted every 100 TU's.
581 .It Cm bmissthreshold Ar count
582 Set the number of consecutive missed beacons at which the station
583 will attempt to roam (i.e. search for a new access point).
586 parameter is must be in the range 1 to 255;
587 though the upper bound may be reduced according to device capabilities..
588 The default threshold is 7 consecutive missed beacons;
589 but this may be overridden by the device driver.
594 .It Cm bssid Ar address
595 Specify the MAC address of the access point to use when operating
596 as a station in a BSS network.
597 This overrides any automatic selection done by the system.
598 To disable a previously selected access point, supply
603 This option is useful when more than one access point uses the same SSID.
609 Enable packet bursting.
610 Packet bursting is a transmission technique whereby the wireless
611 medium is acquired once to send multiple frames and the interframe
613 This technique can significantly increase throughput by reducing
614 transmission overhead.
615 Packet bursting is supported by the 802.11e QoS specification
616 and some devices that do not support QoS may still be capable.
617 By default packet bursting is enabled if a device is capable
619 To disable packet bursting, use
621 .It Cm chanlist Ar channels
622 Set the desired channels to use when scanning for access
623 points, neighbors in an IBSS network, or looking for unoccupied
624 channels when operating as an access point.
625 The set of channels is specified as a comma-separated list with
626 each element in the list representing either a single channel number or a range
629 Channel numbers must be in the range 1 to 255 and be permissible
630 according to the operating characteristics of the device.
631 .It Cm channel Ar number
632 Set a single desired channel.
633 Channels range from 1 to 255, but the exact selection available
634 depends on the region your adaptor was manufactured for.
641 will give you the default for your adaptor.
643 adaptors ignore this setting unless you are in ad-hoc mode.
644 Alternatively the frequency, in megahertz, may be specified
645 instead of the channel number.
646 .It Cm deftxkey Ar index
647 Set the default key to use for transmission.
648 Typically this is only set when using WEP encryption.
651 is an alias for this request; it is provided for backwards compatibility.
652 .It Cm dtimperiod Ar period
655 period for transmitting buffered multicast data frames when
656 operating in ap mode.
659 specifies the number of beacon intervals between DTIM
660 and must be in the range 1 to 15.
661 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
662 .It Cm fragthreshold Ar length
663 Set the threshold for which transmitted frames are broken into fragments.
666 argument is the frame size in bytes and must be in the range 256 to 2346.
674 disables transmit fragmentation.
675 Not all adaptors honor the fragmentation threshold.
677 When operating as an access point, do not broadcast the SSID
678 in beacon frames or respond to probe request frames unless
679 they are directed to the ap (i.e., they include the ap's SSID).
680 By default, the SSID is included in beacon frames and
681 undirected probe request frames are answered.
682 To re-enable the broadcast of the SSID etc., use
685 Display the list of channels available for use taking into account
686 any restrictions set with the
689 See the description of
691 for more information.
693 Display the adaptor's capabilities, including the operating
696 Display the list of channels available for use.
697 Channels are shown with their IEEE channel number, equivalent
698 frequency, and usage modes.
699 Channels identified as
704 Channels identified as
706 may be used only for Atheros' Static Turbo mode
708 .Cm mediaopt turbo ) .
709 Channels marked with a
711 have a regulatory constraint that they be passively scanned.
712 This means a station is not permitted to transmit on the channel until
713 it identifies the channel is being used for 802.11 communication;
714 typically by hearing a beacon frame from an access point operating
717 is another way of requesting this information.
719 Display the current MAC Access Control List state.
720 Each address is prefixed with a character that indicates the
721 current policy applied to it:
723 indicates the address is allowed access,
725 indicates the address is denied access,
727 indicates the address is present but the current policy open
728 (so the ACL is not consulted).
730 Display the access points and/or ad-hoc neighbors
731 located in the vicinity.
734 flag may be used to display long SSIDs.
735 This information may be updated automatically by the adaptor
740 is another way of requesting this information.
742 When operating as an access point display the stations that are
743 currently associated.
744 When operating in ad-hoc mode display stations identified as
745 neighbors in the IBSS.
747 Display the current parameters to use when operating in WME mode.
748 When WME mode is enabled for an adaptor this information will be
749 displayed with the regular status; this command is mostly useful
750 for examining parameters when WME mode is disabled.
751 See the description of the
753 directive for information on the various parameters.
754 .It Cm mcastrate Ar rate
755 Set the rate for transmitting multicast/broadcast frames.
756 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
757 This rate should be valid for the current operating conditions;
758 if an invalid rate is specified drivers are free to chose an
761 Enable powersave operation.
762 When operating as a client, the station will conserve power by
763 periodically turning off the radio and listening for
764 messages from the access point telling it there are packets waiting.
765 The station must then retrieve the packets.
766 When operating as an access point, the station must honor power
767 save operation of associated clients.
768 Not all devices support power save operation, either as a client
769 or as an access point.
772 to disable powersave operation.
773 .It Cm powersavemode Ar mode
775 The set of valid modes is
786 .It Cm powersavesleep Ar sleep
787 Set the desired max powersave sleep time in TU's (1024 usecs).
788 By default the max powersave sleep time is 100 TU's.
789 .It Cm protmode Ar technique
790 For interfaces operating in 802.11g, use the specified
792 for protecting OFDM frames in a mixed 11b/11g network.
793 The set of valid techniques is
799 Technique names are case insensitive.
801 When operating as an access point in 802.11g mode allow only
802 11g-capable stations to associate (11b-only stations are not
803 permitted to associate).
804 To allow both 11g and 11b-only stations to associate, use
806 .It Cm roaming Ar mode
807 When operating as a station, control how the system will
808 behave when communication with the current access point
812 argument may be one of
814 (leave it to the hardware device to decide),
816 (handle either in the device or the operating system\[em]as appropriate),
818 (do nothing until explicitly instructed).
819 By default, the device is left to handle this if it is
820 capable; otherwise, the operating system will automatically
821 attempt to reestablish communication.
822 Manual mode is mostly useful when an application wants to
823 control the selection of an access point.
824 .It Cm ratectl Ar algorithm
825 Set the TX rate control algorithm.
830 (Onoe TX rate control algorithm),
832 (Sample TX rate control algorithm)
835 (AMRR TX rate control algorithm).
837 names are case sensitive.
838 .It Cm rtsthreshold Ar length
839 Set the threshold for which
840 transmitted frames are preceded by transmission of an
846 is the frame size in bytes and must be in the range 1 to 2346.
854 disables transmission of RTS frames.
855 Not all adaptors support setting the RTS threshold.
857 Set the desired Service Set Identifier (aka network name).
858 The SSID is a string up to 32 characters
859 in length and may be specified as either a normal string or in
860 hexadecimal when preceded by
862 Additionally, the SSID may be cleared by setting it to
865 Initiate a scan of neighboring stations, wait for it to complete, and
866 display all stations found.
867 Only the super-user can initiate a scan.
868 Depending on the capabilities of the APs, the following
869 flags can be included in the output:
873 Indicates that the station support channel hopping as described by the
874 IEEE 802.11b specification.
876 Packet Binary Convolution Code (PBCC).
877 A modulation alternative to the standard OFDM method.
883 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
884 Multiplexing (DSSS-OFDM).
885 Indicates the the station supports DSSS-OFDM modulation.
887 Extended Service Set (ESS).
888 Indicates that the station is part of an infrastructure network
889 (in contrast to an IBSS/ad-hoc network).
892 Indicates that the station is part of an ad-hoc network
893 (in contrast to an ESS network).
896 Data confidentiality is required for all data frames
897 exchanged within the BSS.
898 This means that this BSS requires the station to
899 use cryptographic means such as WEP, TKIP or AES-CCMP to
900 encrypt/decrypt data frames being exchanged with others.
902 Robust Security Network (RSN).
903 Indicates that the station supports the IEEE 802.11i authentication
904 and key management protocol.
907 Indicates that the network is using short preambles (defined
908 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
909 56 bit sync field in contrast to a 128 bit field used in long
913 Indicates that the network is using a short slot time.
918 request can be used to show recent scan results without
919 initiating a new scan.
923 flag may be used to prevent the shortening of long SSIDs.
924 .It Cm stationname Ar name
925 Set the name of this station.
926 It appears that the station name is not really part of the IEEE 802.11
927 protocol though all interfaces seem to support it.
929 seems to be meaningful to identical or virtually identical equipment.
930 Setting the station name is identical in syntax to setting the SSID.
931 .It Cm txpower Ar power
932 Set the power used to transmit frames.
936 is a unitless value in the range 0 to 100 that is interpreted
937 by drivers to derive a device-specific value.
938 Out of range values are truncated.
939 Typically only a few discreet power settings are available and
940 the driver will use the setting closest to the specified value.
941 Not all adaptors support changing the transmit power.
942 .It Cm wepmode Ar mode
943 Set the desired WEP mode.
944 Not all adaptors support all modes.
945 The set of valid modes is
951 mode explicitly tells the adaptor to allow association with access
952 points which allow both encrypted and unencrypted traffic.
955 means that the access point must only allow encrypted connections.
958 is generally another name for
960 Modes are case insensitive.
961 .It Cm weptxkey Ar index
962 Set the WEP key to be used for transmission.
963 This is the same as setting the default transmission key with
965 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
966 Set the selected WEP key.
969 is not given, key 1 is set.
970 A WEP key will be either 5 or 13
971 characters (40 or 104 bits) depending of the local network and the
972 capabilities of the adaptor.
973 It may be specified either as a plain
974 string or as a string of hexadecimal digits preceded by
976 For maximum portability, hex keys are recommended;
977 the mapping of text keys to WEP encryption is usually driver-specific.
980 drivers do this mapping differently to
982 A key may be cleared by setting it to
984 If WEP is supported then there are at least four keys.
985 Some adaptors support more than four keys.
986 If that is the case, then the first four keys
987 (1-4) will be the standard temporary keys and any others will be adaptor
988 specific keys such as permanent keys stored in NVRAM.
990 Enable Wireless Multimedia Extensions (WME) support, if available,
991 for the specified interface.
992 WME is a subset of the IEEE 802.11e standard to support the
993 efficient communication of realtime and multimedia data.
994 To disable WME support, use
997 The following parameters are meaningful only when WME support is in use.
998 Parameters are specified per-AC (Access Category) and
999 split into those that are used by a station when acting
1000 as an access point and those for client stations in the BSS.
1001 The latter are received from the access point and may not be changed
1003 The following Access Categories are recognized:
1005 .Bl -tag -width ".Cm AC_BK" -compact
1009 best effort delivery,
1024 AC parameters are case-insensitive.
1025 Traffic classification is done in the operating system using the
1026 vlan priority associated with data frames or the
1027 ToS (Type of Service) indication in IP-encapsulated frames.
1028 If neither information is present, traffic is assigned to the
1029 Best Effort (BE) category.
1030 .Bl -tag -width indent
1032 Set the ACK policy for QoS transmissions by the local station;
1033 this controls whether or not data frames transmitted by a station
1034 require an ACK response from the receiving station.
1035 To disable waiting for an ACK use
1037 This parameter is applied only to the local station.
1039 Enable the Admission Control Mandatory (ACM) mechanism
1040 for transmissions by the local station.
1041 To disable the ACM use
1043 On stations in a BSS this parameter is read-only and indicates
1044 the setting received from the access point.
1045 NB: ACM is not supported right now.
1046 .It Cm aifs Ar ac Ar count
1047 Set the Arbitration Inter Frame Spacing (AIFS)
1048 channel access parameter to use for transmissions
1049 by the local station.
1050 On stations in a BSS this parameter is read-only and indicates
1051 the setting received from the access point.
1052 .It Cm cwmin Ar ac Ar count
1053 Set the CWmin channel access parameter to use for transmissions
1054 by the local station.
1055 On stations in a BSS this parameter is read-only and indicates
1056 the setting received from the access point.
1057 .It Cm cwmax Ar ac Ar count
1058 Set the CWmax channel access parameter to use for transmissions
1059 by the local station.
1060 On stations in a BSS this parameter is read-only and indicates
1061 the setting received from the access point.
1062 .It Cm txoplimit Ar ac Ar limit
1063 Set the Transmission Opportunity Limit channel access parameter
1064 to use for transmissions by the local station.
1065 This parameter defines an interval of time when a WME station
1066 has the right to initiate transmissions onto the wireless medium.
1067 On stations in a BSS this parameter is read-only and indicates
1068 the setting received from the access point.
1069 .It Cm bss:aifs Ar ac Ar count
1070 Set the AIFS channel access parameter to send to stations in a BSS.
1071 This parameter is meaningful only when operating in ap mode.
1072 .It Cm bss:cwmin Ar ac Ar count
1073 Set the CWmin channel access parameter to send to stations in a BSS.
1074 This parameter is meaningful only when operating in ap mode.
1075 .It Cm bss:cwmax Ar ac Ar count
1076 Set the CWmax channel access parameter to send to stations in a BSS.
1077 This parameter is meaningful only when operating in ap mode.
1078 .It Cm bss:txoplimit Ar ac Ar limit
1079 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1080 This parameter is meaningful only when operating in ap mode.
1084 The following parameters support an optional access control list
1085 feature available with some adaptors when operating in ap mode; see
1087 This facility allows an access point to accept/deny association
1088 requests based on the MAC address of the station.
1089 Note that this feature does not significantly enhance security
1090 as MAC address spoofing is easy to do.
1091 .Bl -tag -width indent
1092 .It Cm mac:add Ar address
1093 Add the specified MAC address to the database.
1094 Depending on the policy setting association requests from the
1095 specified station will be allowed or denied.
1097 Set the ACL policy to permit association only by
1098 stations registered in the database.
1099 .It Cm mac:del Ar address
1100 Delete the specified MAC address from the database.
1102 Set the ACL policy to deny association only by
1103 stations registered in the database.
1104 .It Cm mac:kick Ar address
1105 Force the specified station to be deauthenticated.
1106 This typically is done to block a station after updating the
1109 Set the ACL policy to allow all stations to associate.
1111 Delete all entries in the database.
1114 The following parameters are for compatibility with other systems:
1115 .Bl -tag -width indent
1117 Another name for the
1123 .It Cm station Ar name
1124 Another name for the
1131 Another way of saying
1137 Another way of saying
1143 Another way of saying:
1144 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1150 .Ar n : k1 , k2 , k3 , k4
1153 Another way of saying
1154 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1159 Another way of saying
1166 The following parameters are specific to bridge interfaces:
1167 .Bl -tag -width indent
1168 .It Cm addm Ar interface
1169 Add the interface named by
1171 as a member of the bridge.
1172 The interface is put into promiscuous mode
1173 so that it can receive every packet sent on the network.
1174 .It Cm deletem Ar interface
1175 Remove the interface named by
1178 Promiscuous mode is disabled on the interface when
1179 it is removed from the bridge.
1180 .It Cm maxaddr Ar size
1181 Set the size of the bridge address cache to
1183 The default is 100 entries.
1184 .It Cm timeout Ar seconds
1185 Set the timeout of address cache entries to
1190 is zero, then address cache entries will not be expired.
1191 The default is 240 seconds.
1193 Display the addresses that have been learned by the bridge.
1194 .It Cm static Ar interface-name Ar address
1195 Add a static entry into the address cache pointing to
1196 .Ar interface-name .
1197 Static entries are never aged out of the cache or re-placed, even if the
1198 address is seen on a different interface.
1199 .It Cm deladdr Ar address
1202 from the address cache.
1204 Delete all dynamically-learned addresses from the address cache.
1206 Delete all addresses, including static addresses, from the address cache.
1207 .It Cm discover Ar interface
1208 Mark an interface as a
1211 When the bridge has no address cache entry
1212 (either dynamic or static)
1213 for the destination address of a packet,
1214 the bridge will forward the packet to all
1215 member interfaces marked as
1217 This is the default for all interfaces added to a bridge.
1218 .It Fl discover Ar interface
1221 attribute on a member interface.
1222 For packets without the
1224 attribute, the only packets forwarded on the interface are broadcast
1225 or multicast packets and packets for which the destination address
1226 is known to be on the interface's segment.
1227 .It Cm learn Ar interface
1228 Mark an interface as a
1231 When a packet arrives on such an interface, the source
1232 address of the packet is entered into the address cache as being a
1233 destination address on the interface's segment.
1234 This is the default for all interfaces added to a bridge.
1235 .It Fl learn Ar interface
1238 attribute on a member interface.
1239 .It Cm span Ar interface
1240 Add the interface named by
1242 as a span port on the bridge.
1243 Span ports transmit a copy of every frame received by the bridge.
1244 This is most useful for snooping a bridged network passively on
1245 another host connected to one of the span ports of the bridge.
1246 .It Fl span Ar interface
1247 Delete the interface named by
1249 from the list of span ports of the bridge.
1250 .It Cm stp Ar interface
1251 Enable Spanning Tree protocol on
1255 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1256 Spanning Tree is used to detect and remove loops in a network topology.
1257 .It Fl stp Ar interface
1258 Disable Spanning Tree protocol on
1260 This is the default for all interfaces added to a bridge.
1261 .It Cm maxage Ar seconds
1262 Set the time that a Spanning Tree protocol configuration is valid.
1263 The default is 20 seconds.
1264 The minimum is 1 second and the maximum is 255 seconds.
1265 .It Cm fwddelay Ar seconds
1266 Set the time that must pass before an interface begins forwarding
1267 packets when Spanning Tree is enabled.
1268 The default is 15 seconds.
1269 The minimum is 1 second and the maximum is 255 seconds.
1270 .It Cm hellotime Ar seconds
1271 Set the time between broadcasting of Spanning Tree protocol
1272 configuration messages.
1273 The default is 2 seconds.
1274 The minimum is 1 second and the maximum is 255 seconds.
1275 .It Cm priority Ar value
1276 Set the bridge priority for Spanning Tree.
1277 The default is 32768.
1278 The minimum is 0 and the maximum is 65536.
1279 .It Cm ifpriority Ar interface Ar value
1280 Set the Spanning Tree priority of
1285 The minimum is 0 and the maximum is 255.
1286 .It Cm ifpathcost Ar interface Ar value
1287 Set the Spanning Tree path cost of
1292 The minimum is 0 and the maximum is 65535.
1295 The following parameters are specific to IP tunnel interfaces,
1297 .Bl -tag -width indent
1298 .It Cm tunnel Ar src_addr dest_addr
1299 Configure the physical source and destination address for IP tunnel
1305 are interpreted as the outer source/destination for the encapsulating
1308 Unconfigure the physical source and destination address for IP tunnel
1309 interfaces previously configured with
1312 Another name for the
1317 The following parameters are specific to
1320 .Bl -tag -width indent
1321 .It Cm vlan Ar vlan_tag
1322 Set the VLAN tag value to
1324 This value is a 16-bit number which is used to create an 802.1Q
1325 VLAN header for packets sent from the
1332 must both be set at the same time.
1333 .It Cm vlandev Ar iface
1334 Associate the physical interface
1339 Packets transmitted through the
1342 diverted to the specified physical interface
1344 with 802.1Q VLAN encapsulation.
1345 Packets with 802.1Q encapsulation received
1346 by the parent interface with the correct VLAN tag will be diverted to
1352 interface is assigned a
1353 copy of the parent interface's flags and the parent's ethernet address.
1358 must both be set at the same time.
1361 interface already has
1362 a physical interface associated with it, this command will fail.
1364 change the association to another physical interface, the existing
1365 association must be cleared first.
1367 Note: if the hardware tagging capability
1368 is set on the parent interface, the
1371 interface's behavior changes:
1374 interface recognizes that the
1375 parent interface supports insertion and extraction of VLAN tags on its
1376 own (usually in firmware) and that it should pass packets to and from
1377 the parent unaltered.
1378 .It Fl vlandev Op Ar iface
1381 pseudo device, disassociate the parent interface from it.
1382 This breaks the link between the
1384 interface and its parent,
1385 clears its VLAN tag, flags and its link address and shuts the interface down.
1388 argument is useless and hence deprecated.
1393 utility displays the current configuration for a network interface
1394 when no optional parameters are supplied.
1395 If a protocol family is specified,
1397 will report only the details specific to that protocol family.
1401 flag is passed before an interface name,
1403 will display the capability list and all
1404 of the supported media for the specified interface.
1407 flag is supplied, address lifetime is displayed for IPv6 addresses,
1408 as time offset string.
1412 flag may be used instead of an interface name.
1415 to display information about all interfaces in the system.
1418 flag limits this to interfaces that are down, and
1420 limits this to interfaces that are up.
1421 When no arguments are given,
1427 flag may be used to list all available interfaces on the system, with
1428 no other additional information.
1429 Use of this flag is mutually exclusive
1430 with all other flags and commands, except for
1432 (only list interfaces that are down)
1435 (only list interfaces that are up).
1439 flag may be used to get more verbose status for an interface.
1443 flag may be used to list all of the interface cloners available on
1444 the system, with no additional information.
1445 Use of this flag is mutually exclusive with all other flags and commands.
1449 flag causes keying information for the interface, if available, to be
1451 For example, the values of 802.11 WEP keys will be printed, if accessible to
1453 This information is not printed by default, as it may be considered
1456 Only the super-user may modify the configuration of a network interface.
1458 Messages indicating the specified interface does not exist, the
1459 requested address is unknown, or the user is not privileged and
1460 tried to alter an interface's configuration.
1477 Basic IPv6 node operation requires a link-local address on each
1478 interface configured for IPv6.
1479 Normally, such an address is automatically configured by the
1480 kernel on each interface added to the system; this behaviour may
1481 be disabled by setting the sysctl MIB variable
1482 .Va net.inet6.ip6.auto_linklocal
1485 If you delete such an address using
1487 the kernel may act very odd.
1488 Do this at your own risk.
projects / dragonfly.git / blob