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 bmissthreshold Ar count
580 Set the number of consecutive missed beacons at which the station
581 will attempt to roam (i.e. search for a new access point).
584 parameter is must be in the range 1 to 255; though the
585 upper bound may be reduced according to device capabilities..
586 The default threshold is 7 consecutive missed beacons; but
587 this may be overridden by the device driver.
592 .It Cm bssid Ar address
593 Specify the MAC address of the access point to use when operating
594 as a station in a BSS network.
595 This overrides any automatic selection done by the system.
596 To disable a previously selected access point, supply
601 This option is useful when more than one access points have the same SSID.
607 Enable packet bursting.
608 Packet bursting is a transmission technique whereby the wireless
609 medium is acquired once to send multiple frames and the interframe
611 This technique can significantly increase throughput by reducing
612 transmission overhead.
613 Packet bursting is supported by the 802.11e QoS specification
614 and some devices that do not support QoS may still be capable.
615 By default packet bursting is enabled if a device is capable
617 To disable packet bursting, use
619 .It Cm chanlist Ar channels
620 Set the desired channels to use when scanning for access
621 points, neighbors in an IBSS network, or looking for unoccupied
622 channels when operating as an access point.
623 The set of channels is specified as a comma-separated list with
624 each element in the list representing either a single channel number or a range
627 Channel numbers must be in the range 1 to 255 and be permissible
628 according to the operating characteristics of the device.
629 .It Cm channel Ar number
630 Set a single desired channel.
631 Channels range from 1 to 255, but the exact selection available
632 depends on the region your adaptor was manufactured for.
639 will give you the default for your adaptor.
641 adaptors ignore this setting unless you are in ad-hoc mode.
642 Alternatively the frequency, in megahertz, may be specified
643 instead of the channel number.
644 .It Cm deftxkey Ar index
645 Set the default key to use for transmission.
646 Typically this is only set when using WEP encryption.
649 is an alias for this request; it is provided for backwards compatibility.
650 .It Cm dtimperiod Ar period
653 period for transmitting buffered multicast data frames when
654 operating in ap mode.
657 specifies the number of beacon intervals between DTIM
658 and must be in the range 1 to 15.
659 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
660 .It Cm fragthreshold Ar length
661 Set the threshold for which transmitted frames are broken into fragments.
664 argument is the frame size in bytes and must be in the range 256 to 2346.
672 disables transmit fragmentation.
673 Not all adaptors honor the fragmentation threshold.
675 When operating as an access point, do not broadcast the SSID
676 in beacon frames or respond to probe request frames unless
677 they are directed to the ap (i.e., they include the ap's SSID).
678 By default, the SSID is included in beacon frames and
679 undirected probe request frames are answered.
680 To re-enable the broadcast of the SSID etc., use
683 Display the list of channels available for use taking into account
684 any restrictions set with the
687 See the description of
689 for more information.
691 Display the adaptor's capabilities, including the operating
694 Display the list of channels available for use.
695 Channels are shown with their IEEE channel number, equivalent
696 frequency, and usage modes.
697 Channels identified as
702 Channels identified as
704 may be used only for Atheros' Static Turbo mode
705 .Pq specified with Cm mediaopt turbo .
706 Channels marked with a
708 have a regulatory constraint that they be passively scanned.
709 This means a station is not permitted to transmit on the channel until
710 it identifies the channel is being used for 802.11 communication;
711 typically by hearing a beacon frame from an access point operating
714 is another way of requesting this information.
716 Display the current MAC Access Control List state.
717 Each address is prefixed with a character that indicates the
718 current policy applied to it:
720 indicates the address is allowed access,
722 indicates the address is denied access,
724 indicates the address is present but the current policy open
725 (so the ACL is not consulted).
727 Display the access points and/or ad-hoc neighbors
728 located in the vicinity.
729 This information may be updated automatically by the adaptor
734 is another way of requesting this information.
736 When operating as an access point display the stations that are
737 currently associated.
738 When operating in ad-hoc mode display stations identified as
739 neighbors in the IBSS.
740 Capabilities advertised by the stations are described under
744 Depending on the capabilities of the stations the following
745 flags can be included in the output:
749 Indicates that the station is permitted to send/receive data frames.
751 Extended Rate Phy (ERP).
752 Indicates that the station is operating in an 802.11g network
753 using extended transmit rates.
756 Indicates that the station is operating in power save mode.
758 Quality of Service (QoS).
759 Indicates that the station is using QoS encapsulation for
761 QoS encapsulation is enabled only when WME mode is enabled.
764 Display the current parameters to use when operating in WME mode.
765 When WME mode is enabled for an adaptor this information will be
766 displayed with the regular status; this command is mostly useful
767 for examining parameters when WME mode is disabled.
768 See the description of the
770 directive for information on the various parameters.
771 .It Cm mcastrate Ar rate
772 Set the rate for transmitting multicast/broadcast frames.
773 Rates are specified as megabits/second in decimal; e.g. 5.5 for 5.5 Mb/s.
774 This rate should be valid for the current operating conditions;
775 if an invalid rate is specified drivers are free to chose an
778 Enable powersave operation.
779 When operating as a client, the station will conserve power by
780 periodically turning off the radio and listening for
781 messages from the access point telling it there are packets waiting.
782 The station must then retrieve the packets.
783 When operating as an access point, the station must honor power
784 save operation of associated clients.
785 Not all devices support power save operation, either as a client
786 or as an access point.
789 to disable powersave operation.
790 .It Cm powersavesleep Ar sleep
791 Set the desired max powersave sleep time in milliseconds.
792 .It Cm protmode Ar technique
793 For interfaces operating in 802.11g, use the specified
795 for protecting OFDM frames in a mixed 11b/11g network.
796 The set of valid techniques is
802 Technique names are case insensitive.
804 When operating as an access point in 802.11g mode allow only
805 11g-capable stations to associate (11b-only stations are not
806 permitted to associate).
807 To allow both 11g and 11b-only stations to associate, use
809 .It Cm roaming Ar mode
810 When operating as a station, control how the system will
811 behave when communication with the current access point
815 argument may be one of
817 (leave it to the hardware device to decide),
819 (handle either in the device or the operating system\[em]as appropriate),
821 (do nothing until explicitly instructed).
822 By default, the device is left to handle this if it is
823 capable; otherwise, the operating system will automatically
824 attempt to reestablish communication.
825 Manual mode is mostly useful when an application wants to
826 control the selection of an access point.
827 .It Cm rtsthreshold Ar length
828 Set the threshold for which
829 transmitted frames are preceded by transmission of an
835 is the frame size in bytes and must be in the range 1 to 2346.
843 disables transmission of RTS frames.
844 Not all adaptors support setting the RTS threshold.
846 Set the desired Service Set Identifier (aka network name).
847 The SSID is a string up to 32 characters
848 in length and may be specified as either a normal string or in
849 hexadecimal when preceded by
851 Additionally, the SSID may be cleared by setting it to
854 Initiate a scan of neighboring stations, wait for it to complete, and
855 display all stations found.
856 Only the super-user can initiate a scan.
857 Depending on the capabilities of the APs, the following
858 flags can be included in the output:
862 Indicates that the station support channel hopping as described by the
863 IEEE 802.11b specification.
865 Packet Binary Convolution Code (PBCC).
866 A modulation alternative to the standard OFDM method.
872 Direct Sequence Spread Spectrum (DSSSOFDM).
873 Indicates the the station supports DSSS modulation.
875 Extended Service Set (ESS).
876 Indicates that the station is part of an infrastructure network
877 (in contrast to an IBSS/ad-hoc network).
880 Indicates that the station is part of an ad-hoc network
881 (in contrast to an ESS network).
884 Data confidentiality is required for all data frames
885 exchanged within the BSS.
886 This means that this BSS requires the station to
887 use cryptographic means such as WEP, TKIP or AES-CCMP to
888 encrypt/decrypt data frames being exchanged with others.
890 Robust Security Network (RSN).
891 Indicates that the station supports the IEEE 802.11i authentication
892 and key management protocol.
895 Indicates that the network is using short preambles (defined
896 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
897 56 bit sync field in contrast to a 128 bit field used in long
901 Indicates that the network is using a short slot time.
906 request can be used to show recent scan results without
907 initiating a new scan.
908 .It Cm stationname Ar name
909 Set the name of this station.
910 It appears that the station name is not really part of the IEEE 802.11
911 protocol though all interfaces seem to support it.
913 seems to be meaningful to identical or virtually identical equipment.
914 Setting the station name is identical in syntax to setting the SSID.
915 .It Cm txpower Ar power
916 Set the power used to transmit frames.
920 is a unitless value in the range 0 to 100 that is interpreted
921 by drivers to derive a device-specific value.
922 Out of range values are truncated.
923 Typically only a few discreet power settings are available and
924 the driver will use the setting closest to the specified value.
925 Not all adaptors support changing the transmit power.
926 .It Cm wepmode Ar mode
927 Set the desired WEP mode.
928 Not all adaptors support all modes.
929 The set of valid modes is
935 mode explicitly tells the adaptor to allow association with access
936 points which allow both encrypted and unencrypted traffic.
939 means that the access point must only allow encrypted connections.
942 is generally another name for
944 Modes are case insensitive.
945 .It Cm weptxkey Ar index
946 Set the WEP key to be used for transmission.
947 This is the same as setting the default transmission key with
949 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
950 Set the selected WEP key.
953 is not given, key 1 is set.
954 A WEP key will be either 5 or 13
955 characters (40 or 104 bits) depending of the local network and the
956 capabilities of the adaptor.
957 It may be specified either as a plain
958 string or as a string of hexadecimal digits preceded by
960 For maximum portability, hex keys are recommended;
961 the mapping of text keys to WEP encryption is usually driver-specific.
964 drivers do this mapping differently to
966 A key may be cleared by setting it to
968 If WEP is supported then there are at least four keys.
969 Some adaptors support more than four keys.
970 If that is the case, then the first four keys
971 (1-4) will be the standard temporary keys and any others will be adaptor
972 specific keys such as permanent keys stored in NVRAM.
974 Enable Wireless Multimedia Extensions (WME) support, if available,
975 for the specified interface.
976 WME is a subset of the IEEE 802.11e standard to support the
977 efficient communication of realtime and multimedia data.
978 To disable WME support, use
981 The following parameters are meaningful only when WME support is in use.
982 Parameters are specified per-AC (Access Category) and
983 split into those that are used by a station when acting
984 as an access point and those for client stations in the BSS.
985 The latter are received from the access point and may not be changed
987 The following Access Categories are recognized:
989 .Bl -tag -width ".Cm AC_BK" -compact
993 best effort delivery,
1008 AC parameters are case-insensitive.
1009 Traffic classification is done in the operating system using the
1010 vlan priority associated with data frames or the
1011 ToS (Type of Service) indication in IP-encapsulated frames.
1012 If neither information is present, traffic is assigned to the
1013 Best Effort (BE) category.
1014 .Bl -tag -width indent
1016 Set the ACK policy for QoS transmissions by the local station;
1017 this controls whether or not data frames transmitted by a station
1018 require an ACK response from the receiving station.
1019 To disable waiting for an ACK use
1021 This parameter is applied only to the local station.
1023 Enable the Admission Control Mandatory (ACM) mechanism
1024 for transmissions by the local station.
1025 To disable the ACM use
1027 On stations in a BSS this parameter is read-only and indicates
1028 the setting received from the access point.
1029 NB: ACM is not supported right now.
1030 .It Cm aifs Ar ac Ar count
1031 Set the Arbitration Inter Frame Spacing (AIFS)
1032 channel access parameter to use for transmissions
1033 by the local station.
1034 On stations in a BSS this parameter is read-only and indicates
1035 the setting received from the access point.
1036 .It Cm cwmin Ar ac Ar count
1037 Set the CWmin channel access parameter to use for transmissions
1038 by the local station.
1039 On stations in a BSS this parameter is read-only and indicates
1040 the setting received from the access point.
1041 .It Cm cwmax Ar ac Ar count
1042 Set the CWmax channel access parameter to use for transmissions
1043 by the local station.
1044 On stations in a BSS this parameter is read-only and indicates
1045 the setting received from the access point.
1046 .It Cm txoplimit Ar ac Ar limit
1047 Set the Transmission Opportunity Limit channel access parameter
1048 to use for transmissions by the local station.
1049 This parameter defines an interval of time when a WME station
1050 has the right to initiate transmissions onto the wireless medium.
1051 On stations in a BSS this parameter is read-only and indicates
1052 the setting received from the access point.
1053 .It Cm bss:aifs Ar ac Ar count
1054 Set the AIFS channel access parameter to send to stations in a BSS.
1055 This parameter is meaningful only when operating in ap mode.
1056 .It Cm bss:cwmin Ar ac Ar count
1057 Set the CWmin channel access parameter to send to stations in a BSS.
1058 This parameter is meaningful only when operating in ap mode.
1059 .It Cm bss:cwmax Ar ac Ar count
1060 Set the CWmax channel access parameter to send to stations in a BSS.
1061 This parameter is meaningful only when operating in ap mode.
1062 .It Cm bss:txoplimit Ar ac Ar limit
1063 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1064 This parameter is meaningful only when operating in ap mode.
1068 The following parameters support an optional access control list
1069 feature available with some adaptors when operating in ap mode; see
1071 This facility allows an access point to accept/deny association
1072 requests based on the MAC address of the station.
1073 Note that this feature does not significantly enhance security
1074 as MAC address spoofing is easy to do.
1075 .Bl -tag -width indent
1076 .It Cm mac:add Ar address
1077 Add the specified MAC address to the database.
1078 Depending on the policy setting association requests from the
1079 specified station will be allowed or denied.
1081 Set the ACL policy to permit association only by
1082 stations registered in the database.
1083 .It Cm mac:del Ar address
1084 Delete the specified MAC address from the database.
1086 Set the ACL policy to deny association only by
1087 stations registered in the database.
1088 .It Cm mac:kick Ar address
1089 Force the specified station to be deauthenticated.
1090 This typically is done to block a station after updating the
1093 Set the ACL policy to allow all stations to associate.
1095 Delete all entries in the database.
1098 The following parameters are for compatibility with other systems:
1099 .Bl -tag -width indent
1101 Another name for the
1107 .It Cm station Ar name
1108 Another name for the
1115 Another way of saying
1121 Another way of saying
1127 Another way of saying:
1128 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1134 .Ar n : k1 , k2 , k3 , k4
1137 Another way of saying
1138 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1143 Another way of saying
1150 The following parameters are specific to bridge interfaces:
1151 .Bl -tag -width indent
1152 .It Cm addm Ar interface
1153 Add the interface named by
1155 as a member of the bridge.
1156 The interface is put into promiscuous mode
1157 so that it can receive every packet sent on the network.
1158 .It Cm deletem Ar interface
1159 Remove the interface named by
1162 Promiscuous mode is disabled on the interface when
1163 it is removed from the bridge.
1164 .It Cm maxaddr Ar size
1165 Set the size of the bridge address cache to
1167 The default is 100 entries.
1168 .It Cm timeout Ar seconds
1169 Set the timeout of address cache entries to
1174 is zero, then address cache entries will not be expired.
1175 The default is 240 seconds.
1177 Display the addresses that have been learned by the bridge.
1178 .It Cm static Ar interface-name Ar address
1179 Add a static entry into the address cache pointing to
1180 .Ar interface-name .
1181 Static entries are never aged out of the cache or re-placed, even if the
1182 address is seen on a different interface.
1183 .It Cm deladdr Ar address
1186 from the address cache.
1188 Delete all dynamically-learned addresses from the address cache.
1190 Delete all addresses, including static addresses, from the address cache.
1191 .It Cm discover Ar interface
1192 Mark an interface as a
1195 When the bridge has no address cache entry
1196 (either dynamic or static)
1197 for the destination address of a packet,
1198 the bridge will forward the packet to all
1199 member interfaces marked as
1201 This is the default for all interfaces added to a bridge.
1202 .It Cm -discover Ar interface
1205 attribute on a member interface.
1206 For packets without the
1208 attribute, the only packets forwarded on the interface are broadcast
1209 or multicast packets and packets for which the destination address
1210 is known to be on the interface's segment.
1211 .It Cm learn Ar interface
1212 Mark an interface as a
1215 When a packet arrives on such an interface, the source
1216 address of the packet is entered into the address cache as being a
1217 destination address on the interface's segment.
1218 This is the default for all interfaces added to a bridge.
1219 .It Cm -learn Ar interface
1222 attribute on a member interface.
1223 .It Cm span Ar interface
1224 Add the interface named by
1226 as a span port on the bridge.
1227 Span ports transmit a copy of every frame received by the bridge.
1228 This is most useful for snooping a bridged network passively on
1229 another host connected to one of the span ports of the bridge.
1230 .It Cm -span Ar interface
1231 Delete the interface named by
1233 from the list of span ports of the bridge.
1234 .It Cm stp Ar interface
1235 Enable Spanning Tree protocol on
1239 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1240 Spanning Tree is used to detect and remove loops in a network topology.
1241 .It Cm -stp Ar interface
1242 Disable Spanning Tree protocol on
1244 This is the default for all interfaces added to a bridge.
1245 .It Cm maxage Ar seconds
1246 Set the time that a Spanning Tree protocol configuration is valid.
1247 The default is 20 seconds.
1248 The minimum is 1 second and the maximum is 255 seconds.
1249 .It Cm fwddelay Ar seconds
1250 Set the time that must pass before an interface begins forwarding
1251 packets when Spanning Tree is enabled.
1252 The default is 15 seconds.
1253 The minimum is 1 second and the maximum is 255 seconds.
1254 .It Cm hellotime Ar seconds
1255 Set the time between broadcasting of Spanning Tree protocol
1256 configuration messages.
1257 The default is 2 seconds.
1258 The minimum is 1 second and the maximum is 255 seconds.
1259 .It Cm priority Ar value
1260 Set the bridge priority for Spanning Tree.
1261 The default is 32768.
1262 The minimum is 0 and the maximum is 65536.
1263 .It Cm ifpriority Ar interface Ar value
1264 Set the Spanning Tree priority of
1269 The minimum is 0 and the maximum is 255.
1270 .It Cm ifpathcost Ar interface Ar value
1271 Set the Spanning Tree path cost of
1276 The minimum is 0 and the maximum is 65535.
1279 The following parameters are specific to IP tunnel interfaces,
1281 .Bl -tag -width indent
1282 .It Cm tunnel Ar src_addr dest_addr
1283 Configure the physical source and destination address for IP tunnel
1289 are interpreted as the outer source/destination for the encapsulating
1292 Unconfigure the physical source and destination address for IP tunnel
1293 interfaces previously configured with
1296 Another name for the
1301 The following parameters are specific to
1304 .Bl -tag -width indent
1306 Set the maximum number of updates for a single state which
1307 can be collapsed into one.
1308 This is an 8-bit number; the default value is 128.
1311 The following parameters are specific to
1314 .Bl -tag -width indent
1315 .It Cm vlan Ar vlan_tag
1316 Set the VLAN tag value to
1318 This value is a 16-bit number which is used to create an 802.1Q
1319 VLAN header for packets sent from the
1326 must both be set at the same time.
1327 .It Cm vlandev Ar iface
1328 Associate the physical interface
1333 Packets transmitted through the
1336 diverted to the specified physical interface
1338 with 802.1Q VLAN encapsulation.
1339 Packets with 802.1Q encapsulation received
1340 by the parent interface with the correct VLAN tag will be diverted to
1346 interface is assigned a
1347 copy of the parent interface's flags and the parent's ethernet address.
1352 must both be set at the same time.
1355 interface already has
1356 a physical interface associated with it, this command will fail.
1358 change the association to another physical interface, the existing
1359 association must be cleared first.
1361 Note: if the hardware tagging capability
1362 is set on the parent interface, the
1365 interface's behavior changes:
1368 interface recognizes that the
1369 parent interface supports insertion and extraction of VLAN tags on its
1370 own (usually in firmware) and that it should pass packets to and from
1371 the parent unaltered.
1372 .It Fl vlandev Op Ar iface
1375 pseudo device, disassociate the parent interface from it.
1376 This breaks the link between the
1378 interface and its parent,
1379 clears its VLAN tag, flags and its link address and shuts the interface down.
1382 argument is useless and hence deprecated.
1385 The following parameters are specific to
1388 .Bl -tag -width indent
1389 .It Cm advbase Ar seconds
1390 Specifies the base of the advertisement interval in seconds.
1391 The acceptable values are 1 to 255.
1392 The default value is 1.
1393 .\" The default value is
1394 .\" .Dv CARP_DFLTINTV .
1395 .It Cm advskew Ar interval
1396 Specifies the skew to add to the base advertisement interval to
1397 make one host advertise slower than another host.
1398 It is specified in 1/256 of seconds.
1399 The acceptable values are 1 to 254.
1400 The default value is 0.
1401 .It Cm pass Ar phrase
1402 Set the authentication key to
1405 Set the virtual host ID.
1406 This is a required setting.
1407 Acceptable values are 1 to 255.
1412 utility displays the current configuration for a network interface
1413 when no optional parameters are supplied.
1414 If a protocol family is specified,
1416 will report only the details specific to that protocol family.
1420 flag is passed before an interface name,
1422 will display the capability list and all
1423 of the supported media for the specified interface.
1426 flag is supplied, address lifetime is displayed for IPv6 addresses,
1427 as time offset string.
1431 flag may be used instead of an interface name.
1434 to display information about all interfaces in the system.
1437 flag limits this to interfaces that are down, and
1439 limits this to interfaces that are up.
1440 When no arguments are given,
1446 flag may be used to list all available interfaces on the system, with
1447 no other additional information.
1448 Use of this flag is mutually exclusive
1449 with all other flags and commands, except for
1451 (only list interfaces that are down)
1454 (only list interfaces that are up).
1458 flag may be used to get more verbose status for an interface.
1462 flag may be used to list all of the interface cloners available on
1463 the system, with no additional information.
1464 Use of this flag is mutually exclusive with all other flags and commands.
1468 flag causes keying information for the interface, if available, to be
1470 For example, the values of 802.11 WEP keys will be printed, if accessible to
1472 This information is not printed by default, as it may be considered
1475 Only the super-user may modify the configuration of a network interface.
1477 The media selection system is relatively new and only some drivers support
1478 it (or have need for it).
1480 Messages indicating the specified interface does not exist, the
1481 requested address is unknown, or the user is not privileged and
1482 tried to alter an interface's configuration.
1500 Basic IPv6 node operation requires a link-local address on each
1501 interface configured for IPv6.
1502 Normally, such an address is automatically configured by the
1503 kernel on each interface added to the system; this behaviour may
1504 be disabled by setting the sysctl MIB variable
1505 .Va net.inet6.ip6.auto_linklocal
1508 If you delete such an address using
1510 the kernel may act very oddly.
1511 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob