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
80 utility is used to assign an address
81 to a network interface and/or configure
82 network interface parameters.
85 utility must be used at boot time to define the network address
86 of each interface present on a machine; it may also be used at
87 a later time to redefine an interface's address
88 or other operating parameters.
90 The following options are available:
91 .Bl -tag -width indent
94 .Tn DARPA Ns -Internet
96 the address is either a host name present in the host name data
101 Internet address expressed in the Internet standard
104 It is also possible to use the CIDR notation (also known as the
105 slash notation) to include the netmask.
106 That is, one can specify an address like
111 family, it is also possible to specify the prefix length using the slash
116 parameter below for more information.
117 .\" For the Xerox Network Systems(tm) family,
119 .\" .Ar net:a.b.c.d.e.f ,
122 .\" is the assigned network number (in decimal),
123 .\" and each of the six bytes of the host number,
127 .\" are specified in hexadecimal.
128 .\" The host number may be omitted on IEEE 802 protocol
129 .\" (Ethernet, FDDI, and Token Ring) interfaces,
130 .\" which use the hardware physical address,
131 .\" and on interfaces other than the first.
134 .\" family, addresses are specified as a long hexadecimal string,
135 .\" as in the Xerox family.
136 .\" However, two consecutive dots imply a zero
137 .\" byte, and the dots are optional, if the user wishes to (carefully)
138 .\" count out long strings of digits in network byte order.
143 is specified as a series of colon-separated hex digits.
145 e.g.\& set a new MAC address on an ethernet interface, though the
146 mechanism used is not ethernet-specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying ethernet hardware is properly reprogrammed.
151 .It Ar address_family
154 which affects interpretation of the remaining parameters.
155 Since an interface can receive transmissions in differing protocols
156 with different naming schemes, specifying the address family is recommended.
157 The address or protocol families currently
176 Specify the address of the correspondent on the other end
177 of a point to point link.
180 parameter is a string of the form
185 List the interfaces in the given group.
188 The following parameters may be set with
190 .Bl -tag -width indent
195 Introduced for compatibility
199 Establish an additional network address for this interface.
200 This is sometimes useful when changing network numbers, and
201 one wishes to accept packets addressed to the old interface.
202 If the address is on the same subnet as the first network address
203 for this interface, a non-conflicting netmask must be given.
208 Remove the network address specified.
209 This would be used if you incorrectly specified an alias, or it
210 was no longer needed.
211 If you have incorrectly set an NS address having the side effect
212 of specifying the host portion, removing all NS addresses will
213 allow you to respecify the host portion.
216 Specify that the address configured is an anycast address.
217 Based on the current specification,
218 only routers may configure anycast addresses.
219 Anycast address will not be used as source address of any of outgoing
222 Enable the use of the Address Resolution Protocol
225 between network level addresses and link level addresses (default).
226 This is currently implemented for mapping between
231 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
233 Disable the use of the Address Resolution Protocol
236 If the Address Resolution Protocol is enabled,
237 the host will only reply to requests for its addresses,
238 and will never send any requests.
240 If the Address Resolution Protocol is enabled,
241 the host will perform normally,
242 sending out requests and listening for replies.
245 Specify the address to use to represent broadcasts to the
247 The default broadcast address is the address with a host part of all 1's.
249 Enable driver dependent debugging code; usually, this turns on
250 extra console error logging.
252 Disable driver dependent debugging code.
254 Put interface into permanently promiscuous mode.
256 Disable permanently promiscuous mode.
264 When an interface is marked
266 the system will not attempt to
267 transmit messages through that interface.
268 If possible, the interface will be reset to disable reception as well.
269 This action does not automatically disable routes using the interface.
270 .It Cm group Ar group-name
271 Assign the interface to a
273 Any interface can be in multiple groups.
275 Cloned interfaces are members of their interface family group by default.
276 For example, a PPP interface such as
278 is a member of the PPP interface family group,
280 .\" The interface(s) the default route(s) point to are members of the
283 .It Cm -group Ar group-name
284 Remove the interface from the given
289 (lowermost 64bit of an IPv6 address)
292 This is used to specify an Internet host who is willing to receive
293 IP packets encapsulating IPX packets bound for a remote network.
294 An apparent point to point link is constructed, and
295 the address specified will be taken as the IPX address and network
297 .It Cm maclabel Ar label
298 If Mandatory Access Control support is enabled in the kernel,
302 .\" .Xr maclabel 7 ) .
304 If the driver supports the media selection system, set the media type
307 Some interfaces support the mutually exclusive use of one of several
308 different physical media connectors.
309 For example, a 10Mbit/s Ethernet
310 interface might support the use of either
312 or twisted pair connectors.
313 Setting the media type to
315 would change the currently active connector to the AUI port.
318 would activate twisted pair.
319 Refer to the interfaces' driver
320 specific documentation or man page for a complete list of the
322 .It Cm mediaopt Ar opts
323 If the driver supports the media selection system, set the specified
324 media options on the interface.
328 is a comma delimited list of options to apply to the interface.
329 Refer to the interfaces' driver specific man page for a complete
330 list of available options.
331 .It Fl mediaopt Ar opts
332 If the driver supports the media selection system, disable the
333 specified media options on the interface.
335 If the driver supports the media selection system, set the specified
336 operating mode on the interface to
338 For IEEE 802.11 wireless interfaces that support multiple operating modes
339 this directive is used to select between 802.11a
346 .It Cm inst Ar minst , Cm instance Ar minst
347 Set the media instance to
349 This is useful for devices which have multiple physical layer interfaces
352 Set the interface name to
354 .It Cm rxcsum , txcsum
355 If the driver supports user-configurable checksum offloading,
356 enable receive (or transmit) checksum offloading on the interface.
357 Some drivers may not be able to enable these flags independently
358 of each other, so setting one may also set the other.
359 The driver will offload as much checksum work as it can reliably
360 support, the exact level of offloading varies between drivers.
361 .It Fl rxcsum , txcsum
362 If the driver supports user-configurable checksum offloading,
363 disable receive (or transmit) checksum offloading on the interface.
364 These settings may not always be independent of each other.
366 If the driver supports
368 segmentation offloading, enable TSO on the interface.
369 Some drivers may not be able to support TSO for
373 packets, so they may enable only one of them.
375 If the driver supports
377 segmentation offloading, disable TSO on the interface.
378 It will always disable TSO for
383 If the driver supports
385 large receive offloading, enable LRO on the interface.
387 If the driver supports
389 large receive offloading, disable LRO on the interface.
390 .It Cm vlanmtu , vlanhwtag
391 If the driver offers user-configurable VLAN support, enable
392 reception of extended frames or tag processing in hardware,
394 Note that this must be issued on a physical interface associated with
399 .It Fl vlanmtu , vlanhwtag
400 If the driver offers user-configurable VLAN support, disable
401 reception of extended frames or tag processing in hardware,
406 feature and disable interrupts on the interface, if driver supports
411 feature and enable interrupt mode on the interface.
413 Create the specified network pseudo-device.
414 If the interface is given without a unit number, try to create a new
415 device with an arbitrary unit number.
416 If creation of an arbitrary device is successful, the new device name is
417 printed to standard output unless the interface is renamed or destroyed
422 Destroy the specified network pseudo-device.
438 Set the routing metric of the interface to
441 The routing metric is used by the routing protocol
443 Higher metrics have the effect of making a route
444 less favorable; metrics are counted as additional hops
445 to the destination network or host.
447 Set the maximum transmission unit of the interface to
449 default is interface specific.
450 The MTU is used to limit the size of packets that are transmitted on an
452 Not all interfaces support setting the MTU, and some interfaces have
454 .It Cm netmask Ar mask
457 Specify how much of the address to reserve for subdividing
458 networks into sub-networks.
459 The mask includes the network part of the local address
460 and the subnet part, which is taken from the host field of the address.
461 The mask can be specified as a single hexadecimal number
464 with a dot-notation Internet address,
465 or with a pseudo-network name listed in the network table
467 The mask contains 1's for the bit positions in the 32-bit address
468 which are to be used for the network and subnet parts,
469 and 0's for the host part.
470 The mask should contain at least the standard network portion,
471 and the subnet field should be contiguous with the network
474 The netmask can also be specified in CIDR notation after the address.
477 option above for more information.
478 .It Cm prefixlen Ar len
482 bits are reserved for subdividing networks into sub-networks.
485 must be integer, and for syntactical reason it must be between 0 to 128.
486 It is almost always 64 under the current IPv6 assignment rule.
487 If the parameter is omitted, 64 is used.
489 The prefix can also be specified using the slash notation after the address.
492 option above for more information.
495 .\" .It Cm nsellength Ar n
498 .\" This specifies a trailing number of bytes for a received
500 .\" used for local identification, the remaining leading part of which is
503 .\" (Network Entity Title).
504 .\" The default value is 1, which is conformant to US
506 .\" When an ISO address is set in an ifconfig command,
509 .\" which is being specified.
512 .\" 20 hex digits should be
515 .\" to be assigned to the interface.
516 .\" There is some evidence that a number different from 1 may be useful
519 .\" 37 type addresses.
520 .It Cm range Ar netrange
521 Under appletalk, set the interface to respond to a
524 .Ar startnet Ns - Ns Ar endnet .
525 Appletalk uses this scheme instead of
528 implements it internally as a set of netmasks.
533 Introduced for compatibility
537 The argument following this specifies the version (phase) of the
538 Appletalk network attached to the interface.
539 Values of 1 or 2 are permitted.
541 .It Cm link Op Cm 0 No - Cm 2
543 Enable special processing of the link level of the interface.
544 These three options are interface specific in actual effect, however,
545 they are in general used to select special modes of operation.
547 of this is to enable SLIP compression, or to select the connector type
548 for some Ethernet cards.
549 Refer to the man page for the specific driver
550 for more information.
552 .It Fl link Op Cm 0 No - Cm 2
554 Disable special processing at the link level with the specified interface.
556 Put the interface in monitor mode.
557 No packets are transmitted, and received packets are discarded after
561 Take the interface out of monitor mode.
565 This may be used to enable an interface after an
567 It happens automatically when setting the first address on an interface.
568 If the interface was reset when previously marked down,
569 the hardware will be re-initialized.
572 The following parameters are specific to IEEE 802.11 wireless interfaces:
573 .Bl -tag -width indent
575 When operating as an access point, pass packets between
576 wireless clients directly (default).
577 To instead let them pass up through the
578 system and be forwarded using some other mechanism, use
580 Disabling the internal bridging
581 is useful when traffic is to be processed with
583 .It Cm authmode Ar mode
584 Set the desired authentication mode in infrastructure mode.
585 Not all adaptors support all modes.
588 .Cm none , open , shared
594 (IEEE WPA/WPA2/802.11i).
599 modes are only useful when using an authentication service
600 (a supplicant for client operation or an authenticator when
601 operating as an access point).
602 Modes are case insensitive.
603 .It Cm bintval Ar interval
604 Set the interval at which beacon frames are sent when operating in
608 parameter is specified in TU's (1024 usecs).
609 By default beacon frames are transmitted every 100 TU's.
610 .It Cm bmissthreshold Ar count
611 Set the number of consecutive missed beacons at which the station
612 will attempt to roam (i.e., search for a new access point).
615 parameter must be in the range 1 to 255; though the
616 upper bound may be reduced according to device capabilities.
617 The default threshold is 7 consecutive missed beacons; but
618 this may be overridden by the device driver.
623 .It Cm bssid Ar address
624 Specify the MAC address of the access point to use when operating
625 as a station in a BSS network.
626 This overrides any automatic selection done by the system.
627 To disable a previously selected access point, supply
632 This option is useful when more than one access point uses the same SSID.
638 Enable packet bursting.
639 Packet bursting is a transmission technique whereby the wireless
640 medium is acquired once to send multiple frames and the interframe
642 This technique can significantly increase throughput by reducing
643 transmission overhead.
644 Packet bursting is supported by the 802.11e QoS specification
645 and some devices that do not support QoS may still be capable.
646 By default packet bursting is enabled if a device is capable
648 To disable packet bursting, use
650 .It Cm chanlist Ar channels
651 Set the desired channels to use when scanning for access
652 points, neighbors in an IBSS network, or looking for unoccupied
653 channels when operating as an access point.
654 The set of channels is specified as a comma-separated list with
655 each element in the list representing either a single channel number or a range
658 Channel numbers must be in the range 1 to 255 and be permissible
659 according to the operating characteristics of the device.
660 .It Cm channel Ar number
661 Set a single desired channel.
662 Channels range from 1 to 255, but the exact selection available
663 depends on the region your adaptor was manufactured for.
670 will give you the default for your adaptor.
672 adaptors ignore this setting unless you are in ad-hoc mode.
673 Alternatively the frequency, in megahertz, may be specified
674 instead of the channel number.
676 When there are several ways to use a channel the channel
677 number/frequency may be appended with attributes to clarify.
678 For example, if a device is capable of operating on channel 6
679 with 802.11n and 802.11g then one can specify that g-only use
680 should be used by specifying ``6:g''.
681 Similarly the channel width can be specified by appending it
682 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
683 These attributes can be combined as in: ``6:ht/40''.
684 The full set of flags specified following a `:'' are:
690 (Atheros Dynamic Turbo mode),
698 (Atheros Static Turbo mode),
701 (Atheros Dynamic Turbo mode, or appendeded to ``st'' and ``dt'').
702 The full set of channel widths following a '/' are:
704 (5MHz aka quarter-rate channel),
706 (10MHz aka half-rate channel),
708 (20MHz mostly for use in specifying ht20),
711 (40MHz mostly for use in specifying ht40),
713 a 40MHz HT channel specification may include the location
714 of the extension channel by appending ``+'' or ``-'' for above and below,
715 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
716 with the center channel at frequency 2437 and the extension channel above.
717 .It Cm deftxkey Ar index
718 Set the default key to use for transmission.
719 Typically this is only set when using WEP encryption.
722 is an alias for this request; it is provided for backwards compatibility.
723 .It Cm dtimperiod Ar period
726 period for transmitting buffered multicast data frames when
727 operating in ap mode.
730 specifies the number of beacon intervals between DTIM
731 and must be in the range 1 to 15.
732 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
733 .It Cm fragthreshold Ar length
734 Set the threshold for which transmitted frames are broken into fragments.
737 argument is the frame size in bytes and must be in the range 256 to 2346.
745 disables transmit fragmentation.
746 Not all adaptors honor the fragmentation threshold.
748 When operating as an access point, do not broadcast the SSID
749 in beacon frames or respond to probe request frames unless
750 they are directed to the ap (i.e., they include the ap's SSID).
751 By default, the SSID is included in beacon frames and
752 undirected probe request frames are answered.
753 To re-enable the broadcast of the SSID etc., use
756 Display the list of channels available for use taking into account
757 any restrictions set with the
760 See the description of
762 for more information.
764 Display the adaptor's capabilities, including the operating
767 Display the list of channels available for use.
768 Channels are shown with their IEEE channel number, equivalent
769 frequency, and usage modes.
770 Channels identified as
775 Channels identified as
777 may be used only for Atheros' Static Turbo mode
779 . Cm mediaopt turbo ) .
780 Channels marked with a
782 have a regulatory constraint that they be passively scanned.
783 This means a station is not permitted to transmit on the channel until
784 it identifies the channel is being used for 802.11 communication;
785 typically by hearing a beacon frame from an access point operating
788 is another way of requesting this information.
790 Display the current MAC Access Control List state.
791 Each address is prefixed with a character that indicates the
792 current policy applied to it:
794 indicates the address is allowed access,
796 indicates the address is denied access,
798 indicates the address is present but the current policy open
799 (so the ACL is not consulted).
801 Display the access points and/or ad-hoc neighbors
802 located in the vicinity.
805 flag may be used to display long SSIDs.
806 This information may be updated automatically by the adaptor
811 is another way of requesting this information.
813 When operating as an access point display the stations that are
814 currently associated.
815 When operating in ad-hoc mode display stations identified as
816 neighbors in the IBSS.
817 Capabilities advertised by the stations are described under
821 Depending on the capabilities of the stations the following
822 flags can be included in the output:
826 Indicates that the station is permitted to send/receive data frames.
828 Extended Rate Phy (ERP).
829 Indicates that the station is operating in an 802.11g network
830 using extended transmit rates.
833 Indicates that the station is operating in power save mode.
835 Quality of Service (QoS).
836 Indicates that the station is using QoS encapsulation for
838 QoS encapsulation is enabled only when WME mode is enabled.
841 Display the current parameters to use when operating in WME mode.
842 When WME mode is enabled for an adaptor this information will be
843 displayed with the regular status; this command is mostly useful
844 for examining parameters when WME mode is disabled.
845 See the description of the
847 directive for information on the various parameters.
848 .It Cm mcastrate Ar rate
849 Set the rate for transmitting multicast/broadcast frames.
850 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
851 This rate should be valid for the current operating conditions;
852 if an invalid rate is specified drivers are free to chose an
855 Enable powersave operation.
856 When operating as a client, the station will conserve power by
857 periodically turning off the radio and listening for
858 messages from the access point telling it there are packets waiting.
859 The station must then retrieve the packets.
860 When operating as an access point, the station must honor power
861 save operation of associated clients.
862 Not all devices support power save operation, either as a client
863 or as an access point.
866 to disable powersave operation.
867 .It Cm powersavesleep Ar sleep
868 Set the desired max powersave sleep time in TU's (1024 usecs).
869 By default the max powersave sleep time is 100 TU's.
870 .It Cm protmode Ar technique
871 For interfaces operating in 802.11g, use the specified
873 for protecting OFDM frames in a mixed 11b/11g network.
874 The set of valid techniques is
880 Technique names are case insensitive.
882 When operating as an access point in 802.11g mode allow only
883 11g-capable stations to associate (11b-only stations are not
884 permitted to associate).
885 To allow both 11g and 11b-only stations to associate, use
887 .It Cm roaming Ar mode
888 When operating as a station, control how the system will
889 behave when communication with the current access point
893 argument may be one of
895 (leave it to the hardware device to decide),
897 (handle either in the device or the operating system\[em]as appropriate),
899 (do nothing until explicitly instructed).
900 By default, the device is left to handle this if it is
901 capable; otherwise, the operating system will automatically
902 attempt to reestablish communication.
903 Manual mode is mostly useful when an application wants to
904 control the selection of an access point.
905 .It Cm rtsthreshold Ar length
906 Set the threshold for which
907 transmitted frames are preceded by transmission of an
913 is the frame size in bytes and must be in the range 1 to 2346.
921 disables transmission of RTS frames.
922 Not all adaptors support setting the RTS threshold.
924 Set the desired Service Set Identifier (aka network name).
925 The SSID is a string up to 32 characters
926 in length and may be specified as either a normal string or in
927 hexadecimal when preceded by
929 Additionally, the SSID may be cleared by setting it to
932 Initiate a scan of neighboring stations, wait for it to complete, and
933 display all stations found.
934 Only the super-user can initiate a scan.
935 Depending on the capabilities of the APs, the following
936 flags can be included in the output:
940 Indicates that the station support channel hopping as described by the
941 IEEE 802.11b specification.
943 Packet Binary Convolution Code (PBCC).
944 A modulation alternative to the standard OFDM method.
950 Direct Sequence Spread Spectrum (DSSSOFDM).
951 Indicates the the station supports DSSS modulation.
953 Extended Service Set (ESS).
954 Indicates that the station is part of an infrastructure network
955 (in contrast to an IBSS/ad-hoc network).
958 Indicates that the station is part of an ad-hoc network
959 (in contrast to an ESS network).
962 Data confidentiality is required for all data frames
963 exchanged within the BSS.
964 This means that this BSS requires the station to
965 use cryptographic means such as WEP, TKIP or AES-CCMP to
966 encrypt/decrypt data frames being exchanged with others.
968 Robust Security Network (RSN).
969 Indicates that the station supports the IEEE 802.11i authentication
970 and key management protocol.
973 Indicates that the network is using short preambles (defined
974 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
975 56 bit sync field in contrast to a 128 bit field used in long
979 Indicates that the network is using a short slot time.
984 request can be used to show recent scan results without
985 initiating a new scan.
989 flag may be used to prevent the shortening of long SSIDs.
990 .It Cm stationname Ar name
991 Set the name of this station.
992 It appears that the station name is not really part of the IEEE 802.11
993 protocol though all interfaces seem to support it.
995 seems to be meaningful to identical or virtually identical equipment.
996 Setting the station name is identical in syntax to setting the SSID.
997 .It Cm txpower Ar power
998 Set the power used to transmit frames.
1002 is a unitless value in the range 0 to 100 that is interpreted
1003 by drivers to derive a device-specific value.
1004 Out of range values are truncated.
1005 Typically only a few discreet power settings are available and
1006 the driver will use the setting closest to the specified value.
1007 Not all adaptors support changing the transmit power.
1008 .It Cm wepmode Ar mode
1009 Set the desired WEP mode.
1010 Not all adaptors support all modes.
1011 The set of valid modes is
1017 mode explicitly tells the adaptor to allow association with access
1018 points which allow both encrypted and unencrypted traffic.
1021 means that the access point must only allow encrypted connections.
1024 is generally another name for
1026 Modes are case insensitive.
1027 .It Cm weptxkey Ar index
1028 Set the WEP key to be used for transmission.
1029 This is the same as setting the default transmission key with
1031 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1032 Set the selected WEP key.
1035 is not given, key 1 is set.
1036 A WEP key will be either 5 or 13
1037 characters (40 or 104 bits) depending of the local network and the
1038 capabilities of the adaptor.
1039 It may be specified either as a plain
1040 string or as a string of hexadecimal digits preceded by
1042 For maximum portability, hex keys are recommended;
1043 the mapping of text keys to WEP encryption is usually driver-specific.
1046 drivers do this mapping differently to
1048 A key may be cleared by setting it to
1050 If WEP is supported then there are at least four keys.
1051 Some adaptors support more than four keys.
1052 If that is the case, then the first four keys
1053 (1-4) will be the standard temporary keys and any others will be adaptor
1054 specific keys such as permanent keys stored in NVRAM.
1056 Enable Wireless Multimedia Extensions (WME) support, if available,
1057 for the specified interface.
1058 WME is a subset of the IEEE 802.11e standard to support the
1059 efficient communication of realtime and multimedia data.
1060 To disable WME support, use
1063 The following parameters are meaningful only when WME support is in use.
1064 Parameters are specified per-AC (Access Category) and
1065 split into those that are used by a station when acting
1066 as an access point and those for client stations in the BSS.
1067 The latter are received from the access point and may not be changed
1069 The following Access Categories are recognized:
1071 .Bl -tag -width ".Cm AC_BK" -compact
1075 best effort delivery,
1090 AC parameters are case-insensitive.
1091 Traffic classification is done in the operating system using the
1092 vlan priority associated with data frames or the
1093 ToS (Type of Service) indication in IP-encapsulated frames.
1094 If neither information is present, traffic is assigned to the
1095 Best Effort (BE) category.
1096 .Bl -tag -width indent
1098 Set the ACK policy for QoS transmissions by the local station;
1099 this controls whether or not data frames transmitted by a station
1100 require an ACK response from the receiving station.
1101 To disable waiting for an ACK use
1103 This parameter is applied only to the local station.
1105 Enable the Admission Control Mandatory (ACM) mechanism
1106 for transmissions by the local station.
1107 To disable the ACM use
1109 On stations in a BSS this parameter is read-only and indicates
1110 the setting received from the access point.
1111 NB: ACM is not supported right now.
1112 .It Cm aifs Ar ac Ar count
1113 Set the Arbitration Inter Frame Spacing (AIFS)
1114 channel access parameter to use for transmissions
1115 by the local station.
1116 On stations in a BSS this parameter is read-only and indicates
1117 the setting received from the access point.
1118 .It Cm cwmin Ar ac Ar count
1119 Set the CWmin channel access parameter to use for transmissions
1120 by the local station.
1121 On stations in a BSS this parameter is read-only and indicates
1122 the setting received from the access point.
1123 .It Cm cwmax Ar ac Ar count
1124 Set the CWmax channel access parameter to use for transmissions
1125 by the local station.
1126 On stations in a BSS this parameter is read-only and indicates
1127 the setting received from the access point.
1128 .It Cm txoplimit Ar ac Ar limit
1129 Set the Transmission Opportunity Limit channel access parameter
1130 to use for transmissions by the local station.
1131 This parameter defines an interval of time when a WME station
1132 has the right to initiate transmissions onto the wireless medium.
1133 On stations in a BSS this parameter is read-only and indicates
1134 the setting received from the access point.
1135 .It Cm bss:aifs Ar ac Ar count
1136 Set the AIFS channel access parameter to send to stations in a BSS.
1137 This parameter is meaningful only when operating in ap mode.
1138 .It Cm bss:cwmin Ar ac Ar count
1139 Set the CWmin channel access parameter to send to stations in a BSS.
1140 This parameter is meaningful only when operating in ap mode.
1141 .It Cm bss:cwmax Ar ac Ar count
1142 Set the CWmax channel access parameter to send to stations in a BSS.
1143 This parameter is meaningful only when operating in ap mode.
1144 .It Cm bss:txoplimit Ar ac Ar limit
1145 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1146 This parameter is meaningful only when operating in ap mode.
1150 The following parameters support an optional access control list
1151 feature available with some adaptors when operating in ap mode; see
1153 This facility allows an access point to accept/deny association
1154 requests based on the MAC address of the station.
1155 Note that this feature does not significantly enhance security
1156 as MAC address spoofing is easy to do.
1157 .Bl -tag -width indent
1158 .It Cm mac:add Ar address
1159 Add the specified MAC address to the database.
1160 Depending on the policy setting association requests from the
1161 specified station will be allowed or denied.
1163 Set the ACL policy to permit association only by
1164 stations registered in the database.
1165 .It Cm mac:del Ar address
1166 Delete the specified MAC address from the database.
1168 Set the ACL policy to deny association only by
1169 stations registered in the database.
1170 .It Cm mac:kick Ar address
1171 Force the specified station to be deauthenticated.
1172 This typically is done to block a station after updating the
1175 Set the ACL policy to allow all stations to associate.
1177 Delete all entries in the database.
1180 The following parameters are for compatibility with other systems:
1181 .Bl -tag -width indent
1183 Another name for the
1189 .It Cm station Ar name
1190 Another name for the
1197 Another way of saying
1203 Another way of saying
1209 Another way of saying:
1210 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1216 .Ar n : k1 , k2 , k3 , k4
1219 Another way of saying
1220 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1225 Another way of saying
1232 The following parameters are specific to bridge interfaces:
1233 .Bl -tag -width indent
1234 .It Cm addm Ar interface
1235 Add the interface named by
1237 as a member of the bridge.
1238 The interface is put into promiscuous mode
1239 so that it can receive every packet sent on the network.
1240 .It Cm deletem Ar interface
1241 Remove the interface named by
1244 Promiscuous mode is disabled on the interface when
1245 it is removed from the bridge.
1246 .It Cm maxaddr Ar size
1247 Set the size of the bridge address cache to
1249 The default is 100 entries.
1250 .It Cm timeout Ar seconds
1251 Set the timeout of address cache entries to
1256 is zero, then address cache entries will not be expired.
1257 The default is 240 seconds.
1259 Display the addresses that have been learned by the bridge.
1260 .It Cm static Ar interface-name Ar address
1261 Add a static entry into the address cache pointing to
1262 .Ar interface-name .
1263 Static entries are never aged out of the cache or re-placed, even if the
1264 address is seen on a different interface.
1265 .It Cm deladdr Ar address
1268 from the address cache.
1270 Delete all dynamically-learned addresses from the address cache.
1272 Delete all addresses, including static addresses, from the address cache.
1273 .It Cm discover Ar interface
1274 Mark an interface as a
1277 When the bridge has no address cache entry
1278 (either dynamic or static)
1279 for the destination address of a packet,
1280 the bridge will forward the packet to all
1281 member interfaces marked as
1283 This is the default for all interfaces added to a bridge.
1284 .It Cm -discover Ar interface
1287 attribute on a member interface.
1288 For packets without the
1290 attribute, the only packets forwarded on the interface are broadcast
1291 or multicast packets and packets for which the destination address
1292 is known to be on the interface's segment.
1293 .It Cm learn Ar interface
1294 Mark an interface as a
1297 When a packet arrives on such an interface, the source
1298 address of the packet is entered into the address cache as being a
1299 destination address on the interface's segment.
1300 This is the default for all interfaces added to a bridge.
1301 .It Cm -learn Ar interface
1304 attribute on a member interface.
1305 .It Cm sticky Ar interface
1306 Mark an interface as a
1309 Dynamically learned address entries are treated at static once entered into
1311 Sticky entries are never aged out of the cache or replaced, even if the
1312 address is seen on a different interface.
1313 .It Cm -sticky Ar interface
1316 attribute on a member interface.
1317 .It Cm span Ar interface
1318 Add the interface named by
1320 as a span port on the bridge.
1321 Span ports transmit a copy of every frame received by the bridge.
1322 This is most useful for snooping a bridged network passively on
1323 another host connected to one of the span ports of the bridge.
1324 .It Cm -span Ar interface
1325 Delete the interface named by
1327 from the list of span ports of the bridge.
1328 .It Cm stp Ar interface
1329 Enable Spanning Tree protocol on
1333 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1334 Spanning Tree is used to detect and remove loops in a network topology.
1335 .It Cm -stp Ar interface
1336 Disable Spanning Tree protocol on
1338 This is the default for all interfaces added to a bridge.
1339 .It Cm edge Ar interface
1343 An edge port connects directly to end stations cannot create bridging
1344 loops in the network, this allows it to transition straight to forwarding.
1345 .It Cm -edge Ar interface
1346 Disable edge status on
1348 .It Cm autoedge Ar interface
1351 to automatically detect edge status.
1352 This is the default for all interfaces added to a bridge.
1353 .It Cm -autoedge Ar interface
1354 Disable automatic edge status on
1356 .It Cm ptp Ar interface
1359 as a point to point link.
1360 This is required for straight transitions to forwarding and
1361 should be enabled on a direct link to another RSTP capable switch.
1362 .It Cm -ptp Ar interface
1363 Disable point to point link status on
1365 This should be disabled for a half duplex link and for an interface
1366 connected to a shared network segment,
1367 like a hub or a wireless network.
1368 .It Cm autoptp Ar interface
1369 Automatically detect the point to point status on
1371 by checking the full duplex link status.
1372 This is the default for interfaces added to the bridge.
1373 .It Cm -autoptp Ar interface
1374 Disable automatic point to point link detection on
1376 .It Cm maxage Ar seconds
1377 Set the time that a Spanning Tree protocol configuration is valid.
1378 The default is 20 seconds.
1379 The minimum is 6 seconds and the maximum is 40 seconds.
1380 .It Cm fwddelay Ar seconds
1381 Set the time that must pass before an interface begins forwarding
1382 packets when Spanning Tree is enabled.
1383 The default is 15 seconds.
1384 The minimum is 4 seconds and the maximum is 30 seconds.
1385 .It Cm hellotime Ar seconds
1386 Set the time between broadcasting of Spanning Tree protocol
1387 configuration messages.
1388 The hello time may only be changed when operating in legacy stp mode.
1389 The default is 2 seconds.
1390 The minimum is 1 second and the maximum is 2 seconds.
1391 .It Cm priority Ar value
1392 Set the bridge priority for Spanning Tree.
1393 The default is 32768.
1394 The minimum is 0 and the maximum is 61440.
1395 .It Cm proto Ar value
1396 Set the Spanning Tree protocol.
1397 The default is rstp.
1398 The available options are stp and rstp.
1399 .It Cm holdcnt Ar value
1400 Set the transmit hold count for Spanning Tree.
1401 This is the number of packets transmitted before being rate limited.
1403 The minimum is 1 and the maximum is 10.
1404 .It Cm ifpriority Ar interface Ar value
1405 Set the Spanning Tree priority of
1410 The minimum is 0 and the maximum is 240.
1411 .It Cm ifpathcost Ar interface Ar value
1412 Set the Spanning Tree path cost of
1416 The default is calculated from the link speed.
1417 To change a previously selected path cost back to automatic, set the
1419 The minimum is 1 and the maximum is 200000000.
1422 The following parameters are specific to lagg interfaces:
1423 .Bl -tag -width indent
1424 .It Cm laggport Ar interface
1425 Add the interface named by
1427 as a port of the aggregation interface.
1428 .It Cm -laggport Ar interface
1429 Remove the interface named by
1431 from the aggregation interface.
1432 .It Cm laggproto Ar proto
1433 Set the aggregation protocol.
1434 The default is failover.
1435 The available options are failover, fec, lacp, loadbalance, roundrobin and
1439 The following parameters are specific to IP tunnel interfaces,
1441 .Bl -tag -width indent
1442 .It Cm tunnel Ar src_addr dest_addr
1443 Configure the physical source and destination address for IP tunnel
1449 are interpreted as the outer source/destination for the encapsulating
1452 Unconfigure the physical source and destination address for IP tunnel
1453 interfaces previously configured with
1456 Another name for the
1461 The following parameters are specific to
1464 .Bl -tag -width indent
1466 Set the maximum number of updates for a single state which
1467 can be collapsed into one.
1468 This is an 8-bit number; the default value is 128.
1471 The following parameters are specific to
1474 .Bl -tag -width indent
1475 .It Cm vlan Ar vlan_tag
1476 Set the VLAN tag value to
1478 This value is a 16-bit number which is used to create an 802.1Q
1479 VLAN header for packets sent from the
1486 must both be set at the same time.
1487 .It Cm vlandev Ar iface
1488 Associate the physical interface
1493 Packets transmitted through the
1496 diverted to the specified physical interface
1498 with 802.1Q VLAN encapsulation.
1499 Packets with 802.1Q encapsulation received
1500 by the parent interface with the correct VLAN tag will be diverted to
1506 interface is assigned a
1507 copy of the parent interface's flags and the parent's ethernet address.
1512 must both be set at the same time.
1515 interface already has
1516 a physical interface associated with it, this command will fail.
1518 change the association to another physical interface, the existing
1519 association must be cleared first.
1521 Note: if the hardware tagging capability
1522 is set on the parent interface, the
1525 interface's behavior changes:
1528 interface recognizes that the
1529 parent interface supports insertion and extraction of VLAN tags on its
1530 own (usually in firmware) and that it should pass packets to and from
1531 the parent unaltered.
1532 .It Fl vlandev Op Ar iface
1535 pseudo device, disassociate the parent interface from it.
1536 This breaks the link between the
1538 interface and its parent,
1539 clears its VLAN tag, flags and its link address and shuts the interface down.
1542 argument is useless and hence deprecated.
1545 The following parameters are specific to
1548 .Bl -tag -width indent
1549 .It Cm advbase Ar seconds
1550 Specifies the base of the advertisement interval in seconds.
1551 The acceptable values are 1 to 255.
1552 The default value is 1.
1553 .\" The default value is
1554 .\" .Dv CARP_DFLTINTV .
1555 .It Cm advskew Ar interval
1556 Specifies the skew to add to the base advertisement interval to
1557 make one host advertise slower than another host.
1558 It is specified in 1/256 of seconds.
1559 The acceptable values are 1 to 254.
1560 The default value is 0.
1561 .It Cm pass Ar phrase
1562 Set the authentication key to
1565 Set the virtual host ID.
1566 This is a required setting.
1567 Acceptable values are 1 to 255.
1572 utility displays the current configuration for a network interface
1573 when no optional parameters are supplied.
1574 If a protocol family is specified,
1576 will report only the details specific to that protocol family.
1580 flag is passed before an interface name,
1582 will display the capability list and all
1583 of the supported media for the specified interface.
1586 flag is supplied, address lifetime is displayed for IPv6 addresses,
1587 as time offset string.
1591 flag may be used instead of an interface name.
1594 to display information about all interfaces in the system.
1597 flag limits this to interfaces that are down, and
1599 limits this to interfaces that are up.
1600 When no arguments are given,
1606 flag may be used to list all available interfaces on the system, with
1607 no other additional information.
1608 Use of this flag is mutually exclusive
1609 with all other flags and commands, except for
1611 (only list interfaces that are down)
1614 (only list interfaces that are up).
1618 flag may be used to get more verbose status for an interface.
1622 flag may be used to list all of the interface cloners available on
1623 the system, with no additional information.
1624 Use of this flag is mutually exclusive with all other flags and commands.
1628 flag causes keying information for the interface, if available, to be
1630 For example, the values of 802.11 WEP keys will be printed, if accessible to
1632 This information is not printed by default, as it may be considered
1635 If the network interface driver is not present in the kernel then
1637 will attempt to load it.
1640 flag disables this behavior.
1642 Only the super-user may modify the configuration of a network interface.
1644 The media selection system is relatively new and only some drivers support
1645 it (or have need for it).
1647 Assign the IPv4 address
1649 with a network mask of
1653 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
1655 Add the IPv4 address
1657 with the CIDR network prefix
1663 as a synonym for the canonical form of the option
1665 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
1667 Remove the IPv4 address
1671 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
1673 Add the IPv6 address
1674 .Li 2001:DB8:DBDB::123/48
1677 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
1678 Note that lower case hexadecimal IPv6 addresses are acceptable.
1680 Remove the IPv6 address added in the above example,
1683 character as shorthand for the network prefix,
1686 as a synonym for the canonical form of the option
1688 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
1690 Configure the interface
1692 to use 100baseTX, full duplex Ethernet media options:
1693 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
1695 Create the software network interface
1697 .Dl # ifconfig gif1 create
1699 Destroy the software network interface
1701 .Dl # ifconfig gif1 destroy
1703 Messages indicating the specified interface does not exist, the
1704 requested address is unknown, or the user is not privileged and
1705 tried to alter an interface's configuration.
1723 Basic IPv6 node operation requires a link-local address on each
1724 interface configured for IPv6.
1725 Normally, such an address is automatically configured by the
1726 kernel on each interface added to the system; this behaviour may
1727 be disabled by setting the sysctl MIB variable
1728 .Va net.inet6.ip6.auto_linklocal
1731 If you delete such an address using
1733 the kernel may act very odd.
1734 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob