1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
79 utility is used to assign an address
80 to a network interface and/or configure
81 network interface parameters.
84 utility must be used at boot time to define the network address
85 of each interface present on a machine; it may also be used at
86 a later time to redefine an interface's address
87 or other operating parameters.
89 The following options are available:
90 .Bl -tag -width indent
93 .Tn DARPA Ns -Internet
95 the address is either a host name present in the host name data
100 Internet address expressed in the Internet standard
103 It is also possible to use the CIDR notation (also known as the
104 slash notation) to include the netmask.
105 That is, one can specify an address like
110 family, it is also possible to specify the prefix length using the slash
115 parameter below for more information.
116 .\" For the Xerox Network Systems(tm) family,
118 .\" .Ar net:a.b.c.d.e.f ,
121 .\" is the assigned network number (in decimal),
122 .\" and each of the six bytes of the host number,
126 .\" are specified in hexadecimal.
127 .\" The host number may be omitted on IEEE 802 protocol
128 .\" (Ethernet, FDDI, and Token Ring) interfaces,
129 .\" which use the hardware physical address,
130 .\" and on interfaces other than the first.
133 .\" family, addresses are specified as a long hexadecimal string,
134 .\" as in the Xerox family.
135 .\" However, two consecutive dots imply a zero
136 .\" byte, and the dots are optional, if the user wishes to (carefully)
137 .\" count out long strings of digits in network byte order.
142 is specified as a series of colon-separated hex digits.
144 e.g.\& set a new MAC address on an ethernet interface, though the
145 mechanism used is not ethernet-specific.
146 If the interface is already
147 up when this option is used, it will be briefly brought down and
148 then brought back up again in order to ensure that the receive
149 filter in the underlying ethernet hardware is properly reprogrammed.
150 .It Ar address_family
153 which affects interpretation of the remaining parameters.
154 Since an interface can receive transmissions in differing protocols
155 with different naming schemes, specifying the address family is recommended.
156 The address or protocol families currently
175 Specify the address of the correspondent on the other end
176 of a point to point link.
179 parameter is a string of the form
184 List the interfaces in the given group.
187 The following parameters may be set with
189 .Bl -tag -width indent
194 Introduced for compatibility
198 Establish an additional network address for this interface.
199 This is sometimes useful when changing network numbers, and
200 one wishes to accept packets addressed to the old interface.
201 If the address is on the same subnet as the first network address
202 for this interface, a non-conflicting netmask must be given.
207 Remove the network address specified.
208 This would be used if you incorrectly specified an alias, or it
209 was no longer needed.
210 If you have incorrectly set an NS address having the side effect
211 of specifying the host portion, removing all NS addresses will
212 allow you to respecify the host portion.
215 Specify that the address configured is an anycast address.
216 Based on the current specification,
217 only routers may configure anycast addresses.
218 Anycast address will not be used as source address of any of outgoing
221 Enable the use of the Address Resolution Protocol
224 between network level addresses and link level addresses (default).
225 This is currently implemented for mapping between
230 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
232 Disable the use of the Address Resolution Protocol
235 If the Address Resolution Protocol is enabled,
236 the host will only reply to requests for its addresses,
237 and will never send any requests.
239 If the Address Resolution Protocol is enabled,
240 the host will perform normally,
241 sending out requests and listening for replies.
244 Specify the address to use to represent broadcasts to the
246 The default broadcast address is the address with a host part of all 1's.
248 Enable driver dependent debugging code; usually, this turns on
249 extra console error logging.
251 Disable driver dependent debugging code.
253 Put interface into permanently promiscuous mode.
255 Disable permanently promiscuous mode.
263 When an interface is marked
265 the system will not attempt to
266 transmit messages through that interface.
267 If possible, the interface will be reset to disable reception as well.
268 This action does not automatically disable routes using the interface.
269 .It Cm group Ar group-name
270 Assign the interface to a
272 Any interface can be in multiple groups.
274 Cloned interfaces are members of their interface family group by default.
275 For example, a PPP interface such as
277 is a member of the PPP interface family group,
279 .\" The interface(s) the default route(s) point to are members of the
282 .It Cm -group Ar group-name
283 Remove the interface from the given
288 (lowermost 64bit of an IPv6 address)
291 This is used to specify an Internet host who is willing to receive
292 IP packets encapsulating IPX packets bound for a remote network.
293 An apparent point to point link is constructed, and
294 the address specified will be taken as the IPX address and network
296 .It Cm maclabel Ar label
297 If Mandatory Access Control support is enabled in the kernel,
301 .\" .Xr maclabel 7 ) .
303 If the driver supports the media selection system, set the media type
306 Some interfaces support the mutually exclusive use of one of several
307 different physical media connectors.
308 For example, a 10Mbit/s Ethernet
309 interface might support the use of either
311 or twisted pair connectors.
312 Setting the media type to
314 would change the currently active connector to the AUI port.
317 would activate twisted pair.
318 Refer to the interfaces' driver
319 specific documentation or man page for a complete list of the
321 .It Cm mediaopt Ar opts
322 If the driver supports the media selection system, set the specified
323 media options on the interface.
327 is a comma delimited list of options to apply to the interface.
328 Refer to the interfaces' driver specific man page for a complete
329 list of available options.
330 .It Fl mediaopt Ar opts
331 If the driver supports the media selection system, disable the
332 specified media options on the interface.
334 If the driver supports the media selection system, set the specified
335 operating mode on the interface to
337 For IEEE 802.11 wireless interfaces that support multiple operating modes
338 this directive is used to select between 802.11a
346 Set the interface name to
348 .It Cm rxcsum , txcsum
349 If the driver supports user-configurable checksum offloading,
350 enable receive (or transmit) checksum offloading on the interface.
351 Some drivers may not be able to enable these flags independently
352 of each other, so setting one may also set the other.
353 The driver will offload as much checksum work as it can reliably
354 support, the exact level of offloading varies between drivers.
355 .It Fl rxcsum , txcsum
356 If the driver supports user-configurable checksum offloading,
357 disable receive (or transmit) checksum offloading on the interface.
358 These settings may not always be independent of each other.
359 .It Cm vlanmtu , vlanhwtag
360 If the driver offers user-configurable VLAN support, enable
361 reception of extended frames or tag processing in hardware,
363 Note that this must be issued on a physical interface associated with
368 .It Fl vlanmtu , vlanhwtag
369 If the driver offers user-configurable VLAN support, disable
370 reception of extended frames or tag processing in hardware,
375 feature and disable interrupts on the interface, if driver supports
380 feature and enable interrupt mode on the interface.
382 Create the specified network pseudo-device.
383 If the interface is given without a unit number, try to create a new
384 device with an arbitrary unit number.
385 If creation of an arbitrary device is successful, the new device name is
386 printed to standard output unless the interface is renamed or destroyed
391 Destroy the specified network pseudo-device.
407 Set the routing metric of the interface to
410 The routing metric is used by the routing protocol
412 Higher metrics have the effect of making a route
413 less favorable; metrics are counted as addition hops
414 to the destination network or host.
416 Set the maximum transmission unit of the interface to
418 default is interface specific.
419 The MTU is used to limit the size of packets that are transmitted on an
421 Not all interfaces support setting the MTU, and some interfaces have
423 .It Cm netmask Ar mask
426 Specify how much of the address to reserve for subdividing
427 networks into sub-networks.
428 The mask includes the network part of the local address
429 and the subnet part, which is taken from the host field of the address.
430 The mask can be specified as a single hexadecimal number
433 with a dot-notation Internet address,
434 or with a pseudo-network name listed in the network table
436 The mask contains 1's for the bit positions in the 32-bit address
437 which are to be used for the network and subnet parts,
438 and 0's for the host part.
439 The mask should contain at least the standard network portion,
440 and the subnet field should be contiguous with the network
443 The netmask can also be specified in CIDR notation after the address.
446 option above for more information.
447 .It Cm prefixlen Ar len
451 bits are reserved for subdividing networks into sub-networks.
454 must be integer, and for syntactical reason it must be between 0 to 128.
455 It is almost always 64 under the current IPv6 assignment rule.
456 If the parameter is omitted, 64 is used.
458 The prefix can also be specified using the slash notation after the address.
461 option above for more information.
464 .\" .It Cm nsellength Ar n
467 .\" This specifies a trailing number of bytes for a received
469 .\" used for local identification, the remaining leading part of which is
472 .\" (Network Entity Title).
473 .\" The default value is 1, which is conformant to US
475 .\" When an ISO address is set in an ifconfig command,
478 .\" which is being specified.
481 .\" 20 hex digits should be
484 .\" to be assigned to the interface.
485 .\" There is some evidence that a number different from 1 may be useful
488 .\" 37 type addresses.
489 .It Cm range Ar netrange
490 Under appletalk, set the interface to respond to a
493 .Ar startnet Ns - Ns Ar endnet .
494 Appletalk uses this scheme instead of
497 implements it internally as a set of netmasks.
502 Introduced for compatibility
506 The argument following this specifies the version (phase) of the
507 Appletalk network attached to the interface.
508 Values of 1 or 2 are permitted.
510 .It Cm link Op Cm 0 No - Cm 2
512 Enable special processing of the link level of the interface.
513 These three options are interface specific in actual effect, however,
514 they are in general used to select special modes of operation.
516 of this is to enable SLIP compression, or to select the connector type
517 for some Ethernet cards.
518 Refer to the man page for the specific driver
519 for more information.
521 .It Fl link Op Cm 0 No - Cm 2
523 Disable special processing at the link level with the specified interface.
525 Put the interface in monitor mode.
526 No packets are transmitted, and received packets are discarded after
530 Take the interface out of monitor mode.
534 This may be used to enable an interface after an
536 It happens automatically when setting the first address on an interface.
537 If the interface was reset when previously marked down,
538 the hardware will be re-initialized.
541 The following parameters are specific to IEEE 802.11 wireless interfaces:
542 .Bl -tag -width indent
544 When operating as an access point, pass packets between
545 wireless clients directly (default).
546 To instead let them pass up through the
547 system and be forwarded using some other mechanism, use
549 Disabling the internal bridging
550 is useful when traffic is to be processed with
552 .It Cm authmode Ar mode
553 Set the desired authentication mode in infrastructure mode.
554 Not all adaptors support all modes.
557 .Cm none , open , shared
563 (IEEE WPA/WPA2/802.11i).
568 modes are only useful when using an authentication service
569 (a supplicant for client operation or an authenticator when
570 operating as an access point).
571 Modes are case insensitive.
572 .It Cm bintval Ar interval
573 Set the interval at which beacon frames are sent when operating in
577 parameter is specified in TU's (1/1024 msecs).
578 By default beacon frames are transmitted every 100 TU's.
579 .It Cm bssid Ar address
580 Specify the MAC address of the access point to use when operating
581 as a station in a BSS network.
582 This overrides any automatic selection done by the system.
583 To disable a previously selected access point, supply
588 This option is useful when more than one access points have the same SSID.
594 Enable packet bursting.
595 Packet bursting is a transmission technique whereby the wireless
596 medium is acquired once to send multiple frames and the interframe
598 This technique can significantly increase throughput by reducing
599 transmission overhead.
600 Packet bursting is supported by the 802.11e QoS specification
601 and some devices that do not support QoS may still be capable.
602 By default packet bursting is enabled if a device is capable
604 To disable packet bursting, use
606 .It Cm chanlist Ar channels
607 Set the desired channels to use when scanning for access
608 points, neighbors in an IBSS network, or looking for unoccupied
609 channels when operating as an access point.
610 The set of channels is specified as a comma-separated list with
611 each element in the list representing either a single channel number or a range
614 Channel numbers must be in the range 1 to 255 and be permissible
615 according to the operating characteristics of the device.
616 .It Cm channel Ar number
617 Set a single desired channel.
618 Channels range from 1 to 255, but the exact selection available
619 depends on the region your adaptor was manufactured for.
626 will give you the default for your adaptor.
628 adaptors ignore this setting unless you are in ad-hoc mode.
629 Alternatively the frequency, in megahertz, may be specified
630 instead of the channel number.
631 .It Cm deftxkey Ar index
632 Set the default key to use for transmission.
633 Typically this is only set when using WEP encryption.
636 is an alias for this request; it is provided for backwards compatibility.
637 .It Cm dtimperiod Ar period
640 period for transmitting buffered multicast data frames when
641 operating in ap mode.
644 specifies the number of beacon intervals between DTIM
645 and must be in the range 1 to 15.
646 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
647 .It Cm fragthreshold Ar length
648 Set the threshold for which transmitted frames are broken into fragments.
651 argument is the frame size in bytes and must be in the range 256 to 2346.
659 disables transmit fragmentation.
660 Not all adaptors honor the fragmentation threshold.
662 When operating as an access point, do not broadcast the SSID
663 in beacon frames or respond to probe request frames unless
664 they are directed to the ap (i.e., they include the ap's SSID).
665 By default, the SSID is included in beacon frames and
666 undirected probe request frames are answered.
667 To re-enable the broadcast of the SSID etc., use
670 Display the list of channels available for use taking into account
671 any restrictions set with the
674 See the description of
676 for more information.
678 Display the adaptor's capabilities, including the operating
681 Display the list of channels available for use.
682 Channels are shown with their IEEE channel number, equivalent
683 frequency, and usage modes.
684 Channels identified as
689 Channels identified as
691 may be used only for Atheros' Static Turbo mode
692 .Pq specified with Cm mediaopt turbo .
693 Channels marked with a
695 have a regulatory constraint that they be passively scanned.
696 This means a station is not permitted to transmit on the channel until
697 it identifies the channel is being used for 802.11 communication;
698 typically by hearing a beacon frame from an access point operating
701 is another way of requesting this information.
703 Display the current MAC Access Control List state.
704 Each address is prefixed with a character that indicates the
705 current policy applied to it:
707 indicates the address is allowed access,
709 indicates the address is denied access,
711 indicates the address is present but the current policy open
712 (so the ACL is not consulted).
714 Display the access points and/or ad-hoc neighbors
715 located in the vicinity.
716 This information may be updated automatically by the adaptor
721 is another way of requesting this information.
723 When operating as an access point display the stations that are
724 currently associated.
725 When operating in ad-hoc mode display stations identified as
726 neighbors in the IBSS.
727 Capabilities advertised by the stations are described under
731 Depending on the capabilities of the stations the following
732 flags can be included in the output:
736 Indicates that the station is permitted to send/receive data frames.
738 Extended Rate Phy (ERP).
739 Indicates that the station is operating in an 802.11g network
740 using extended transmit rates.
743 Indicates that the station is operating in power save mode.
745 Quality of Service (QoS).
746 Indicates that the station is using QoS encapsulation for
748 QoS encapsulation is enabled only when WME mode is enabled.
751 Display the current parameters to use when operating in WME mode.
752 When WME mode is enabled for an adaptor this information will be
753 displayed with the regular status; this command is mostly useful
754 for examining parameters when WME mode is disabled.
755 See the description of the
757 directive for information on the various parameters.
758 .It Cm mcastrate Ar rate
759 Set the rate for transmitting multicast/broadcast frames.
760 Rates are specified as megabits/second in decimal; e.g. 5.5 for 5.5 Mb/s.
761 This rate should be valid for the current operating conditions;
762 if an invalid rate is specified drivers are free to chose an
765 Enable powersave operation.
766 When operating as a client, the station will conserve power by
767 periodically turning off the radio and listening for
768 messages from the access point telling it there are packets waiting.
769 The station must then retrieve the packets.
770 When operating as an access point, the station must honor power
771 save operation of associated clients.
772 Not all devices support power save operation, either as a client
773 or as an access point.
776 to disable powersave operation.
777 .It Cm powersavesleep Ar sleep
778 Set the desired max powersave sleep time in milliseconds.
779 .It Cm protmode Ar technique
780 For interfaces operating in 802.11g, use the specified
782 for protecting OFDM frames in a mixed 11b/11g network.
783 The set of valid techniques is
789 Technique names are case insensitive.
791 When operating as an access point in 802.11g mode allow only
792 11g-capable stations to associate (11b-only stations are not
793 permitted to associate).
794 To allow both 11g and 11b-only stations to associate, use
796 .It Cm roaming Ar mode
797 When operating as a station, control how the system will
798 behave when communication with the current access point
802 argument may be one of
804 (leave it to the hardware device to decide),
806 (handle either in the device or the operating system\[em]as appropriate),
808 (do nothing until explicitly instructed).
809 By default, the device is left to handle this if it is
810 capable; otherwise, the operating system will automatically
811 attempt to reestablish communication.
812 Manual mode is mostly useful when an application wants to
813 control the selection of an access point.
814 .It Cm rtsthreshold Ar length
815 Set the threshold for which
816 transmitted frames are preceded by transmission of an
822 is the frame size in bytes and must be in the range 1 to 2346.
830 disables transmission of RTS frames.
831 Not all adaptors support setting the RTS threshold.
833 Set the desired Service Set Identifier (aka network name).
834 The SSID is a string up to 32 characters
835 in length and may be specified as either a normal string or in
836 hexadecimal when preceded by
838 Additionally, the SSID may be cleared by setting it to
841 Initiate a scan of neighboring stations, wait for it to complete, and
842 display all stations found.
843 Only the super-user can initiate a scan.
844 Depending on the capabilities of the APs, the following
845 flags can be included in the output:
849 Indicates that the station support channel hopping as described by the
850 IEEE 802.11b specification.
852 Packet Binary Convolution Code (PBCC).
853 A modulation alternative to the standard OFDM method.
859 Direct Sequence Spread Spectrum (DSSSOFDM).
860 Indicates the the station supports DSSS modulation.
862 Extended Service Set (ESS).
863 Indicates that the station is part of an infrastructure network
864 (in contrast to an IBSS/ad-hoc network).
867 Indicates that the station is part of an ad-hoc network
868 (in contrast to an ESS network).
871 Data confidentiality is required for all data frames
872 exchanged within the BSS.
873 This means that this BSS requires the station to
874 use cryptographic means such as WEP, TKIP or AES-CCMP to
875 encrypt/decrypt data frames being exchanged with others.
877 Robust Security Network (RSN).
878 Indicates that the station supports the IEEE 802.11i authentication
879 and key management protocol.
882 Indicates that the network is using short preambles (defined
883 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
884 56 bit sync field in contrast to a 128 bit field used in long
888 Indicates that the network is using a short slot time.
893 request can be used to show recent scan results without
894 initiating a new scan.
895 .It Cm stationname Ar name
896 Set the name of this station.
897 It appears that the station name is not really part of the IEEE 802.11
898 protocol though all interfaces seem to support it.
900 seems to be meaningful to identical or virtually identical equipment.
901 Setting the station name is identical in syntax to setting the SSID.
902 .It Cm txpower Ar power
903 Set the power used to transmit frames.
907 is a unitless value in the range 0 to 100 that is interpreted
908 by drivers to derive a device-specific value.
909 Out of range values are truncated.
910 Typically only a few discreet power settings are available and
911 the driver will use the setting closest to the specified value.
912 Not all adaptors support changing the transmit power.
913 .It Cm wepmode Ar mode
914 Set the desired WEP mode.
915 Not all adaptors support all modes.
916 The set of valid modes is
922 mode explicitly tells the adaptor to allow association with access
923 points which allow both encrypted and unencrypted traffic.
926 means that the access point must only allow encrypted connections.
929 is generally another name for
931 Modes are case insensitive.
932 .It Cm weptxkey Ar index
933 Set the WEP key to be used for transmission.
934 This is the same as setting the default transmission key with
936 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
937 Set the selected WEP key.
940 is not given, key 1 is set.
941 A WEP key will be either 5 or 13
942 characters (40 or 104 bits) depending of the local network and the
943 capabilities of the adaptor.
944 It may be specified either as a plain
945 string or as a string of hexadecimal digits preceded by
947 For maximum portability, hex keys are recommended;
948 the mapping of text keys to WEP encryption is usually driver-specific.
951 drivers do this mapping differently to
953 A key may be cleared by setting it to
955 If WEP is supported then there are at least four keys.
956 Some adaptors support more than four keys.
957 If that is the case, then the first four keys
958 (1-4) will be the standard temporary keys and any others will be adaptor
959 specific keys such as permanent keys stored in NVRAM.
961 Enable Wireless Multimedia Extensions (WME) support, if available,
962 for the specified interface.
963 WME is a subset of the IEEE 802.11e standard to support the
964 efficient communication of realtime and multimedia data.
965 To disable WME support, use
968 The following parameters are meaningful only when WME support is in use.
969 Parameters are specified per-AC (Access Category) and
970 split into those that are used by a station when acting
971 as an access point and those for client stations in the BSS.
972 The latter are received from the access point and may not be changed
974 The following Access Categories are recognized:
976 .Bl -tag -width ".Cm AC_BK" -compact
980 best effort delivery,
995 AC parameters are case-insensitive.
996 Traffic classification is done in the operating system using the
997 vlan priority associated with data frames or the
998 ToS (Type of Service) indication in IP-encapsulated frames.
999 If neither information is present, traffic is assigned to the
1000 Best Effort (BE) category.
1001 .Bl -tag -width indent
1003 Set the ACK policy for QoS transmissions by the local station;
1004 this controls whether or not data frames transmitted by a station
1005 require an ACK response from the receiving station.
1006 To disable waiting for an ACK use
1008 This parameter is applied only to the local station.
1010 Enable the Admission Control Mandatory (ACM) mechanism
1011 for transmissions by the local station.
1012 To disable the ACM use
1014 On stations in a BSS this parameter is read-only and indicates
1015 the setting received from the access point.
1016 NB: ACM is not supported right now.
1017 .It Cm aifs Ar ac Ar count
1018 Set the Arbitration Inter Frame Spacing (AIFS)
1019 channel access parameter to use for transmissions
1020 by the local station.
1021 On stations in a BSS this parameter is read-only and indicates
1022 the setting received from the access point.
1023 .It Cm cwmin Ar ac Ar count
1024 Set the CWmin channel access parameter to use for transmissions
1025 by the local station.
1026 On stations in a BSS this parameter is read-only and indicates
1027 the setting received from the access point.
1028 .It Cm cwmax Ar ac Ar count
1029 Set the CWmax channel access parameter to use for transmissions
1030 by the local station.
1031 On stations in a BSS this parameter is read-only and indicates
1032 the setting received from the access point.
1033 .It Cm txoplimit Ar ac Ar limit
1034 Set the Transmission Opportunity Limit channel access parameter
1035 to use for transmissions by the local station.
1036 This parameter defines an interval of time when a WME station
1037 has the right to initiate transmissions onto the wireless medium.
1038 On stations in a BSS this parameter is read-only and indicates
1039 the setting received from the access point.
1040 .It Cm bss:aifs Ar ac Ar count
1041 Set the AIFS channel access parameter to send to stations in a BSS.
1042 This parameter is meaningful only when operating in ap mode.
1043 .It Cm bss:cwmin Ar ac Ar count
1044 Set the CWmin channel access parameter to send to stations in a BSS.
1045 This parameter is meaningful only when operating in ap mode.
1046 .It Cm bss:cwmax Ar ac Ar count
1047 Set the CWmax channel access parameter to send to stations in a BSS.
1048 This parameter is meaningful only when operating in ap mode.
1049 .It Cm bss:txoplimit Ar ac Ar limit
1050 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1051 This parameter is meaningful only when operating in ap mode.
1055 The following parameters support an optional access control list
1056 feature available with some adaptors when operating in ap mode; see
1058 This facility allows an access point to accept/deny association
1059 requests based on the MAC address of the station.
1060 Note that this feature does not significantly enhance security
1061 as MAC address spoofing is easy to do.
1062 .Bl -tag -width indent
1063 .It Cm mac:add Ar address
1064 Add the specified MAC address to the database.
1065 Depending on the policy setting association requests from the
1066 specified station will be allowed or denied.
1068 Set the ACL policy to permit association only by
1069 stations registered in the database.
1070 .It Cm mac:del Ar address
1071 Delete the specified MAC address from the database.
1073 Set the ACL policy to deny association only by
1074 stations registered in the database.
1075 .It Cm mac:kick Ar address
1076 Force the specified station to be deauthenticated.
1077 This typically is done to block a station after updating the
1080 Set the ACL policy to allow all stations to associate.
1082 Delete all entries in the database.
1085 The following parameters are for compatibility with other systems:
1086 .Bl -tag -width indent
1088 Another name for the
1094 .It Cm station Ar name
1095 Another name for the
1102 Another way of saying
1108 Another way of saying
1114 Another way of saying:
1115 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1121 .Ar n : k1 , k2 , k3 , k4
1124 Another way of saying
1125 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1130 Another way of saying
1137 The following parameters are specific to bridge interfaces:
1138 .Bl -tag -width indent
1139 .It Cm addm Ar interface
1140 Add the interface named by
1142 as a member of the bridge.
1143 The interface is put into promiscuous mode
1144 so that it can receive every packet sent on the network.
1145 .It Cm deletem Ar interface
1146 Remove the interface named by
1149 Promiscuous mode is disabled on the interface when
1150 it is removed from the bridge.
1151 .It Cm maxaddr Ar size
1152 Set the size of the bridge address cache to
1154 The default is 100 entries.
1155 .It Cm timeout Ar seconds
1156 Set the timeout of address cache entries to
1161 is zero, then address cache entries will not be expired.
1162 The default is 240 seconds.
1164 Display the addresses that have been learned by the bridge.
1165 .It Cm static Ar interface-name Ar address
1166 Add a static entry into the address cache pointing to
1167 .Ar interface-name .
1168 Static entries are never aged out of the cache or re-placed, even if the
1169 address is seen on a different interface.
1170 .It Cm deladdr Ar address
1173 from the address cache.
1175 Delete all dynamically-learned addresses from the address cache.
1177 Delete all addresses, including static addresses, from the address cache.
1178 .It Cm discover Ar interface
1179 Mark an interface as a
1182 When the bridge has no address cache entry
1183 (either dynamic or static)
1184 for the destination address of a packet,
1185 the bridge will forward the packet to all
1186 member interfaces marked as
1188 This is the default for all interfaces added to a bridge.
1189 .It Cm -discover Ar interface
1192 attribute on a member interface.
1193 For packets without the
1195 attribute, the only packets forwarded on the interface are broadcast
1196 or multicast packets and packets for which the destination address
1197 is known to be on the interface's segment.
1198 .It Cm learn Ar interface
1199 Mark an interface as a
1202 When a packet arrives on such an interface, the source
1203 address of the packet is entered into the address cache as being a
1204 destination address on the interface's segment.
1205 This is the default for all interfaces added to a bridge.
1206 .It Cm -learn Ar interface
1209 attribute on a member interface.
1210 .It Cm span Ar interface
1211 Add the interface named by
1213 as a span port on the bridge.
1214 Span ports transmit a copy of every frame received by the bridge.
1215 This is most useful for snooping a bridged network passively on
1216 another host connected to one of the span ports of the bridge.
1217 .It Cm -span Ar interface
1218 Delete the interface named by
1220 from the list of span ports of the bridge.
1221 .It Cm stp Ar interface
1222 Enable Spanning Tree protocol on
1226 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1227 Spanning Tree is used to detect and remove loops in a network topology.
1228 .It Cm -stp Ar interface
1229 Disable Spanning Tree protocol on
1231 This is the default for all interfaces added to a bridge.
1232 .It Cm maxage Ar seconds
1233 Set the time that a Spanning Tree protocol configuration is valid.
1234 The default is 20 seconds.
1235 The minimum is 1 second and the maximum is 255 seconds.
1236 .It Cm fwddelay Ar seconds
1237 Set the time that must pass before an interface begins forwarding
1238 packets when Spanning Tree is enabled.
1239 The default is 15 seconds.
1240 The minimum is 1 second and the maximum is 255 seconds.
1241 .It Cm hellotime Ar seconds
1242 Set the time between broadcasting of Spanning Tree protocol
1243 configuration messages.
1244 The default is 2 seconds.
1245 The minimum is 1 second and the maximum is 255 seconds.
1246 .It Cm priority Ar value
1247 Set the bridge priority for Spanning Tree.
1248 The default is 32768.
1249 The minimum is 0 and the maximum is 65536.
1250 .It Cm ifpriority Ar interface Ar value
1251 Set the Spanning Tree priority of
1256 The minimum is 0 and the maximum is 255.
1257 .It Cm ifpathcost Ar interface Ar value
1258 Set the Spanning Tree path cost of
1263 The minimum is 0 and the maximum is 65535.
1266 The following parameters are specific to IP tunnel interfaces,
1268 .Bl -tag -width indent
1269 .It Cm tunnel Ar src_addr dest_addr
1270 Configure the physical source and destination address for IP tunnel
1276 are interpreted as the outer source/destination for the encapsulating
1279 Unconfigure the physical source and destination address for IP tunnel
1280 interfaces previously configured with
1283 Another name for the
1288 The following parameters are specific to
1291 .Bl -tag -width indent
1293 Set the maximum number of updates for a single state which
1294 can be collapsed into one.
1295 This is an 8-bit number; the default value is 128.
1298 The following parameters are specific to
1301 .Bl -tag -width indent
1302 .It Cm vlan Ar vlan_tag
1303 Set the VLAN tag value to
1305 This value is a 16-bit number which is used to create an 802.1Q
1306 VLAN header for packets sent from the
1313 must both be set at the same time.
1314 .It Cm vlandev Ar iface
1315 Associate the physical interface
1320 Packets transmitted through the
1323 diverted to the specified physical interface
1325 with 802.1Q VLAN encapsulation.
1326 Packets with 802.1Q encapsulation received
1327 by the parent interface with the correct VLAN tag will be diverted to
1333 interface is assigned a
1334 copy of the parent interface's flags and the parent's ethernet address.
1339 must both be set at the same time.
1342 interface already has
1343 a physical interface associated with it, this command will fail.
1345 change the association to another physical interface, the existing
1346 association must be cleared first.
1348 Note: if the hardware tagging capability
1349 is set on the parent interface, the
1352 interface's behavior changes:
1355 interface recognizes that the
1356 parent interface supports insertion and extraction of VLAN tags on its
1357 own (usually in firmware) and that it should pass packets to and from
1358 the parent unaltered.
1359 .It Fl vlandev Op Ar iface
1362 pseudo device, disassociate the parent interface from it.
1363 This breaks the link between the
1365 interface and its parent,
1366 clears its VLAN tag, flags and its link address and shuts the interface down.
1369 argument is useless and hence deprecated.
1372 The following parameters are specific to
1375 .Bl -tag -width indent
1376 .It Cm advbase Ar seconds
1377 Specifies the base of the advertisement interval in seconds.
1378 The acceptable values are 1 to 255.
1379 The default value is 1.
1380 .\" The default value is
1381 .\" .Dv CARP_DFLTINTV .
1382 .It Cm advskew Ar interval
1383 Specifies the skew to add to the base advertisement interval to
1384 make one host advertise slower than another host.
1385 It is specified in 1/256 of seconds.
1386 The acceptable values are 1 to 254.
1387 The default value is 0.
1388 .It Cm pass Ar phrase
1389 Set the authentication key to
1392 Set the virtual host ID.
1393 This is a required setting.
1394 Acceptable values are 1 to 255.
1399 utility displays the current configuration for a network interface
1400 when no optional parameters are supplied.
1401 If a protocol family is specified,
1403 will report only the details specific to that protocol family.
1407 flag is passed before an interface name,
1409 will display the capability list and all
1410 of the supported media for the specified interface.
1413 flag is supplied, address lifetime is displayed for IPv6 addresses,
1414 as time offset string.
1418 flag may be used instead of an interface name.
1421 to display information about all interfaces in the system.
1424 flag limits this to interfaces that are down, and
1426 limits this to interfaces that are up.
1427 When no arguments are given,
1433 flag may be used to list all available interfaces on the system, with
1434 no other additional information.
1435 Use of this flag is mutually exclusive
1436 with all other flags and commands, except for
1438 (only list interfaces that are down)
1441 (only list interfaces that are up).
1445 flag may be used to get more verbose status for an interface.
1449 flag may be used to list all of the interface cloners available on
1450 the system, with no additional information.
1451 Use of this flag is mutually exclusive with all other flags and commands.
1455 flag causes keying information for the interface, if available, to be
1457 For example, the values of 802.11 WEP keys will be printed, if accessible to
1459 This information is not printed by default, as it may be considered
1462 Only the super-user may modify the configuration of a network interface.
1464 The media selection system is relatively new and only some drivers support
1465 it (or have need for it).
1467 Messages indicating the specified interface does not exist, the
1468 requested address is unknown, or the user is not privileged and
1469 tried to alter an interface's configuration.
1487 Basic IPv6 node operation requires a link-local address on each
1488 interface configured for IPv6.
1489 Normally, such an address is automatically configured by the
1490 kernel on each interface added to the system; this behaviour may
1491 be disabled by setting the sysctl MIB variable
1492 .Va net.inet6.ip6.auto_linklocal
1495 If you delete such an address using
1497 the kernel may act very oddly.
1498 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob