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
382 .It Cm vlanmtu , vlanhwtag
383 If the driver offers user-configurable VLAN support, enable
384 reception of extended frames or tag processing in hardware,
386 Note that this must be issued on a physical interface associated with
391 .It Fl vlanmtu , vlanhwtag
392 If the driver offers user-configurable VLAN support, disable
393 reception of extended frames or tag processing in hardware,
398 feature and disable interrupts on the interface, if driver supports
403 feature and enable interrupt mode on the interface.
405 Create the specified network pseudo-device.
406 If the interface is given without a unit number, try to create a new
407 device with an arbitrary unit number.
408 If creation of an arbitrary device is successful, the new device name is
409 printed to standard output unless the interface is renamed or destroyed
414 Destroy the specified network pseudo-device.
430 Set the routing metric of the interface to
433 The routing metric is used by the routing protocol
435 Higher metrics have the effect of making a route
436 less favorable; metrics are counted as additional hops
437 to the destination network or host.
439 Set the maximum transmission unit of the interface to
441 default is interface specific.
442 The MTU is used to limit the size of packets that are transmitted on an
444 Not all interfaces support setting the MTU, and some interfaces have
446 .It Cm netmask Ar mask
449 Specify how much of the address to reserve for subdividing
450 networks into sub-networks.
451 The mask includes the network part of the local address
452 and the subnet part, which is taken from the host field of the address.
453 The mask can be specified as a single hexadecimal number
456 with a dot-notation Internet address,
457 or with a pseudo-network name listed in the network table
459 The mask contains 1's for the bit positions in the 32-bit address
460 which are to be used for the network and subnet parts,
461 and 0's for the host part.
462 The mask should contain at least the standard network portion,
463 and the subnet field should be contiguous with the network
466 The netmask can also be specified in CIDR notation after the address.
469 option above for more information.
470 .It Cm prefixlen Ar len
474 bits are reserved for subdividing networks into sub-networks.
477 must be integer, and for syntactical reason it must be between 0 to 128.
478 It is almost always 64 under the current IPv6 assignment rule.
479 If the parameter is omitted, 64 is used.
481 The prefix can also be specified using the slash notation after the address.
484 option above for more information.
487 .\" .It Cm nsellength Ar n
490 .\" This specifies a trailing number of bytes for a received
492 .\" used for local identification, the remaining leading part of which is
495 .\" (Network Entity Title).
496 .\" The default value is 1, which is conformant to US
498 .\" When an ISO address is set in an ifconfig command,
501 .\" which is being specified.
504 .\" 20 hex digits should be
507 .\" to be assigned to the interface.
508 .\" There is some evidence that a number different from 1 may be useful
511 .\" 37 type addresses.
512 .It Cm range Ar netrange
513 Under appletalk, set the interface to respond to a
516 .Ar startnet Ns - Ns Ar endnet .
517 Appletalk uses this scheme instead of
520 implements it internally as a set of netmasks.
525 Introduced for compatibility
529 The argument following this specifies the version (phase) of the
530 Appletalk network attached to the interface.
531 Values of 1 or 2 are permitted.
533 .It Cm link Op Cm 0 No - Cm 2
535 Enable special processing of the link level of the interface.
536 These three options are interface specific in actual effect, however,
537 they are in general used to select special modes of operation.
539 of this is to enable SLIP compression, or to select the connector type
540 for some Ethernet cards.
541 Refer to the man page for the specific driver
542 for more information.
544 .It Fl link Op Cm 0 No - Cm 2
546 Disable special processing at the link level with the specified interface.
548 Put the interface in monitor mode.
549 No packets are transmitted, and received packets are discarded after
553 Take the interface out of monitor mode.
557 This may be used to enable an interface after an
559 It happens automatically when setting the first address on an interface.
560 If the interface was reset when previously marked down,
561 the hardware will be re-initialized.
564 The following parameters are specific to IEEE 802.11 wireless interfaces:
565 .Bl -tag -width indent
567 When operating as an access point, pass packets between
568 wireless clients directly (default).
569 To instead let them pass up through the
570 system and be forwarded using some other mechanism, use
572 Disabling the internal bridging
573 is useful when traffic is to be processed with
575 .It Cm authmode Ar mode
576 Set the desired authentication mode in infrastructure mode.
577 Not all adaptors support all modes.
580 .Cm none , open , shared
586 (IEEE WPA/WPA2/802.11i).
591 modes are only useful when using an authentication service
592 (a supplicant for client operation or an authenticator when
593 operating as an access point).
594 Modes are case insensitive.
595 .It Cm bintval Ar interval
596 Set the interval at which beacon frames are sent when operating in
600 parameter is specified in TU's (1024 usecs).
601 By default beacon frames are transmitted every 100 TU's.
602 .It Cm bmissthreshold Ar count
603 Set the number of consecutive missed beacons at which the station
604 will attempt to roam (i.e., search for a new access point).
607 parameter must be in the range 1 to 255; though the
608 upper bound may be reduced according to device capabilities.
609 The default threshold is 7 consecutive missed beacons; but
610 this may be overridden by the device driver.
615 .It Cm bssid Ar address
616 Specify the MAC address of the access point to use when operating
617 as a station in a BSS network.
618 This overrides any automatic selection done by the system.
619 To disable a previously selected access point, supply
624 This option is useful when more than one access point uses the same SSID.
630 Enable packet bursting.
631 Packet bursting is a transmission technique whereby the wireless
632 medium is acquired once to send multiple frames and the interframe
634 This technique can significantly increase throughput by reducing
635 transmission overhead.
636 Packet bursting is supported by the 802.11e QoS specification
637 and some devices that do not support QoS may still be capable.
638 By default packet bursting is enabled if a device is capable
640 To disable packet bursting, use
642 .It Cm chanlist Ar channels
643 Set the desired channels to use when scanning for access
644 points, neighbors in an IBSS network, or looking for unoccupied
645 channels when operating as an access point.
646 The set of channels is specified as a comma-separated list with
647 each element in the list representing either a single channel number or a range
650 Channel numbers must be in the range 1 to 255 and be permissible
651 according to the operating characteristics of the device.
652 .It Cm channel Ar number
653 Set a single desired channel.
654 Channels range from 1 to 255, but the exact selection available
655 depends on the region your adaptor was manufactured for.
662 will give you the default for your adaptor.
664 adaptors ignore this setting unless you are in ad-hoc mode.
665 Alternatively the frequency, in megahertz, may be specified
666 instead of the channel number.
668 When there are several ways to use a channel the channel
669 number/frequency may be appended with attributes to clarify.
670 For example, if a device is capable of operating on channel 6
671 with 802.11n and 802.11g then one can specify that g-only use
672 should be used by specifying ``6:g''.
673 Similarly the channel width can be specified by appending it
674 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
675 These attributes can be combined as in: ``6:ht/40''.
676 The full set of flags specified following a `:'' are:
682 (Atheros Dynamic Turbo mode),
690 (Atheros Static Turbo mode),
693 (Atheros Dynamic Turbo mode, or appendeded to ``st'' and ``dt'').
694 The full set of channel widths following a '/' are:
696 (5MHz aka quarter-rate channel),
698 (10MHz aka half-rate channel),
700 (20MHz mostly for use in specifying ht20),
703 (40MHz mostly for use in specifying ht40),
705 a 40MHz HT channel specification may include the location
706 of the extension channel by appending ``+'' or ``-'' for above and below,
707 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
708 with the center channel at frequency 2437 and the extension channel above.
709 .It Cm deftxkey Ar index
710 Set the default key to use for transmission.
711 Typically this is only set when using WEP encryption.
714 is an alias for this request; it is provided for backwards compatibility.
715 .It Cm dtimperiod Ar period
718 period for transmitting buffered multicast data frames when
719 operating in ap mode.
722 specifies the number of beacon intervals between DTIM
723 and must be in the range 1 to 15.
724 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
725 .It Cm fragthreshold Ar length
726 Set the threshold for which transmitted frames are broken into fragments.
729 argument is the frame size in bytes and must be in the range 256 to 2346.
737 disables transmit fragmentation.
738 Not all adaptors honor the fragmentation threshold.
740 When operating as an access point, do not broadcast the SSID
741 in beacon frames or respond to probe request frames unless
742 they are directed to the ap (i.e., they include the ap's SSID).
743 By default, the SSID is included in beacon frames and
744 undirected probe request frames are answered.
745 To re-enable the broadcast of the SSID etc., use
748 Display the list of channels available for use taking into account
749 any restrictions set with the
752 See the description of
754 for more information.
756 Display the adaptor's capabilities, including the operating
759 Display the list of channels available for use.
760 Channels are shown with their IEEE channel number, equivalent
761 frequency, and usage modes.
762 Channels identified as
767 Channels identified as
769 may be used only for Atheros' Static Turbo mode
771 . Cm mediaopt turbo ) .
772 Channels marked with a
774 have a regulatory constraint that they be passively scanned.
775 This means a station is not permitted to transmit on the channel until
776 it identifies the channel is being used for 802.11 communication;
777 typically by hearing a beacon frame from an access point operating
780 is another way of requesting this information.
782 Display the current MAC Access Control List state.
783 Each address is prefixed with a character that indicates the
784 current policy applied to it:
786 indicates the address is allowed access,
788 indicates the address is denied access,
790 indicates the address is present but the current policy open
791 (so the ACL is not consulted).
793 Display the access points and/or ad-hoc neighbors
794 located in the vicinity.
797 flag may be used to display long SSIDs.
798 This information may be updated automatically by the adaptor
803 is another way of requesting this information.
805 When operating as an access point display the stations that are
806 currently associated.
807 When operating in ad-hoc mode display stations identified as
808 neighbors in the IBSS.
809 Capabilities advertised by the stations are described under
813 Depending on the capabilities of the stations the following
814 flags can be included in the output:
818 Indicates that the station is permitted to send/receive data frames.
820 Extended Rate Phy (ERP).
821 Indicates that the station is operating in an 802.11g network
822 using extended transmit rates.
825 Indicates that the station is operating in power save mode.
827 Quality of Service (QoS).
828 Indicates that the station is using QoS encapsulation for
830 QoS encapsulation is enabled only when WME mode is enabled.
833 Display the current parameters to use when operating in WME mode.
834 When WME mode is enabled for an adaptor this information will be
835 displayed with the regular status; this command is mostly useful
836 for examining parameters when WME mode is disabled.
837 See the description of the
839 directive for information on the various parameters.
840 .It Cm mcastrate Ar rate
841 Set the rate for transmitting multicast/broadcast frames.
842 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
843 This rate should be valid for the current operating conditions;
844 if an invalid rate is specified drivers are free to chose an
847 Enable powersave operation.
848 When operating as a client, the station will conserve power by
849 periodically turning off the radio and listening for
850 messages from the access point telling it there are packets waiting.
851 The station must then retrieve the packets.
852 When operating as an access point, the station must honor power
853 save operation of associated clients.
854 Not all devices support power save operation, either as a client
855 or as an access point.
858 to disable powersave operation.
859 .It Cm powersavesleep Ar sleep
860 Set the desired max powersave sleep time in TU's (1024 usecs).
861 By default the max powersave sleep time is 100 TU's.
862 .It Cm protmode Ar technique
863 For interfaces operating in 802.11g, use the specified
865 for protecting OFDM frames in a mixed 11b/11g network.
866 The set of valid techniques is
872 Technique names are case insensitive.
874 When operating as an access point in 802.11g mode allow only
875 11g-capable stations to associate (11b-only stations are not
876 permitted to associate).
877 To allow both 11g and 11b-only stations to associate, use
879 .It Cm roaming Ar mode
880 When operating as a station, control how the system will
881 behave when communication with the current access point
885 argument may be one of
887 (leave it to the hardware device to decide),
889 (handle either in the device or the operating system\[em]as appropriate),
891 (do nothing until explicitly instructed).
892 By default, the device is left to handle this if it is
893 capable; otherwise, the operating system will automatically
894 attempt to reestablish communication.
895 Manual mode is mostly useful when an application wants to
896 control the selection of an access point.
897 .It Cm rtsthreshold Ar length
898 Set the threshold for which
899 transmitted frames are preceded by transmission of an
905 is the frame size in bytes and must be in the range 1 to 2346.
913 disables transmission of RTS frames.
914 Not all adaptors support setting the RTS threshold.
916 Set the desired Service Set Identifier (aka network name).
917 The SSID is a string up to 32 characters
918 in length and may be specified as either a normal string or in
919 hexadecimal when preceded by
921 Additionally, the SSID may be cleared by setting it to
924 Initiate a scan of neighboring stations, wait for it to complete, and
925 display all stations found.
926 Only the super-user can initiate a scan.
927 Depending on the capabilities of the APs, the following
928 flags can be included in the output:
932 Indicates that the station support channel hopping as described by the
933 IEEE 802.11b specification.
935 Packet Binary Convolution Code (PBCC).
936 A modulation alternative to the standard OFDM method.
942 Direct Sequence Spread Spectrum (DSSSOFDM).
943 Indicates the the station supports DSSS modulation.
945 Extended Service Set (ESS).
946 Indicates that the station is part of an infrastructure network
947 (in contrast to an IBSS/ad-hoc network).
950 Indicates that the station is part of an ad-hoc network
951 (in contrast to an ESS network).
954 Data confidentiality is required for all data frames
955 exchanged within the BSS.
956 This means that this BSS requires the station to
957 use cryptographic means such as WEP, TKIP or AES-CCMP to
958 encrypt/decrypt data frames being exchanged with others.
960 Robust Security Network (RSN).
961 Indicates that the station supports the IEEE 802.11i authentication
962 and key management protocol.
965 Indicates that the network is using short preambles (defined
966 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
967 56 bit sync field in contrast to a 128 bit field used in long
971 Indicates that the network is using a short slot time.
976 request can be used to show recent scan results without
977 initiating a new scan.
981 flag may be used to prevent the shortening of long SSIDs.
982 .It Cm stationname Ar name
983 Set the name of this station.
984 It appears that the station name is not really part of the IEEE 802.11
985 protocol though all interfaces seem to support it.
987 seems to be meaningful to identical or virtually identical equipment.
988 Setting the station name is identical in syntax to setting the SSID.
989 .It Cm txpower Ar power
990 Set the power used to transmit frames.
994 is a unitless value in the range 0 to 100 that is interpreted
995 by drivers to derive a device-specific value.
996 Out of range values are truncated.
997 Typically only a few discreet power settings are available and
998 the driver will use the setting closest to the specified value.
999 Not all adaptors support changing the transmit power.
1000 .It Cm wepmode Ar mode
1001 Set the desired WEP mode.
1002 Not all adaptors support all modes.
1003 The set of valid modes is
1009 mode explicitly tells the adaptor to allow association with access
1010 points which allow both encrypted and unencrypted traffic.
1013 means that the access point must only allow encrypted connections.
1016 is generally another name for
1018 Modes are case insensitive.
1019 .It Cm weptxkey Ar index
1020 Set the WEP key to be used for transmission.
1021 This is the same as setting the default transmission key with
1023 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1024 Set the selected WEP key.
1027 is not given, key 1 is set.
1028 A WEP key will be either 5 or 13
1029 characters (40 or 104 bits) depending of the local network and the
1030 capabilities of the adaptor.
1031 It may be specified either as a plain
1032 string or as a string of hexadecimal digits preceded by
1034 For maximum portability, hex keys are recommended;
1035 the mapping of text keys to WEP encryption is usually driver-specific.
1038 drivers do this mapping differently to
1040 A key may be cleared by setting it to
1042 If WEP is supported then there are at least four keys.
1043 Some adaptors support more than four keys.
1044 If that is the case, then the first four keys
1045 (1-4) will be the standard temporary keys and any others will be adaptor
1046 specific keys such as permanent keys stored in NVRAM.
1048 Enable Wireless Multimedia Extensions (WME) support, if available,
1049 for the specified interface.
1050 WME is a subset of the IEEE 802.11e standard to support the
1051 efficient communication of realtime and multimedia data.
1052 To disable WME support, use
1055 The following parameters are meaningful only when WME support is in use.
1056 Parameters are specified per-AC (Access Category) and
1057 split into those that are used by a station when acting
1058 as an access point and those for client stations in the BSS.
1059 The latter are received from the access point and may not be changed
1061 The following Access Categories are recognized:
1063 .Bl -tag -width ".Cm AC_BK" -compact
1067 best effort delivery,
1082 AC parameters are case-insensitive.
1083 Traffic classification is done in the operating system using the
1084 vlan priority associated with data frames or the
1085 ToS (Type of Service) indication in IP-encapsulated frames.
1086 If neither information is present, traffic is assigned to the
1087 Best Effort (BE) category.
1088 .Bl -tag -width indent
1090 Set the ACK policy for QoS transmissions by the local station;
1091 this controls whether or not data frames transmitted by a station
1092 require an ACK response from the receiving station.
1093 To disable waiting for an ACK use
1095 This parameter is applied only to the local station.
1097 Enable the Admission Control Mandatory (ACM) mechanism
1098 for transmissions by the local station.
1099 To disable the ACM use
1101 On stations in a BSS this parameter is read-only and indicates
1102 the setting received from the access point.
1103 NB: ACM is not supported right now.
1104 .It Cm aifs Ar ac Ar count
1105 Set the Arbitration Inter Frame Spacing (AIFS)
1106 channel access parameter to use for transmissions
1107 by the local station.
1108 On stations in a BSS this parameter is read-only and indicates
1109 the setting received from the access point.
1110 .It Cm cwmin Ar ac Ar count
1111 Set the CWmin channel access parameter to use for transmissions
1112 by the local station.
1113 On stations in a BSS this parameter is read-only and indicates
1114 the setting received from the access point.
1115 .It Cm cwmax Ar ac Ar count
1116 Set the CWmax channel access parameter to use for transmissions
1117 by the local station.
1118 On stations in a BSS this parameter is read-only and indicates
1119 the setting received from the access point.
1120 .It Cm txoplimit Ar ac Ar limit
1121 Set the Transmission Opportunity Limit channel access parameter
1122 to use for transmissions by the local station.
1123 This parameter defines an interval of time when a WME station
1124 has the right to initiate transmissions onto the wireless medium.
1125 On stations in a BSS this parameter is read-only and indicates
1126 the setting received from the access point.
1127 .It Cm bss:aifs Ar ac Ar count
1128 Set the AIFS channel access parameter to send to stations in a BSS.
1129 This parameter is meaningful only when operating in ap mode.
1130 .It Cm bss:cwmin Ar ac Ar count
1131 Set the CWmin channel access parameter to send to stations in a BSS.
1132 This parameter is meaningful only when operating in ap mode.
1133 .It Cm bss:cwmax Ar ac Ar count
1134 Set the CWmax channel access parameter to send to stations in a BSS.
1135 This parameter is meaningful only when operating in ap mode.
1136 .It Cm bss:txoplimit Ar ac Ar limit
1137 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1138 This parameter is meaningful only when operating in ap mode.
1142 The following parameters support an optional access control list
1143 feature available with some adaptors when operating in ap mode; see
1145 This facility allows an access point to accept/deny association
1146 requests based on the MAC address of the station.
1147 Note that this feature does not significantly enhance security
1148 as MAC address spoofing is easy to do.
1149 .Bl -tag -width indent
1150 .It Cm mac:add Ar address
1151 Add the specified MAC address to the database.
1152 Depending on the policy setting association requests from the
1153 specified station will be allowed or denied.
1155 Set the ACL policy to permit association only by
1156 stations registered in the database.
1157 .It Cm mac:del Ar address
1158 Delete the specified MAC address from the database.
1160 Set the ACL policy to deny association only by
1161 stations registered in the database.
1162 .It Cm mac:kick Ar address
1163 Force the specified station to be deauthenticated.
1164 This typically is done to block a station after updating the
1167 Set the ACL policy to allow all stations to associate.
1169 Delete all entries in the database.
1172 The following parameters are for compatibility with other systems:
1173 .Bl -tag -width indent
1175 Another name for the
1181 .It Cm station Ar name
1182 Another name for the
1189 Another way of saying
1195 Another way of saying
1201 Another way of saying:
1202 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1208 .Ar n : k1 , k2 , k3 , k4
1211 Another way of saying
1212 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1217 Another way of saying
1224 The following parameters are specific to bridge interfaces:
1225 .Bl -tag -width indent
1226 .It Cm addm Ar interface
1227 Add the interface named by
1229 as a member of the bridge.
1230 The interface is put into promiscuous mode
1231 so that it can receive every packet sent on the network.
1232 .It Cm deletem Ar interface
1233 Remove the interface named by
1236 Promiscuous mode is disabled on the interface when
1237 it is removed from the bridge.
1238 .It Cm maxaddr Ar size
1239 Set the size of the bridge address cache to
1241 The default is 100 entries.
1242 .It Cm timeout Ar seconds
1243 Set the timeout of address cache entries to
1248 is zero, then address cache entries will not be expired.
1249 The default is 240 seconds.
1251 Display the addresses that have been learned by the bridge.
1252 .It Cm static Ar interface-name Ar address
1253 Add a static entry into the address cache pointing to
1254 .Ar interface-name .
1255 Static entries are never aged out of the cache or re-placed, even if the
1256 address is seen on a different interface.
1257 .It Cm deladdr Ar address
1260 from the address cache.
1262 Delete all dynamically-learned addresses from the address cache.
1264 Delete all addresses, including static addresses, from the address cache.
1265 .It Cm discover Ar interface
1266 Mark an interface as a
1269 When the bridge has no address cache entry
1270 (either dynamic or static)
1271 for the destination address of a packet,
1272 the bridge will forward the packet to all
1273 member interfaces marked as
1275 This is the default for all interfaces added to a bridge.
1276 .It Cm -discover Ar interface
1279 attribute on a member interface.
1280 For packets without the
1282 attribute, the only packets forwarded on the interface are broadcast
1283 or multicast packets and packets for which the destination address
1284 is known to be on the interface's segment.
1285 .It Cm learn Ar interface
1286 Mark an interface as a
1289 When a packet arrives on such an interface, the source
1290 address of the packet is entered into the address cache as being a
1291 destination address on the interface's segment.
1292 This is the default for all interfaces added to a bridge.
1293 .It Cm -learn Ar interface
1296 attribute on a member interface.
1297 .It Cm sticky Ar interface
1298 Mark an interface as a
1301 Dynamically learned address entries are treated at static once entered into
1303 Sticky entries are never aged out of the cache or replaced, even if the
1304 address is seen on a different interface.
1305 .It Cm -sticky Ar interface
1308 attribute on a member interface.
1309 .It Cm span Ar interface
1310 Add the interface named by
1312 as a span port on the bridge.
1313 Span ports transmit a copy of every frame received by the bridge.
1314 This is most useful for snooping a bridged network passively on
1315 another host connected to one of the span ports of the bridge.
1316 .It Cm -span Ar interface
1317 Delete the interface named by
1319 from the list of span ports of the bridge.
1320 .It Cm stp Ar interface
1321 Enable Spanning Tree protocol on
1325 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1326 Spanning Tree is used to detect and remove loops in a network topology.
1327 .It Cm -stp Ar interface
1328 Disable Spanning Tree protocol on
1330 This is the default for all interfaces added to a bridge.
1331 .It Cm edge Ar interface
1335 An edge port connects directly to end stations cannot create bridging
1336 loops in the network, this allows it to transition straight to forwarding.
1337 .It Cm -edge Ar interface
1338 Disable edge status on
1340 .It Cm autoedge Ar interface
1343 to automatically detect edge status.
1344 This is the default for all interfaces added to a bridge.
1345 .It Cm -autoedge Ar interface
1346 Disable automatic edge status on
1348 .It Cm ptp Ar interface
1351 as a point to point link.
1352 This is required for straight transitions to forwarding and
1353 should be enabled on a direct link to another RSTP capable switch.
1354 .It Cm -ptp Ar interface
1355 Disable point to point link status on
1357 This should be disabled for a half duplex link and for an interface
1358 connected to a shared network segment,
1359 like a hub or a wireless network.
1360 .It Cm autoptp Ar interface
1361 Automatically detect the point to point status on
1363 by checking the full duplex link status.
1364 This is the default for interfaces added to the bridge.
1365 .It Cm -autoptp Ar interface
1366 Disable automatic point to point link detection on
1368 .It Cm maxage Ar seconds
1369 Set the time that a Spanning Tree protocol configuration is valid.
1370 The default is 20 seconds.
1371 The minimum is 6 seconds and the maximum is 40 seconds.
1372 .It Cm fwddelay Ar seconds
1373 Set the time that must pass before an interface begins forwarding
1374 packets when Spanning Tree is enabled.
1375 The default is 15 seconds.
1376 The minimum is 4 seconds and the maximum is 30 seconds.
1377 .It Cm hellotime Ar seconds
1378 Set the time between broadcasting of Spanning Tree protocol
1379 configuration messages.
1380 The hello time may only be changed when operating in legacy stp mode.
1381 The default is 2 seconds.
1382 The minimum is 1 second and the maximum is 2 seconds.
1383 .It Cm priority Ar value
1384 Set the bridge priority for Spanning Tree.
1385 The default is 32768.
1386 The minimum is 0 and the maximum is 61440.
1387 .It Cm proto Ar value
1388 Set the Spanning Tree protocol.
1389 The default is rstp.
1390 The available options are stp and rstp.
1391 .It Cm holdcnt Ar value
1392 Set the transmit hold count for Spanning Tree.
1393 This is the number of packets transmitted before being rate limited.
1395 The minimum is 1 and the maximum is 10.
1396 .It Cm ifpriority Ar interface Ar value
1397 Set the Spanning Tree priority of
1402 The minimum is 0 and the maximum is 240.
1403 .It Cm ifpathcost Ar interface Ar value
1404 Set the Spanning Tree path cost of
1408 The default is calculated from the link speed.
1409 To change a previously selected path cost back to automatic, set the
1411 The minimum is 1 and the maximum is 200000000.
1414 The following parameters are specific to lagg interfaces:
1415 .Bl -tag -width indent
1416 .It Cm laggport Ar interface
1417 Add the interface named by
1419 as a port of the aggregation interface.
1420 .It Cm -laggport Ar interface
1421 Remove the interface named by
1423 from the aggregation interface.
1424 .It Cm laggproto Ar proto
1425 Set the aggregation protocol.
1426 The default is failover.
1427 The available options are failover, fec, lacp, loadbalance, roundrobin and
1431 The following parameters are specific to IP tunnel interfaces,
1433 .Bl -tag -width indent
1434 .It Cm tunnel Ar src_addr dest_addr
1435 Configure the physical source and destination address for IP tunnel
1441 are interpreted as the outer source/destination for the encapsulating
1444 Unconfigure the physical source and destination address for IP tunnel
1445 interfaces previously configured with
1448 Another name for the
1453 The following parameters are specific to
1456 .Bl -tag -width indent
1458 Set the maximum number of updates for a single state which
1459 can be collapsed into one.
1460 This is an 8-bit number; the default value is 128.
1463 The following parameters are specific to
1466 .Bl -tag -width indent
1467 .It Cm vlan Ar vlan_tag
1468 Set the VLAN tag value to
1470 This value is a 16-bit number which is used to create an 802.1Q
1471 VLAN header for packets sent from the
1478 must both be set at the same time.
1479 .It Cm vlandev Ar iface
1480 Associate the physical interface
1485 Packets transmitted through the
1488 diverted to the specified physical interface
1490 with 802.1Q VLAN encapsulation.
1491 Packets with 802.1Q encapsulation received
1492 by the parent interface with the correct VLAN tag will be diverted to
1498 interface is assigned a
1499 copy of the parent interface's flags and the parent's ethernet address.
1504 must both be set at the same time.
1507 interface already has
1508 a physical interface associated with it, this command will fail.
1510 change the association to another physical interface, the existing
1511 association must be cleared first.
1513 Note: if the hardware tagging capability
1514 is set on the parent interface, the
1517 interface's behavior changes:
1520 interface recognizes that the
1521 parent interface supports insertion and extraction of VLAN tags on its
1522 own (usually in firmware) and that it should pass packets to and from
1523 the parent unaltered.
1524 .It Fl vlandev Op Ar iface
1527 pseudo device, disassociate the parent interface from it.
1528 This breaks the link between the
1530 interface and its parent,
1531 clears its VLAN tag, flags and its link address and shuts the interface down.
1534 argument is useless and hence deprecated.
1537 The following parameters are specific to
1540 .Bl -tag -width indent
1541 .It Cm advbase Ar seconds
1542 Specifies the base of the advertisement interval in seconds.
1543 The acceptable values are 1 to 255.
1544 The default value is 1.
1545 .\" The default value is
1546 .\" .Dv CARP_DFLTINTV .
1547 .It Cm advskew Ar interval
1548 Specifies the skew to add to the base advertisement interval to
1549 make one host advertise slower than another host.
1550 It is specified in 1/256 of seconds.
1551 The acceptable values are 1 to 254.
1552 The default value is 0.
1553 .It Cm pass Ar phrase
1554 Set the authentication key to
1557 Set the virtual host ID.
1558 This is a required setting.
1559 Acceptable values are 1 to 255.
1564 utility displays the current configuration for a network interface
1565 when no optional parameters are supplied.
1566 If a protocol family is specified,
1568 will report only the details specific to that protocol family.
1572 flag is passed before an interface name,
1574 will display the capability list and all
1575 of the supported media for the specified interface.
1578 flag is supplied, address lifetime is displayed for IPv6 addresses,
1579 as time offset string.
1583 flag may be used instead of an interface name.
1586 to display information about all interfaces in the system.
1589 flag limits this to interfaces that are down, and
1591 limits this to interfaces that are up.
1592 When no arguments are given,
1598 flag may be used to list all available interfaces on the system, with
1599 no other additional information.
1600 Use of this flag is mutually exclusive
1601 with all other flags and commands, except for
1603 (only list interfaces that are down)
1606 (only list interfaces that are up).
1610 flag may be used to get more verbose status for an interface.
1614 flag may be used to list all of the interface cloners available on
1615 the system, with no additional information.
1616 Use of this flag is mutually exclusive with all other flags and commands.
1620 flag causes keying information for the interface, if available, to be
1622 For example, the values of 802.11 WEP keys will be printed, if accessible to
1624 This information is not printed by default, as it may be considered
1627 If the network interface driver is not present in the kernel then
1629 will attempt to load it.
1632 flag disables this behavior.
1634 Only the super-user may modify the configuration of a network interface.
1636 The media selection system is relatively new and only some drivers support
1637 it (or have need for it).
1639 Assign the IPv4 address
1641 with a network mask of
1645 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
1647 Add the IPv4 address
1649 with the CIDR network prefix
1655 as a synonym for the canonical form of the option
1657 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
1659 Remove the IPv4 address
1663 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
1665 Add the IPv6 address
1666 .Li 2001:DB8:DBDB::123/48
1669 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
1670 Note that lower case hexadecimal IPv6 addresses are acceptable.
1672 Remove the IPv6 address added in the above example,
1675 character as shorthand for the network prefix,
1678 as a synonym for the canonical form of the option
1680 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
1682 Configure the interface
1684 to use 100baseTX, full duplex Ethernet media options:
1685 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
1687 Create the software network interface
1689 .Dl # ifconfig gif1 create
1691 Destroy the software network interface
1693 .Dl # ifconfig gif1 destroy
1695 Messages indicating the specified interface does not exist, the
1696 requested address is unknown, or the user is not privileged and
1697 tried to alter an interface's configuration.
1715 Basic IPv6 node operation requires a link-local address on each
1716 interface configured for IPv6.
1717 Normally, such an address is automatically configured by the
1718 kernel on each interface added to the system; this behaviour may
1719 be disabled by setting the sysctl MIB variable
1720 .Va net.inet6.ip6.auto_linklocal
1723 If you delete such an address using
1725 the kernel may act very odd.
1726 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob