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 Ns Cm \&: Ns Ar format Ns Op Cm \&, Ns Ar type Ns Cm \& : Ns Ar format ...
59 .Op Fl [gG] Ar groupname
82 utility is used to assign an address
83 to a network interface and/or configure
84 network interface parameters.
87 utility must be used at boot time to define the network address
88 of each interface present on a machine; it may also be used at
89 a later time to redefine an interface's address
90 or other operating parameters.
92 The following options are available:
93 .Bl -tag -width indent
95 For the DARPA-Internet family,
96 the address is either a host name present in the host name data
99 or a DARPA Internet address expressed in the Internet standard
102 It is also possible to use the CIDR notation (also known as the
103 slash notation) to include the netmask.
104 That is, one can specify an address like
109 family, it is also possible to specify the prefix length using the slash
114 parameter below for more information.
115 .\" For the Xerox Network Systems(tm) family,
117 .\" .Ar net:a.b.c.d.e.f ,
120 .\" is the assigned network number (in decimal),
121 .\" and each of the six bytes of the host number,
125 .\" are specified in hexadecimal.
126 .\" The host number may be omitted on IEEE 802 protocol
127 .\" (Ethernet, FDDI, and Token Ring) interfaces,
128 .\" which use the hardware physical address,
129 .\" and on interfaces other than the first.
130 .\" For the ISO family, addresses are specified as a long hexadecimal string,
131 .\" as in the Xerox family.
132 .\" However, two consecutive dots imply a zero
133 .\" byte, and the dots are optional, if the user wishes to (carefully)
134 .\" count out long strings of digits in network byte order.
139 is specified as a series of colon-separated hex digits.
140 This can be used to, for example,
141 set a new MAC address on an Ethernet interface, though the
142 mechanism used is not Ethernet specific.
145 keyword to set a randomly generated MAC address.
146 A randomly-generated MAC address might be the same as one already in use
148 Such duplications are extremely unlikely.
149 If the interface is already
150 up when this option is used, it will be briefly brought down and
151 then brought back up again in order to ensure that the receive
152 filter in the underlying Ethernet hardware is properly reprogrammed.
153 .It Ar address_family
156 which affects interpretation of the remaining parameters.
157 Since an interface can receive transmissions in differing protocols
158 with different naming schemes, specifying the address family is recommended.
159 The address or protocol families currently
165 The default if available is
178 address family has special meaning and is no longer synonymous with
184 will list only Ethernet interfaces, excluding all other interface types,
185 including the loopback interface.
187 Specify the address of the correspondent on the other end
188 of a point to point link.
191 parameter is a string of the form
196 List the interfaces in the given group.
201 can be controlled using the
205 environment variable.
206 The format is specified as a comma separated list of
211 section for more information.
217 .Bl -tag -width ether
219 Adjust the display of inet and inet6 addresses
220 .Bl -tag -width default
222 Display inet and inet6 addresses in the default format,
225 Display inet and inet6 addresses as fully qualified domain names
228 Display inet and inet6 addresses as unqualified hostnames
230 Display inet and inet6 addresses in numeric format
233 Adjust the display of link-level ethernet (MAC) addresses
234 .Bl -tag -width default
236 Separate address segments with a colon
238 Separate address segments with a dash
240 Display ethernet addresses in the default format,
244 Adjust the display of inet address subnet masks:
245 .Bl -tag -width default
247 Display subnet masks in CIDR notation, for example:
249 10.0.0.0/8 or 203.0.113.224/26
251 Display subnet masks in the default format,
254 Display subnet masks in dotted quad notation, for example:
256 255.255.0.0 or 255.255.255.192
258 Display subnet masks in hexadecimal, for example:
260 0xffff0000 or 0xffffffc0
263 Adjust the display of inet6 address prefixes (subnet masks):
264 .Bl -tag -width default
266 Display subnet prefix in CIDR notation, for example:
268 ::1/128 or fe80::1%lo0/64
270 Display subnet prefix in the default format
273 Display subnet prefix in integer format, for example:
279 The following parameters may be set with
281 .Bl -tag -width indent
286 Introduced for compatibility
290 Establish an additional network address for this interface.
291 This is sometimes useful when changing network numbers, and
292 one wishes to accept packets addressed to the old interface.
293 If the address is on the same subnet as the first network address
294 for this interface, a non-conflicting netmask must be given.
299 Remove the network address specified.
300 This would be used if you incorrectly specified an alias, or it
301 was no longer needed.
302 If you have incorrectly set an NS address having the side effect
303 of specifying the host portion, removing all NS addresses will
304 allow you to respecify the host portion.
307 Specify that the address configured is an anycast address.
308 Based on the current specification,
309 only routers may configure anycast addresses.
310 Anycast address will not be used as source address of any of outgoing
313 Enable the use of the Address Resolution Protocol
316 between network level addresses and link level addresses (default).
317 This is currently implemented for mapping between DARPA Internet addresses
318 and IEEE 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
320 Disable the use of the Address Resolution Protocol
323 If the Address Resolution Protocol is enabled,
324 the host will only reply to requests for its addresses,
325 and will never send any requests.
327 If the Address Resolution Protocol is enabled,
328 the host will perform normally,
329 sending out requests and listening for replies.
332 Specify the address to use to represent broadcasts to the
334 The default broadcast address is the address with a host part of all 1's.
336 Enable driver dependent debugging code; usually, this turns on
337 extra console error logging.
339 Disable driver dependent debugging code.
341 Put interface into permanently promiscuous mode.
343 Disable permanently promiscuous mode.
348 .It Cm description Ar value , Cm descr Ar value
349 Specify a description of the interface.
350 This can be used to label interfaces in situations where they may
351 otherwise be difficult to distinguish.
352 .It Cm -description , Cm -descr
353 Clear the interface description.
357 When an interface is marked
359 the system will not attempt to
360 transmit messages through that interface.
361 If possible, the interface will be reset to disable reception as well.
362 This action does not automatically disable routes using the interface.
363 .It Cm group Ar groupname
364 Assign the interface to a
366 Any interface can be in multiple groups.
368 Cloned interfaces are members of their interface family group by default.
369 For example, a PPP interface such as
371 is a member of the PPP interface family group,
373 .\" The interface(s) the default route(s) point to are members of the
376 .It Cm -group Ar groupname
377 Remove the interface from the given
382 (lowermost 64bit of an IPv6 address)
384 .It Cm fib Ar fib_number
385 Specify interface FIB.
388 is assigned to all frames or packets received on that interface.
389 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
390 the default FIB (0) irrespective of the parent interface's FIB.
391 The kernel needs to be tuned to support more than the default FIB
394 kernel configuration option, or the
397 .It Cm tunnelfib Ar fib_number
401 is assigned to all packets encapsulated by tunnel interface, e.g.,
405 .It Cm maclabel Ar label
406 If Mandatory Access Control support is enabled in the kernel,
410 .\" .Xr maclabel 7 ) .
412 If the driver supports the media selection system, set the media type
415 Some interfaces support the mutually exclusive use of one of several
416 different physical media connectors.
417 For example, a 10Mbit/s Ethernet
418 interface might support the use of either AUI
419 or twisted pair connectors.
420 Setting the media type to
422 would change the currently active connector to the AUI port.
425 would activate twisted pair.
426 Refer to the interfaces' driver
427 specific documentation or man page for a complete list of the
429 .It Cm mediaopt Ar opts
430 If the driver supports the media selection system, set the specified
431 media options on the interface.
435 is a comma delimited list of options to apply to the interface.
436 Refer to the interfaces' driver specific man page for a complete
437 list of available options.
438 .It Fl mediaopt Ar opts
439 If the driver supports the media selection system, disable the
440 specified media options on the interface.
442 If the driver supports the media selection system, set the specified
443 operating mode on the interface to
445 For IEEE 802.11 wireless interfaces that support multiple operating modes
446 this directive is used to select between 802.11a
454 Set if the driver supports TX rate limiting.
455 .It Cm inst Ar minst , Cm instance Ar minst
456 Set the media instance to
458 This is useful for devices which have multiple physical layer interfaces
461 Set the interface name to
463 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
464 If the driver supports user-configurable checksum offloading,
465 enable receive (or transmit) checksum offloading on the interface.
466 The feature can be turned on selectively per protocol family.
468 .Cm rxcsum6 , txcsum6
474 Some drivers may not be able to enable these flags independently
475 of each other, so setting one may also set the other.
476 The driver will offload as much checksum work as it can reliably
477 support, the exact level of offloading varies between drivers.
478 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
479 If the driver supports user-configurable checksum offloading,
480 disable receive (or transmit) checksum offloading on the interface.
481 The feature can be turned off selectively per protocol family.
483 .Fl rxcsum6 , txcsum6
489 These settings may not always be independent of each other.
491 If the driver supports
493 segmentation offloading, enable TSO on the interface.
494 Some drivers may not be able to support TSO for
498 packets, so they may enable only one of them.
500 If the driver supports
502 segmentation offloading, disable TSO on the interface.
503 It will always disable TSO for
508 If the driver supports
510 segmentation offloading for
514 use one of these to selectively enabled it only for one protocol family.
516 If the driver supports
518 segmentation offloading for
522 use one of these to selectively disable it only for one protocol family.
524 If the driver supports
526 large receive offloading, enable LRO on the interface.
528 If the driver supports
530 large receive offloading, disable LRO on the interface.
532 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
533 segments the encrypted record into one or more
539 If the driver supports transmit TLS offload,
540 enable transmit TLS offload on the interface.
541 Some drivers may not be able to support transmit TLS offload for
545 packets, so they may enable only one of them.
547 If the driver supports transmit TLS offload,
548 disable transmit TLS offload on the interface.
549 It will always disable TLS for
554 Enable use of rate limiting (packet pacing) for TLS offload.
556 Disable use of rate limiting for TLS offload.
558 If the driver supports extended multi-page
560 buffers, enable them on the interface.
562 If the driver supports extended multi-page
564 biffers, disable them on the interface.
565 .It Cm wol , wol_ucast , wol_mcast , wol_magic
566 Enable Wake On Lan (WOL) support, if available.
567 WOL is a facility whereby a machine in a low power state may be woken
568 in response to a received packet.
569 There are three types of packets that may wake a system:
570 ucast (directed solely to the machine's mac address),
571 mcast (directed to a broadcast or multicast address),
573 magic (unicast or multicast frames with a ``magic contents'').
574 Not all devices support WOL, those that do indicate the mechanisms
575 they support in their capabilities.
577 is a synonym for enabling all available WOL mechanisms.
580 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
581 If the driver offers user-configurable VLAN support, enable
582 reception of extended frames, tag processing in hardware,
583 frame filtering in hardware, checksum offloading, or TSO on VLAN,
585 Note that this must be configured on a physical interface associated with
590 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwtso
591 If the driver offers user-configurable VLAN support, disable
592 reception of extended frames, tag processing in hardware,
593 frame filtering in hardware, or TSO on VLAN,
595 .It Cm vxlanhwcsum , vxlanhwtso
596 If the driver offers user-configurable VXLAN support, enable inner checksum
597 offloading (receive and transmit) or TSO on VXLAN, respectively.
598 Note that this must be configured on a physical interface associated with
603 The physical interface is either the interface specified as the vxlandev
604 or the interface hosting the vxlanlocal address.
605 The driver will offload as much checksum work and TSO as it can reliably
606 support, the exact level of offloading may vary between drivers.
607 .It Fl vxlanhwcsum , vxlanhwtso
608 If the driver offers user-configurable VXLAN support, disable checksum
609 offloading (receive and transmit) or TSO on VXLAN, respectively.
611 Move the interface to the
613 specified by name or JID.
614 If the jail has a virtual network stack, the interface will disappear
615 from the current environment and become visible to the jail.
617 Reclaim the interface from the
619 specified by name or JID.
620 If the jail has a virtual network stack, the interface will disappear
621 from the jail, and become visible to the current network environment.
625 feature and disable interrupts on the interface, if driver supports
630 feature and enable interrupt mode on the interface.
632 Create the specified network pseudo-device.
633 If the interface is given without a unit number, try to create a new
634 device with an arbitrary unit number.
635 If creation of an arbitrary device is successful, the new device name is
636 printed to standard output unless the interface is renamed or destroyed
641 Destroy the specified network pseudo-device.
646 Included for Solaris compatibility.
651 Included for Solaris compatibility.
653 Set the routing metric of the interface to
656 The routing metric is used by the routing protocol
658 Higher metrics have the effect of making a route
659 less favorable; metrics are counted as additional hops
660 to the destination network or host.
662 Set the maximum transmission unit of the interface to
664 default is interface specific.
665 The MTU is used to limit the size of packets that are transmitted on an
667 Not all interfaces support setting the MTU, and some interfaces have
669 .It Cm netmask Ar mask
672 Specify how much of the address to reserve for subdividing
673 networks into sub-networks.
674 The mask includes the network part of the local address
675 and the subnet part, which is taken from the host field of the address.
676 The mask can be specified as a single hexadecimal number
679 with a dot-notation Internet address,
680 or with a pseudo-network name listed in the network table
682 The mask contains 1's for the bit positions in the 32-bit address
683 which are to be used for the network and subnet parts,
684 and 0's for the host part.
685 The mask should contain at least the standard network portion,
686 and the subnet field should be contiguous with the network
689 The netmask can also be specified in CIDR notation after the address.
692 option above for more information.
693 .It Cm prefixlen Ar len
697 bits are reserved for subdividing networks into sub-networks.
700 must be integer, and for syntactical reason it must be between 0 to 128.
701 It is almost always 64 under the current IPv6 assignment rule.
702 If the parameter is omitted, 64 is used.
704 The prefix can also be specified using the slash notation after the address.
707 option above for more information.
712 Introduced for compatibility
716 .It Cm link Op Cm 0 No - Cm 2
718 Enable special processing of the link level of the interface.
719 These three options are interface specific in actual effect, however,
720 they are in general used to select special modes of operation.
722 of this is to enable SLIP compression, or to select the connector type
723 for some Ethernet cards.
724 Refer to the man page for the specific driver
725 for more information.
727 .It Fl link Op Cm 0 No - Cm 2
729 Disable special processing at the link level with the specified interface.
731 Put the interface in monitor mode.
732 No packets are transmitted, and received packets are discarded after
736 Take the interface out of monitor mode.
737 .It Cm pcp Ar priority_code_point
740 is an 3-bit field which refers to the IEEE 802.1p
741 class of service and maps to the frame priority level.
743 Stop tagging packets on the interface w/ the priority code point.
747 This may be used to enable an interface after an
749 It happens automatically when setting the first address on an interface.
750 If the interface was reset when previously marked down,
751 the hardware will be re-initialized.
754 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
755 Note that the address family keyword
758 .Bl -tag -width indent
760 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
764 .Va net.inet6.ip6.accept_rtadv
765 controls whether this flag is set by default or not.
770 Set a flag to control whether routers from which the system accepts
771 Router Advertisement messages will be added to the Default Router List
775 flag is disabled, this flag has no effect.
779 .Va net.inet6.ip6.no_radr
780 controls whether this flag is set by default or not.
784 .It Cm auto_linklocal
785 Set a flag to perform automatic link-local address configuration when
786 the interface becomes available.
790 .Va net.inet6.ip6.auto_linklocal
791 controls whether this flag is set by default or not.
792 .It Cm -auto_linklocal
796 Set the specified interface as the default route when there is no
802 Set a flag to disable all of IPv6 network communications on the
804 Note that if there are already configured IPv6
805 addresses on that interface, all of them are marked as
807 and DAD will be performed when this flag is cleared.
811 When this flag is cleared and
813 flag is enabled, automatic configuration of a link-local address is
816 Set a flag to enable Neighbor Unreachability Detection.
820 .It Cm no_prefer_iface
821 Set a flag to not honor rule 5 of source address selection in RFC 3484.
822 In practice this means the address on the outgoing interface will not be
823 preferred, effectively yielding the decision to the address selection
824 policy table, configurable with
826 .It Cm -no_prefer_iface
828 .Cm no_prefer_iface .
830 Set a flag to disable Duplicate Address Detection.
836 The following parameters are specific for IPv6 addresses.
837 Note that the address family keyword
840 .Bl -tag -width indent
842 Set the IPv6 autoconfigured address bit.
844 Clear the IPv6 autoconfigured address bit.
846 Set the IPv6 deprecated address bit.
848 Clear the IPv6 deprecated address bit.
850 Set preferred lifetime for the address.
852 Set a flag to prefer address as a candidate of the source address for
854 .It Cm -prefer_source
858 Set valid lifetime for the address.
861 The following parameters are specific to cloning
862 IEEE 802.11 wireless interfaces with the
865 .Bl -tag -width indent
866 .It Cm wlandev Ar device
869 as the parent for the cloned device.
870 .It Cm wlanmode Ar mode
871 Specify the operating mode for this cloned device.
889 The operating mode of a cloned interface cannot be changed.
892 mode is actually implemented as an
894 interface with special properties.
895 .It Cm wlanbssid Ar bssid
896 The 802.11 mac address to use for the bssid.
897 This must be specified at create time for a legacy
900 .It Cm wlanaddr Ar address
901 The local mac address.
902 If this is not specified then a mac address will automatically be assigned
903 to the cloned device.
904 Typically this address is the same as the address of the parent device
907 parameter is specified then the driver will craft a unique address for
908 the device (if supported).
912 device as operating in ``legacy mode''.
915 devices have a fixed peer relationship and do not, for example, roam
916 if their peer stops communicating.
917 For completeness a Dynamic WDS (DWDS) interface may marked as
920 Request a unique local mac address for the cloned device.
921 This is only possible if the device supports multiple mac addresses.
922 To force use of the parent's mac address use
925 Mark the cloned interface as depending on hardware support to
926 track received beacons.
927 To have beacons tracked in software use
933 can also be used to indicate no beacons should
934 be transmitted; this can be useful when creating a WDS configuration but
936 interfaces can only be created as companions to an access point.
939 The following parameters are specific to IEEE 802.11 wireless interfaces
943 .Bl -tag -width indent
945 Enable sending and receiving AMPDU frames when using 802.11n (default).
946 The 802.11n specification states a compliant station must be capable
947 of receiving AMPDU frames but transmission is optional.
950 to disable all use of AMPDU with 802.11n.
951 For testing and/or to work around interoperability problems one can use
955 to control use of AMPDU in one direction.
956 .It Cm ampdudensity Ar density
957 Set the AMPDU density parameter used when operating with 802.11n.
958 This parameter controls the inter-packet gap for AMPDU frames.
959 The sending device normally controls this setting but a receiving station
960 may request wider gaps.
963 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
966 is treated the same as 0.
967 .It Cm ampdulimit Ar limit
968 Set the limit on packet size for receiving AMPDU frames when operating
972 are 8192, 16384, 32768, and 65536 but one can also specify
973 just the unique prefix: 8, 16, 32, 64.
974 Note the sender may limit the size of AMPDU frames to be less
975 than the maximum specified by the receiving station.
977 Enable sending and receiving AMSDU frames when using 802.11n.
978 By default AMSDU is received but not transmitted.
981 to disable all use of AMSDU with 802.11n.
982 For testing and/or to work around interoperability problems one can use
986 to control use of AMSDU in one direction.
987 .It Cm amsdulimit Ar limit
988 Set the limit on packet size for sending and receiving AMSDU frames
989 when operating with 802.11n.
992 are 7935 and 3839 (bytes).
993 Note the sender may limit the size of AMSDU frames to be less
994 than the maximum specified by the receiving station.
995 Note also that devices are not required to support the 7935 limit,
996 only 3839 is required by the specification and the larger value
997 may require more memory to be dedicated to support functionality
1000 When operating as an access point, pass packets between
1001 wireless clients directly (default).
1002 To instead let them pass up through the
1003 system and be forwarded using some other mechanism, use
1005 Disabling the internal bridging
1006 is useful when traffic is to be processed with
1008 .It Cm authmode Ar mode
1009 Set the desired authentication mode in infrastructure mode.
1010 Not all adapters support all modes.
1013 .Cm none , open , shared
1019 (IEEE WPA/WPA2/802.11i).
1024 modes are only useful when using an authentication service
1025 (a supplicant for client operation or an authenticator when
1026 operating as an access point).
1027 Modes are case insensitive.
1029 Enable background scanning when operating as a station.
1030 Background scanning is a technique whereby a station associated to
1031 an access point will temporarily leave the channel to scan for
1032 neighboring stations.
1033 This allows a station to maintain a cache of nearby access points
1034 so that roaming between access points can be done without
1035 a lengthy scan operation.
1036 Background scanning is done only when a station is not busy and
1037 any outbound traffic will cancel a scan operation.
1038 Background scanning should never cause packets to be lost though
1039 there may be some small latency if outbound traffic interrupts a
1041 By default background scanning is enabled if the device is capable.
1042 To disable background scanning, use
1044 Background scanning is controlled by the
1049 Background scanning must be enabled for roaming; this is an artifact
1050 of the current implementation and may not be required in the future.
1051 .It Cm bgscanidle Ar idletime
1052 Set the minimum time a station must be idle (not transmitting or
1053 receiving frames) before a background scan is initiated.
1056 parameter is specified in milliseconds.
1057 By default a station must be idle at least 250 milliseconds before
1058 a background scan is initiated.
1059 The idle time may not be set to less than 100 milliseconds.
1060 .It Cm bgscanintvl Ar interval
1061 Set the interval at which background scanning is attempted.
1064 parameter is specified in seconds.
1065 By default a background scan is considered every 300 seconds (5 minutes).
1068 may not be set to less than 15 seconds.
1069 .It Cm bintval Ar interval
1070 Set the interval at which beacon frames are sent when operating in
1074 parameter is specified in TU's (1024 usecs).
1075 By default beacon frames are transmitted every 100 TU's.
1076 .It Cm bmissthreshold Ar count
1077 Set the number of consecutive missed beacons at which the station
1078 will attempt to roam (i.e., search for a new access point).
1081 parameter must be in the range 1 to 255; though the
1082 upper bound may be reduced according to device capabilities.
1083 The default threshold is 7 consecutive missed beacons; but
1084 this may be overridden by the device driver.
1085 Another name for the
1089 .It Cm bssid Ar address
1090 Specify the MAC address of the access point to use when operating
1091 as a station in a BSS network.
1092 This overrides any automatic selection done by the system.
1093 To disable a previously selected access point, supply
1098 This option is useful when more than one access point uses the same SSID.
1099 Another name for the
1104 Enable packet bursting.
1105 Packet bursting is a transmission technique whereby the wireless
1106 medium is acquired once to send multiple frames and the interframe
1108 This technique can significantly increase throughput by reducing
1109 transmission overhead.
1110 Packet bursting is supported by the 802.11e QoS specification
1111 and some devices that do not support QoS may still be capable.
1112 By default packet bursting is enabled if a device is capable
1114 To disable packet bursting, use
1116 .It Cm chanlist Ar channels
1117 Set the desired channels to use when scanning for access
1118 points, neighbors in an IBSS network, or looking for unoccupied
1119 channels when operating as an access point.
1120 The set of channels is specified as a comma-separated list with
1121 each element in the list representing either a single channel number or a range
1124 Channel numbers must be in the range 1 to 255 and be permissible
1125 according to the operating characteristics of the device.
1126 .It Cm channel Ar number
1127 Set a single desired channel.
1128 Channels range from 1 to 255, but the exact selection available
1129 depends on the region your adaptor was manufactured for.
1135 will clear any desired channel and, if the device is marked up,
1136 force a scan for a channel to operate on.
1137 Alternatively the frequency, in megahertz, may be specified
1138 instead of the channel number.
1140 When there are several ways to use a channel the channel
1141 number/frequency may be appended with attributes to clarify.
1142 For example, if a device is capable of operating on channel 6
1143 with 802.11n and 802.11g then one can specify that g-only use
1144 should be used by specifying ``6:g''.
1145 Similarly the channel width can be specified by appending it
1146 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1147 These attributes can be combined as in: ``6:ht/40''.
1148 The full set of flags specified following a ``:'' are:
1154 (Atheros Dynamic Turbo mode),
1162 (Atheros Static Turbo mode),
1165 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1166 The full set of channel widths following a '/' are:
1168 (5MHz aka quarter-rate channel),
1170 (10MHz aka half-rate channel),
1172 (20MHz mostly for use in specifying ht20),
1175 (40MHz mostly for use in specifying ht40).
1177 a 40MHz HT channel specification may include the location
1178 of the extension channel by appending ``+'' or ``-'' for above and below,
1179 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1180 with the center channel at frequency 2437 and the extension channel above.
1181 .It Cm country Ar name
1182 Set the country code to use in calculating the regulatory constraints
1184 In particular the set of available channels, how the wireless device
1185 will operation on the channels, and the maximum transmit power that
1186 can be used on a channel are defined by this setting.
1187 Country/Region codes are specified as a 2-character abbreviation
1188 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1189 e.g., "ES" and "Spain".
1190 The set of country codes are taken from
1191 .Pa /etc/regdomain.xml
1193 be viewed with the ``list countries'' request.
1194 Note that not all devices support changing the country code from a default
1195 setting; typically stored in EEPROM.
1203 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1204 DFS embodies several facilities including detection of overlapping
1205 radar signals, dynamic transmit power control, and channel selection
1206 according to a least-congested criteria.
1207 DFS support is mandatory for some 5GHz frequencies in certain
1208 locales (e.g., ETSI).
1209 By default DFS is enabled according to the regulatory definitions
1211 .Pa /etc/regdomain.xml
1212 and the current country code, regdomain,
1214 Note the underlying device (and driver) must support radar detection
1215 for full DFS support to work.
1216 To be fully compliant with the local regulatory agency frequencies that
1217 require DFS should not be used unless it is fully supported.
1220 to disable this functionality for testing.
1222 Enable support for the 802.11d specification (default).
1223 When this support is enabled in station mode, beacon frames that advertise
1224 a country code different than the currently configured country code will
1225 cause an event to be dispatched to user applications.
1226 This event can be used by the station to adopt that country code and
1227 operate according to the associated regulatory constraints.
1228 When operating as an access point with 802.11d enabled the beacon and
1229 probe response frames transmitted will advertise the current regulatory
1231 To disable 802.11d use
1234 Enable 802.11h support including spectrum management.
1235 When 802.11h is enabled beacon and probe response frames will have
1236 the SpectrumMgt bit set in the capabilities field and
1237 country and power constraint information elements will be present.
1238 802.11h support also includes handling Channel Switch Announcements (CSA)
1239 which are a mechanism to coordinate channel changes by an access point.
1240 By default 802.11h is enabled if the device is capable.
1241 To disable 802.11h use
1243 .It Cm deftxkey Ar index
1244 Set the default key to use for transmission.
1245 Typically this is only set when using WEP encryption.
1246 Note that you must set a default transmit key
1247 for the system to know which key to use in encrypting outbound traffic.
1250 is an alias for this request; it is provided for backwards compatibility.
1251 .It Cm dtimperiod Ar period
1254 period for transmitting buffered multicast data frames when
1255 operating in ap mode.
1258 specifies the number of beacon intervals between DTIM
1259 and must be in the range 1 to 15.
1260 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1262 Enable the use of quiet IE.
1263 Hostap will use this to silence other
1264 stations to reduce interference for radar detection when
1265 operating on 5GHz frequency and doth support is enabled.
1268 to disable this functionality.
1269 .It Cm quiet_period Ar period
1272 to the number of beacon intervals between the start of regularly
1273 scheduled quiet intervals defined by Quiet element.
1274 .It Cm quiet_count Ar count
1277 to the number of TBTTs until the beacon interval during which the
1278 next quiet interval shall start.
1279 A value of 1 indicates the quiet
1280 interval will start during the beacon interval starting at the next
1282 A value 0 is reserved.
1283 .It Cm quiet_offset Ar offset
1286 to the offset of the start of the quiet interval from the TBTT
1287 specified by the Quiet count, expressed in TUs.
1290 shall be less than one beacon interval.
1291 .It Cm quiet_duration Ar dur
1294 to the duration of the Quiet interval, expressed in TUs.
1295 The value should be less than beacon interval.
1297 Enable the use of Atheros Dynamic Turbo mode when communicating with
1298 another Dynamic Turbo-capable station.
1299 Dynamic Turbo mode is an Atheros-specific mechanism by which
1300 stations switch between normal 802.11 operation and a ``boosted''
1301 mode in which a 40MHz wide channel is used for communication.
1302 Stations using Dynamic Turbo mode operate boosted only when the
1303 channel is free of non-dturbo stations; when a non-dturbo station
1304 is identified on the channel all stations will automatically drop
1305 back to normal operation.
1306 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1307 Note that turbo mode (dynamic or static) is only allowed on some
1308 channels depending on the regulatory constraints; use the
1310 command to identify the channels where turbo mode may be used.
1311 To disable Dynamic Turbo mode use
1314 Enable Dynamic WDS (DWDS) support.
1315 DWDS is a facility by which 4-address traffic can be carried between
1316 stations operating in infrastructure mode.
1317 A station first associates to an access point and authenticates using
1318 normal procedures (e.g., WPA).
1319 Then 4-address frames are passed to carry traffic for stations
1320 operating on either side of the wireless link.
1321 DWDS extends the normal WDS mechanism by leveraging existing security
1322 protocols and eliminating static binding.
1324 When DWDS is enabled on an access point 4-address frames received from
1325 an authorized station will generate a ``DWDS discovery'' event to user
1327 This event should be used to create a WDS interface that is bound
1328 to the remote station (and usually plumbed into a bridge).
1329 Once the WDS interface is up and running 4-address traffic then logically
1330 flows through that interface.
1332 When DWDS is enabled on a station, traffic with a destination address
1333 different from the peer station are encapsulated in a 4-address frame
1334 and transmitted to the peer.
1335 All 4-address traffic uses the security information of the stations
1336 (e.g., cryptographic keys).
1337 A station is associated using 802.11n facilities may transport
1338 4-address traffic using these same mechanisms; this depends on available
1339 resources and capabilities of the device.
1340 The DWDS implementation guards against layer 2 routing loops of
1343 Enable the use of Atheros Fast Frames when communicating with
1344 another Fast Frames-capable station.
1345 Fast Frames are an encapsulation technique by which two 802.3
1346 frames are transmitted in a single 802.11 frame.
1347 This can noticeably improve throughput but requires that the
1348 receiving station understand how to decapsulate the frame.
1349 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1350 protocol extension so enabling use is safe when communicating with
1351 non-Atheros devices.
1352 By default, use of fast frames is enabled if the device is capable.
1353 To explicitly disable fast frames, use
1355 .It Cm fragthreshold Ar length
1356 Set the threshold for which transmitted frames are broken into fragments.
1359 argument is the frame size in bytes and must be in the range 256 to 2346.
1367 disables transmit fragmentation.
1368 Not all adapters honor the fragmentation threshold.
1370 When operating as an access point, do not broadcast the SSID
1371 in beacon frames or respond to probe request frames unless
1372 they are directed to the ap (i.e., they include the ap's SSID).
1373 By default, the SSID is included in beacon frames and
1374 undirected probe request frames are answered.
1375 To re-enable the broadcast of the SSID etc., use
1378 Enable use of High Throughput (HT) when using 802.11n (default).
1379 The 802.11n specification includes mechanisms for operation
1380 on 20MHz and 40MHz wide channels using different signalling mechanisms
1381 than specified in 802.11b, 802.11g, and 802.11a.
1382 Stations negotiate use of these facilities, termed HT20 and HT40,
1383 when they associate.
1384 To disable all use of 802.11n use
1386 To disable use of HT20 (e.g., to force only HT40 use) use
1388 To disable use of HT40 use
1391 HT configuration is used to ``auto promote'' operation
1392 when several choices are available.
1393 For example, if a station associates to an 11n-capable access point
1394 it controls whether the station uses legacy operation, HT20, or HT40.
1395 When an 11n-capable device is setup as an access point and
1396 Auto Channel Selection is used to locate a channel to operate on,
1397 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1398 on the selected channel.
1399 If a fixed channel is specified for a station then HT configuration can
1400 be given as part of the channel specification; e.g., 6:ht/20 to setup
1401 HT20 operation on channel 6.
1403 Enable use of compatibility support for pre-802.11n devices (default).
1404 The 802.11n protocol specification went through several incompatible iterations.
1405 Some vendors implemented 11n support to older specifications that
1406 will not interoperate with a purely 11n-compliant station.
1407 In particular the information elements included in management frames
1408 for old devices are different.
1409 When compatibility support is enabled both standard and compatible data
1411 Stations that associate using the compatibility mechanisms are flagged
1413 To disable compatibility support use
1415 .It Cm htprotmode Ar technique
1416 For interfaces operating in 802.11n, use the specified
1418 for protecting HT frames in a mixed legacy/HT network.
1419 The set of valid techniques is
1424 Technique names are case insensitive.
1426 Enable inactivity processing for stations associated to an
1427 access point (default).
1428 When operating as an access point the 802.11 layer monitors
1429 the activity of each associated station.
1430 When a station is inactive for 5 minutes it will send several
1431 ``probe frames'' to see if the station is still present.
1432 If no response is received then the station is deauthenticated.
1433 Applications that prefer to handle this work can disable this
1437 Set the location to use in calculating regulatory constraints.
1438 The location is also advertised in beacon and probe response frames
1439 when 802.11d is enabled with
1448 Display the list of channels available for use taking into account
1449 any restrictions set with the
1452 See the description of
1454 for more information.
1456 Display the adaptor's capabilities, including the operating
1459 Display the list of channels available for use.
1460 Channels are shown with their IEEE channel number, equivalent
1461 frequency, and usage modes.
1462 Channels identified as
1467 Channels identified as
1469 may be used only for Atheros' Static Turbo mode
1471 . Cm mediaopt turbo ) .
1472 Channels marked with a
1474 have a regulatory constraint that they be passively scanned.
1475 This means a station is not permitted to transmit on the channel until
1476 it identifies the channel is being used for 802.11 communication;
1477 typically by hearing a beacon frame from an access point operating
1480 is another way of requesting this information.
1481 By default a compacted list of channels is displayed; if the
1483 option is specified then all channels are shown.
1484 .It Cm list countries
1485 Display the set of country codes and regulatory domains that can be
1486 used in regulatory configuration.
1488 Display the current MAC Access Control List state.
1489 Each address is prefixed with a character that indicates the
1490 current policy applied to it:
1492 indicates the address is allowed access,
1494 indicates the address is denied access,
1496 indicates the address is present but the current policy open
1497 (so the ACL is not consulted).
1499 Displays the mesh routing table, used for forwarding packets on a mesh
1501 .It Cm list regdomain
1502 Display the current regulatory settings including the available channels
1503 and transmit power caps.
1505 Display the parameters that govern roaming operation.
1507 Display the parameters that govern transmit operation.
1509 Display the transmit power caps for each channel.
1511 Display the access points and/or ad-hoc neighbors
1512 located in the vicinity.
1513 This information may be updated automatically by the adapter
1516 request or through background scanning.
1517 Depending on the capabilities of the stations the following
1518 flags can be included in the output:
1525 Poll request capability.
1527 DSSS/OFDM capability.
1529 Extended Service Set (ESS).
1531 Independent Basic Service Set (IBSS).
1534 The station requires authentication.
1536 Robust Secure Network (RSN).
1539 Indicates that the station is doing short preamble to optionally
1540 improve throughput performance with 802.11g and 802.11b.
1542 Pollable capability.
1544 Short slot time capability.
1547 By default interesting information elements captured from the neighboring
1548 stations are displayed at the end of each row.
1549 Possible elements include:
1551 (station supports WME),
1553 (station supports WPA),
1555 (station supports WPS),
1557 (station supports 802.11i/RSN),
1559 (station supports 802.11n/HT communication),
1561 (station supports Atheros protocol extensions),
1563 (station supports unknown vendor-specific extensions).
1566 flag is used all the information elements and their
1567 contents will be shown.
1570 flag also enables display of long SSIDs.
1573 command is another way of requesting this information.
1575 When operating as an access point display the stations that are
1576 currently associated.
1577 When operating in ad-hoc mode display stations identified as
1578 neighbors in the IBSS.
1579 When operating in mesh mode display stations identified as
1580 neighbors in the MBSS.
1581 When operating in station mode display the access point.
1582 Capabilities advertised by the stations are described under
1586 The following flags can be included in the output:
1590 Indicates that the station is permitted to send/receive data frames.
1592 Extended Rate Phy (ERP).
1593 Indicates that the station is operating in an 802.11g network
1594 using extended transmit rates.
1596 High Throughput (HT).
1597 Indicates that the station is using HT transmit rates.
1600 follows immediately after then the station associated
1601 using deprecated mechanisms supported only when
1606 Indicates that the station is operating in power save mode.
1608 Quality of Service (QoS).
1609 Indicates that the station is using QoS encapsulation for
1611 QoS encapsulation is enabled only when WME mode is enabled.
1613 Short GI in HT 40MHz mode enabled.
1616 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1618 Transitional Security Network (TSN).
1619 Indicates that the station associated using TSN; see also
1623 Wi-Fi Protected Setup (WPS).
1624 Indicates that the station associated using WPS.
1626 Short GI in HT 20MHz mode enabled.
1629 By default information elements received from associated stations
1630 are displayed in a short form; the
1632 flag causes this information to be displayed symbolically.
1634 Display the current channel parameters to use when operating in WME mode.
1637 option is specified then both channel and BSS parameters are displayed
1638 for each AC (first channel, then BSS).
1639 When WME mode is enabled for an adaptor this information will be
1640 displayed with the regular status; this command is mostly useful
1641 for examining parameters when WME mode is disabled.
1642 See the description of the
1644 directive for information on the various parameters.
1645 .It Cm maxretry Ar count
1646 Set the maximum number of tries to use in sending unicast frames.
1647 The default setting is 6 but drivers may override this with a value
1649 .It Cm mcastrate Ar rate
1650 Set the rate for transmitting multicast/broadcast frames.
1651 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1652 This rate should be valid for the current operating conditions;
1653 if an invalid rate is specified drivers are free to chose an
1655 .It Cm mgtrate Ar rate
1656 Set the rate for transmitting management and/or control frames.
1657 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1659 Set the location to use in calculating regulatory constraints.
1660 The location is also advertised in beacon and probe response frames
1661 when 802.11d is enabled with
1670 Enable powersave operation.
1671 When operating as a client, the station will conserve power by
1672 periodically turning off the radio and listening for
1673 messages from the access point telling it there are packets waiting.
1674 The station must then retrieve the packets.
1675 Not all devices support power save operation as a client.
1676 The 802.11 specification requires that all access points support
1677 power save but some drivers do not.
1680 to disable powersave operation when operating as a client.
1681 .It Cm powersavesleep Ar sleep
1682 Set the desired max powersave sleep time in TU's (1024 usecs).
1683 By default the max powersave sleep time is 100 TU's.
1684 .It Cm protmode Ar technique
1685 For interfaces operating in 802.11g, use the specified
1687 for protecting OFDM frames in a mixed 11b/11g network.
1688 The set of valid techniques is
1694 Technique names are case insensitive.
1695 Not all devices support
1697 as a protection technique.
1699 When operating as an access point in 802.11g mode allow only
1700 11g-capable stations to associate (11b-only stations are not
1701 permitted to associate).
1702 To allow both 11g and 11b-only stations to associate, use
1705 When operating as an access point in 802.11n mode allow only
1706 HT-capable stations to associate (legacy stations are not
1707 permitted to associate).
1708 To allow both HT and legacy stations to associate, use
1710 .It Cm regdomain Ar sku
1711 Set the regulatory domain to use in calculating the regulatory constraints
1713 In particular the set of available channels, how the wireless device
1714 will operation on the channels, and the maximum transmit power that
1715 can be used on a channel are defined by this setting.
1716 Regdomain codes (SKU's) are taken from
1717 .Pa /etc/regdomain.xml
1719 be viewed with the ``list countries'' request.
1720 Note that not all devices support changing the regdomain from a default
1721 setting; typically stored in EEPROM.
1729 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1731 Note that RIFS must be supported by both the station and access point
1735 .It Cm roam:rate Ar rate
1736 Set the threshold for controlling roaming when operating in a BSS.
1739 parameter specifies the transmit rate in megabits
1740 at which roaming should be considered.
1741 If the current transmit rate drops below this setting and background scanning
1742 is enabled, then the system will check if a more desirable access point is
1743 available and switch over to it.
1744 The current scan cache contents are used if they are considered
1745 valid according to the
1747 parameter; otherwise a background scan operation is triggered before
1748 any selection occurs.
1749 Each channel type has a separate rate threshold; the default values are:
1750 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1751 .It Cm roam:rssi Ar rssi
1752 Set the threshold for controlling roaming when operating in a BSS.
1755 parameter specifies the receive signal strength in dBm units
1756 at which roaming should be considered.
1757 If the current rssi drops below this setting and background scanning
1758 is enabled, then the system will check if a more desirable access point is
1759 available and switch over to it.
1760 The current scan cache contents are used if they are considered
1761 valid according to the
1763 parameter; otherwise a background scan operation is triggered before
1764 any selection occurs.
1765 Each channel type has a separate rssi threshold; the default values are
1767 .It Cm roaming Ar mode
1768 When operating as a station, control how the system will
1769 behave when communication with the current access point
1773 argument may be one of
1775 (leave it to the hardware device to decide),
1777 (handle either in the device or the operating system\[em]as appropriate),
1779 (do nothing until explicitly instructed).
1780 By default, the device is left to handle this if it is
1781 capable; otherwise, the operating system will automatically
1782 attempt to reestablish communication.
1783 Manual mode is used by applications such as
1784 .Xr wpa_supplicant 8
1785 that want to control the selection of an access point.
1786 .It Cm rtsthreshold Ar length
1787 Set the threshold for which
1788 transmitted frames are preceded by transmission of an
1794 is the frame size in bytes and must be in the range 1 to 2346.
1802 disables transmission of RTS frames.
1803 Not all adapters support setting the RTS threshold.
1805 Initiate a scan of neighboring stations, wait for it to complete, and
1806 display all stations found.
1807 Only the super-user can initiate a scan.
1810 for information on the display.
1811 By default a background scan is done; otherwise a foreground
1812 scan is done and the station may roam to a different access point.
1815 request can be used to show recent scan results without
1816 initiating a new scan.
1817 .It Cm scanvalid Ar threshold
1818 Set the maximum time the scan cache contents are considered valid;
1819 i.e., will be used without first triggering a scan operation to
1823 parameter is specified in seconds and defaults to 60 seconds.
1824 The minimum setting for
1827 One should take care setting this threshold; if it is set too low
1828 then attempts to roam to another access point may trigger unnecessary
1829 background scan operations.
1831 Enable use of Short Guard Interval when operating in 802.11n
1833 NB: this currently enables Short GI on both HT40 and HT20 channels.
1834 To disable Short GI use
1837 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1838 when operating in 802.11n.
1839 A station operating with Static SMPS maintains only a single
1840 receive chain active (this can significantly reduce power consumption).
1844 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1845 when operating in 802.11n.
1846 A station operating with Dynamic SMPS maintains only a single
1847 receive chain active but switches to multiple receive chains when it
1848 receives an RTS frame (this can significantly reduce power consumption).
1849 Note that stations cannot distinguish between RTS/CTS intended to
1850 enable multiple receive chains and those used for other purposes.
1854 Set the desired Service Set Identifier (aka network name).
1855 The SSID is a string up to 32 characters
1856 in length and may be specified as either a normal string or in
1857 hexadecimal when preceded by
1859 Additionally, the SSID may be cleared by setting it to
1861 .It Cm tdmaslot Ar slot
1862 When operating with TDMA, use the specified
1867 is a number between 0 and the maximum number of slots in the BSS.
1868 Note that a station configured as slot 0 is a master and
1869 will broadcast beacon frames advertising the BSS;
1870 stations configured to use other slots will always
1871 scan to locate a master before they ever transmit.
1875 .It Cm tdmaslotcnt Ar cnt
1876 When operating with TDMA, setup a BSS with
1879 The slot count may be at most 8.
1880 The current implementation is only tested with two stations
1881 (i.e., point to point applications).
1882 This setting is only meaningful when a station is configured as slot 0;
1883 other stations adopt this setting from the BSS they join.
1887 .It Cm tdmaslotlen Ar len
1888 When operating with TDMA, setup a BSS such that each station has a slot
1891 The slot length must be at least 150 microseconds (1/8 TU)
1892 and no more than 65 milliseconds.
1893 Note that setting too small a slot length may result in poor channel
1894 bandwidth utilization due to factors such as timer granularity and
1896 This setting is only meaningful when a station is configured as slot 0;
1897 other stations adopt this setting from the BSS they join.
1900 is set to 10 milliseconds.
1901 .It Cm tdmabintval Ar intval
1902 When operating with TDMA, setup a BSS such that beacons are transmitted every
1904 superframes to synchronize the TDMA slot timing.
1905 A superframe is defined as the number of slots times the slot length; e.g.,
1906 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1907 The beacon interval may not be zero.
1910 causes the timers to be resynchronized more often; this can be help if
1911 significant timer drift is observed.
1916 When operating as an access point with WPA/802.11i allow legacy
1917 stations to associate using static key WEP and open authentication.
1918 To disallow legacy station use of WEP, use
1920 .It Cm txpower Ar power
1921 Set the power used to transmit frames.
1924 argument is specified in .5 dBm units.
1925 Out of range values are truncated.
1926 Typically only a few discreet power settings are available and
1927 the driver will use the setting closest to the specified value.
1928 Not all adapters support changing the transmit power.
1929 .It Cm ucastrate Ar rate
1930 Set a fixed rate for transmitting unicast frames.
1931 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1932 This rate should be valid for the current operating conditions;
1933 if an invalid rate is specified drivers are free to chose an
1935 .It Cm wepmode Ar mode
1936 Set the desired WEP mode.
1937 Not all adapters support all modes.
1938 The set of valid modes is
1944 mode explicitly tells the adaptor to allow association with access
1945 points which allow both encrypted and unencrypted traffic.
1948 means that the access point must only allow encrypted connections.
1951 is generally another name for
1953 Modes are case insensitive.
1954 .It Cm weptxkey Ar index
1955 Set the WEP key to be used for transmission.
1956 This is the same as setting the default transmission key with
1958 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1959 Set the selected WEP key.
1962 is not given, key 1 is set.
1963 A WEP key will be either 5 or 13
1964 characters (40 or 104 bits) depending on the local network and the
1965 capabilities of the adaptor.
1966 It may be specified either as a plain
1967 string or as a string of hexadecimal digits preceded by
1969 For maximum portability, hex keys are recommended;
1970 the mapping of text keys to WEP encryption is usually driver-specific.
1971 In particular, the Windows drivers do this mapping differently to
1973 A key may be cleared by setting it to
1975 If WEP is supported then there are at least four keys.
1976 Some adapters support more than four keys.
1977 If that is the case, then the first four keys
1978 (1-4) will be the standard temporary keys and any others will be adaptor
1979 specific keys such as permanent keys stored in NVRAM.
1981 Note that you must set a default transmit key with
1983 for the system to know which key to use in encrypting outbound traffic.
1985 Enable Wireless Multimedia Extensions (WME) support, if available,
1986 for the specified interface.
1987 WME is a subset of the IEEE 802.11e standard to support the
1988 efficient communication of realtime and multimedia data.
1989 To disable WME support, use
1991 Another name for this parameter is
1994 The following parameters are meaningful only when WME support is in use.
1995 Parameters are specified per-AC (Access Category) and
1996 split into those that are used by a station when acting
1997 as an access point and those for client stations in the BSS.
1998 The latter are received from the access point and may not be changed
2000 The following Access Categories are recognized:
2002 .Bl -tag -width ".Cm AC_BK" -compact
2006 best effort delivery,
2021 AC parameters are case-insensitive.
2022 Traffic classification is done in the operating system using the
2023 vlan priority associated with data frames or the
2024 ToS (Type of Service) indication in IP-encapsulated frames.
2025 If neither information is present, traffic is assigned to the
2026 Best Effort (BE) category.
2027 .Bl -tag -width indent
2029 Set the ACK policy for QoS transmissions by the local station;
2030 this controls whether or not data frames transmitted by a station
2031 require an ACK response from the receiving station.
2032 To disable waiting for an ACK use
2034 This parameter is applied only to the local station.
2036 Enable the Admission Control Mandatory (ACM) mechanism
2037 for transmissions by the local station.
2038 To disable the ACM use
2040 On stations in a BSS this parameter is read-only and indicates
2041 the setting received from the access point.
2042 NB: ACM is not supported right now.
2043 .It Cm aifs Ar ac Ar count
2044 Set the Arbitration Inter Frame Spacing (AIFS)
2045 channel access parameter to use for transmissions
2046 by the local station.
2047 On stations in a BSS this parameter is read-only and indicates
2048 the setting received from the access point.
2049 .It Cm cwmin Ar ac Ar count
2050 Set the CWmin channel access parameter to use for transmissions
2051 by the local station.
2052 On stations in a BSS this parameter is read-only and indicates
2053 the setting received from the access point.
2054 .It Cm cwmax Ar ac Ar count
2055 Set the CWmax channel access parameter to use for transmissions
2056 by the local station.
2057 On stations in a BSS this parameter is read-only and indicates
2058 the setting received from the access point.
2059 .It Cm txoplimit Ar ac Ar limit
2060 Set the Transmission Opportunity Limit channel access parameter
2061 to use for transmissions by the local station.
2062 This parameter defines an interval of time when a WME station
2063 has the right to initiate transmissions onto the wireless medium.
2064 On stations in a BSS this parameter is read-only and indicates
2065 the setting received from the access point.
2066 .It Cm bss:aifs Ar ac Ar count
2067 Set the AIFS channel access parameter to send to stations in a BSS.
2068 This parameter is meaningful only when operating in ap mode.
2069 .It Cm bss:cwmin Ar ac Ar count
2070 Set the CWmin channel access parameter to send to stations in a BSS.
2071 This parameter is meaningful only when operating in ap mode.
2072 .It Cm bss:cwmax Ar ac Ar count
2073 Set the CWmax channel access parameter to send to stations in a BSS.
2074 This parameter is meaningful only when operating in ap mode.
2075 .It Cm bss:txoplimit Ar ac Ar limit
2076 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2077 This parameter is meaningful only when operating in ap mode.
2080 Enable Wireless Privacy Subscriber support.
2081 Note that WPS support requires a WPS-capable supplicant.
2082 To disable this function use
2086 The following parameters support an optional access control list
2087 feature available with some adapters when operating in ap mode; see
2089 This facility allows an access point to accept/deny association
2090 requests based on the MAC address of the station.
2091 Note that this feature does not significantly enhance security
2092 as MAC address spoofing is easy to do.
2093 .Bl -tag -width indent
2094 .It Cm mac:add Ar address
2095 Add the specified MAC address to the database.
2096 Depending on the policy setting association requests from the
2097 specified station will be allowed or denied.
2099 Set the ACL policy to permit association only by
2100 stations registered in the database.
2101 .It Cm mac:del Ar address
2102 Delete the specified MAC address from the database.
2104 Set the ACL policy to deny association only by
2105 stations registered in the database.
2106 .It Cm mac:kick Ar address
2107 Force the specified station to be deauthenticated.
2108 This typically is done to block a station after updating the
2111 Set the ACL policy to allow all stations to associate.
2113 Delete all entries in the database.
2115 Set the ACL policy to permit association only by
2116 stations approved by a RADIUS server.
2117 Note that this feature requires the
2119 program be configured to do the right thing
2120 as it handles the RADIUS processing
2121 (and marks stations as authorized).
2124 The following parameters are related to a wireless interface operating in mesh
2126 .Bl -tag -width indent
2127 .It Cm meshid Ar meshid
2128 Set the desired Mesh Identifier.
2129 The Mesh ID is a string up to 32 characters in length.
2130 A mesh interface must have a Mesh Identifier specified
2131 to reach an operational state.
2132 .It Cm meshttl Ar ttl
2133 Set the desired ``time to live'' for mesh forwarded packets;
2134 this is the number of hops a packet may be forwarded before
2136 The default setting for
2140 Enable or disable peering with neighbor mesh stations.
2141 Stations must peer before any data packets can be exchanged.
2146 Enable or disable forwarding packets by a mesh interface.
2151 This attribute specifies whether or not the mesh STA activates mesh gate
2156 .It Cm meshmetric Ar protocol
2159 as the link metric protocol used on a mesh network.
2160 The default protocol is called
2162 The mesh interface will restart after changing this setting.
2163 .It Cm meshpath Ar protocol
2166 as the path selection protocol used on a mesh network.
2167 The only available protocol at the moment is called
2169 (Hybrid Wireless Mesh Protocol).
2170 The mesh interface will restart after changing this setting.
2171 .It Cm hwmprootmode Ar mode
2172 Stations on a mesh network can operate as ``root nodes.''
2173 Root nodes try to find paths to all mesh nodes and advertise themselves
2175 When there is a root mesh node on a network, other mesh nodes can setup
2176 paths between themselves faster because they can use the root node
2177 to find the destination.
2178 This path may not be the best, but on-demand
2179 routing will eventually find the best path.
2180 The following modes are recognized:
2182 .Bl -tag -width ".Cm PROACTIVE" -compact
2186 Send broadcast path requests every two seconds.
2187 Nodes on the mesh without a path to this root mesh station with try to
2188 discover a path to us.
2190 Send broadcast path requests every two seconds and every node must reply
2191 with a path reply even if it already has a path to this root mesh station.
2193 Send broadcast root announcement (RANN) frames.
2194 Nodes on the mesh without a path to this root mesh station with try to
2195 discover a path to us.
2201 .It Cm hwmpmaxhops Ar cnt
2202 Set the maximum number of hops allowed in an HMWP path to
2204 The default setting for
2209 The following parameters are for compatibility with other systems:
2210 .Bl -tag -width indent
2212 Another name for the
2218 .It Cm stationname Ar name
2219 Set the name of this station.
2220 The station name is not part of the IEEE 802.11
2221 protocol though some interfaces support it.
2223 seems to be meaningful to identical or virtually identical equipment.
2224 Setting the station name is identical in syntax to setting the SSID.
2231 Another way of saying
2237 Another way of saying
2243 Another way of saying:
2244 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2250 .Ar n : k1 , k2 , k3 , k4
2253 Another way of saying
2254 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2259 Another way of saying
2266 The following parameters are specific to bridge interfaces:
2267 .Bl -tag -width indent
2268 .It Cm addm Ar interface
2269 Add the interface named by
2271 as a member of the bridge.
2272 The interface is put into promiscuous mode
2273 so that it can receive every packet sent on the network.
2274 .It Cm deletem Ar interface
2275 Remove the interface named by
2278 Promiscuous mode is disabled on the interface when
2279 it is removed from the bridge.
2280 .It Cm maxaddr Ar size
2281 Set the size of the bridge address cache to
2283 The default is 2000 entries.
2284 .It Cm timeout Ar seconds
2285 Set the timeout of address cache entries to
2290 is zero, then address cache entries will not be expired.
2291 The default is 1200 seconds.
2293 Display the addresses that have been learned by the bridge.
2294 .It Cm static Ar interface-name Ar address
2295 Add a static entry into the address cache pointing to
2296 .Ar interface-name .
2297 Static entries are never aged out of the cache or re-placed, even if the
2298 address is seen on a different interface.
2299 .It Cm deladdr Ar address
2302 from the address cache.
2304 Delete all dynamically-learned addresses from the address cache.
2306 Delete all addresses, including static addresses, from the address cache.
2307 .It Cm discover Ar interface
2308 Mark an interface as a
2311 When the bridge has no address cache entry
2312 (either dynamic or static)
2313 for the destination address of a packet,
2314 the bridge will forward the packet to all
2315 member interfaces marked as
2317 This is the default for all interfaces added to a bridge.
2318 .It Cm -discover Ar interface
2321 attribute on a member interface.
2322 For packets without the
2324 attribute, the only packets forwarded on the interface are broadcast
2325 or multicast packets and packets for which the destination address
2326 is known to be on the interface's segment.
2327 .It Cm learn Ar interface
2328 Mark an interface as a
2331 When a packet arrives on such an interface, the source
2332 address of the packet is entered into the address cache as being a
2333 destination address on the interface's segment.
2334 This is the default for all interfaces added to a bridge.
2335 .It Cm -learn Ar interface
2338 attribute on a member interface.
2339 .It Cm sticky Ar interface
2340 Mark an interface as a
2343 Dynamically learned address entries are treated at static once entered into
2345 Sticky entries are never aged out of the cache or replaced, even if the
2346 address is seen on a different interface.
2347 .It Cm -sticky Ar interface
2350 attribute on a member interface.
2351 .It Cm private Ar interface
2352 Mark an interface as a
2355 A private interface does not forward any traffic to any other port that is also
2356 a private interface.
2357 .It Cm -private Ar interface
2360 attribute on a member interface.
2361 .It Cm span Ar interface
2362 Add the interface named by
2364 as a span port on the bridge.
2365 Span ports transmit a copy of every frame received by the bridge.
2366 This is most useful for snooping a bridged network passively on
2367 another host connected to one of the span ports of the bridge.
2368 .It Cm -span Ar interface
2369 Delete the interface named by
2371 from the list of span ports of the bridge.
2372 .It Cm stp Ar interface
2373 Enable Spanning Tree protocol on
2377 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2378 Spanning Tree is used to detect and remove loops in a network topology.
2379 .It Cm -stp Ar interface
2380 Disable Spanning Tree protocol on
2382 This is the default for all interfaces added to a bridge.
2383 .It Cm edge Ar interface
2387 An edge port connects directly to end stations cannot create bridging
2388 loops in the network, this allows it to transition straight to forwarding.
2389 .It Cm -edge Ar interface
2390 Disable edge status on
2392 .It Cm autoedge Ar interface
2395 to automatically detect edge status.
2396 This is the default for all interfaces added to a bridge.
2397 .It Cm -autoedge Ar interface
2398 Disable automatic edge status on
2400 .It Cm ptp Ar interface
2403 as a point to point link.
2404 This is required for straight transitions to forwarding and
2405 should be enabled on a direct link to another RSTP capable switch.
2406 .It Cm -ptp Ar interface
2407 Disable point to point link status on
2409 This should be disabled for a half duplex link and for an interface
2410 connected to a shared network segment,
2411 like a hub or a wireless network.
2412 .It Cm autoptp Ar interface
2413 Automatically detect the point to point status on
2415 by checking the full duplex link status.
2416 This is the default for interfaces added to the bridge.
2417 .It Cm -autoptp Ar interface
2418 Disable automatic point to point link detection on
2420 .It Cm maxage Ar seconds
2421 Set the time that a Spanning Tree protocol configuration is valid.
2422 The default is 20 seconds.
2423 The minimum is 6 seconds and the maximum is 40 seconds.
2424 .It Cm fwddelay Ar seconds
2425 Set the time that must pass before an interface begins forwarding
2426 packets when Spanning Tree is enabled.
2427 The default is 15 seconds.
2428 The minimum is 4 seconds and the maximum is 30 seconds.
2429 .It Cm hellotime Ar seconds
2430 Set the time between broadcasting of Spanning Tree protocol
2431 configuration messages.
2432 The hello time may only be changed when operating in legacy stp mode.
2433 The default is 2 seconds.
2434 The minimum is 1 second and the maximum is 2 seconds.
2435 .It Cm priority Ar value
2436 Set the bridge priority for Spanning Tree.
2437 The default is 32768.
2438 The minimum is 0 and the maximum is 61440.
2439 .It Cm proto Ar value
2440 Set the Spanning Tree protocol.
2441 The default is rstp.
2442 The available options are stp and rstp.
2443 .It Cm holdcnt Ar value
2444 Set the transmit hold count for Spanning Tree.
2445 This is the number of packets transmitted before being rate limited.
2447 The minimum is 1 and the maximum is 10.
2448 .It Cm ifpriority Ar interface Ar value
2449 Set the Spanning Tree priority of
2454 The minimum is 0 and the maximum is 240.
2455 .It Cm ifpathcost Ar interface Ar value
2456 Set the Spanning Tree path cost of
2460 The default is calculated from the link speed.
2461 To change a previously selected path cost back to automatic, set the
2463 The minimum is 1 and the maximum is 200000000.
2464 .It Cm ifmaxaddr Ar interface Ar size
2465 Set the maximum number of hosts allowed from an interface, packets with unknown
2466 source addresses are dropped until an existing host cache entry expires or is
2468 Set to 0 to disable.
2471 The following parameters are specific to lagg interfaces:
2472 .Bl -tag -width indent
2473 .It Cm laggtype Ar type
2474 When creating a lagg interface the type can be specified as either
2478 If not specified ethernet is the default lagg type.
2479 .It Cm laggport Ar interface
2480 Add the interface named by
2482 as a port of the aggregation interface.
2483 .It Cm -laggport Ar interface
2484 Remove the interface named by
2486 from the aggregation interface.
2487 .It Cm laggproto Ar proto
2488 Set the aggregation protocol.
2491 The available options are
2499 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2500 Set the packet layers to hash for aggregation protocols which load balance.
2503 The options can be combined using commas.
2505 .Bl -tag -width ".Cm l2" -compact
2507 src/dst mac address and optional vlan number.
2509 src/dst address for IPv4 or IPv6.
2511 src/dst port for TCP/UDP/SCTP.
2514 Enable local hash computation for RSS hash on the interface.
2519 modes will use the RSS hash from the network card if available
2520 to avoid computing one, this may give poor traffic distribution
2521 if the hash is invalid or uses less of the protocol header information.
2523 disables use of RSS hash from the network card.
2524 The default value can be set via the
2525 .Va net.link.lagg.default_use_flowid
2536 Use the RSS hash from the network card if available.
2537 .It Cm flowid_shift Ar number
2538 Set a shift parameter for RSS local hash computation.
2539 Hash is calculated by using flowid bits in a packet header mbuf
2540 which are shifted by the number of this parameter.
2542 Enable selection of egress ports based on the native
2544 domain for the packets being transmitted.
2545 This is currently only implemented for lacp mode.
2548 hardware, running a kernel compiled with the
2550 option, and when interfaces from multiple
2552 domains are ports of the aggregation interface.
2554 Disable selection of egress ports based on the native
2556 domain for the packets being transmitted.
2557 .It Cm lacp_fast_timeout
2558 Enable lacp fast-timeout on the interface.
2559 .It Cm -lacp_fast_timeout
2560 Disable lacp fast-timeout on the interface.
2562 Enable lacp strict compliance on the interface.
2563 The default value can be set via the
2564 .Va net.link.lagg.lacp.default_strict_mode
2575 Disable lacp strict compliance on the interface.
2576 .It Cm rr_limit Ar number
2577 Configure a stride for an interface in round-robin mode.
2578 The default stride is 1.
2581 The following parameters apply to IP tunnel interfaces,
2583 .Bl -tag -width indent
2584 .It Cm tunnel Ar src_addr dest_addr
2585 Configure the physical source and destination address for IP tunnel
2591 are interpreted as the outer source/destination for the encapsulating
2594 Unconfigure the physical source and destination address for IP tunnel
2595 interfaces previously configured with
2598 Another name for the
2601 .It Cm accept_rev_ethip_ver
2602 Set a flag to accept both correct EtherIP packets and ones
2603 with reversed version field.
2605 This is for backward compatibility with
2607 6.2, 6.3, 7.0, and 7.1.
2608 .It Cm -accept_rev_ethip_ver
2610 .Cm accept_rev_ethip_ver .
2611 .It Cm ignore_source
2612 Set a flag to accept encapsulated packets destined to this host
2613 independently from source address.
2614 This may be useful for hosts, that receive encapsulated packets
2615 from the load balancers.
2616 .It Cm -ignore_source
2619 .It Cm send_rev_ethip_ver
2620 Set a flag to send EtherIP packets with reversed version
2621 field intentionally.
2622 Disabled by default.
2623 This is for backward compatibility with
2625 6.2, 6.3, 7.0, and 7.1.
2626 .It Cm -send_rev_ethip_ver
2628 .Cm send_rev_ethip_ver .
2631 The following parameters apply to GRE tunnel interfaces,
2633 .Bl -tag -width indent
2634 .It Cm tunnel Ar src_addr dest_addr
2635 Configure the physical source and destination address for GRE tunnel
2641 are interpreted as the outer source/destination for the encapsulating
2644 Unconfigure the physical source and destination address for GRE tunnel
2645 interfaces previously configured with
2648 Another name for the
2651 .It Cm grekey Ar key
2652 Configure the GRE key to be used for outgoing packets.
2654 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2655 This command will result in a four byte MTU reduction on the interface.
2658 The following parameters are specific to
2661 .Bl -tag -width indent
2662 .It Cm syncdev Ar iface
2663 Use the specified interface
2664 to send and receive pfsync state synchronisation messages.
2666 Stop sending pfsync state synchronisation messages over the network.
2667 .It Cm syncpeer Ar peer_address
2668 Make the pfsync link point-to-point rather than using
2669 multicast to broadcast the state synchronisation messages.
2670 The peer_address is the IP address of the other host taking part in
2673 Broadcast the packets using multicast.
2675 Set the maximum number of updates for a single state which
2676 can be collapsed into one.
2677 This is an 8-bit number; the default value is 128.
2679 Defer transmission of the first packet in a state until a peer has
2680 acknowledged that the associated state has been inserted.
2682 Do not defer the first packet in a state.
2683 This is the default.
2686 The following parameters are specific to
2689 .Bl -tag -width indent
2690 .It Cm vlan Ar vlan_tag
2691 Set the VLAN tag value to
2693 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2694 or 802.1ad VLAN header for packets sent from the
2701 must both be set at the same time.
2702 .It Cm vlanproto Ar vlan_proto
2703 Set the VLAN encapsulation protocol to
2705 Supported encapsulation protocols are currently
2709 The default encapsulation protocol is
2713 protocol is also commonly known as
2715 either name can be used.
2716 .It Cm vlanpcp Ar priority_code_point
2719 is an 3-bit field which refers to the IEEE 802.1p
2720 class of service and maps to the frame priority level.
2722 Values in order of priority are:
2724 .Pq Dv Background (lowest) ,
2726 .Pq Dv Best effort (default) ,
2728 .Pq Dv Excellent effort ,
2730 .Pq Dv Critical applications ,
2732 .Pq Dv Video, < 100ms latency and jitter ,
2734 .Pq Dv Voice, < 10ms latency and jitter ,
2736 .Pq Dv Internetwork control ,
2738 .Pq Dv Network control (highest) .
2739 .It Cm vlandev Ar iface
2740 Associate the physical interface
2745 Packets transmitted through the
2748 diverted to the specified physical interface
2750 with 802.1Q VLAN encapsulation.
2751 Packets with 802.1Q encapsulation received
2752 by the parent interface with the correct VLAN Identifier will be diverted to
2758 interface is assigned a
2759 copy of the parent interface's flags and the parent's Ethernet address.
2764 must both be set at the same time.
2767 interface already has
2768 a physical interface associated with it, this command will fail.
2770 change the association to another physical interface, the existing
2771 association must be cleared first.
2773 Note: if the hardware tagging capability
2774 is set on the parent interface, the
2777 interface's behavior changes:
2780 interface recognizes that the
2781 parent interface supports insertion and extraction of VLAN tags on its
2782 own (usually in firmware) and that it should pass packets to and from
2783 the parent unaltered.
2784 .It Fl vlandev Op Ar iface
2787 pseudo device, disassociate the parent interface from it.
2788 This breaks the link between the
2790 interface and its parent,
2791 clears its VLAN Identifier, flags and its link address and shuts the interface
2795 argument is useless and hence deprecated.
2798 The following parameters are used to configure
2801 .Bl -tag -width indent
2802 .It Cm vxlanid Ar identifier
2803 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2804 virtual network segment membership of the interface.
2805 .It Cm vxlanlocal Ar address
2806 The source address used in the encapsulating IPv4/IPv6 header.
2807 The address should already be assigned to an existing interface.
2808 When the interface is configured in unicast mode, the listening socket
2809 is bound to this address.
2810 .It Cm vxlanremote Ar address
2811 The interface can be configured in a unicast, or point-to-point, mode
2812 to create a tunnel between two hosts.
2813 This is the IP address of the remote end of the tunnel.
2814 .It Cm vxlangroup Ar address
2815 The interface can be configured in a multicast mode
2816 to create a virtual network of hosts.
2817 This is the IP multicast group address the interface will join.
2818 .It Cm vxlanlocalport Ar port
2819 The port number the interface will listen on.
2820 The default port number is 4789.
2821 .It Cm vxlanremoteport Ar port
2822 The destination port number used in the encapsulating IPv4/IPv6 header.
2823 The remote host should be listening on this port.
2824 The default port number is 4789.
2825 Note some other implementations, such as Linux,
2826 do not default to the IANA assigned port,
2827 but instead listen on port 8472.
2828 .It Cm vxlanportrange Ar low high
2829 The range of source ports used in the encapsulating IPv4/IPv6 header.
2830 The port selected within the range is based on a hash of the inner frame.
2831 A range is useful to provide entropy within the outer IP header
2832 for more effective load balancing.
2833 The default range is between the
2836 .Va net.inet.ip.portrange.first
2838 .Va net.inet.ip.portrange.last
2839 .It Cm vxlantimeout Ar timeout
2840 The maximum time, in seconds, before an entry in the forwarding table
2842 The default is 1200 seconds (20 minutes).
2843 .It Cm vxlanmaxaddr Ar max
2844 The maximum number of entries in the forwarding table.
2845 The default is 2000.
2846 .It Cm vxlandev Ar dev
2847 When the interface is configured in multicast mode, the
2849 interface is used to transmit IP multicast packets.
2850 .It Cm vxlanttl Ar ttl
2851 The TTL used in the encapsulating IPv4/IPv6 header.
2854 The source IP address and inner source Ethernet MAC address of
2855 received packets are used to dynamically populate the forwarding table.
2856 When in multicast mode, an entry in the forwarding table allows the
2857 interface to send the frame directly to the remote host instead of
2858 broadcasting the frame to the multicast group.
2859 This is the default.
2861 The forwarding table is not populated by received packets.
2863 Delete all dynamically-learned addresses from the forwarding table.
2864 .It Cm vxlanflushall
2865 Delete all addresses, including static addresses, from the forwarding table.
2868 The following parameters are used to configure
2870 protocol on an interface:
2871 .Bl -tag -width indent
2873 Set the virtual host ID.
2874 This is a required setting to initiate
2876 If the virtual host ID does not exist yet, it is created and attached to the
2877 interface, otherwise configuration of an existing vhid is adjusted.
2880 keyword is supplied along with an
2884 address, then this address is configured to be run under control of the
2886 Whenever a last address that refers to a particular vhid is removed from an
2887 interface, the vhid is automatically removed from interface and destroyed.
2888 Any other configuration parameters for the
2890 protocol should be supplied along with the
2893 Acceptable values for vhid are 1 to 255.
2894 .It Cm advbase Ar seconds
2895 Specifies the base of the advertisement interval in seconds.
2896 The acceptable values are 1 to 255.
2897 The default value is 1.
2898 .It Cm advskew Ar interval
2899 Specifies the skew to add to the base advertisement interval to
2900 make one host advertise slower than another host.
2901 It is specified in 1/256 of seconds.
2902 The acceptable values are 1 to 254.
2903 The default value is 0.
2904 .It Cm pass Ar phrase
2905 Set the authentication key to
2907 .It Cm state Ar MASTER|BACKUP
2908 Forcibly change state of a given vhid.
2913 utility displays the current configuration for a network interface
2914 when no optional parameters are supplied.
2915 If a protocol family is specified,
2917 will report only the details specific to that protocol family.
2921 flag is passed before an interface name,
2923 will display the capability list and all
2924 of the supported media for the specified interface.
2927 flag is supplied, address lifetime is displayed for IPv6 addresses,
2928 as time offset string.
2932 flag may be used instead of an interface name.
2935 to display information about all interfaces in the system.
2938 flag limits this to interfaces that are down,
2940 limits this to interfaces that are up,
2942 limits this to members of the specified group of interfaces, and
2944 excludes members of the specified group from the list.
2949 flags may be specified to apply both conditions.
2952 should be specified as later override previous ones
2956 may contain shell patterns in which case it should be quoted.
2957 When no arguments are given,
2963 flag may be used to list all available interfaces on the system, with
2964 no other additional information.
2967 is specified, only interfaces of that type will be listed.
2969 will list only Ethernet adapters, excluding the loopback interface.
2970 Use of this flag is mutually exclusive
2971 with all other flags and commands, except for
2973 (only list interfaces that are down)
2976 (only list interfaces that are up).
2980 flag may be used to get more verbose status for an interface.
2984 flag may be used to list all of the interface cloners available on
2985 the system, with no additional information.
2986 Use of this flag is mutually exclusive with all other flags and commands.
2990 flag causes keying information for the interface, if available, to be
2992 For example, the values of 802.11 WEP keys and
2994 passphrases will be printed, if accessible to the current user.
2995 This information is not printed by default, as it may be considered
2998 If the network interface driver is not present in the kernel then
3000 will attempt to load it.
3003 flag disables this behavior.
3005 Only the super-user may modify the configuration of a network interface.
3007 Assign the IPv4 address
3009 with a network mask of
3013 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3015 Add the IPv4 address
3017 with the CIDR network prefix
3023 as a synonym for the canonical form of the option
3025 .Dl # ifconfig em0 inet 192.0.2.45/28 add
3027 Remove the IPv4 address
3031 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3033 Enable IPv6 functionality of the interface:
3034 .Dl # ifconfig em0 inet6 -ifdisabled
3036 Add the IPv6 address
3037 .Li 2001:DB8:DBDB::123/48
3040 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3041 Note that lower case hexadecimal IPv6 addresses are acceptable.
3043 Remove the IPv6 address added in the above example,
3046 character as shorthand for the network prefix,
3049 as a synonym for the canonical form of the option
3051 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
3053 Configure a single CARP redundant address on igb0, and then switch it
3055 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3056 .Dl # ifconfig igb0 vhid 1 state master
3058 Configure the interface
3060 to use 100baseTX, full duplex Ethernet media options:
3061 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3063 Label the em0 interface as an uplink:
3064 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3066 Create the software network interface
3068 .Dl # ifconfig gif1 create
3070 Destroy the software network interface
3072 .Dl # ifconfig gif1 destroy
3074 Display available wireless networks using
3076 .Dl # ifconfig wlan0 list scan
3078 Display inet and inet6 address subnet masks in CIDR notation
3079 .Dl # ifconfig -f inet:cidr,inet6:cidr
3081 Display interfaces that are up with the exception of loopback
3082 .Dl # ifconfig -a -u -G lo
3084 Messages indicating the specified interface does not exist, the
3085 requested address is unknown, or the user is not privileged and
3086 tried to alter an interface's configuration.
3109 Basic IPv6 node operation requires a link-local address on each
3110 interface configured for IPv6.
3111 Normally, such an address is automatically configured by the
3112 kernel on each interface added to the system or enabled; this behavior may
3113 be disabled by setting per-interface flag
3114 .Cm -auto_linklocal .
3115 The default value of this flag is 1 and can be disabled by using the sysctl
3117 .Va net.inet6.ip6.auto_linklocal .
3119 Do not configure IPv6 addresses with no link-local address by using
3121 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob