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.25 2008/11/14 12:52:04 sephe Exp $
33 .Dd September 30, 2007
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,
340 .It Cm pollcpu Ar cpu
343 feature and disable interrupts on the interface,
344 if the driver supports this mode and
348 Driver will be polled by
353 feature and disable interrupts on the interface, if the driver supports
358 feature and enable interrupt mode on the interface.
360 Create the specified network pseudo-device.
361 If the interface is given without a unit number, try to create a new
362 device with an arbitrary unit number.
363 If creation of an arbitrary device is successful, the new device name is
364 printed to standard output unless the interface is renamed or destroyed
369 Destroy the specified network pseudo-device.
385 Set the routing metric of the interface to
388 The routing metric is used by the routing protocol
390 Higher metrics have the effect of making a route
391 less favorable; metrics are counted as additional hops
392 to the destination network or host.
394 Set the maximum transmission unit of the interface to
396 default is interface specific.
397 The MTU is used to limit the size of packets that are transmitted on an
399 Not all interfaces support setting the MTU, and some interfaces have
401 .It Cm netmask Ar mask
404 Specify how much of the address to reserve for subdividing
405 networks into sub-networks.
406 The mask includes the network part of the local address
407 and the subnet part, which is taken from the host field of the address.
408 The mask can be specified as a single hexadecimal number
411 with a dot-notation Internet address,
412 or with a pseudo-network name listed in the network table
414 The mask contains 1's for the bit positions in the 32-bit address
415 which are to be used for the network and subnet parts,
416 and 0's for the host part.
417 The mask should contain at least the standard network portion,
418 and the subnet field should be contiguous with the network
421 The netmask can also be specified in CIDR notation after the address.
424 option above for more information.
427 Enable autoconfiguration.
429 Disable autoconfiguration.
432 Set preferred lifetime for the address.
435 Set valid lifetime for the address.
436 .It Cm prefixlen Ar len
440 bits are reserved for subdividing networks into sub-networks.
443 must be integer, and for syntactical reason it must be between 0 to 128.
444 It is almost always 64 under the current IPv6 assignment rule.
445 If the parameter is omitted, 64 is used.
447 The prefix can also be specified using the slash notation after the address.
450 option above for more information.
453 Set the IPv6 deprecated address bit.
456 Clear the IPv6 deprecated address bit.
459 Set the IPv6 tentative address bit.
462 Clear the IPv6 tentative address bit.
465 .\" .It Cm nsellength Ar n
468 .\" This specifies a trailing number of bytes for a received
470 .\" used for local identification, the remaining leading part of which is
473 .\" (Network Entity Title).
474 .\" The default value is 1, which is conformant to US
476 .\" When an ISO address is set in an ifconfig command,
479 .\" which is being specified.
482 .\" 20 hex digits should be
485 .\" to be assigned to the interface.
486 .\" There is some evidence that a number different from 1 may be useful
489 .\" 37 type addresses.
490 .It Cm range Ar netrange
491 Under appletalk, set the interface to respond to a
494 .Ar startnet Ns - Ns Ar endnet .
495 Appletalk uses this scheme instead of
498 implements it internally as a set of netmasks.
503 Introduced for compatibility
507 The argument following this specifies the version (phase) of the
508 Appletalk network attached to the interface.
509 Values of 1 or 2 are permitted.
511 .It Cm link Op Cm 0 No - Cm 2
513 Enable special processing of the link level of the interface.
514 These three options are interface specific in actual effect, however,
515 they are in general used to select special modes of operation.
517 of this is to enable SLIP compression, or to select the connector type
518 for some Ethernet cards.
519 Refer to the man page for the specific driver
520 for more information.
522 .It Fl link Op Cm 0 No - Cm 2
524 Disable special processing at the link level with the specified interface.
538 Put the interface in monitor mode.
539 No packets are transmitted, and received packets are discarded after
543 Take the interface out of monitor mode.
547 This may be used to enable an interface after an
549 It happens automatically when setting the first address on an interface.
550 If the interface was reset when previously marked down,
551 the hardware will be re-initialized.
554 The following parameters are specific to IEEE 802.11 wireless interfaces:
555 .Bl -tag -width indent
557 When operating as an access point, pass packets between
558 wireless clients directly (default).
559 To instead let them pass up through the
560 system and be forwarded using some other mechanism, use
562 Disabling the internal bridging
563 is useful when traffic is to be processed with
565 .It Cm authmode Ar mode
566 Set the desired authentication mode in infrastructure mode.
567 Not all adaptors support all modes.
570 .Cm none , open , shared
576 (IEEE WPA/WPA2/802.11i).
581 modes are only useful when using an authentication service
582 (a supplicant for client operation or an authenticator when
583 operating as an access point).
584 Modes are case insensitive.
585 .It Cm bintval Ar interval
586 Set the interval at which beacon frames are sent when operating in
590 parameter is specified in TU's (1024 usecs).
591 By default beacon frames are transmitted every 100 TU's.
592 .It Cm bmissthreshold Ar count
593 Set the number of consecutive missed beacons at which the station
594 will attempt to roam (i.e. search for a new access point).
597 parameter is must be in the range 1 to 255;
598 though the upper bound may be reduced according to device capabilities..
599 The default threshold is 7 consecutive missed beacons;
600 but this may be overridden by the device driver.
605 .It Cm bssid Ar address
606 Specify the MAC address of the access point to use when operating
607 as a station in a BSS network.
608 This overrides any automatic selection done by the system.
609 To disable a previously selected access point, supply
614 This option is useful when more than one access point uses the same SSID.
620 Enable packet bursting.
621 Packet bursting is a transmission technique whereby the wireless
622 medium is acquired once to send multiple frames and the interframe
624 This technique can significantly increase throughput by reducing
625 transmission overhead.
626 Packet bursting is supported by the 802.11e QoS specification
627 and some devices that do not support QoS may still be capable.
628 By default packet bursting is enabled if a device is capable
630 To disable packet bursting, use
632 .It Cm chanlist Ar channels
633 Set the desired channels to use when scanning for access
634 points, neighbors in an IBSS network, or looking for unoccupied
635 channels when operating as an access point.
636 The set of channels is specified as a comma-separated list with
637 each element in the list representing either a single channel number or a range
640 Channel numbers must be in the range 1 to 255 and be permissible
641 according to the operating characteristics of the device.
642 .It Cm channel Ar number
643 Set a single desired channel.
644 Channels range from 1 to 255, but the exact selection available
645 depends on the region your adaptor was manufactured for.
652 will give you the default for your adaptor.
654 adaptors ignore this setting unless you are in ad-hoc mode.
655 Alternatively the frequency, in megahertz, may be specified
656 instead of the channel number.
657 .It Cm deftxkey Ar index
658 Set the default key to use for transmission.
659 Typically this is only set when using WEP encryption.
662 is an alias for this request; it is provided for backwards compatibility.
663 .It Cm dtimperiod Ar period
666 period for transmitting buffered multicast data frames when
667 operating in ap mode.
670 specifies the number of beacon intervals between DTIM
671 and must be in the range 1 to 15.
672 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
673 .It Cm fragthreshold Ar length
674 Set the threshold for which transmitted frames are broken into fragments.
677 argument is the frame size in bytes and must be in the range 256 to 2346.
685 disables transmit fragmentation.
686 Not all adaptors honor the fragmentation threshold.
688 When operating as an access point, do not broadcast the SSID
689 in beacon frames or respond to probe request frames unless
690 they are directed to the ap (i.e., they include the ap's SSID).
691 By default, the SSID is included in beacon frames and
692 undirected probe request frames are answered.
693 To re-enable the broadcast of the SSID etc., use
696 Display the list of channels available for use taking into account
697 any restrictions set with the
700 See the description of
702 for more information.
704 Display the adaptor's capabilities, including the operating
707 Display the list of channels available for use.
708 Channels are shown with their IEEE channel number, equivalent
709 frequency, and usage modes.
710 Channels identified as
715 Channels identified as
717 may be used only for Atheros' Static Turbo mode
719 .Cm mediaopt turbo ) .
720 Channels marked with a
722 have a regulatory constraint that they be passively scanned.
723 This means a station is not permitted to transmit on the channel until
724 it identifies the channel is being used for 802.11 communication;
725 typically by hearing a beacon frame from an access point operating
728 is another way of requesting this information.
730 Display the current MAC Access Control List state.
731 Each address is prefixed with a character that indicates the
732 current policy applied to it:
734 indicates the address is allowed access,
736 indicates the address is denied access,
738 indicates the address is present but the current policy open
739 (so the ACL is not consulted).
741 Display the access points and/or ad-hoc neighbors
742 located in the vicinity.
745 flag may be used to display long SSIDs.
746 This information may be updated automatically by the adaptor
751 is another way of requesting this information.
753 When operating as an access point display the stations that are
754 currently associated.
755 When operating in ad-hoc mode display stations identified as
756 neighbors in the IBSS.
758 Display the current parameters to use when operating in WME mode.
759 When WME mode is enabled for an adaptor this information will be
760 displayed with the regular status; this command is mostly useful
761 for examining parameters when WME mode is disabled.
762 See the description of the
764 directive for information on the various parameters.
765 .It Cm mcastrate Ar rate
766 Set the rate for transmitting multicast/broadcast frames.
767 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
768 This rate should be valid for the current operating conditions;
769 if an invalid rate is specified drivers are free to chose an
772 Enable powersave operation.
773 When operating as a client, the station will conserve power by
774 periodically turning off the radio and listening for
775 messages from the access point telling it there are packets waiting.
776 The station must then retrieve the packets.
777 When operating as an access point, the station must honor power
778 save operation of associated clients.
779 Not all devices support power save operation, either as a client
780 or as an access point.
783 to disable powersave operation.
784 .It Cm powersavemode Ar mode
786 The set of valid modes is
797 .It Cm powersavesleep Ar sleep
798 Set the desired max powersave sleep time in TU's (1024 usecs).
799 By default the max powersave sleep time is 100 TU's.
800 .It Cm protmode Ar technique
801 For interfaces operating in 802.11g, use the specified
803 for protecting OFDM frames in a mixed 11b/11g network.
804 The set of valid techniques is
810 Technique names are case insensitive.
812 When operating as an access point in 802.11g mode allow only
813 11g-capable stations to associate (11b-only stations are not
814 permitted to associate).
815 To allow both 11g and 11b-only stations to associate, use
817 .It Cm roaming Ar mode
818 When operating as a station, control how the system will
819 behave when communication with the current access point
823 argument may be one of
825 (leave it to the hardware device to decide),
827 (handle either in the device or the operating system\[em]as appropriate),
829 (do nothing until explicitly instructed).
830 By default, the device is left to handle this if it is
831 capable; otherwise, the operating system will automatically
832 attempt to reestablish communication.
833 Manual mode is mostly useful when an application wants to
834 control the selection of an access point.
835 .It Cm ratectl Ar algorithm
836 Set the TX rate control algorithm.
841 (Onoe TX rate control algorithm),
843 (Sample TX rate control algorithm)
846 (AMRR TX rate control algorithm).
848 names are case sensitive.
849 .It Cm rtsthreshold Ar length
850 Set the threshold for which
851 transmitted frames are preceded by transmission of an
857 is the frame size in bytes and must be in the range 1 to 2346.
865 disables transmission of RTS frames.
866 Not all adaptors support setting the RTS threshold.
868 Set the desired Service Set Identifier (aka network name).
869 The SSID is a string up to 32 characters
870 in length and may be specified as either a normal string or in
871 hexadecimal when preceded by
873 Additionally, the SSID may be cleared by setting it to
876 Initiate a scan of neighboring stations, wait for it to complete, and
877 display all stations found.
878 Only the super-user can initiate a scan.
879 Depending on the capabilities of the APs, the following
880 flags can be included in the output:
884 Indicates that the station support channel hopping as described by the
885 IEEE 802.11b specification.
887 Packet Binary Convolution Code (PBCC).
888 A modulation alternative to the standard OFDM method.
894 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
895 Multiplexing (DSSS-OFDM).
896 Indicates the the station supports DSSS-OFDM modulation.
898 Extended Service Set (ESS).
899 Indicates that the station is part of an infrastructure network
900 (in contrast to an IBSS/ad-hoc network).
903 Indicates that the station is part of an ad-hoc network
904 (in contrast to an ESS network).
907 Data confidentiality is required for all data frames
908 exchanged within the BSS.
909 This means that this BSS requires the station to
910 use cryptographic means such as WEP, TKIP or AES-CCMP to
911 encrypt/decrypt data frames being exchanged with others.
913 Robust Security Network (RSN).
914 Indicates that the station supports the IEEE 802.11i authentication
915 and key management protocol.
918 Indicates that the network is using short preambles (defined
919 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
920 56 bit sync field in contrast to a 128 bit field used in long
924 Indicates that the network is using a short slot time.
929 request can be used to show recent scan results without
930 initiating a new scan.
934 flag may be used to prevent the shortening of long SSIDs.
935 .It Cm stationname Ar name
936 Set the name of this station.
937 It appears that the station name is not really part of the IEEE 802.11
938 protocol though all interfaces seem to support it.
940 seems to be meaningful to identical or virtually identical equipment.
941 Setting the station name is identical in syntax to setting the SSID.
942 .It Cm txpower Ar power
943 Set the power used to transmit frames.
947 is a unitless value in the range 0 to 100 that is interpreted
948 by drivers to derive a device-specific value.
949 Out of range values are truncated.
950 Typically only a few discreet power settings are available and
951 the driver will use the setting closest to the specified value.
952 Not all adaptors support changing the transmit power.
953 .It Cm wepmode Ar mode
954 Set the desired WEP mode.
955 Not all adaptors support all modes.
956 The set of valid modes is
962 mode explicitly tells the adaptor to allow association with access
963 points which allow both encrypted and unencrypted traffic.
966 means that the access point must only allow encrypted connections.
969 is generally another name for
971 Modes are case insensitive.
972 .It Cm weptxkey Ar index
973 Set the WEP key to be used for transmission.
974 This is the same as setting the default transmission key with
976 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
977 Set the selected WEP key.
980 is not given, key 1 is set.
981 A WEP key will be either 5 or 13
982 characters (40 or 104 bits) depending of the local network and the
983 capabilities of the adaptor.
984 It may be specified either as a plain
985 string or as a string of hexadecimal digits preceded by
987 For maximum portability, hex keys are recommended;
988 the mapping of text keys to WEP encryption is usually driver-specific.
991 drivers do this mapping differently to
993 A key may be cleared by setting it to
995 If WEP is supported then there are at least four keys.
996 Some adaptors support more than four keys.
997 If that is the case, then the first four keys
998 (1-4) will be the standard temporary keys and any others will be adaptor
999 specific keys such as permanent keys stored in NVRAM.
1001 Enable Wireless Multimedia Extensions (WME) support, if available,
1002 for the specified interface.
1003 WME is a subset of the IEEE 802.11e standard to support the
1004 efficient communication of realtime and multimedia data.
1005 To disable WME support, use
1008 The following parameters are meaningful only when WME support is in use.
1009 Parameters are specified per-AC (Access Category) and
1010 split into those that are used by a station when acting
1011 as an access point and those for client stations in the BSS.
1012 The latter are received from the access point and may not be changed
1014 The following Access Categories are recognized:
1016 .Bl -tag -width ".Cm AC_BK" -compact
1020 best effort delivery,
1035 AC parameters are case-insensitive.
1036 Traffic classification is done in the operating system using the
1037 vlan priority associated with data frames or the
1038 ToS (Type of Service) indication in IP-encapsulated frames.
1039 If neither information is present, traffic is assigned to the
1040 Best Effort (BE) category.
1041 .Bl -tag -width indent
1043 Set the ACK policy for QoS transmissions by the local station;
1044 this controls whether or not data frames transmitted by a station
1045 require an ACK response from the receiving station.
1046 To disable waiting for an ACK use
1048 This parameter is applied only to the local station.
1050 Enable the Admission Control Mandatory (ACM) mechanism
1051 for transmissions by the local station.
1052 To disable the ACM use
1054 On stations in a BSS this parameter is read-only and indicates
1055 the setting received from the access point.
1056 NB: ACM is not supported right now.
1057 .It Cm aifs Ar ac Ar count
1058 Set the Arbitration Inter Frame Spacing (AIFS)
1059 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 cwmin Ar ac Ar count
1064 Set the CWmin channel access parameter to use for transmissions
1065 by the local station.
1066 On stations in a BSS this parameter is read-only and indicates
1067 the setting received from the access point.
1068 .It Cm cwmax Ar ac Ar count
1069 Set the CWmax channel access parameter to use for transmissions
1070 by the local station.
1071 On stations in a BSS this parameter is read-only and indicates
1072 the setting received from the access point.
1073 .It Cm txoplimit Ar ac Ar limit
1074 Set the Transmission Opportunity Limit channel access parameter
1075 to use for transmissions by the local station.
1076 This parameter defines an interval of time when a WME station
1077 has the right to initiate transmissions onto the wireless medium.
1078 On stations in a BSS this parameter is read-only and indicates
1079 the setting received from the access point.
1080 .It Cm bss:aifs Ar ac Ar count
1081 Set the AIFS channel access parameter to send to stations in a BSS.
1082 This parameter is meaningful only when operating in ap mode.
1083 .It Cm bss:cwmin Ar ac Ar count
1084 Set the CWmin channel access parameter to send to stations in a BSS.
1085 This parameter is meaningful only when operating in ap mode.
1086 .It Cm bss:cwmax Ar ac Ar count
1087 Set the CWmax channel access parameter to send to stations in a BSS.
1088 This parameter is meaningful only when operating in ap mode.
1089 .It Cm bss:txoplimit Ar ac Ar limit
1090 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1091 This parameter is meaningful only when operating in ap mode.
1095 The following parameters support an optional access control list
1096 feature available with some adaptors when operating in ap mode; see
1098 This facility allows an access point to accept/deny association
1099 requests based on the MAC address of the station.
1100 Note that this feature does not significantly enhance security
1101 as MAC address spoofing is easy to do.
1102 .Bl -tag -width indent
1103 .It Cm mac:add Ar address
1104 Add the specified MAC address to the database.
1105 Depending on the policy setting association requests from the
1106 specified station will be allowed or denied.
1108 Set the ACL policy to permit association only by
1109 stations registered in the database.
1110 .It Cm mac:del Ar address
1111 Delete the specified MAC address from the database.
1113 Set the ACL policy to deny association only by
1114 stations registered in the database.
1115 .It Cm mac:kick Ar address
1116 Force the specified station to be deauthenticated.
1117 This typically is done to block a station after updating the
1120 Set the ACL policy to allow all stations to associate.
1122 Delete all entries in the database.
1125 The following parameters are for compatibility with other systems:
1126 .Bl -tag -width indent
1128 Another name for the
1134 .It Cm station Ar name
1135 Another name for the
1142 Another way of saying
1148 Another way of saying
1154 Another way of saying:
1155 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1161 .Ar n : k1 , k2 , k3 , k4
1164 Another way of saying
1165 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1170 Another way of saying
1177 The following parameters are specific to bridge interfaces:
1178 .Bl -tag -width indent
1179 .It Cm addm Ar interface
1180 Add the interface named by
1182 as a member of the bridge.
1183 The interface is put into promiscuous mode
1184 so that it can receive every packet sent on the network.
1185 .It Cm deletem Ar interface
1186 Remove the interface named by
1189 Promiscuous mode is disabled on the interface when
1190 it is removed from the bridge.
1191 .It Cm maxaddr Ar size
1192 Set the size of the bridge address cache to
1194 The default is 100 entries.
1195 .It Cm timeout Ar seconds
1196 Set the timeout of address cache entries to
1201 is zero, then address cache entries will not be expired.
1202 The default is 1200 seconds.
1204 Display the addresses that have been learned by the bridge.
1205 .It Cm static Ar interface-name Ar address
1206 Add a static entry into the address cache pointing to
1207 .Ar interface-name .
1208 Static entries are never aged out of the cache or re-placed, even if the
1209 address is seen on a different interface.
1210 .It Cm deladdr Ar address
1213 from the address cache.
1215 Delete all dynamically-learned addresses from the address cache.
1217 Delete all addresses, including static addresses, from the address cache.
1218 .It Cm discover Ar interface
1219 Mark an interface as a
1222 When the bridge has no address cache entry
1223 (either dynamic or static)
1224 for the destination address of a packet,
1225 the bridge will forward the packet to all
1226 member interfaces marked as
1228 This is the default for all interfaces added to a bridge.
1229 .It Fl discover Ar interface
1232 attribute on a member interface.
1233 For packets without the
1235 attribute, the only packets forwarded on the interface are broadcast
1236 or multicast packets and packets for which the destination address
1237 is known to be on the interface's segment.
1238 .It Cm learn Ar interface
1239 Mark an interface as a
1242 When a packet arrives on such an interface, the source
1243 address of the packet is entered into the address cache as being a
1244 destination address on the interface's segment.
1245 This is the default for all interfaces added to a bridge.
1246 .It Fl learn Ar interface
1249 attribute on a member interface.
1250 .It Cm span Ar interface
1251 Add the interface named by
1253 as a span port on the bridge.
1254 Span ports transmit a copy of every frame received by the bridge.
1255 This is most useful for snooping a bridged network passively on
1256 another host connected to one of the span ports of the bridge.
1257 .It Fl span Ar interface
1258 Delete the interface named by
1260 from the list of span ports of the bridge.
1261 .It Cm stp Ar interface
1262 Enable Spanning Tree protocol on
1266 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1267 Spanning Tree is used to detect and remove loops in a network topology.
1268 .It Fl stp Ar interface
1269 Disable Spanning Tree protocol on
1271 This is the default for all interfaces added to a bridge.
1272 .It Cm maxage Ar seconds
1273 Set the time that a Spanning Tree protocol configuration is valid.
1274 The default is 20 seconds.
1275 The minimum is 1 second and the maximum is 255 seconds.
1276 .It Cm fwddelay Ar seconds
1277 Set the time that must pass before an interface begins forwarding
1278 packets when Spanning Tree is enabled.
1279 The default is 15 seconds.
1280 The minimum is 1 second and the maximum is 255 seconds.
1281 .It Cm hellotime Ar seconds
1282 Set the time between broadcasting of Spanning Tree protocol
1283 configuration messages.
1284 The default is 2 seconds.
1285 The minimum is 1 second and the maximum is 255 seconds.
1286 .It Cm priority Ar value
1287 Set the bridge priority for Spanning Tree.
1288 The default is 32768.
1289 The minimum is 0 and the maximum is 65536.
1290 .It Cm ifpriority Ar interface Ar value
1291 Set the Spanning Tree priority of
1296 The minimum is 0 and the maximum is 255.
1297 .It Cm ifpathcost Ar interface Ar value
1298 Set the Spanning Tree path cost of
1303 The minimum is 0 and the maximum is 65535.
1306 The following parameters are specific to IP tunnel interfaces,
1308 .Bl -tag -width indent
1309 .It Cm tunnel Ar src_addr dest_addr
1310 Configure the physical source and destination address for IP tunnel
1316 are interpreted as the outer source/destination for the encapsulating
1319 Unconfigure the physical source and destination address for IP tunnel
1320 interfaces previously configured with
1323 Another name for the
1328 The following parameters are specific to
1331 .Bl -tag -width indent
1332 .It Cm vlan Ar vlan_tag
1333 Set the VLAN tag value to
1335 This value is a 16-bit number which is used to create an 802.1Q
1336 VLAN header for packets sent from the
1343 must both be set at the same time.
1344 .It Cm vlandev Ar iface
1345 Associate the physical interface
1350 Packets transmitted through the
1353 diverted to the specified physical interface
1355 with 802.1Q VLAN encapsulation.
1356 Packets with 802.1Q encapsulation received
1357 by the parent interface with the correct VLAN tag will be diverted to
1363 interface is assigned a
1364 copy of the parent interface's flags and the parent's ethernet address.
1369 must both be set at the same time.
1372 interface already has
1373 a physical interface associated with it, this command will fail.
1375 change the association to another physical interface, the existing
1376 association must be cleared first.
1378 Note: if the hardware tagging capability
1379 is set on the parent interface, the
1382 interface's behavior changes:
1385 interface recognizes that the
1386 parent interface supports insertion and extraction of VLAN tags on its
1387 own (usually in firmware) and that it should pass packets to and from
1388 the parent unaltered.
1389 .It Fl vlandev Op Ar iface
1392 pseudo device, disassociate the parent interface from it.
1393 This breaks the link between the
1395 interface and its parent,
1396 clears its VLAN tag, flags and its link address and shuts the interface down.
1399 argument is useless and hence deprecated.
1402 The following parameters are specific to
1405 .Bl -tag -width indent
1406 .It Cm advbase Ar seconds
1407 Specifies the base of the advertisement interval in seconds.
1408 The acceptable values are 1 to 255.
1409 The default value is 1.
1410 .\" The default value is
1411 .\" .Dv CARP_DFLTINTV .
1412 .It Cm advskew Ar interval
1413 Specifies the skew to add to the base advertisement interval to
1414 make one host advertise slower than another host.
1415 It is specified in 1/256 of seconds.
1416 The acceptable values are 1 to 254.
1417 The default value is 0.
1418 .It Cm pass Ar phrase
1419 Set the authentication key to
1422 Set the virtual host ID.
1423 This is a required setting.
1424 Acceptable values are 1 to 255.
1429 utility displays the current configuration for a network interface
1430 when no optional parameters are supplied.
1431 If a protocol family is specified,
1433 will report only the details specific to that protocol family.
1437 flag is passed before an interface name,
1439 will display the capability list and all
1440 of the supported media for the specified interface.
1443 flag is supplied, address lifetime is displayed for IPv6 addresses,
1444 as time offset string.
1448 flag may be used instead of an interface name.
1451 to display information about all interfaces in the system.
1454 flag limits this to interfaces that are down, and
1456 limits this to interfaces that are up.
1457 When no arguments are given,
1463 flag may be used to list all available interfaces on the system, with
1464 no other additional information.
1465 Use of this flag is mutually exclusive
1466 with all other flags and commands, except for
1468 (only list interfaces that are down)
1471 (only list interfaces that are up).
1475 flag may be used to get more verbose status for an interface.
1479 flag may be used to list all of the interface cloners available on
1480 the system, with no additional information.
1481 Use of this flag is mutually exclusive with all other flags and commands.
1485 flag causes keying information for the interface, if available, to be
1487 For example, the values of 802.11 WEP keys will be printed, if accessible to
1489 This information is not printed by default, as it may be considered
1492 Only the super-user may modify the configuration of a network interface.
1494 Messages indicating the specified interface does not exist, the
1495 requested address is unknown, or the user is not privileged and
1496 tried to alter an interface's configuration.
1514 Basic IPv6 node operation requires a link-local address on each
1515 interface configured for IPv6.
1516 Normally, such an address is automatically configured by the
1517 kernel on each interface added to the system; this behaviour may
1518 be disabled by setting the sysctl MIB variable
1519 .Va net.inet6.ip6.auto_linklocal
1522 If you delete such an address using
1524 the kernel may act very odd.
1525 Do this at your own risk.
projects / dragonfly.git / blob