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 .\" 3. 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
39 .Op Fl f Ar type:format Ns Op Ar ,type:format
81 utility is used to assign an address
82 to a network interface and/or configure
83 network interface parameters.
86 utility must be used at boot time to define the network address
87 of each interface present on a machine; it may also be used at
88 a later time to redefine an interface's address
89 or other operating parameters.
91 The following options are available:
92 .Bl -tag -width indent
95 .Tn DARPA Ns -Internet
97 the address is either a host name present in the host name data
102 Internet address expressed in the Internet standard
105 It is also possible to use the CIDR notation (also known as the
106 slash notation) to include the netmask.
107 That is, one can specify an address like
112 family, it is also possible to specify the prefix length using the slash
117 parameter below for more information.
118 .\" For the Xerox Network Systems(tm) family,
120 .\" .Ar net:a.b.c.d.e.f ,
123 .\" is the assigned network number (in decimal),
124 .\" and each of the six bytes of the host number,
128 .\" are specified in hexadecimal.
129 .\" The host number may be omitted on IEEE 802 protocol
130 .\" (Ethernet, FDDI, and Token Ring) interfaces,
131 .\" which use the hardware physical address,
132 .\" and on interfaces other than the first.
135 .\" family, addresses are specified as a long hexadecimal string,
136 .\" as in the Xerox family.
137 .\" However, two consecutive dots imply a zero
138 .\" byte, and the dots are optional, if the user wishes to (carefully)
139 .\" count out long strings of digits in network byte order.
144 is specified as a series of colon-separated hex digits.
145 This can be used to, for example,
146 set a new MAC address on an Ethernet interface, though the
147 mechanism used is not Ethernet specific.
150 keyword to set a randomly generated MAC address.
151 A randomly-generated MAC address might be the same as one already in use
153 Such duplications are extremely unlikely.
154 If the interface is already
155 up when this option is used, it will be briefly brought down and
156 then brought back up again in order to ensure that the receive
157 filter in the underlying Ethernet hardware is properly reprogrammed.
158 .It Ar address_family
161 which affects interpretation of the remaining parameters.
162 Since an interface can receive transmissions in differing protocols
163 with different naming schemes, specifying the address family is recommended.
164 The address or protocol families currently
170 The default if available is
183 address family has special meaning and is no longer synonymous with
189 will list only Ethernet interfaces, excluding all other interface types,
190 including the loopback interface.
192 Specify the address of the correspondent on the other end
193 of a point to point link.
196 parameter is a string of the form
201 List the interfaces in the given group.
206 can be controlled using the
210 environment variable.
211 The format is specified as a comma separated list of
216 section for more information.
222 .Bl -tag -width ether
224 Adjust the display of inet and inet6 addresses
225 .Bl -tag -width default
227 Display inet and inet6 addresses in the default format,
230 Display inet and inet6 addresses as fully qualified domain names
233 Display inet and inet6 addresses as unqualified hostnames
235 Display inet and inet6 addresses in numeric format
238 Adjust the display of link-level ethernet (MAC) addresses
239 .Bl -tag -width default
241 Separate address segments with a colon
243 Separate address segments with a dash
245 Display ethernet addresses in the default format,
249 Adjust the display of inet address subnet masks:
250 .Bl -tag -width default
252 Display subnet masks in CIDR notation, for example:
254 10.0.0.0/8 or 203.0.113.224/26
256 Display subnet masks in the default format,
259 Display subnet masks in dotted quad notation, for example:
261 255.255.0.0 or 255.255.255.192
263 Display subnet masks in hexadecimal, for example:
265 0xffff0000 or 0xffffffc0
268 Adjust the display of inet6 address prefixes (subnet masks):
269 .Bl -tag -width default
271 Display subnet prefix in CIDR notation, for example:
273 ::1/128 or fe80::1%lo0/64
275 Display subnet prefix in the default format
278 Display subnet prefix in integer format, for example:
284 The following parameters may be set with
286 .Bl -tag -width indent
291 Introduced for compatibility
295 Establish an additional network address for this interface.
296 This is sometimes useful when changing network numbers, and
297 one wishes to accept packets addressed to the old interface.
298 If the address is on the same subnet as the first network address
299 for this interface, a non-conflicting netmask must be given.
304 Remove the network address specified.
305 This would be used if you incorrectly specified an alias, or it
306 was no longer needed.
307 If you have incorrectly set an NS address having the side effect
308 of specifying the host portion, removing all NS addresses will
309 allow you to respecify the host portion.
312 Specify that the address configured is an anycast address.
313 Based on the current specification,
314 only routers may configure anycast addresses.
315 Anycast address will not be used as source address of any of outgoing
318 Enable the use of the Address Resolution Protocol
321 between network level addresses and link level addresses (default).
322 This is currently implemented for mapping between
327 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
329 Disable the use of the Address Resolution Protocol
332 If the Address Resolution Protocol is enabled,
333 the host will only reply to requests for its addresses,
334 and will never send any requests.
336 If the Address Resolution Protocol is enabled,
337 the host will perform normally,
338 sending out requests and listening for replies.
341 Specify the address to use to represent broadcasts to the
343 The default broadcast address is the address with a host part of all 1's.
345 Enable driver dependent debugging code; usually, this turns on
346 extra console error logging.
348 Disable driver dependent debugging code.
350 Put interface into permanently promiscuous mode.
352 Disable permanently promiscuous mode.
357 .It Cm description Ar value , Cm descr Ar value
358 Specify a description of the interface.
359 This can be used to label interfaces in situations where they may
360 otherwise be difficult to distinguish.
361 .It Cm -description , Cm -descr
362 Clear the interface description.
366 When an interface is marked
368 the system will not attempt to
369 transmit messages through that interface.
370 If possible, the interface will be reset to disable reception as well.
371 This action does not automatically disable routes using the interface.
372 .It Cm group Ar group-name
373 Assign the interface to a
375 Any interface can be in multiple groups.
377 Cloned interfaces are members of their interface family group by default.
378 For example, a PPP interface such as
380 is a member of the PPP interface family group,
382 .\" The interface(s) the default route(s) point to are members of the
385 .It Cm -group Ar group-name
386 Remove the interface from the given
391 (lowermost 64bit of an IPv6 address)
393 .It Cm fib Ar fib_number
394 Specify interface FIB.
397 is assigned to all frames or packets received on that interface.
398 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
399 the default FIB (0) irrespective of the parent interface's FIB.
400 The kernel needs to be tuned to support more than the default FIB
403 kernel configuration option, or the
406 .It Cm tunnelfib Ar fib_number
410 is assigned to all packets encapsulated by tunnel interface, e.g.,
414 .It Cm maclabel Ar label
415 If Mandatory Access Control support is enabled in the kernel,
419 .\" .Xr maclabel 7 ) .
421 If the driver supports the media selection system, set the media type
424 Some interfaces support the mutually exclusive use of one of several
425 different physical media connectors.
426 For example, a 10Mbit/s Ethernet
427 interface might support the use of either
429 or twisted pair connectors.
430 Setting the media type to
432 would change the currently active connector to the AUI port.
435 would activate twisted pair.
436 Refer to the interfaces' driver
437 specific documentation or man page for a complete list of the
439 .It Cm mediaopt Ar opts
440 If the driver supports the media selection system, set the specified
441 media options on the interface.
445 is a comma delimited list of options to apply to the interface.
446 Refer to the interfaces' driver specific man page for a complete
447 list of available options.
448 .It Fl mediaopt Ar opts
449 If the driver supports the media selection system, disable the
450 specified media options on the interface.
452 If the driver supports the media selection system, set the specified
453 operating mode on the interface to
455 For IEEE 802.11 wireless interfaces that support multiple operating modes
456 this directive is used to select between 802.11a
464 Set if the driver supports TX rate limiting.
465 .It Cm inst Ar minst , Cm instance Ar minst
466 Set the media instance to
468 This is useful for devices which have multiple physical layer interfaces
471 Set the interface name to
473 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
474 If the driver supports user-configurable checksum offloading,
475 enable receive (or transmit) checksum offloading on the interface.
476 The feature can be turned on selectively per protocol family.
478 .Cm rxcsum6 , txcsum6
484 Some drivers may not be able to enable these flags independently
485 of each other, so setting one may also set the other.
486 The driver will offload as much checksum work as it can reliably
487 support, the exact level of offloading varies between drivers.
488 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
489 If the driver supports user-configurable checksum offloading,
490 disable receive (or transmit) checksum offloading on the interface.
491 The feature can be turned off selectively per protocol family.
493 .Fl rxcsum6 , txcsum6
499 These settings may not always be independent of each other.
501 If the driver supports
503 segmentation offloading, enable TSO on the interface.
504 Some drivers may not be able to support TSO for
508 packets, so they may enable only one of them.
510 If the driver supports
512 segmentation offloading, disable TSO on the interface.
513 It will always disable TSO for
518 If the driver supports
520 segmentation offloading for
524 use one of these to selectively enabled it only for one protocol family.
526 If the driver supports
528 segmentation offloading for
532 use one of these to selectively disable it only for one protocol family.
534 If the driver supports
536 large receive offloading, enable LRO on the interface.
538 If the driver supports
540 large receive offloading, disable LRO on the interface.
542 If the driver supports unmapped network buffers,
543 enable them on the interface.
545 If the driver supports unmapped network buffers,
546 disable them on the interface.
547 .It Cm wol , wol_ucast , wol_mcast , wol_magic
548 Enable Wake On Lan (WOL) support, if available.
549 WOL is a facility whereby a machine in a low power state may be woken
550 in response to a received packet.
551 There are three types of packets that may wake a system:
552 ucast (directed solely to the machine's mac address),
553 mcast (directed to a broadcast or multicast address),
555 magic (unicast or multicast frames with a ``magic contents'').
556 Not all devices support WOL, those that do indicate the mechanisms
557 they support in their capabilities.
559 is a synonym for enabling all available WOL mechanisms.
562 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
563 If the driver offers user-configurable VLAN support, enable
564 reception of extended frames, tag processing in hardware,
565 frame filtering in hardware, checksum offloading, or TSO on VLAN,
567 Note that this must be issued on a physical interface associated with
572 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
573 If the driver offers user-configurable VLAN support, disable
574 reception of extended frames, tag processing in hardware,
575 frame filtering in hardware, or TSO on VLAN,
578 Move the interface to the
580 specified by name or JID.
581 If the jail has a virtual network stack, the interface will disappear
582 from the current environment and become visible to the jail.
584 Reclaim the interface from the
586 specified by name or JID.
587 If the jail has a virtual network stack, the interface will disappear
588 from the jail, and become visible to the current network environment.
592 feature and disable interrupts on the interface, if driver supports
597 feature and enable interrupt mode on the interface.
599 Create the specified network pseudo-device.
600 If the interface is given without a unit number, try to create a new
601 device with an arbitrary unit number.
602 If creation of an arbitrary device is successful, the new device name is
603 printed to standard output unless the interface is renamed or destroyed
608 Destroy the specified network pseudo-device.
624 Set the routing metric of the interface to
627 The routing metric is used by the routing protocol
629 Higher metrics have the effect of making a route
630 less favorable; metrics are counted as additional hops
631 to the destination network or host.
633 Set the maximum transmission unit of the interface to
635 default is interface specific.
636 The MTU is used to limit the size of packets that are transmitted on an
638 Not all interfaces support setting the MTU, and some interfaces have
640 .It Cm netmask Ar mask
643 Specify how much of the address to reserve for subdividing
644 networks into sub-networks.
645 The mask includes the network part of the local address
646 and the subnet part, which is taken from the host field of the address.
647 The mask can be specified as a single hexadecimal number
650 with a dot-notation Internet address,
651 or with a pseudo-network name listed in the network table
653 The mask contains 1's for the bit positions in the 32-bit address
654 which are to be used for the network and subnet parts,
655 and 0's for the host part.
656 The mask should contain at least the standard network portion,
657 and the subnet field should be contiguous with the network
660 The netmask can also be specified in CIDR notation after the address.
663 option above for more information.
664 .It Cm prefixlen Ar len
668 bits are reserved for subdividing networks into sub-networks.
671 must be integer, and for syntactical reason it must be between 0 to 128.
672 It is almost always 64 under the current IPv6 assignment rule.
673 If the parameter is omitted, 64 is used.
675 The prefix can also be specified using the slash notation after the address.
678 option above for more information.
683 Introduced for compatibility
687 .It Cm link Op Cm 0 No - Cm 2
689 Enable special processing of the link level of the interface.
690 These three options are interface specific in actual effect, however,
691 they are in general used to select special modes of operation.
693 of this is to enable SLIP compression, or to select the connector type
694 for some Ethernet cards.
695 Refer to the man page for the specific driver
696 for more information.
698 .It Fl link Op Cm 0 No - Cm 2
700 Disable special processing at the link level with the specified interface.
702 Put the interface in monitor mode.
703 No packets are transmitted, and received packets are discarded after
707 Take the interface out of monitor mode.
711 This may be used to enable an interface after an
713 It happens automatically when setting the first address on an interface.
714 If the interface was reset when previously marked down,
715 the hardware will be re-initialized.
718 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
719 Note that the address family keyword
722 .Bl -tag -width indent
724 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
728 .Va net.inet6.ip6.accept_rtadv
729 controls whether this flag is set by default or not.
734 Set a flag to control whether routers from which the system accepts
735 Router Advertisement messages will be added to the Default Router List
739 flag is disabled, this flag has no effect.
743 .Va net.inet6.ip6.no_radr
744 controls whether this flag is set by default or not.
748 .It Cm auto_linklocal
749 Set a flag to perform automatic link-local address configuration when
750 the interface becomes available.
754 .Va net.inet6.ip6.auto_linklocal
755 controls whether this flag is set by default or not.
756 .It Cm -auto_linklocal
760 Set the specified interface as the default route when there is no
766 Set a flag to disable all of IPv6 network communications on the
768 Note that if there are already configured IPv6
769 addresses on that interface, all of them are marked as
771 and DAD will be performed when this flag is cleared.
775 When this flag is cleared and
777 flag is enabled, automatic configuration of a link-local address is
780 Set a flag to enable Neighbor Unreachability Detection.
784 .It Cm no_prefer_iface
785 Set a flag to not honor rule 5 of source address selection in RFC 3484.
786 In practice this means the address on the outgoing interface will not be
787 preferred, effectively yielding the decision to the address selection
788 policy table, configurable with
790 .It Cm -no_prefer_iface
792 .Cm no_prefer_iface .
794 Set a flag to disable Duplicate Address Detection.
800 The following parameters are specific for IPv6 addresses.
801 Note that the address family keyword
804 .Bl -tag -width indent
806 Set the IPv6 autoconfigured address bit.
808 Clear the IPv6 autoconfigured address bit.
810 Set the IPv6 deprecated address bit.
812 Clear the IPv6 deprecated address bit.
814 Set preferred lifetime for the address.
816 Set a flag to prefer address as a candidate of the source address for
818 .It Cm -prefer_source
822 Set valid lifetime for the address.
825 The following parameters are specific to cloning
826 IEEE 802.11 wireless interfaces with the
829 .Bl -tag -width indent
830 .It Cm wlandev Ar device
833 as the parent for the cloned device.
834 .It Cm wlanmode Ar mode
835 Specify the operating mode for this cloned device.
853 The operating mode of a cloned interface cannot be changed.
856 mode is actually implemented as an
858 interface with special properties.
859 .It Cm wlanbssid Ar bssid
860 The 802.11 mac address to use for the bssid.
861 This must be specified at create time for a legacy
864 .It Cm wlanaddr Ar address
865 The local mac address.
866 If this is not specified then a mac address will automatically be assigned
867 to the cloned device.
868 Typically this address is the same as the address of the parent device
871 parameter is specified then the driver will craft a unique address for
872 the device (if supported).
876 device as operating in ``legacy mode''.
879 devices have a fixed peer relationship and do not, for example, roam
880 if their peer stops communicating.
881 For completeness a Dynamic WDS (DWDS) interface may marked as
884 Request a unique local mac address for the cloned device.
885 This is only possible if the device supports multiple mac addresses.
886 To force use of the parent's mac address use
889 Mark the cloned interface as depending on hardware support to
890 track received beacons.
891 To have beacons tracked in software use
897 can also be used to indicate no beacons should
898 be transmitted; this can be useful when creating a WDS configuration but
900 interfaces can only be created as companions to an access point.
903 The following parameters are specific to IEEE 802.11 wireless interfaces
907 .Bl -tag -width indent
909 Enable sending and receiving AMPDU frames when using 802.11n (default).
910 The 802.11n specification states a compliant station must be capable
911 of receiving AMPDU frames but transmission is optional.
914 to disable all use of AMPDU with 802.11n.
915 For testing and/or to work around interoperability problems one can use
919 to control use of AMPDU in one direction.
920 .It Cm ampdudensity Ar density
921 Set the AMPDU density parameter used when operating with 802.11n.
922 This parameter controls the inter-packet gap for AMPDU frames.
923 The sending device normally controls this setting but a receiving station
924 may request wider gaps.
927 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
930 is treated the same as 0.
931 .It Cm ampdulimit Ar limit
932 Set the limit on packet size for receiving AMPDU frames when operating
936 are 8192, 16384, 32768, and 65536 but one can also specify
937 just the unique prefix: 8, 16, 32, 64.
938 Note the sender may limit the size of AMPDU frames to be less
939 than the maximum specified by the receiving station.
941 Enable sending and receiving AMSDU frames when using 802.11n.
942 By default AMSDU is received but not transmitted.
945 to disable all use of AMSDU with 802.11n.
946 For testing and/or to work around interoperability problems one can use
950 to control use of AMSDU in one direction.
951 .It Cm amsdulimit Ar limit
952 Set the limit on packet size for sending and receiving AMSDU frames
953 when operating with 802.11n.
956 are 7935 and 3839 (bytes).
957 Note the sender may limit the size of AMSDU frames to be less
958 than the maximum specified by the receiving station.
959 Note also that devices are not required to support the 7935 limit,
960 only 3839 is required by the specification and the larger value
961 may require more memory to be dedicated to support functionality
964 When operating as an access point, pass packets between
965 wireless clients directly (default).
966 To instead let them pass up through the
967 system and be forwarded using some other mechanism, use
969 Disabling the internal bridging
970 is useful when traffic is to be processed with
972 .It Cm authmode Ar mode
973 Set the desired authentication mode in infrastructure mode.
974 Not all adapters support all modes.
977 .Cm none , open , shared
983 (IEEE WPA/WPA2/802.11i).
988 modes are only useful when using an authentication service
989 (a supplicant for client operation or an authenticator when
990 operating as an access point).
991 Modes are case insensitive.
993 Enable background scanning when operating as a station.
994 Background scanning is a technique whereby a station associated to
995 an access point will temporarily leave the channel to scan for
996 neighboring stations.
997 This allows a station to maintain a cache of nearby access points
998 so that roaming between access points can be done without
999 a lengthy scan operation.
1000 Background scanning is done only when a station is not busy and
1001 any outbound traffic will cancel a scan operation.
1002 Background scanning should never cause packets to be lost though
1003 there may be some small latency if outbound traffic interrupts a
1005 By default background scanning is enabled if the device is capable.
1006 To disable background scanning, use
1008 Background scanning is controlled by the
1013 Background scanning must be enabled for roaming; this is an artifact
1014 of the current implementation and may not be required in the future.
1015 .It Cm bgscanidle Ar idletime
1016 Set the minimum time a station must be idle (not transmitting or
1017 receiving frames) before a background scan is initiated.
1020 parameter is specified in milliseconds.
1021 By default a station must be idle at least 250 milliseconds before
1022 a background scan is initiated.
1023 The idle time may not be set to less than 100 milliseconds.
1024 .It Cm bgscanintvl Ar interval
1025 Set the interval at which background scanning is attempted.
1028 parameter is specified in seconds.
1029 By default a background scan is considered every 300 seconds (5 minutes).
1032 may not be set to less than 15 seconds.
1033 .It Cm bintval Ar interval
1034 Set the interval at which beacon frames are sent when operating in
1038 parameter is specified in TU's (1024 usecs).
1039 By default beacon frames are transmitted every 100 TU's.
1040 .It Cm bmissthreshold Ar count
1041 Set the number of consecutive missed beacons at which the station
1042 will attempt to roam (i.e., search for a new access point).
1045 parameter must be in the range 1 to 255; though the
1046 upper bound may be reduced according to device capabilities.
1047 The default threshold is 7 consecutive missed beacons; but
1048 this may be overridden by the device driver.
1049 Another name for the
1053 .It Cm bssid Ar address
1054 Specify the MAC address of the access point to use when operating
1055 as a station in a BSS network.
1056 This overrides any automatic selection done by the system.
1057 To disable a previously selected access point, supply
1062 This option is useful when more than one access point uses the same SSID.
1063 Another name for the
1068 Enable packet bursting.
1069 Packet bursting is a transmission technique whereby the wireless
1070 medium is acquired once to send multiple frames and the interframe
1072 This technique can significantly increase throughput by reducing
1073 transmission overhead.
1074 Packet bursting is supported by the 802.11e QoS specification
1075 and some devices that do not support QoS may still be capable.
1076 By default packet bursting is enabled if a device is capable
1078 To disable packet bursting, use
1080 .It Cm chanlist Ar channels
1081 Set the desired channels to use when scanning for access
1082 points, neighbors in an IBSS network, or looking for unoccupied
1083 channels when operating as an access point.
1084 The set of channels is specified as a comma-separated list with
1085 each element in the list representing either a single channel number or a range
1088 Channel numbers must be in the range 1 to 255 and be permissible
1089 according to the operating characteristics of the device.
1090 .It Cm channel Ar number
1091 Set a single desired channel.
1092 Channels range from 1 to 255, but the exact selection available
1093 depends on the region your adaptor was manufactured for.
1099 will clear any desired channel and, if the device is marked up,
1100 force a scan for a channel to operate on.
1101 Alternatively the frequency, in megahertz, may be specified
1102 instead of the channel number.
1104 When there are several ways to use a channel the channel
1105 number/frequency may be appended with attributes to clarify.
1106 For example, if a device is capable of operating on channel 6
1107 with 802.11n and 802.11g then one can specify that g-only use
1108 should be used by specifying ``6:g''.
1109 Similarly the channel width can be specified by appending it
1110 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1111 These attributes can be combined as in: ``6:ht/40''.
1112 The full set of flags specified following a ``:'' are:
1118 (Atheros Dynamic Turbo mode),
1126 (Atheros Static Turbo mode),
1129 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1130 The full set of channel widths following a '/' are:
1132 (5MHz aka quarter-rate channel),
1134 (10MHz aka half-rate channel),
1136 (20MHz mostly for use in specifying ht20),
1139 (40MHz mostly for use in specifying ht40).
1141 a 40MHz HT channel specification may include the location
1142 of the extension channel by appending ``+'' or ``-'' for above and below,
1143 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1144 with the center channel at frequency 2437 and the extension channel above.
1145 .It Cm country Ar name
1146 Set the country code to use in calculating the regulatory constraints
1148 In particular the set of available channels, how the wireless device
1149 will operation on the channels, and the maximum transmit power that
1150 can be used on a channel are defined by this setting.
1151 Country/Region codes are specified as a 2-character abbreviation
1152 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1153 e.g., "ES" and "Spain".
1154 The set of country codes are taken from
1155 .Pa /etc/regdomain.xml
1157 be viewed with the ``list countries'' request.
1158 Note that not all devices support changing the country code from a default
1159 setting; typically stored in EEPROM.
1167 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1168 DFS embodies several facilities including detection of overlapping
1169 radar signals, dynamic transmit power control, and channel selection
1170 according to a least-congested criteria.
1171 DFS support is mandatory for some 5GHz frequencies in certain
1172 locales (e.g., ETSI).
1173 By default DFS is enabled according to the regulatory definitions
1175 .Pa /etc/regdomain.xml
1176 and the current country code, regdomain,
1178 Note the underlying device (and driver) must support radar detection
1179 for full DFS support to work.
1180 To be fully compliant with the local regulatory agency frequencies that
1181 require DFS should not be used unless it is fully supported.
1184 to disable this functionality for testing.
1186 Enable support for the 802.11d specification (default).
1187 When this support is enabled in station mode, beacon frames that advertise
1188 a country code different than the currently configured country code will
1189 cause an event to be dispatched to user applications.
1190 This event can be used by the station to adopt that country code and
1191 operate according to the associated regulatory constraints.
1192 When operating as an access point with 802.11d enabled the beacon and
1193 probe response frames transmitted will advertise the current regulatory
1195 To disable 802.11d use
1198 Enable 802.11h support including spectrum management.
1199 When 802.11h is enabled beacon and probe response frames will have
1200 the SpectrumMgt bit set in the capabilities field and
1201 country and power constraint information elements will be present.
1202 802.11h support also includes handling Channel Switch Announcements (CSA)
1203 which are a mechanism to coordinate channel changes by an access point.
1204 By default 802.11h is enabled if the device is capable.
1205 To disable 802.11h use
1207 .It Cm deftxkey Ar index
1208 Set the default key to use for transmission.
1209 Typically this is only set when using WEP encryption.
1210 Note that you must set a default transmit key
1211 for the system to know which key to use in encrypting outbound traffic.
1214 is an alias for this request; it is provided for backwards compatibility.
1215 .It Cm dtimperiod Ar period
1218 period for transmitting buffered multicast data frames when
1219 operating in ap mode.
1222 specifies the number of beacon intervals between DTIM
1223 and must be in the range 1 to 15.
1224 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1226 Enable the use of quiet IE.
1227 Hostap will use this to silence other
1228 stations to reduce interference for radar detection when
1229 operating on 5GHz frequency and doth support is enabled.
1232 to disable this functionality.
1233 .It Cm quiet_period Ar period
1236 to the number of beacon intervals between the start of regularly
1237 scheduled quiet intervals defined by Quiet element.
1238 .It Cm quiet_count Ar count
1241 to the number of TBTTs until the beacon interval during which the
1242 next quiet interval shall start.
1243 A value of 1 indicates the quiet
1244 interval will start during the beacon interval starting at the next
1246 A value 0 is reserved.
1247 .It Cm quiet_offset Ar offset
1250 to the offset of the start of the quiet interval from the TBTT
1251 specified by the Quiet count, expressed in TUs.
1254 shall be less than one beacon interval.
1255 .It Cm quiet_duration Ar dur
1258 to the duration of the Quiet interval, expressed in TUs.
1259 The value should be less than beacon interval.
1261 Enable the use of Atheros Dynamic Turbo mode when communicating with
1262 another Dynamic Turbo-capable station.
1263 Dynamic Turbo mode is an Atheros-specific mechanism by which
1264 stations switch between normal 802.11 operation and a ``boosted''
1265 mode in which a 40MHz wide channel is used for communication.
1266 Stations using Dynamic Turbo mode operate boosted only when the
1267 channel is free of non-dturbo stations; when a non-dturbo station
1268 is identified on the channel all stations will automatically drop
1269 back to normal operation.
1270 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1271 Note that turbo mode (dynamic or static) is only allowed on some
1272 channels depending on the regulatory constraints; use the
1274 command to identify the channels where turbo mode may be used.
1275 To disable Dynamic Turbo mode use
1278 Enable Dynamic WDS (DWDS) support.
1279 DWDS is a facility by which 4-address traffic can be carried between
1280 stations operating in infrastructure mode.
1281 A station first associates to an access point and authenticates using
1282 normal procedures (e.g., WPA).
1283 Then 4-address frames are passed to carry traffic for stations
1284 operating on either side of the wireless link.
1285 DWDS extends the normal WDS mechanism by leveraging existing security
1286 protocols and eliminating static binding.
1288 When DWDS is enabled on an access point 4-address frames received from
1289 an authorized station will generate a ``DWDS discovery'' event to user
1291 This event should be used to create a WDS interface that is bound
1292 to the remote station (and usually plumbed into a bridge).
1293 Once the WDS interface is up and running 4-address traffic then logically
1294 flows through that interface.
1296 When DWDS is enabled on a station, traffic with a destination address
1297 different from the peer station are encapsulated in a 4-address frame
1298 and transmitted to the peer.
1299 All 4-address traffic uses the security information of the stations
1300 (e.g., cryptographic keys).
1301 A station is associated using 802.11n facilities may transport
1302 4-address traffic using these same mechanisms; this depends on available
1303 resources and capabilities of the device.
1304 The DWDS implementation guards against layer 2 routing loops of
1307 Enable the use of Atheros Fast Frames when communicating with
1308 another Fast Frames-capable station.
1309 Fast Frames are an encapsulation technique by which two 802.3
1310 frames are transmitted in a single 802.11 frame.
1311 This can noticeably improve throughput but requires that the
1312 receiving station understand how to decapsulate the frame.
1313 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1314 protocol extension so enabling use is safe when communicating with
1315 non-Atheros devices.
1316 By default, use of fast frames is enabled if the device is capable.
1317 To explicitly disable fast frames, use
1319 .It Cm fragthreshold Ar length
1320 Set the threshold for which transmitted frames are broken into fragments.
1323 argument is the frame size in bytes and must be in the range 256 to 2346.
1331 disables transmit fragmentation.
1332 Not all adapters honor the fragmentation threshold.
1334 When operating as an access point, do not broadcast the SSID
1335 in beacon frames or respond to probe request frames unless
1336 they are directed to the ap (i.e., they include the ap's SSID).
1337 By default, the SSID is included in beacon frames and
1338 undirected probe request frames are answered.
1339 To re-enable the broadcast of the SSID etc., use
1342 Enable use of High Throughput (HT) when using 802.11n (default).
1343 The 802.11n specification includes mechanisms for operation
1344 on 20MHz and 40MHz wide channels using different signalling mechanisms
1345 than specified in 802.11b, 802.11g, and 802.11a.
1346 Stations negotiate use of these facilities, termed HT20 and HT40,
1347 when they associate.
1348 To disable all use of 802.11n use
1350 To disable use of HT20 (e.g., to force only HT40 use) use
1352 To disable use of HT40 use
1355 HT configuration is used to ``auto promote'' operation
1356 when several choices are available.
1357 For example, if a station associates to an 11n-capable access point
1358 it controls whether the station uses legacy operation, HT20, or HT40.
1359 When an 11n-capable device is setup as an access point and
1360 Auto Channel Selection is used to locate a channel to operate on,
1361 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1362 on the selected channel.
1363 If a fixed channel is specified for a station then HT configuration can
1364 be given as part of the channel specification; e.g., 6:ht/20 to setup
1365 HT20 operation on channel 6.
1367 Enable use of compatibility support for pre-802.11n devices (default).
1368 The 802.11n protocol specification went through several incompatible iterations.
1369 Some vendors implemented 11n support to older specifications that
1370 will not interoperate with a purely 11n-compliant station.
1371 In particular the information elements included in management frames
1372 for old devices are different.
1373 When compatibility support is enabled both standard and compatible data
1375 Stations that associate using the compatibility mechanisms are flagged
1377 To disable compatibility support use
1379 .It Cm htprotmode Ar technique
1380 For interfaces operating in 802.11n, use the specified
1382 for protecting HT frames in a mixed legacy/HT network.
1383 The set of valid techniques is
1388 Technique names are case insensitive.
1390 Enable inactivity processing for stations associated to an
1391 access point (default).
1392 When operating as an access point the 802.11 layer monitors
1393 the activity of each associated station.
1394 When a station is inactive for 5 minutes it will send several
1395 ``probe frames'' to see if the station is still present.
1396 If no response is received then the station is deauthenticated.
1397 Applications that prefer to handle this work can disable this
1401 Set the location to use in calculating regulatory constraints.
1402 The location is also advertised in beacon and probe response frames
1403 when 802.11d is enabled with
1412 Display the list of channels available for use taking into account
1413 any restrictions set with the
1416 See the description of
1418 for more information.
1420 Display the adaptor's capabilities, including the operating
1423 Display the list of channels available for use.
1424 Channels are shown with their IEEE channel number, equivalent
1425 frequency, and usage modes.
1426 Channels identified as
1431 Channels identified as
1433 may be used only for Atheros' Static Turbo mode
1435 . Cm mediaopt turbo ) .
1436 Channels marked with a
1438 have a regulatory constraint that they be passively scanned.
1439 This means a station is not permitted to transmit on the channel until
1440 it identifies the channel is being used for 802.11 communication;
1441 typically by hearing a beacon frame from an access point operating
1444 is another way of requesting this information.
1445 By default a compacted list of channels is displayed; if the
1447 option is specified then all channels are shown.
1448 .It Cm list countries
1449 Display the set of country codes and regulatory domains that can be
1450 used in regulatory configuration.
1452 Display the current MAC Access Control List state.
1453 Each address is prefixed with a character that indicates the
1454 current policy applied to it:
1456 indicates the address is allowed access,
1458 indicates the address is denied access,
1460 indicates the address is present but the current policy open
1461 (so the ACL is not consulted).
1463 Displays the mesh routing table, used for forwarding packets on a mesh
1465 .It Cm list regdomain
1466 Display the current regulatory settings including the available channels
1467 and transmit power caps.
1469 Display the parameters that govern roaming operation.
1471 Display the parameters that govern transmit operation.
1473 Display the transmit power caps for each channel.
1475 Display the access points and/or ad-hoc neighbors
1476 located in the vicinity.
1477 This information may be updated automatically by the adapter
1480 request or through background scanning.
1481 Depending on the capabilities of the stations the following
1482 flags can be included in the output:
1486 Indicates that the station is permitted to send/receive data frames.
1488 Extended Rate Phy (ERP).
1489 Indicates that the station is operating in an 802.11g network
1490 using extended transmit rates.
1492 High Throughput (HT).
1493 Indicates that the station is using HT transmit rates.
1494 If a `+' follows immediately after then the station associated
1495 using deprecated mechanisms supported only when
1500 Indicates that the station is operating in power save mode.
1502 Quality of Service (QoS).
1503 Indicates that the station is using QoS encapsulation for
1505 QoS encapsulation is enabled only when WME mode is enabled.
1508 Indicates that the station is doing short preamble to optionally
1509 improve throughput performance with 802.11g and 802.11b.
1511 Transitional Security Network (TSN).
1512 Indicates that the station associated using TSN; see also
1516 Wi-Fi Protected Setup (WPS).
1517 Indicates that the station associated using WPS.
1520 By default interesting information elements captured from the neighboring
1521 stations are displayed at the end of each row.
1522 Possible elements include:
1524 (station supports WME),
1526 (station supports WPA),
1528 (station supports WPS),
1530 (station supports 802.11i/RSN),
1532 (station supports 802.11n/HT communication),
1534 (station supports Atheros protocol extensions),
1536 (station supports unknown vendor-specific extensions).
1539 flag is used all the information elements and their
1540 contents will be shown.
1543 flag also enables display of long SSIDs.
1546 command is another way of requesting this information.
1548 When operating as an access point display the stations that are
1549 currently associated.
1550 When operating in ad-hoc mode display stations identified as
1551 neighbors in the IBSS.
1552 When operating in mesh mode display stations identified as
1553 neighbors in the MBSS.
1554 When operating in station mode display the access point.
1555 Capabilities advertised by the stations are described under
1559 Depending on the capabilities of the stations the following
1560 flags can be included in the output:
1564 Indicates that the station is permitted to send/receive data frames.
1566 Extended Rate Phy (ERP).
1567 Indicates that the station is operating in an 802.11g network
1568 using extended transmit rates.
1570 High Throughput (HT).
1571 Indicates that the station is using HT transmit rates.
1572 If a `+' follows immediately after then the station associated
1573 using deprecated mechanisms supported only when
1578 Indicates that the station is operating in power save mode.
1580 Quality of Service (QoS).
1581 Indicates that the station is using QoS encapsulation for
1583 QoS encapsulation is enabled only when WME mode is enabled.
1586 Indicates that the station is doing short preamble to optionally
1587 improve throughput performance with 802.11g and 802.11b.
1589 Transitional Security Network (TSN).
1590 Indicates that the station associated using TSN; see also
1594 Wi-Fi Protected Setup (WPS).
1595 Indicates that the station associated using WPS.
1598 By default information elements received from associated stations
1599 are displayed in a short form; the
1601 flag causes this information to be displayed symbolically.
1603 Display the current channel parameters to use when operating in WME mode.
1606 option is specified then both channel and BSS parameters are displayed
1607 for each AC (first channel, then BSS).
1608 When WME mode is enabled for an adaptor this information will be
1609 displayed with the regular status; this command is mostly useful
1610 for examining parameters when WME mode is disabled.
1611 See the description of the
1613 directive for information on the various parameters.
1614 .It Cm maxretry Ar count
1615 Set the maximum number of tries to use in sending unicast frames.
1616 The default setting is 6 but drivers may override this with a value
1618 .It Cm mcastrate Ar rate
1619 Set the rate for transmitting multicast/broadcast frames.
1620 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1621 This rate should be valid for the current operating conditions;
1622 if an invalid rate is specified drivers are free to chose an
1624 .It Cm mgtrate Ar rate
1625 Set the rate for transmitting management and/or control frames.
1626 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1628 Set the location to use in calculating regulatory constraints.
1629 The location is also advertised in beacon and probe response frames
1630 when 802.11d is enabled with
1639 Enable powersave operation.
1640 When operating as a client, the station will conserve power by
1641 periodically turning off the radio and listening for
1642 messages from the access point telling it there are packets waiting.
1643 The station must then retrieve the packets.
1644 Not all devices support power save operation as a client.
1645 The 802.11 specification requires that all access points support
1646 power save but some drivers do not.
1649 to disable powersave operation when operating as a client.
1650 .It Cm powersavesleep Ar sleep
1651 Set the desired max powersave sleep time in TU's (1024 usecs).
1652 By default the max powersave sleep time is 100 TU's.
1653 .It Cm protmode Ar technique
1654 For interfaces operating in 802.11g, use the specified
1656 for protecting OFDM frames in a mixed 11b/11g network.
1657 The set of valid techniques is
1663 Technique names are case insensitive.
1664 Not all devices support
1666 as a protection technique.
1668 When operating as an access point in 802.11g mode allow only
1669 11g-capable stations to associate (11b-only stations are not
1670 permitted to associate).
1671 To allow both 11g and 11b-only stations to associate, use
1674 When operating as an access point in 802.11n mode allow only
1675 HT-capable stations to associate (legacy stations are not
1676 permitted to associate).
1677 To allow both HT and legacy stations to associate, use
1679 .It Cm regdomain Ar sku
1680 Set the regulatory domain to use in calculating the regulatory constraints
1682 In particular the set of available channels, how the wireless device
1683 will operation on the channels, and the maximum transmit power that
1684 can be used on a channel are defined by this setting.
1685 Regdomain codes (SKU's) are taken from
1686 .Pa /etc/regdomain.xml
1688 be viewed with the ``list countries'' request.
1689 Note that not all devices support changing the regdomain from a default
1690 setting; typically stored in EEPROM.
1698 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1700 Note that RIFS must be supported by both the station and access point
1704 .It Cm roam:rate Ar rate
1705 Set the threshold for controlling roaming when operating in a BSS.
1708 parameter specifies the transmit rate in megabits
1709 at which roaming should be considered.
1710 If the current transmit rate drops below this setting and background scanning
1711 is enabled, then the system will check if a more desirable access point is
1712 available and switch over to it.
1713 The current scan cache contents are used if they are considered
1714 valid according to the
1716 parameter; otherwise a background scan operation is triggered before
1717 any selection occurs.
1718 Each channel type has a separate rate threshold; the default values are:
1719 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1720 .It Cm roam:rssi Ar rssi
1721 Set the threshold for controlling roaming when operating in a BSS.
1724 parameter specifies the receive signal strength in dBm units
1725 at which roaming should be considered.
1726 If the current rssi drops below this setting and background scanning
1727 is enabled, then the system will check if a more desirable access point is
1728 available and switch over to it.
1729 The current scan cache contents are used if they are considered
1730 valid according to the
1732 parameter; otherwise a background scan operation is triggered before
1733 any selection occurs.
1734 Each channel type has a separate rssi threshold; the default values are
1736 .It Cm roaming Ar mode
1737 When operating as a station, control how the system will
1738 behave when communication with the current access point
1742 argument may be one of
1744 (leave it to the hardware device to decide),
1746 (handle either in the device or the operating system\[em]as appropriate),
1748 (do nothing until explicitly instructed).
1749 By default, the device is left to handle this if it is
1750 capable; otherwise, the operating system will automatically
1751 attempt to reestablish communication.
1752 Manual mode is used by applications such as
1753 .Xr wpa_supplicant 8
1754 that want to control the selection of an access point.
1755 .It Cm rtsthreshold Ar length
1756 Set the threshold for which
1757 transmitted frames are preceded by transmission of an
1763 is the frame size in bytes and must be in the range 1 to 2346.
1771 disables transmission of RTS frames.
1772 Not all adapters support setting the RTS threshold.
1774 Initiate a scan of neighboring stations, wait for it to complete, and
1775 display all stations found.
1776 Only the super-user can initiate a scan.
1779 for information on the display.
1780 By default a background scan is done; otherwise a foreground
1781 scan is done and the station may roam to a different access point.
1784 request can be used to show recent scan results without
1785 initiating a new scan.
1786 .It Cm scanvalid Ar threshold
1787 Set the maximum time the scan cache contents are considered valid;
1788 i.e., will be used without first triggering a scan operation to
1792 parameter is specified in seconds and defaults to 60 seconds.
1793 The minimum setting for
1796 One should take care setting this threshold; if it is set too low
1797 then attempts to roam to another access point may trigger unnecessary
1798 background scan operations.
1800 Enable use of Short Guard Interval when operating in 802.11n
1802 NB: this currently enables Short GI on both HT40 and HT20 channels.
1803 To disable Short GI use
1806 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1807 when operating in 802.11n.
1808 A station operating with Static SMPS maintains only a single
1809 receive chain active (this can significantly reduce power consumption).
1813 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1814 when operating in 802.11n.
1815 A station operating with Dynamic SMPS maintains only a single
1816 receive chain active but switches to multiple receive chains when it
1817 receives an RTS frame (this can significantly reduce power consumption).
1818 Note that stations cannot distinguish between RTS/CTS intended to
1819 enable multiple receive chains and those used for other purposes.
1823 Set the desired Service Set Identifier (aka network name).
1824 The SSID is a string up to 32 characters
1825 in length and may be specified as either a normal string or in
1826 hexadecimal when preceded by
1828 Additionally, the SSID may be cleared by setting it to
1830 .It Cm tdmaslot Ar slot
1831 When operating with TDMA, use the specified
1836 is a number between 0 and the maximum number of slots in the BSS.
1837 Note that a station configured as slot 0 is a master and
1838 will broadcast beacon frames advertising the BSS;
1839 stations configured to use other slots will always
1840 scan to locate a master before they ever transmit.
1844 .It Cm tdmaslotcnt Ar cnt
1845 When operating with TDMA, setup a BSS with
1848 The slot count may be at most 8.
1849 The current implementation is only tested with two stations
1850 (i.e., point to point applications).
1851 This setting is only meaningful when a station is configured as slot 0;
1852 other stations adopt this setting from the BSS they join.
1856 .It Cm tdmaslotlen Ar len
1857 When operating with TDMA, setup a BSS such that each station has a slot
1860 The slot length must be at least 150 microseconds (1/8 TU)
1861 and no more than 65 milliseconds.
1862 Note that setting too small a slot length may result in poor channel
1863 bandwidth utilization due to factors such as timer granularity and
1865 This setting is only meaningful when a station is configured as slot 0;
1866 other stations adopt this setting from the BSS they join.
1869 is set to 10 milliseconds.
1870 .It Cm tdmabintval Ar intval
1871 When operating with TDMA, setup a BSS such that beacons are transmitted every
1873 superframes to synchronize the TDMA slot timing.
1874 A superframe is defined as the number of slots times the slot length; e.g.,
1875 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1876 The beacon interval may not be zero.
1879 causes the timers to be resynchronized more often; this can be help if
1880 significant timer drift is observed.
1885 When operating as an access point with WPA/802.11i allow legacy
1886 stations to associate using static key WEP and open authentication.
1887 To disallow legacy station use of WEP, use
1889 .It Cm txpower Ar power
1890 Set the power used to transmit frames.
1893 argument is specified in .5 dBm units.
1894 Out of range values are truncated.
1895 Typically only a few discreet power settings are available and
1896 the driver will use the setting closest to the specified value.
1897 Not all adapters support changing the transmit power.
1898 .It Cm ucastrate Ar rate
1899 Set a fixed rate for transmitting unicast frames.
1900 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1901 This rate should be valid for the current operating conditions;
1902 if an invalid rate is specified drivers are free to chose an
1904 .It Cm wepmode Ar mode
1905 Set the desired WEP mode.
1906 Not all adapters support all modes.
1907 The set of valid modes is
1913 mode explicitly tells the adaptor to allow association with access
1914 points which allow both encrypted and unencrypted traffic.
1917 means that the access point must only allow encrypted connections.
1920 is generally another name for
1922 Modes are case insensitive.
1923 .It Cm weptxkey Ar index
1924 Set the WEP key to be used for transmission.
1925 This is the same as setting the default transmission key with
1927 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1928 Set the selected WEP key.
1931 is not given, key 1 is set.
1932 A WEP key will be either 5 or 13
1933 characters (40 or 104 bits) depending on the local network and the
1934 capabilities of the adaptor.
1935 It may be specified either as a plain
1936 string or as a string of hexadecimal digits preceded by
1938 For maximum portability, hex keys are recommended;
1939 the mapping of text keys to WEP encryption is usually driver-specific.
1942 drivers do this mapping differently to
1944 A key may be cleared by setting it to
1946 If WEP is supported then there are at least four keys.
1947 Some adapters support more than four keys.
1948 If that is the case, then the first four keys
1949 (1-4) will be the standard temporary keys and any others will be adaptor
1950 specific keys such as permanent keys stored in NVRAM.
1952 Note that you must set a default transmit key with
1954 for the system to know which key to use in encrypting outbound traffic.
1956 Enable Wireless Multimedia Extensions (WME) support, if available,
1957 for the specified interface.
1958 WME is a subset of the IEEE 802.11e standard to support the
1959 efficient communication of realtime and multimedia data.
1960 To disable WME support, use
1962 Another name for this parameter is
1965 The following parameters are meaningful only when WME support is in use.
1966 Parameters are specified per-AC (Access Category) and
1967 split into those that are used by a station when acting
1968 as an access point and those for client stations in the BSS.
1969 The latter are received from the access point and may not be changed
1971 The following Access Categories are recognized:
1973 .Bl -tag -width ".Cm AC_BK" -compact
1977 best effort delivery,
1992 AC parameters are case-insensitive.
1993 Traffic classification is done in the operating system using the
1994 vlan priority associated with data frames or the
1995 ToS (Type of Service) indication in IP-encapsulated frames.
1996 If neither information is present, traffic is assigned to the
1997 Best Effort (BE) category.
1998 .Bl -tag -width indent
2000 Set the ACK policy for QoS transmissions by the local station;
2001 this controls whether or not data frames transmitted by a station
2002 require an ACK response from the receiving station.
2003 To disable waiting for an ACK use
2005 This parameter is applied only to the local station.
2007 Enable the Admission Control Mandatory (ACM) mechanism
2008 for transmissions by the local station.
2009 To disable the ACM use
2011 On stations in a BSS this parameter is read-only and indicates
2012 the setting received from the access point.
2013 NB: ACM is not supported right now.
2014 .It Cm aifs Ar ac Ar count
2015 Set the Arbitration Inter Frame Spacing (AIFS)
2016 channel access parameter to use for transmissions
2017 by the local station.
2018 On stations in a BSS this parameter is read-only and indicates
2019 the setting received from the access point.
2020 .It Cm cwmin Ar ac Ar count
2021 Set the CWmin channel access parameter to use for transmissions
2022 by the local station.
2023 On stations in a BSS this parameter is read-only and indicates
2024 the setting received from the access point.
2025 .It Cm cwmax Ar ac Ar count
2026 Set the CWmax channel access parameter to use for transmissions
2027 by the local station.
2028 On stations in a BSS this parameter is read-only and indicates
2029 the setting received from the access point.
2030 .It Cm txoplimit Ar ac Ar limit
2031 Set the Transmission Opportunity Limit channel access parameter
2032 to use for transmissions by the local station.
2033 This parameter defines an interval of time when a WME station
2034 has the right to initiate transmissions onto the wireless medium.
2035 On stations in a BSS this parameter is read-only and indicates
2036 the setting received from the access point.
2037 .It Cm bss:aifs Ar ac Ar count
2038 Set the AIFS channel access parameter to send to stations in a BSS.
2039 This parameter is meaningful only when operating in ap mode.
2040 .It Cm bss:cwmin Ar ac Ar count
2041 Set the CWmin channel access parameter to send to stations in a BSS.
2042 This parameter is meaningful only when operating in ap mode.
2043 .It Cm bss:cwmax Ar ac Ar count
2044 Set the CWmax channel access parameter to send to stations in a BSS.
2045 This parameter is meaningful only when operating in ap mode.
2046 .It Cm bss:txoplimit Ar ac Ar limit
2047 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2048 This parameter is meaningful only when operating in ap mode.
2051 Enable Wireless Privacy Subscriber support.
2052 Note that WPS support requires a WPS-capable supplicant.
2053 To disable this function use
2057 The following parameters support an optional access control list
2058 feature available with some adapters when operating in ap mode; see
2060 This facility allows an access point to accept/deny association
2061 requests based on the MAC address of the station.
2062 Note that this feature does not significantly enhance security
2063 as MAC address spoofing is easy to do.
2064 .Bl -tag -width indent
2065 .It Cm mac:add Ar address
2066 Add the specified MAC address to the database.
2067 Depending on the policy setting association requests from the
2068 specified station will be allowed or denied.
2070 Set the ACL policy to permit association only by
2071 stations registered in the database.
2072 .It Cm mac:del Ar address
2073 Delete the specified MAC address from the database.
2075 Set the ACL policy to deny association only by
2076 stations registered in the database.
2077 .It Cm mac:kick Ar address
2078 Force the specified station to be deauthenticated.
2079 This typically is done to block a station after updating the
2082 Set the ACL policy to allow all stations to associate.
2084 Delete all entries in the database.
2086 Set the ACL policy to permit association only by
2087 stations approved by a RADIUS server.
2088 Note that this feature requires the
2090 program be configured to do the right thing
2091 as it handles the RADIUS processing
2092 (and marks stations as authorized).
2095 The following parameters are related to a wireless interface operating in mesh
2097 .Bl -tag -width indent
2098 .It Cm meshid Ar meshid
2099 Set the desired Mesh Identifier.
2100 The Mesh ID is a string up to 32 characters in length.
2101 A mesh interface must have a Mesh Identifier specified
2102 to reach an operational state.
2103 .It Cm meshttl Ar ttl
2104 Set the desired ``time to live'' for mesh forwarded packets;
2105 this is the number of hops a packet may be forwarded before
2107 The default setting for
2111 Enable or disable peering with neighbor mesh stations.
2112 Stations must peer before any data packets can be exchanged.
2117 Enable or disable forwarding packets by a mesh interface.
2122 This attribute specifies whether or not the mesh STA activates mesh gate
2127 .It Cm meshmetric Ar protocol
2130 as the link metric protocol used on a mesh network.
2131 The default protocol is called
2133 The mesh interface will restart after changing this setting.
2134 .It Cm meshpath Ar protocol
2137 as the path selection protocol used on a mesh network.
2138 The only available protocol at the moment is called
2140 (Hybrid Wireless Mesh Protocol).
2141 The mesh interface will restart after changing this setting.
2142 .It Cm hwmprootmode Ar mode
2143 Stations on a mesh network can operate as ``root nodes.''
2144 Root nodes try to find paths to all mesh nodes and advertise themselves
2146 When there is a root mesh node on a network, other mesh nodes can setup
2147 paths between themselves faster because they can use the root node
2148 to find the destination.
2149 This path may not be the best, but on-demand
2150 routing will eventually find the best path.
2151 The following modes are recognized:
2153 .Bl -tag -width ".Cm PROACTIVE" -compact
2157 Send broadcast path requests every two seconds.
2158 Nodes on the mesh without a path to this root mesh station with try to
2159 discover a path to us.
2161 Send broadcast path requests every two seconds and every node must reply
2162 with a path reply even if it already has a path to this root mesh station.
2164 Send broadcast root announcement (RANN) frames.
2165 Nodes on the mesh without a path to this root mesh station with try to
2166 discover a path to us.
2172 .It Cm hwmpmaxhops Ar cnt
2173 Set the maximum number of hops allowed in an HMWP path to
2175 The default setting for
2180 The following parameters are for compatibility with other systems:
2181 .Bl -tag -width indent
2183 Another name for the
2189 .It Cm stationname Ar name
2190 Set the name of this station.
2191 The station name is not part of the IEEE 802.11
2192 protocol though some interfaces support it.
2194 seems to be meaningful to identical or virtually identical equipment.
2195 Setting the station name is identical in syntax to setting the SSID.
2202 Another way of saying
2208 Another way of saying
2214 Another way of saying:
2215 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2221 .Ar n : k1 , k2 , k3 , k4
2224 Another way of saying
2225 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2230 Another way of saying
2237 The following parameters are specific to bridge interfaces:
2238 .Bl -tag -width indent
2239 .It Cm addm Ar interface
2240 Add the interface named by
2242 as a member of the bridge.
2243 The interface is put into promiscuous mode
2244 so that it can receive every packet sent on the network.
2245 .It Cm deletem Ar interface
2246 Remove the interface named by
2249 Promiscuous mode is disabled on the interface when
2250 it is removed from the bridge.
2251 .It Cm maxaddr Ar size
2252 Set the size of the bridge address cache to
2254 The default is 2000 entries.
2255 .It Cm timeout Ar seconds
2256 Set the timeout of address cache entries to
2261 is zero, then address cache entries will not be expired.
2262 The default is 1200 seconds.
2264 Display the addresses that have been learned by the bridge.
2265 .It Cm static Ar interface-name Ar address
2266 Add a static entry into the address cache pointing to
2267 .Ar interface-name .
2268 Static entries are never aged out of the cache or re-placed, even if the
2269 address is seen on a different interface.
2270 .It Cm deladdr Ar address
2273 from the address cache.
2275 Delete all dynamically-learned addresses from the address cache.
2277 Delete all addresses, including static addresses, from the address cache.
2278 .It Cm discover Ar interface
2279 Mark an interface as a
2282 When the bridge has no address cache entry
2283 (either dynamic or static)
2284 for the destination address of a packet,
2285 the bridge will forward the packet to all
2286 member interfaces marked as
2288 This is the default for all interfaces added to a bridge.
2289 .It Cm -discover Ar interface
2292 attribute on a member interface.
2293 For packets without the
2295 attribute, the only packets forwarded on the interface are broadcast
2296 or multicast packets and packets for which the destination address
2297 is known to be on the interface's segment.
2298 .It Cm learn Ar interface
2299 Mark an interface as a
2302 When a packet arrives on such an interface, the source
2303 address of the packet is entered into the address cache as being a
2304 destination address on the interface's segment.
2305 This is the default for all interfaces added to a bridge.
2306 .It Cm -learn Ar interface
2309 attribute on a member interface.
2310 .It Cm sticky Ar interface
2311 Mark an interface as a
2314 Dynamically learned address entries are treated at static once entered into
2316 Sticky entries are never aged out of the cache or replaced, even if the
2317 address is seen on a different interface.
2318 .It Cm -sticky Ar interface
2321 attribute on a member interface.
2322 .It Cm private Ar interface
2323 Mark an interface as a
2326 A private interface does not forward any traffic to any other port that is also
2327 a private interface.
2328 .It Cm -private Ar interface
2331 attribute on a member interface.
2332 .It Cm span Ar interface
2333 Add the interface named by
2335 as a span port on the bridge.
2336 Span ports transmit a copy of every frame received by the bridge.
2337 This is most useful for snooping a bridged network passively on
2338 another host connected to one of the span ports of the bridge.
2339 .It Cm -span Ar interface
2340 Delete the interface named by
2342 from the list of span ports of the bridge.
2343 .It Cm stp Ar interface
2344 Enable Spanning Tree protocol on
2348 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2349 Spanning Tree is used to detect and remove loops in a network topology.
2350 .It Cm -stp Ar interface
2351 Disable Spanning Tree protocol on
2353 This is the default for all interfaces added to a bridge.
2354 .It Cm edge Ar interface
2358 An edge port connects directly to end stations cannot create bridging
2359 loops in the network, this allows it to transition straight to forwarding.
2360 .It Cm -edge Ar interface
2361 Disable edge status on
2363 .It Cm autoedge Ar interface
2366 to automatically detect edge status.
2367 This is the default for all interfaces added to a bridge.
2368 .It Cm -autoedge Ar interface
2369 Disable automatic edge status on
2371 .It Cm ptp Ar interface
2374 as a point to point link.
2375 This is required for straight transitions to forwarding and
2376 should be enabled on a direct link to another RSTP capable switch.
2377 .It Cm -ptp Ar interface
2378 Disable point to point link status on
2380 This should be disabled for a half duplex link and for an interface
2381 connected to a shared network segment,
2382 like a hub or a wireless network.
2383 .It Cm autoptp Ar interface
2384 Automatically detect the point to point status on
2386 by checking the full duplex link status.
2387 This is the default for interfaces added to the bridge.
2388 .It Cm -autoptp Ar interface
2389 Disable automatic point to point link detection on
2391 .It Cm maxage Ar seconds
2392 Set the time that a Spanning Tree protocol configuration is valid.
2393 The default is 20 seconds.
2394 The minimum is 6 seconds and the maximum is 40 seconds.
2395 .It Cm fwddelay Ar seconds
2396 Set the time that must pass before an interface begins forwarding
2397 packets when Spanning Tree is enabled.
2398 The default is 15 seconds.
2399 The minimum is 4 seconds and the maximum is 30 seconds.
2400 .It Cm hellotime Ar seconds
2401 Set the time between broadcasting of Spanning Tree protocol
2402 configuration messages.
2403 The hello time may only be changed when operating in legacy stp mode.
2404 The default is 2 seconds.
2405 The minimum is 1 second and the maximum is 2 seconds.
2406 .It Cm priority Ar value
2407 Set the bridge priority for Spanning Tree.
2408 The default is 32768.
2409 The minimum is 0 and the maximum is 61440.
2410 .It Cm proto Ar value
2411 Set the Spanning Tree protocol.
2412 The default is rstp.
2413 The available options are stp and rstp.
2414 .It Cm holdcnt Ar value
2415 Set the transmit hold count for Spanning Tree.
2416 This is the number of packets transmitted before being rate limited.
2418 The minimum is 1 and the maximum is 10.
2419 .It Cm ifpriority Ar interface Ar value
2420 Set the Spanning Tree priority of
2425 The minimum is 0 and the maximum is 240.
2426 .It Cm ifpathcost Ar interface Ar value
2427 Set the Spanning Tree path cost of
2431 The default is calculated from the link speed.
2432 To change a previously selected path cost back to automatic, set the
2434 The minimum is 1 and the maximum is 200000000.
2435 .It Cm ifmaxaddr Ar interface Ar size
2436 Set the maximum number of hosts allowed from an interface, packets with unknown
2437 source addresses are dropped until an existing host cache entry expires or is
2439 Set to 0 to disable.
2442 The following parameters are specific to lagg interfaces:
2443 .Bl -tag -width indent
2444 .It Cm laggport Ar interface
2445 Add the interface named by
2447 as a port of the aggregation interface.
2448 .It Cm -laggport Ar interface
2449 Remove the interface named by
2451 from the aggregation interface.
2452 .It Cm laggproto Ar proto
2453 Set the aggregation protocol.
2456 The available options are
2464 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2465 Set the packet layers to hash for aggregation protocols which load balance.
2468 The options can be combined using commas.
2470 .Bl -tag -width ".Cm l2" -compact
2472 src/dst mac address and optional vlan number.
2474 src/dst address for IPv4 or IPv6.
2476 src/dst port for TCP/UDP/SCTP.
2479 Enable local hash computation for RSS hash on the interface.
2484 modes will use the RSS hash from the network card if available
2485 to avoid computing one, this may give poor traffic distribution
2486 if the hash is invalid or uses less of the protocol header information.
2488 disables use of RSS hash from the network card.
2489 The default value can be set via the
2490 .Va net.link.lagg.default_use_flowid
2501 Use the RSS hash from the network card if available.
2502 .It Cm flowid_shift Ar number
2503 Set a shift parameter for RSS local hash computation.
2504 Hash is calculated by using flowid bits in a packet header mbuf
2505 which are shifted by the number of this parameter.
2507 Enable selection of egress ports based on the native
2509 domain for the packets being transmitted.
2510 This is currently only implemented for lacp mode.
2513 hardware, running a kernel compiled with the
2515 option, and when interfaces from multiple
2517 domains are ports of the aggregation interface.
2519 Disable selection of egress ports based on the native
2521 domain for the packets being transmitted.
2522 .It Cm lacp_fast_timeout
2523 Enable lacp fast-timeout on the interface.
2524 .It Cm -lacp_fast_timeout
2525 Disable lacp fast-timeout on the interface.
2527 Enable lacp strict compliance on the interface.
2528 The default value can be set via the
2529 .Va net.link.lagg.lacp.default_strict_mode
2540 Disable lacp strict compliance on the interface.
2543 The following parameters apply to IP tunnel interfaces,
2545 .Bl -tag -width indent
2546 .It Cm tunnel Ar src_addr dest_addr
2547 Configure the physical source and destination address for IP tunnel
2553 are interpreted as the outer source/destination for the encapsulating
2556 Unconfigure the physical source and destination address for IP tunnel
2557 interfaces previously configured with
2560 Another name for the
2563 .It Cm accept_rev_ethip_ver
2564 Set a flag to accept both correct EtherIP packets and ones
2565 with reversed version field.
2567 This is for backward compatibility with
2569 6.2, 6.3, 7.0, and 7.1.
2570 .It Cm -accept_rev_ethip_ver
2572 .Cm accept_rev_ethip_ver .
2573 .It Cm ignore_source
2574 Set a flag to accept encapsulated packets destined to this host
2575 independently from source address.
2576 This may be useful for hosts, that receive encapsulated packets
2577 from the load balancers.
2578 .It Cm -ignore_source
2581 .It Cm send_rev_ethip_ver
2582 Set a flag to send EtherIP packets with reversed version
2583 field intentionally.
2584 Disabled by default.
2585 This is for backward compatibility with
2587 6.2, 6.3, 7.0, and 7.1.
2588 .It Cm -send_rev_ethip_ver
2590 .Cm send_rev_ethip_ver .
2593 The following parameters apply to GRE tunnel interfaces,
2595 .Bl -tag -width indent
2596 .It Cm tunnel Ar src_addr dest_addr
2597 Configure the physical source and destination address for GRE tunnel
2603 are interpreted as the outer source/destination for the encapsulating
2606 Unconfigure the physical source and destination address for GRE tunnel
2607 interfaces previously configured with
2610 Another name for the
2613 .It Cm grekey Ar key
2614 Configure the GRE key to be used for outgoing packets.
2616 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2617 This command will result in a four byte MTU reduction on the interface.
2620 The following parameters are specific to
2623 .Bl -tag -width indent
2624 .It Cm syncdev Ar iface
2625 Use the specified interface
2626 to send and receive pfsync state synchronisation messages.
2628 Stop sending pfsync state synchronisation messages over the network.
2629 .It Cm syncpeer Ar peer_address
2630 Make the pfsync link point-to-point rather than using
2631 multicast to broadcast the state synchronisation messages.
2632 The peer_address is the IP address of the other host taking part in
2635 Broadcast the packets using multicast.
2637 Set the maximum number of updates for a single state which
2638 can be collapsed into one.
2639 This is an 8-bit number; the default value is 128.
2641 Defer transmission of the first packet in a state until a peer has
2642 acknowledged that the associated state has been inserted.
2644 Do not defer the first packet in a state.
2645 This is the default.
2648 The following parameters are specific to
2651 .Bl -tag -width indent
2652 .It Cm vlan Ar vlan_tag
2653 Set the VLAN tag value to
2655 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2656 VLAN header for packets sent from the
2663 must both be set at the same time.
2664 .It Cm vlanpcp Ar priority_code_point
2667 is an 3-bit field which refers to the IEEE 802.1p
2668 class of service and maps to the frame priority level.
2670 Values in order of priority are:
2672 .Pq Dv Background (lowest) ,
2674 .Pq Dv Best effort (default) ,
2676 .Pq Dv Excellent effort ,
2678 .Pq Dv Critical applications ,
2680 .Pq Dv Video, < 100ms latency ,
2682 .Pq Dv Video, < 10ms latency ,
2684 .Pq Dv Internetwork control ,
2686 .Pq Dv Network control (highest) .
2687 .It Cm vlandev Ar iface
2688 Associate the physical interface
2693 Packets transmitted through the
2696 diverted to the specified physical interface
2698 with 802.1Q VLAN encapsulation.
2699 Packets with 802.1Q encapsulation received
2700 by the parent interface with the correct VLAN Identifier will be diverted to
2706 interface is assigned a
2707 copy of the parent interface's flags and the parent's Ethernet address.
2712 must both be set at the same time.
2715 interface already has
2716 a physical interface associated with it, this command will fail.
2718 change the association to another physical interface, the existing
2719 association must be cleared first.
2721 Note: if the hardware tagging capability
2722 is set on the parent interface, the
2725 interface's behavior changes:
2728 interface recognizes that the
2729 parent interface supports insertion and extraction of VLAN tags on its
2730 own (usually in firmware) and that it should pass packets to and from
2731 the parent unaltered.
2732 .It Fl vlandev Op Ar iface
2735 pseudo device, disassociate the parent interface from it.
2736 This breaks the link between the
2738 interface and its parent,
2739 clears its VLAN Identifier, flags and its link address and shuts the interface
2743 argument is useless and hence deprecated.
2746 The following parameters are used to configure
2749 .Bl -tag -width indent
2750 .It Cm vxlanid Ar identifier
2751 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2752 virtual network segment membership of the interface.
2753 .It Cm vxlanlocal Ar address
2754 The source address used in the encapsulating IPv4/IPv6 header.
2755 The address should already be assigned to an existing interface.
2756 When the interface is configured in unicast mode, the listening socket
2757 is bound to this address.
2758 .It Cm vxlanremote Ar address
2759 The interface can be configured in a unicast, or point-to-point, mode
2760 to create a tunnel between two hosts.
2761 This is the IP address of the remote end of the tunnel.
2762 .It Cm vxlangroup Ar address
2763 The interface can be configured in a multicast mode
2764 to create a virtual network of hosts.
2765 This is the IP multicast group address the interface will join.
2766 .It Cm vxlanlocalport Ar port
2767 The port number the interface will listen on.
2768 The default port number is 4789.
2769 .It Cm vxlanremoteport Ar port
2770 The destination port number used in the encapsulating IPv4/IPv6 header.
2771 The remote host should be listening on this port.
2772 The default port number is 4789.
2773 Note some other implementations, such as Linux,
2774 do not default to the IANA assigned port,
2775 but instead listen on port 8472.
2776 .It Cm vxlanportrange Ar low high
2777 The range of source ports used in the encapsulating IPv4/IPv6 header.
2778 The port selected within the range is based on a hash of the inner frame.
2779 A range is useful to provide entropy within the outer IP header
2780 for more effective load balancing.
2781 The default range is between the
2784 .Va net.inet.ip.portrange.first
2786 .Va net.inet.ip.portrange.last
2787 .It Cm vxlantimeout Ar timeout
2788 The maximum time, in seconds, before an entry in the forwarding table
2790 The default is 1200 seconds (20 minutes).
2791 .It Cm vxlanmaxaddr Ar max
2792 The maximum number of entries in the forwarding table.
2793 The default is 2000.
2794 .It Cm vxlandev Ar dev
2795 When the interface is configured in multicast mode, the
2797 interface is used to transmit IP multicast packets.
2798 .It Cm vxlanttl Ar ttl
2799 The TTL used in the encapsulating IPv4/IPv6 header.
2802 The source IP address and inner source Ethernet MAC address of
2803 received packets are used to dynamically populate the forwarding table.
2804 When in multicast mode, an entry in the forwarding table allows the
2805 interface to send the frame directly to the remote host instead of
2806 broadcasting the frame to the multicast group.
2807 This is the default.
2809 The forwarding table is not populated by received packets.
2811 Delete all dynamically-learned addresses from the forwarding table.
2812 .It Cm vxlanflushall
2813 Delete all addresses, including static addresses, from the forwarding table.
2816 The following parameters are used to configure
2818 protocol on an interface:
2819 .Bl -tag -width indent
2821 Set the virtual host ID.
2822 This is a required setting to initiate
2824 If the virtual host ID does not exist yet, it is created and attached to the
2825 interface, otherwise configuration of an existing vhid is adjusted.
2828 keyword is supplied along with an
2832 address, then this address is configured to be run under control of the
2834 Whenever a last address that refers to a particular vhid is removed from an
2835 interface, the vhid is automatically removed from interface and destroyed.
2836 Any other configuration parameters for the
2838 protocol should be supplied along with the
2841 Acceptable values for vhid are 1 to 255.
2842 .It Cm advbase Ar seconds
2843 Specifies the base of the advertisement interval in seconds.
2844 The acceptable values are 1 to 255.
2845 The default value is 1.
2846 .It Cm advskew Ar interval
2847 Specifies the skew to add to the base advertisement interval to
2848 make one host advertise slower than another host.
2849 It is specified in 1/256 of seconds.
2850 The acceptable values are 1 to 254.
2851 The default value is 0.
2852 .It Cm pass Ar phrase
2853 Set the authentication key to
2855 .It Cm state Ar MASTER|BACKUP
2856 Forcibly change state of a given vhid.
2861 utility displays the current configuration for a network interface
2862 when no optional parameters are supplied.
2863 If a protocol family is specified,
2865 will report only the details specific to that protocol family.
2869 flag is passed before an interface name,
2871 will display the capability list and all
2872 of the supported media for the specified interface.
2875 flag is supplied, address lifetime is displayed for IPv6 addresses,
2876 as time offset string.
2880 flag may be used instead of an interface name.
2883 to display information about all interfaces in the system.
2886 flag limits this to interfaces that are down, and
2888 limits this to interfaces that are up.
2889 When no arguments are given,
2895 flag may be used to list all available interfaces on the system, with
2896 no other additional information.
2899 is specified, only interfaces of that type will be listed.
2901 will list only Ethernet adapters, excluding the loopback interface.
2902 Use of this flag is mutually exclusive
2903 with all other flags and commands, except for
2905 (only list interfaces that are down)
2908 (only list interfaces that are up).
2912 flag may be used to get more verbose status for an interface.
2916 flag may be used to list all of the interface cloners available on
2917 the system, with no additional information.
2918 Use of this flag is mutually exclusive with all other flags and commands.
2922 flag causes keying information for the interface, if available, to be
2924 For example, the values of 802.11 WEP keys and
2926 passphrases will be printed, if accessible to the current user.
2927 This information is not printed by default, as it may be considered
2930 If the network interface driver is not present in the kernel then
2932 will attempt to load it.
2935 flag disables this behavior.
2937 Only the super-user may modify the configuration of a network interface.
2939 Assign the IPv4 address
2941 with a network mask of
2945 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
2947 Add the IPv4 address
2949 with the CIDR network prefix
2955 as a synonym for the canonical form of the option
2957 .Dl # ifconfig em0 inet 192.0.2.45/28 add
2959 Remove the IPv4 address
2963 .Dl # ifconfig em0 inet 192.0.2.45 -alias
2965 Enable IPv6 functionality of the interface:
2966 .Dl # ifconfig em0 inet6 -ifdisabled
2968 Add the IPv6 address
2969 .Li 2001:DB8:DBDB::123/48
2972 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2973 Note that lower case hexadecimal IPv6 addresses are acceptable.
2975 Remove the IPv6 address added in the above example,
2978 character as shorthand for the network prefix,
2981 as a synonym for the canonical form of the option
2983 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2985 Configure a single CARP redundant address on igb0, and then switch it
2987 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2988 .Dl # ifconfig igb0 vhid 1 state master
2990 Configure the interface
2992 to use 100baseTX, full duplex Ethernet media options:
2993 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2995 Label the em0 interface as an uplink:
2996 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2998 Create the software network interface
3000 .Dl # ifconfig gif1 create
3002 Destroy the software network interface
3004 .Dl # ifconfig gif1 destroy
3006 Display available wireless networks using
3008 .Dl # ifconfig wlan0 list scan
3010 Display inet and inet6 address subnet masks in CIDR notation
3011 .Dl # ifconfig -f inet:cidr,inet6:cidr
3013 Messages indicating the specified interface does not exist, the
3014 requested address is unknown, or the user is not privileged and
3015 tried to alter an interface's configuration.
3038 Basic IPv6 node operation requires a link-local address on each
3039 interface configured for IPv6.
3040 Normally, such an address is automatically configured by the
3041 kernel on each interface added to the system or enabled; this behavior may
3042 be disabled by setting per-interface flag
3043 .Cm -auto_linklocal .
3044 The default value of this flag is 1 and can be disabled by using the sysctl
3046 .Va net.inet6.ip6.auto_linklocal .
3048 Do not configure IPv6 addresses with no link-local address by using
3050 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob