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
36 .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
184 List the interfaces in the given group.
187 The following parameters may be set with
189 .Bl -tag -width indent
194 Introduced for compatibility
198 Establish an additional network address for this interface.
199 This is sometimes useful when changing network numbers, and
200 one wishes to accept packets addressed to the old interface.
201 If the address is on the same subnet as the first network address
202 for this interface, a non-conflicting netmask must be given.
207 Remove the network address specified.
208 This would be used if you incorrectly specified an alias, or it
209 was no longer needed.
210 If you have incorrectly set an NS address having the side effect
211 of specifying the host portion, removing all NS addresses will
212 allow you to respecify the host portion.
215 Specify that the address configured is an anycast address.
216 Based on the current specification,
217 only routers may configure anycast addresses.
218 Anycast address will not be used as source address of any of outgoing
221 Enable the use of the Address Resolution Protocol
224 between network level addresses and link level addresses (default).
225 This is currently implemented for mapping between
230 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
232 Disable the use of the Address Resolution Protocol
235 If the Address Resolution Protocol is enabled,
236 the host will only reply to requests for its addresses,
237 and will never send any requests.
239 If the Address Resolution Protocol is enabled,
240 the host will perform normally,
241 sending out requests and listening for replies.
244 Specify the address to use to represent broadcasts to the
246 The default broadcast address is the address with a host part of all 1's.
248 Enable driver dependent debugging code; usually, this turns on
249 extra console error logging.
251 Disable driver dependent debugging code.
253 Put interface into permanently promiscuous mode.
255 Disable permanently promiscuous mode.
263 When an interface is marked
265 the system will not attempt to
266 transmit messages through that interface.
267 If possible, the interface will be reset to disable reception as well.
268 This action does not automatically disable routes using the interface.
269 .It Cm group Ar group-name
270 Assign the interface to a
272 Any interface can be in multiple groups.
274 Cloned interfaces are members of their interface family group by default.
275 For example, a PPP interface such as
277 is a member of the PPP interface family group,
279 .\" The interface(s) the default route(s) point to are members of the
282 .It Cm -group Ar group-name
283 Remove the interface from the given
288 (lowermost 64bit of an IPv6 address)
291 This is used to specify an Internet host who is willing to receive
292 IP packets encapsulating IPX packets bound for a remote network.
293 An apparent point to point link is constructed, and
294 the address specified will be taken as the IPX address and network
296 .It Cm maclabel Ar label
297 If Mandatory Access Control support is enabled in the kernel,
301 .\" .Xr maclabel 7 ) .
303 If the driver supports the media selection system, set the media type
306 Some interfaces support the mutually exclusive use of one of several
307 different physical media connectors.
308 For example, a 10Mbit/s Ethernet
309 interface might support the use of either
311 or twisted pair connectors.
312 Setting the media type to
314 would change the currently active connector to the AUI port.
317 would activate twisted pair.
318 Refer to the interfaces' driver
319 specific documentation or man page for a complete list of the
321 .It Cm mediaopt Ar opts
322 If the driver supports the media selection system, set the specified
323 media options on the interface.
327 is a comma delimited list of options to apply to the interface.
328 Refer to the interfaces' driver specific man page for a complete
329 list of available options.
330 .It Fl mediaopt Ar opts
331 If the driver supports the media selection system, disable the
332 specified media options on the interface.
334 If the driver supports the media selection system, set the specified
335 operating mode on the interface to
337 For IEEE 802.11 wireless interfaces that support multiple operating modes
338 this directive is used to select between 802.11a
346 Set the interface name to
348 .It Cm rxcsum , txcsum
349 If the driver supports user-configurable checksum offloading,
350 enable receive (or transmit) checksum offloading on the interface.
351 Some drivers may not be able to enable these flags independently
352 of each other, so setting one may also set the other.
353 The driver will offload as much checksum work as it can reliably
354 support, the exact level of offloading varies between drivers.
355 .It Fl rxcsum , txcsum
356 If the driver supports user-configurable checksum offloading,
357 disable receive (or transmit) checksum offloading on the interface.
358 These settings may not always be independent of each other.
360 If the driver supports
362 segmentation offloading, enable TSO on the interface.
363 Some drivers may not be able to support TSO for
367 packets, so they may enable only one of them.
369 If the driver supports
371 segmentation offloading, disable TSO on the interface.
372 It will always disable TSO for
376 .It Cm vlanmtu , vlanhwtag
377 If the driver offers user-configurable VLAN support, enable
378 reception of extended frames or tag processing in hardware,
380 Note that this must be issued on a physical interface associated with
385 .It Fl vlanmtu , vlanhwtag
386 If the driver offers user-configurable VLAN support, disable
387 reception of extended frames or tag processing in hardware,
392 feature and disable interrupts on the interface, if driver supports
397 feature and enable interrupt mode on the interface.
399 Create the specified network pseudo-device.
400 If the interface is given without a unit number, try to create a new
401 device with an arbitrary unit number.
402 If creation of an arbitrary device is successful, the new device name is
403 printed to standard output unless the interface is renamed or destroyed
408 Destroy the specified network pseudo-device.
424 Set the routing metric of the interface to
427 The routing metric is used by the routing protocol
429 Higher metrics have the effect of making a route
430 less favorable; metrics are counted as additional hops
431 to the destination network or host.
433 Set the maximum transmission unit of the interface to
435 default is interface specific.
436 The MTU is used to limit the size of packets that are transmitted on an
438 Not all interfaces support setting the MTU, and some interfaces have
440 .It Cm netmask Ar mask
443 Specify how much of the address to reserve for subdividing
444 networks into sub-networks.
445 The mask includes the network part of the local address
446 and the subnet part, which is taken from the host field of the address.
447 The mask can be specified as a single hexadecimal number
450 with a dot-notation Internet address,
451 or with a pseudo-network name listed in the network table
453 The mask contains 1's for the bit positions in the 32-bit address
454 which are to be used for the network and subnet parts,
455 and 0's for the host part.
456 The mask should contain at least the standard network portion,
457 and the subnet field should be contiguous with the network
460 The netmask can also be specified in CIDR notation after the address.
463 option above for more information.
464 .It Cm prefixlen Ar len
468 bits are reserved for subdividing networks into sub-networks.
471 must be integer, and for syntactical reason it must be between 0 to 128.
472 It is almost always 64 under the current IPv6 assignment rule.
473 If the parameter is omitted, 64 is used.
475 The prefix can also be specified using the slash notation after the address.
478 option above for more information.
481 .\" .It Cm nsellength Ar n
484 .\" This specifies a trailing number of bytes for a received
486 .\" used for local identification, the remaining leading part of which is
489 .\" (Network Entity Title).
490 .\" The default value is 1, which is conformant to US
492 .\" When an ISO address is set in an ifconfig command,
495 .\" which is being specified.
498 .\" 20 hex digits should be
501 .\" to be assigned to the interface.
502 .\" There is some evidence that a number different from 1 may be useful
505 .\" 37 type addresses.
506 .It Cm range Ar netrange
507 Under appletalk, set the interface to respond to a
510 .Ar startnet Ns - Ns Ar endnet .
511 Appletalk uses this scheme instead of
514 implements it internally as a set of netmasks.
519 Introduced for compatibility
523 The argument following this specifies the version (phase) of the
524 Appletalk network attached to the interface.
525 Values of 1 or 2 are permitted.
527 .It Cm link Op Cm 0 No - Cm 2
529 Enable special processing of the link level of the interface.
530 These three options are interface specific in actual effect, however,
531 they are in general used to select special modes of operation.
533 of this is to enable SLIP compression, or to select the connector type
534 for some Ethernet cards.
535 Refer to the man page for the specific driver
536 for more information.
538 .It Fl link Op Cm 0 No - Cm 2
540 Disable special processing at the link level with the specified interface.
542 Put the interface in monitor mode.
543 No packets are transmitted, and received packets are discarded after
547 Take the interface out of monitor mode.
551 This may be used to enable an interface after an
553 It happens automatically when setting the first address on an interface.
554 If the interface was reset when previously marked down,
555 the hardware will be re-initialized.
558 The following parameters are specific to IEEE 802.11 wireless interfaces:
559 .Bl -tag -width indent
561 When operating as an access point, pass packets between
562 wireless clients directly (default).
563 To instead let them pass up through the
564 system and be forwarded using some other mechanism, use
566 Disabling the internal bridging
567 is useful when traffic is to be processed with
569 .It Cm authmode Ar mode
570 Set the desired authentication mode in infrastructure mode.
571 Not all adaptors support all modes.
574 .Cm none , open , shared
580 (IEEE WPA/WPA2/802.11i).
585 modes are only useful when using an authentication service
586 (a supplicant for client operation or an authenticator when
587 operating as an access point).
588 Modes are case insensitive.
589 .It Cm bintval Ar interval
590 Set the interval at which beacon frames are sent when operating in
594 parameter is specified in TU's (1/1024 msecs).
595 By default beacon frames are transmitted every 100 TU's.
596 .It Cm bmissthreshold Ar count
597 Set the number of consecutive missed beacons at which the station
598 will attempt to roam (i.e., search for a new access point).
601 parameter must be in the range 1 to 255; though the
602 upper bound may be reduced according to device capabilities.
603 The default threshold is 7 consecutive missed beacons; but
604 this may be overridden by the device driver.
609 .It Cm bssid Ar address
610 Specify the MAC address of the access point to use when operating
611 as a station in a BSS network.
612 This overrides any automatic selection done by the system.
613 To disable a previously selected access point, supply
618 This option is useful when more than one access point uses the same SSID.
624 Enable packet bursting.
625 Packet bursting is a transmission technique whereby the wireless
626 medium is acquired once to send multiple frames and the interframe
628 This technique can significantly increase throughput by reducing
629 transmission overhead.
630 Packet bursting is supported by the 802.11e QoS specification
631 and some devices that do not support QoS may still be capable.
632 By default packet bursting is enabled if a device is capable
634 To disable packet bursting, use
636 .It Cm chanlist Ar channels
637 Set the desired channels to use when scanning for access
638 points, neighbors in an IBSS network, or looking for unoccupied
639 channels when operating as an access point.
640 The set of channels is specified as a comma-separated list with
641 each element in the list representing either a single channel number or a range
644 Channel numbers must be in the range 1 to 255 and be permissible
645 according to the operating characteristics of the device.
646 .It Cm channel Ar number
647 Set a single desired channel.
648 Channels range from 1 to 255, but the exact selection available
649 depends on the region your adaptor was manufactured for.
656 will give you the default for your adaptor.
658 adaptors ignore this setting unless you are in ad-hoc mode.
659 Alternatively the frequency, in megahertz, may be specified
660 instead of the channel number.
661 .It Cm deftxkey Ar index
662 Set the default key to use for transmission.
663 Typically this is only set when using WEP encryption.
666 is an alias for this request; it is provided for backwards compatibility.
667 .It Cm dtimperiod Ar period
670 period for transmitting buffered multicast data frames when
671 operating in ap mode.
674 specifies the number of beacon intervals between DTIM
675 and must be in the range 1 to 15.
676 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
677 .It Cm fragthreshold Ar length
678 Set the threshold for which transmitted frames are broken into fragments.
681 argument is the frame size in bytes and must be in the range 256 to 2346.
689 disables transmit fragmentation.
690 Not all adaptors honor the fragmentation threshold.
692 When operating as an access point, do not broadcast the SSID
693 in beacon frames or respond to probe request frames unless
694 they are directed to the ap (i.e., they include the ap's SSID).
695 By default, the SSID is included in beacon frames and
696 undirected probe request frames are answered.
697 To re-enable the broadcast of the SSID etc., use
700 Display the list of channels available for use taking into account
701 any restrictions set with the
704 See the description of
706 for more information.
708 Display the adaptor's capabilities, including the operating
711 Display the list of channels available for use.
712 Channels are shown with their IEEE channel number, equivalent
713 frequency, and usage modes.
714 Channels identified as
719 Channels identified as
721 may be used only for Atheros' Static Turbo mode
723 . Cm mediaopt turbo ) .
724 Channels marked with a
726 have a regulatory constraint that they be passively scanned.
727 This means a station is not permitted to transmit on the channel until
728 it identifies the channel is being used for 802.11 communication;
729 typically by hearing a beacon frame from an access point operating
732 is another way of requesting this information.
734 Display the current MAC Access Control List state.
735 Each address is prefixed with a character that indicates the
736 current policy applied to it:
738 indicates the address is allowed access,
740 indicates the address is denied access,
742 indicates the address is present but the current policy open
743 (so the ACL is not consulted).
745 Display the access points and/or ad-hoc neighbors
746 located in the vicinity.
749 flag may be used to display long SSIDs.
750 This information may be updated automatically by the adaptor
755 is another way of requesting this information.
757 When operating as an access point display the stations that are
758 currently associated.
759 When operating in ad-hoc mode display stations identified as
760 neighbors in the IBSS.
761 Capabilities advertised by the stations are described under
765 Depending on the capabilities of the stations the following
766 flags can be included in the output:
770 Indicates that the station is permitted to send/receive data frames.
772 Extended Rate Phy (ERP).
773 Indicates that the station is operating in an 802.11g network
774 using extended transmit rates.
777 Indicates that the station is operating in power save mode.
779 Quality of Service (QoS).
780 Indicates that the station is using QoS encapsulation for
782 QoS encapsulation is enabled only when WME mode is enabled.
785 Display the current parameters to use when operating in WME mode.
786 When WME mode is enabled for an adaptor this information will be
787 displayed with the regular status; this command is mostly useful
788 for examining parameters when WME mode is disabled.
789 See the description of the
791 directive for information on the various parameters.
792 .It Cm mcastrate Ar rate
793 Set the rate for transmitting multicast/broadcast frames.
794 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
795 This rate should be valid for the current operating conditions;
796 if an invalid rate is specified drivers are free to chose an
799 Enable powersave operation.
800 When operating as a client, the station will conserve power by
801 periodically turning off the radio and listening for
802 messages from the access point telling it there are packets waiting.
803 The station must then retrieve the packets.
804 When operating as an access point, the station must honor power
805 save operation of associated clients.
806 Not all devices support power save operation, either as a client
807 or as an access point.
810 to disable powersave operation.
811 .It Cm powersavesleep Ar sleep
812 Set the desired max powersave sleep time in milliseconds.
813 .It Cm protmode Ar technique
814 For interfaces operating in 802.11g, use the specified
816 for protecting OFDM frames in a mixed 11b/11g network.
817 The set of valid techniques is
823 Technique names are case insensitive.
825 When operating as an access point in 802.11g mode allow only
826 11g-capable stations to associate (11b-only stations are not
827 permitted to associate).
828 To allow both 11g and 11b-only stations to associate, use
830 .It Cm roaming Ar mode
831 When operating as a station, control how the system will
832 behave when communication with the current access point
836 argument may be one of
838 (leave it to the hardware device to decide),
840 (handle either in the device or the operating system\[em]as appropriate),
842 (do nothing until explicitly instructed).
843 By default, the device is left to handle this if it is
844 capable; otherwise, the operating system will automatically
845 attempt to reestablish communication.
846 Manual mode is mostly useful when an application wants to
847 control the selection of an access point.
848 .It Cm rtsthreshold Ar length
849 Set the threshold for which
850 transmitted frames are preceded by transmission of an
856 is the frame size in bytes and must be in the range 1 to 2346.
864 disables transmission of RTS frames.
865 Not all adaptors support setting the RTS threshold.
867 Set the desired Service Set Identifier (aka network name).
868 The SSID is a string up to 32 characters
869 in length and may be specified as either a normal string or in
870 hexadecimal when preceded by
872 Additionally, the SSID may be cleared by setting it to
875 Initiate a scan of neighboring stations, wait for it to complete, and
876 display all stations found.
877 Only the super-user can initiate a scan.
878 Depending on the capabilities of the APs, the following
879 flags can be included in the output:
883 Indicates that the station support channel hopping as described by the
884 IEEE 802.11b specification.
886 Packet Binary Convolution Code (PBCC).
887 A modulation alternative to the standard OFDM method.
893 Direct Sequence Spread Spectrum (DSSSOFDM).
894 Indicates the the station supports DSSS modulation.
896 Extended Service Set (ESS).
897 Indicates that the station is part of an infrastructure network
898 (in contrast to an IBSS/ad-hoc network).
901 Indicates that the station is part of an ad-hoc network
902 (in contrast to an ESS network).
905 Data confidentiality is required for all data frames
906 exchanged within the BSS.
907 This means that this BSS requires the station to
908 use cryptographic means such as WEP, TKIP or AES-CCMP to
909 encrypt/decrypt data frames being exchanged with others.
911 Robust Security Network (RSN).
912 Indicates that the station supports the IEEE 802.11i authentication
913 and key management protocol.
916 Indicates that the network is using short preambles (defined
917 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
918 56 bit sync field in contrast to a 128 bit field used in long
922 Indicates that the network is using a short slot time.
927 request can be used to show recent scan results without
928 initiating a new scan.
932 flag may be used to prevent the shortening of long SSIDs.
933 .It Cm stationname Ar name
934 Set the name of this station.
935 It appears that the station name is not really part of the IEEE 802.11
936 protocol though all interfaces seem to support it.
938 seems to be meaningful to identical or virtually identical equipment.
939 Setting the station name is identical in syntax to setting the SSID.
940 .It Cm txpower Ar power
941 Set the power used to transmit frames.
945 is a unitless value in the range 0 to 100 that is interpreted
946 by drivers to derive a device-specific value.
947 Out of range values are truncated.
948 Typically only a few discreet power settings are available and
949 the driver will use the setting closest to the specified value.
950 Not all adaptors support changing the transmit power.
951 .It Cm wepmode Ar mode
952 Set the desired WEP mode.
953 Not all adaptors support all modes.
954 The set of valid modes is
960 mode explicitly tells the adaptor to allow association with access
961 points which allow both encrypted and unencrypted traffic.
964 means that the access point must only allow encrypted connections.
967 is generally another name for
969 Modes are case insensitive.
970 .It Cm weptxkey Ar index
971 Set the WEP key to be used for transmission.
972 This is the same as setting the default transmission key with
974 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
975 Set the selected WEP key.
978 is not given, key 1 is set.
979 A WEP key will be either 5 or 13
980 characters (40 or 104 bits) depending of the local network and the
981 capabilities of the adaptor.
982 It may be specified either as a plain
983 string or as a string of hexadecimal digits preceded by
985 For maximum portability, hex keys are recommended;
986 the mapping of text keys to WEP encryption is usually driver-specific.
989 drivers do this mapping differently to
991 A key may be cleared by setting it to
993 If WEP is supported then there are at least four keys.
994 Some adaptors support more than four keys.
995 If that is the case, then the first four keys
996 (1-4) will be the standard temporary keys and any others will be adaptor
997 specific keys such as permanent keys stored in NVRAM.
999 Enable Wireless Multimedia Extensions (WME) support, if available,
1000 for the specified interface.
1001 WME is a subset of the IEEE 802.11e standard to support the
1002 efficient communication of realtime and multimedia data.
1003 To disable WME support, use
1006 The following parameters are meaningful only when WME support is in use.
1007 Parameters are specified per-AC (Access Category) and
1008 split into those that are used by a station when acting
1009 as an access point and those for client stations in the BSS.
1010 The latter are received from the access point and may not be changed
1012 The following Access Categories are recognized:
1014 .Bl -tag -width ".Cm AC_BK" -compact
1018 best effort delivery,
1033 AC parameters are case-insensitive.
1034 Traffic classification is done in the operating system using the
1035 vlan priority associated with data frames or the
1036 ToS (Type of Service) indication in IP-encapsulated frames.
1037 If neither information is present, traffic is assigned to the
1038 Best Effort (BE) category.
1039 .Bl -tag -width indent
1041 Set the ACK policy for QoS transmissions by the local station;
1042 this controls whether or not data frames transmitted by a station
1043 require an ACK response from the receiving station.
1044 To disable waiting for an ACK use
1046 This parameter is applied only to the local station.
1048 Enable the Admission Control Mandatory (ACM) mechanism
1049 for transmissions by the local station.
1050 To disable the ACM use
1052 On stations in a BSS this parameter is read-only and indicates
1053 the setting received from the access point.
1054 NB: ACM is not supported right now.
1055 .It Cm aifs Ar ac Ar count
1056 Set the Arbitration Inter Frame Spacing (AIFS)
1057 channel access parameter to use for transmissions
1058 by the local station.
1059 On stations in a BSS this parameter is read-only and indicates
1060 the setting received from the access point.
1061 .It Cm cwmin Ar ac Ar count
1062 Set the CWmin channel access parameter to use for transmissions
1063 by the local station.
1064 On stations in a BSS this parameter is read-only and indicates
1065 the setting received from the access point.
1066 .It Cm cwmax Ar ac Ar count
1067 Set the CWmax channel access parameter to use for transmissions
1068 by the local station.
1069 On stations in a BSS this parameter is read-only and indicates
1070 the setting received from the access point.
1071 .It Cm txoplimit Ar ac Ar limit
1072 Set the Transmission Opportunity Limit channel access parameter
1073 to use for transmissions by the local station.
1074 This parameter defines an interval of time when a WME station
1075 has the right to initiate transmissions onto the wireless medium.
1076 On stations in a BSS this parameter is read-only and indicates
1077 the setting received from the access point.
1078 .It Cm bss:aifs Ar ac Ar count
1079 Set the AIFS channel access parameter to send to stations in a BSS.
1080 This parameter is meaningful only when operating in ap mode.
1081 .It Cm bss:cwmin Ar ac Ar count
1082 Set the CWmin channel access parameter to send to stations in a BSS.
1083 This parameter is meaningful only when operating in ap mode.
1084 .It Cm bss:cwmax Ar ac Ar count
1085 Set the CWmax channel access parameter to send to stations in a BSS.
1086 This parameter is meaningful only when operating in ap mode.
1087 .It Cm bss:txoplimit Ar ac Ar limit
1088 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1089 This parameter is meaningful only when operating in ap mode.
1093 The following parameters support an optional access control list
1094 feature available with some adaptors when operating in ap mode; see
1096 This facility allows an access point to accept/deny association
1097 requests based on the MAC address of the station.
1098 Note that this feature does not significantly enhance security
1099 as MAC address spoofing is easy to do.
1100 .Bl -tag -width indent
1101 .It Cm mac:add Ar address
1102 Add the specified MAC address to the database.
1103 Depending on the policy setting association requests from the
1104 specified station will be allowed or denied.
1106 Set the ACL policy to permit association only by
1107 stations registered in the database.
1108 .It Cm mac:del Ar address
1109 Delete the specified MAC address from the database.
1111 Set the ACL policy to deny association only by
1112 stations registered in the database.
1113 .It Cm mac:kick Ar address
1114 Force the specified station to be deauthenticated.
1115 This typically is done to block a station after updating the
1118 Set the ACL policy to allow all stations to associate.
1120 Delete all entries in the database.
1123 The following parameters are for compatibility with other systems:
1124 .Bl -tag -width indent
1126 Another name for the
1132 .It Cm station Ar name
1133 Another name for the
1140 Another way of saying
1146 Another way of saying
1152 Another way of saying:
1153 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1159 .Ar n : k1 , k2 , k3 , k4
1162 Another way of saying
1163 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1168 Another way of saying
1175 The following parameters are specific to bridge interfaces:
1176 .Bl -tag -width indent
1177 .It Cm addm Ar interface
1178 Add the interface named by
1180 as a member of the bridge.
1181 The interface is put into promiscuous mode
1182 so that it can receive every packet sent on the network.
1183 .It Cm deletem Ar interface
1184 Remove the interface named by
1187 Promiscuous mode is disabled on the interface when
1188 it is removed from the bridge.
1189 .It Cm maxaddr Ar size
1190 Set the size of the bridge address cache to
1192 The default is 100 entries.
1193 .It Cm timeout Ar seconds
1194 Set the timeout of address cache entries to
1199 is zero, then address cache entries will not be expired.
1200 The default is 240 seconds.
1202 Display the addresses that have been learned by the bridge.
1203 .It Cm static Ar interface-name Ar address
1204 Add a static entry into the address cache pointing to
1205 .Ar interface-name .
1206 Static entries are never aged out of the cache or re-placed, even if the
1207 address is seen on a different interface.
1208 .It Cm deladdr Ar address
1211 from the address cache.
1213 Delete all dynamically-learned addresses from the address cache.
1215 Delete all addresses, including static addresses, from the address cache.
1216 .It Cm discover Ar interface
1217 Mark an interface as a
1220 When the bridge has no address cache entry
1221 (either dynamic or static)
1222 for the destination address of a packet,
1223 the bridge will forward the packet to all
1224 member interfaces marked as
1226 This is the default for all interfaces added to a bridge.
1227 .It Cm -discover Ar interface
1230 attribute on a member interface.
1231 For packets without the
1233 attribute, the only packets forwarded on the interface are broadcast
1234 or multicast packets and packets for which the destination address
1235 is known to be on the interface's segment.
1236 .It Cm learn Ar interface
1237 Mark an interface as a
1240 When a packet arrives on such an interface, the source
1241 address of the packet is entered into the address cache as being a
1242 destination address on the interface's segment.
1243 This is the default for all interfaces added to a bridge.
1244 .It Cm -learn Ar interface
1247 attribute on a member interface.
1248 .It Cm span Ar interface
1249 Add the interface named by
1251 as a span port on the bridge.
1252 Span ports transmit a copy of every frame received by the bridge.
1253 This is most useful for snooping a bridged network passively on
1254 another host connected to one of the span ports of the bridge.
1255 .It Cm -span Ar interface
1256 Delete the interface named by
1258 from the list of span ports of the bridge.
1259 .It Cm stp Ar interface
1260 Enable Spanning Tree protocol on
1264 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1265 Spanning Tree is used to detect and remove loops in a network topology.
1266 .It Cm -stp Ar interface
1267 Disable Spanning Tree protocol on
1269 This is the default for all interfaces added to a bridge.
1270 .It Cm maxage Ar seconds
1271 Set the time that a Spanning Tree protocol configuration is valid.
1272 The default is 20 seconds.
1273 The minimum is 1 second and the maximum is 255 seconds.
1274 .It Cm fwddelay Ar seconds
1275 Set the time that must pass before an interface begins forwarding
1276 packets when Spanning Tree is enabled.
1277 The default is 15 seconds.
1278 The minimum is 1 second and the maximum is 255 seconds.
1279 .It Cm hellotime Ar seconds
1280 Set the time between broadcasting of Spanning Tree protocol
1281 configuration messages.
1282 The default is 2 seconds.
1283 The minimum is 1 second and the maximum is 255 seconds.
1284 .It Cm priority Ar value
1285 Set the bridge priority for Spanning Tree.
1286 The default is 32768.
1287 The minimum is 0 and the maximum is 65536.
1288 .It Cm ifpriority Ar interface Ar value
1289 Set the Spanning Tree priority of
1294 The minimum is 0 and the maximum is 255.
1295 .It Cm ifpathcost Ar interface Ar value
1296 Set the Spanning Tree path cost of
1301 The minimum is 0 and the maximum is 65535.
1304 The following parameters are specific to IP tunnel interfaces,
1306 .Bl -tag -width indent
1307 .It Cm tunnel Ar src_addr dest_addr
1308 Configure the physical source and destination address for IP tunnel
1314 are interpreted as the outer source/destination for the encapsulating
1317 Unconfigure the physical source and destination address for IP tunnel
1318 interfaces previously configured with
1321 Another name for the
1326 The following parameters are specific to
1329 .Bl -tag -width indent
1331 Set the maximum number of updates for a single state which
1332 can be collapsed into one.
1333 This is an 8-bit number; the default value is 128.
1336 The following parameters are specific to
1339 .Bl -tag -width indent
1340 .It Cm vlan Ar vlan_tag
1341 Set the VLAN tag value to
1343 This value is a 16-bit number which is used to create an 802.1Q
1344 VLAN header for packets sent from the
1351 must both be set at the same time.
1352 .It Cm vlandev Ar iface
1353 Associate the physical interface
1358 Packets transmitted through the
1361 diverted to the specified physical interface
1363 with 802.1Q VLAN encapsulation.
1364 Packets with 802.1Q encapsulation received
1365 by the parent interface with the correct VLAN tag will be diverted to
1371 interface is assigned a
1372 copy of the parent interface's flags and the parent's ethernet address.
1377 must both be set at the same time.
1380 interface already has
1381 a physical interface associated with it, this command will fail.
1383 change the association to another physical interface, the existing
1384 association must be cleared first.
1386 Note: if the hardware tagging capability
1387 is set on the parent interface, the
1390 interface's behavior changes:
1393 interface recognizes that the
1394 parent interface supports insertion and extraction of VLAN tags on its
1395 own (usually in firmware) and that it should pass packets to and from
1396 the parent unaltered.
1397 .It Fl vlandev Op Ar iface
1400 pseudo device, disassociate the parent interface from it.
1401 This breaks the link between the
1403 interface and its parent,
1404 clears its VLAN tag, flags and its link address and shuts the interface down.
1407 argument is useless and hence deprecated.
1410 The following parameters are specific to
1413 .Bl -tag -width indent
1414 .It Cm advbase Ar seconds
1415 Specifies the base of the advertisement interval in seconds.
1416 The acceptable values are 1 to 255.
1417 The default value is 1.
1418 .\" The default value is
1419 .\" .Dv CARP_DFLTINTV .
1420 .It Cm advskew Ar interval
1421 Specifies the skew to add to the base advertisement interval to
1422 make one host advertise slower than another host.
1423 It is specified in 1/256 of seconds.
1424 The acceptable values are 1 to 254.
1425 The default value is 0.
1426 .It Cm pass Ar phrase
1427 Set the authentication key to
1430 Set the virtual host ID.
1431 This is a required setting.
1432 Acceptable values are 1 to 255.
1437 utility displays the current configuration for a network interface
1438 when no optional parameters are supplied.
1439 If a protocol family is specified,
1441 will report only the details specific to that protocol family.
1445 flag is passed before an interface name,
1447 will display the capability list and all
1448 of the supported media for the specified interface.
1451 flag is supplied, address lifetime is displayed for IPv6 addresses,
1452 as time offset string.
1456 flag may be used instead of an interface name.
1459 to display information about all interfaces in the system.
1462 flag limits this to interfaces that are down, and
1464 limits this to interfaces that are up.
1465 When no arguments are given,
1471 flag may be used to list all available interfaces on the system, with
1472 no other additional information.
1473 Use of this flag is mutually exclusive
1474 with all other flags and commands, except for
1476 (only list interfaces that are down)
1479 (only list interfaces that are up).
1483 flag may be used to get more verbose status for an interface.
1487 flag may be used to list all of the interface cloners available on
1488 the system, with no additional information.
1489 Use of this flag is mutually exclusive with all other flags and commands.
1493 flag causes keying information for the interface, if available, to be
1495 For example, the values of 802.11 WEP keys will be printed, if accessible to
1497 This information is not printed by default, as it may be considered
1500 Only the super-user may modify the configuration of a network interface.
1502 The media selection system is relatively new and only some drivers support
1503 it (or have need for it).
1505 Messages indicating the specified interface does not exist, the
1506 requested address is unknown, or the user is not privileged and
1507 tried to alter an interface's configuration.
1525 Basic IPv6 node operation requires a link-local address on each
1526 interface configured for IPv6.
1527 Normally, such an address is automatically configured by the
1528 kernel on each interface added to the system; this behaviour may
1529 be disabled by setting the sysctl MIB variable
1530 .Va net.inet6.ip6.auto_linklocal
1533 If you delete such an address using
1535 the kernel may act very odd.
1536 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob