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
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
96 .Tn DARPA Ns -Internet
98 the address is either a host name present in the host name data
103 Internet address expressed in the Internet standard
106 It is also possible to use the CIDR notation (also known as the
107 slash notation) to include the netmask.
108 That is, one can specify an address like
113 family, it is also possible to specify the prefix length using the slash
118 parameter below for more information.
119 .\" For the Xerox Network Systems(tm) family,
121 .\" .Ar net:a.b.c.d.e.f ,
124 .\" is the assigned network number (in decimal),
125 .\" and each of the six bytes of the host number,
129 .\" are specified in hexadecimal.
130 .\" The host number may be omitted on IEEE 802 protocol
131 .\" (Ethernet, FDDI, and Token Ring) interfaces,
132 .\" which use the hardware physical address,
133 .\" and on interfaces other than the first.
136 .\" family, addresses are specified as a long hexadecimal string,
137 .\" as in the Xerox family.
138 .\" However, two consecutive dots imply a zero
139 .\" byte, and the dots are optional, if the user wishes to (carefully)
140 .\" count out long strings of digits in network byte order.
145 is specified as a series of colon-separated hex digits.
146 This can be used to, for example,
147 set a new MAC address on an Ethernet interface, though the
148 mechanism used is not Ethernet specific.
151 keyword to set a randomly generated MAC address.
152 A randomly-generated MAC address might be the same as one already in use
154 Such duplications are extremely unlikely.
155 If the interface is already
156 up when this option is used, it will be briefly brought down and
157 then brought back up again in order to ensure that the receive
158 filter in the underlying Ethernet hardware is properly reprogrammed.
159 .It Ar address_family
162 which affects interpretation of the remaining parameters.
163 Since an interface can receive transmissions in differing protocols
164 with different naming schemes, specifying the address family is recommended.
165 The address or protocol families currently
171 The default if available is
184 address family has special meaning and is no longer synonymous with
190 will list only Ethernet interfaces, excluding all other interface types,
191 including the loopback interface.
193 Specify the address of the correspondent on the other end
194 of a point to point link.
197 parameter is a string of the form
202 List the interfaces in the given group.
207 can be controlled using the
211 environment variable.
212 The format is specified as a comma separated list of
217 section for more information.
223 .Bl -tag -width ether
225 Adjust the display of inet and inet6 addresses
226 .Bl -tag -width default
228 Display inet and inet6 addresses in the default format,
231 Display inet and inet6 addresses as fully qualified domain names
234 Display inet and inet6 addresses as unqualified hostnames
236 Display inet and inet6 addresses in numeric format
239 Adjust the display of link-level ethernet (MAC) addresses
240 .Bl -tag -width default
242 Separate address segments with a colon
244 Separate address segments with a dash
246 Display ethernet addresses in the default format,
250 Adjust the display of inet address subnet masks:
251 .Bl -tag -width default
253 Display subnet masks in CIDR notation, for example:
255 10.0.0.0/8 or 203.0.113.224/26
257 Display subnet masks in the default format,
260 Display subnet masks in dotted quad notation, for example:
262 255.255.0.0 or 255.255.255.192
264 Display subnet masks in hexadecimal, for example:
266 0xffff0000 or 0xffffffc0
269 Adjust the display of inet6 address prefixes (subnet masks):
270 .Bl -tag -width default
272 Display subnet prefix in CIDR notation, for example:
274 ::1/128 or fe80::1%lo0/64
276 Display subnet prefix in the default format
279 Display subnet prefix in integer format, for example:
285 The following parameters may be set with
287 .Bl -tag -width indent
292 Introduced for compatibility
296 Establish an additional network address for this interface.
297 This is sometimes useful when changing network numbers, and
298 one wishes to accept packets addressed to the old interface.
299 If the address is on the same subnet as the first network address
300 for this interface, a non-conflicting netmask must be given.
305 Remove the network address specified.
306 This would be used if you incorrectly specified an alias, or it
307 was no longer needed.
308 If you have incorrectly set an NS address having the side effect
309 of specifying the host portion, removing all NS addresses will
310 allow you to respecify the host portion.
313 Specify that the address configured is an anycast address.
314 Based on the current specification,
315 only routers may configure anycast addresses.
316 Anycast address will not be used as source address of any of outgoing
319 Enable the use of the Address Resolution Protocol
322 between network level addresses and link level addresses (default).
323 This is currently implemented for mapping between
328 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
330 Disable the use of the Address Resolution Protocol
333 If the Address Resolution Protocol is enabled,
334 the host will only reply to requests for its addresses,
335 and will never send any requests.
337 If the Address Resolution Protocol is enabled,
338 the host will perform normally,
339 sending out requests and listening for replies.
342 Specify the address to use to represent broadcasts to the
344 The default broadcast address is the address with a host part of all 1's.
346 Enable driver dependent debugging code; usually, this turns on
347 extra console error logging.
349 Disable driver dependent debugging code.
351 Put interface into permanently promiscuous mode.
353 Disable permanently promiscuous mode.
358 .It Cm description Ar value , Cm descr Ar value
359 Specify a description of the interface.
360 This can be used to label interfaces in situations where they may
361 otherwise be difficult to distinguish.
362 .It Cm -description , Cm -descr
363 Clear the interface description.
367 When an interface is marked
369 the system will not attempt to
370 transmit messages through that interface.
371 If possible, the interface will be reset to disable reception as well.
372 This action does not automatically disable routes using the interface.
373 .It Cm group Ar groupname
374 Assign the interface to a
376 Any interface can be in multiple groups.
378 Cloned interfaces are members of their interface family group by default.
379 For example, a PPP interface such as
381 is a member of the PPP interface family group,
383 .\" The interface(s) the default route(s) point to are members of the
386 .It Cm -group Ar groupname
387 Remove the interface from the given
392 (lowermost 64bit of an IPv6 address)
394 .It Cm fib Ar fib_number
395 Specify interface FIB.
398 is assigned to all frames or packets received on that interface.
399 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
400 the default FIB (0) irrespective of the parent interface's FIB.
401 The kernel needs to be tuned to support more than the default FIB
404 kernel configuration option, or the
407 .It Cm tunnelfib Ar fib_number
411 is assigned to all packets encapsulated by tunnel interface, e.g.,
415 .It Cm maclabel Ar label
416 If Mandatory Access Control support is enabled in the kernel,
420 .\" .Xr maclabel 7 ) .
422 If the driver supports the media selection system, set the media type
425 Some interfaces support the mutually exclusive use of one of several
426 different physical media connectors.
427 For example, a 10Mbit/s Ethernet
428 interface might support the use of either
430 or twisted pair connectors.
431 Setting the media type to
433 would change the currently active connector to the AUI port.
436 would activate twisted pair.
437 Refer to the interfaces' driver
438 specific documentation or man page for a complete list of the
440 .It Cm mediaopt Ar opts
441 If the driver supports the media selection system, set the specified
442 media options on the interface.
446 is a comma delimited list of options to apply to the interface.
447 Refer to the interfaces' driver specific man page for a complete
448 list of available options.
449 .It Fl mediaopt Ar opts
450 If the driver supports the media selection system, disable the
451 specified media options on the interface.
453 If the driver supports the media selection system, set the specified
454 operating mode on the interface to
456 For IEEE 802.11 wireless interfaces that support multiple operating modes
457 this directive is used to select between 802.11a
465 Set if the driver supports TX rate limiting.
466 .It Cm inst Ar minst , Cm instance Ar minst
467 Set the media instance to
469 This is useful for devices which have multiple physical layer interfaces
472 Set the interface name to
474 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
475 If the driver supports user-configurable checksum offloading,
476 enable receive (or transmit) checksum offloading on the interface.
477 The feature can be turned on selectively per protocol family.
479 .Cm rxcsum6 , txcsum6
485 Some drivers may not be able to enable these flags independently
486 of each other, so setting one may also set the other.
487 The driver will offload as much checksum work as it can reliably
488 support, the exact level of offloading varies between drivers.
489 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
490 If the driver supports user-configurable checksum offloading,
491 disable receive (or transmit) checksum offloading on the interface.
492 The feature can be turned off selectively per protocol family.
494 .Fl rxcsum6 , txcsum6
500 These settings may not always be independent of each other.
502 If the driver supports
504 segmentation offloading, enable TSO on the interface.
505 Some drivers may not be able to support TSO for
509 packets, so they may enable only one of them.
511 If the driver supports
513 segmentation offloading, disable TSO on the interface.
514 It will always disable TSO for
519 If the driver supports
521 segmentation offloading for
525 use one of these to selectively enabled it only for one protocol family.
527 If the driver supports
529 segmentation offloading for
533 use one of these to selectively disable it only for one protocol family.
535 If the driver supports
537 large receive offloading, enable LRO on the interface.
539 If the driver supports
541 large receive offloading, disable LRO on the interface.
543 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
544 segments the encrypted record into one or more
550 If the driver supports transmit TLS offload,
551 enable transmit TLS offload on the interface.
552 Some drivers may not be able to support transmit TLS offload for
556 packets, so they may enable only one of them.
558 If the driver supports transmit TLS offload,
559 disable transmit TLS offload on the interface.
560 It will always disable TLS for
565 If the driver supports unmapped network buffers,
566 enable them on the interface.
568 If the driver supports unmapped network buffers,
569 disable them on the interface.
570 .It Cm wol , wol_ucast , wol_mcast , wol_magic
571 Enable Wake On Lan (WOL) support, if available.
572 WOL is a facility whereby a machine in a low power state may be woken
573 in response to a received packet.
574 There are three types of packets that may wake a system:
575 ucast (directed solely to the machine's mac address),
576 mcast (directed to a broadcast or multicast address),
578 magic (unicast or multicast frames with a ``magic contents'').
579 Not all devices support WOL, those that do indicate the mechanisms
580 they support in their capabilities.
582 is a synonym for enabling all available WOL mechanisms.
585 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
586 If the driver offers user-configurable VLAN support, enable
587 reception of extended frames, tag processing in hardware,
588 frame filtering in hardware, checksum offloading, or TSO on VLAN,
590 Note that this must be configured on a physical interface associated with
595 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
596 If the driver offers user-configurable VLAN support, disable
597 reception of extended frames, tag processing in hardware,
598 frame filtering in hardware, or TSO on VLAN,
600 .It Cm vxlanhwcsum , vxlanhwtso
601 If the driver offers user-configurable VXLAN support, enable inner checksum
602 offloading (receive and transmit) or TSO on VXLAN, respectively.
603 Note that this must be configured on a physical interface associated with
608 The physical interface is either the interface specified as the vxlandev
609 or the interface hosting the vxlanlocal address.
610 The driver will offload as much checksum work and TSO as it can reliably
611 support, the exact level of offloading may vary between drivers.
612 .It Fl vxlanhwcsum , vxlanhwtso
613 If the driver offers user-configurable VXLAN support, disable checksum
614 offloading (receive and transmit) or TSO on VXLAN, respectively.
616 Move the interface to the
618 specified by name or JID.
619 If the jail has a virtual network stack, the interface will disappear
620 from the current environment and become visible to the jail.
622 Reclaim the interface from the
624 specified by name or JID.
625 If the jail has a virtual network stack, the interface will disappear
626 from the jail, and become visible to the current network environment.
630 feature and disable interrupts on the interface, if driver supports
635 feature and enable interrupt mode on the interface.
637 Create the specified network pseudo-device.
638 If the interface is given without a unit number, try to create a new
639 device with an arbitrary unit number.
640 If creation of an arbitrary device is successful, the new device name is
641 printed to standard output unless the interface is renamed or destroyed
646 Destroy the specified network pseudo-device.
662 Set the routing metric of the interface to
665 The routing metric is used by the routing protocol
667 Higher metrics have the effect of making a route
668 less favorable; metrics are counted as additional hops
669 to the destination network or host.
671 Set the maximum transmission unit of the interface to
673 default is interface specific.
674 The MTU is used to limit the size of packets that are transmitted on an
676 Not all interfaces support setting the MTU, and some interfaces have
678 .It Cm netmask Ar mask
681 Specify how much of the address to reserve for subdividing
682 networks into sub-networks.
683 The mask includes the network part of the local address
684 and the subnet part, which is taken from the host field of the address.
685 The mask can be specified as a single hexadecimal number
688 with a dot-notation Internet address,
689 or with a pseudo-network name listed in the network table
691 The mask contains 1's for the bit positions in the 32-bit address
692 which are to be used for the network and subnet parts,
693 and 0's for the host part.
694 The mask should contain at least the standard network portion,
695 and the subnet field should be contiguous with the network
698 The netmask can also be specified in CIDR notation after the address.
701 option above for more information.
702 .It Cm prefixlen Ar len
706 bits are reserved for subdividing networks into sub-networks.
709 must be integer, and for syntactical reason it must be between 0 to 128.
710 It is almost always 64 under the current IPv6 assignment rule.
711 If the parameter is omitted, 64 is used.
713 The prefix can also be specified using the slash notation after the address.
716 option above for more information.
721 Introduced for compatibility
725 .It Cm link Op Cm 0 No - Cm 2
727 Enable special processing of the link level of the interface.
728 These three options are interface specific in actual effect, however,
729 they are in general used to select special modes of operation.
731 of this is to enable SLIP compression, or to select the connector type
732 for some Ethernet cards.
733 Refer to the man page for the specific driver
734 for more information.
736 .It Fl link Op Cm 0 No - Cm 2
738 Disable special processing at the link level with the specified interface.
740 Put the interface in monitor mode.
741 No packets are transmitted, and received packets are discarded after
745 Take the interface out of monitor mode.
746 .It Cm pcp Ar priority_code_point
749 is an 3-bit field which refers to the IEEE 802.1p
750 class of service and maps to the frame priority level.
752 Stop tagging packets on the interface w/ the priority code point.
756 This may be used to enable an interface after an
758 It happens automatically when setting the first address on an interface.
759 If the interface was reset when previously marked down,
760 the hardware will be re-initialized.
763 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
764 Note that the address family keyword
767 .Bl -tag -width indent
769 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
773 .Va net.inet6.ip6.accept_rtadv
774 controls whether this flag is set by default or not.
779 Set a flag to control whether routers from which the system accepts
780 Router Advertisement messages will be added to the Default Router List
784 flag is disabled, this flag has no effect.
788 .Va net.inet6.ip6.no_radr
789 controls whether this flag is set by default or not.
793 .It Cm auto_linklocal
794 Set a flag to perform automatic link-local address configuration when
795 the interface becomes available.
799 .Va net.inet6.ip6.auto_linklocal
800 controls whether this flag is set by default or not.
801 .It Cm -auto_linklocal
805 Set the specified interface as the default route when there is no
811 Set a flag to disable all of IPv6 network communications on the
813 Note that if there are already configured IPv6
814 addresses on that interface, all of them are marked as
816 and DAD will be performed when this flag is cleared.
820 When this flag is cleared and
822 flag is enabled, automatic configuration of a link-local address is
825 Set a flag to enable Neighbor Unreachability Detection.
829 .It Cm no_prefer_iface
830 Set a flag to not honor rule 5 of source address selection in RFC 3484.
831 In practice this means the address on the outgoing interface will not be
832 preferred, effectively yielding the decision to the address selection
833 policy table, configurable with
835 .It Cm -no_prefer_iface
837 .Cm no_prefer_iface .
839 Set a flag to disable Duplicate Address Detection.
845 The following parameters are specific for IPv6 addresses.
846 Note that the address family keyword
849 .Bl -tag -width indent
851 Set the IPv6 autoconfigured address bit.
853 Clear the IPv6 autoconfigured address bit.
855 Set the IPv6 deprecated address bit.
857 Clear the IPv6 deprecated address bit.
859 Set preferred lifetime for the address.
861 Set a flag to prefer address as a candidate of the source address for
863 .It Cm -prefer_source
867 Set valid lifetime for the address.
870 The following parameters are specific to cloning
871 IEEE 802.11 wireless interfaces with the
874 .Bl -tag -width indent
875 .It Cm wlandev Ar device
878 as the parent for the cloned device.
879 .It Cm wlanmode Ar mode
880 Specify the operating mode for this cloned device.
898 The operating mode of a cloned interface cannot be changed.
901 mode is actually implemented as an
903 interface with special properties.
904 .It Cm wlanbssid Ar bssid
905 The 802.11 mac address to use for the bssid.
906 This must be specified at create time for a legacy
909 .It Cm wlanaddr Ar address
910 The local mac address.
911 If this is not specified then a mac address will automatically be assigned
912 to the cloned device.
913 Typically this address is the same as the address of the parent device
916 parameter is specified then the driver will craft a unique address for
917 the device (if supported).
921 device as operating in ``legacy mode''.
924 devices have a fixed peer relationship and do not, for example, roam
925 if their peer stops communicating.
926 For completeness a Dynamic WDS (DWDS) interface may marked as
929 Request a unique local mac address for the cloned device.
930 This is only possible if the device supports multiple mac addresses.
931 To force use of the parent's mac address use
934 Mark the cloned interface as depending on hardware support to
935 track received beacons.
936 To have beacons tracked in software use
942 can also be used to indicate no beacons should
943 be transmitted; this can be useful when creating a WDS configuration but
945 interfaces can only be created as companions to an access point.
948 The following parameters are specific to IEEE 802.11 wireless interfaces
952 .Bl -tag -width indent
954 Enable sending and receiving AMPDU frames when using 802.11n (default).
955 The 802.11n specification states a compliant station must be capable
956 of receiving AMPDU frames but transmission is optional.
959 to disable all use of AMPDU with 802.11n.
960 For testing and/or to work around interoperability problems one can use
964 to control use of AMPDU in one direction.
965 .It Cm ampdudensity Ar density
966 Set the AMPDU density parameter used when operating with 802.11n.
967 This parameter controls the inter-packet gap for AMPDU frames.
968 The sending device normally controls this setting but a receiving station
969 may request wider gaps.
972 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
975 is treated the same as 0.
976 .It Cm ampdulimit Ar limit
977 Set the limit on packet size for receiving AMPDU frames when operating
981 are 8192, 16384, 32768, and 65536 but one can also specify
982 just the unique prefix: 8, 16, 32, 64.
983 Note the sender may limit the size of AMPDU frames to be less
984 than the maximum specified by the receiving station.
986 Enable sending and receiving AMSDU frames when using 802.11n.
987 By default AMSDU is received but not transmitted.
990 to disable all use of AMSDU with 802.11n.
991 For testing and/or to work around interoperability problems one can use
995 to control use of AMSDU in one direction.
996 .It Cm amsdulimit Ar limit
997 Set the limit on packet size for sending and receiving AMSDU frames
998 when operating with 802.11n.
1001 are 7935 and 3839 (bytes).
1002 Note the sender may limit the size of AMSDU frames to be less
1003 than the maximum specified by the receiving station.
1004 Note also that devices are not required to support the 7935 limit,
1005 only 3839 is required by the specification and the larger value
1006 may require more memory to be dedicated to support functionality
1007 that is rarely used.
1009 When operating as an access point, pass packets between
1010 wireless clients directly (default).
1011 To instead let them pass up through the
1012 system and be forwarded using some other mechanism, use
1014 Disabling the internal bridging
1015 is useful when traffic is to be processed with
1017 .It Cm authmode Ar mode
1018 Set the desired authentication mode in infrastructure mode.
1019 Not all adapters support all modes.
1022 .Cm none , open , shared
1028 (IEEE WPA/WPA2/802.11i).
1033 modes are only useful when using an authentication service
1034 (a supplicant for client operation or an authenticator when
1035 operating as an access point).
1036 Modes are case insensitive.
1038 Enable background scanning when operating as a station.
1039 Background scanning is a technique whereby a station associated to
1040 an access point will temporarily leave the channel to scan for
1041 neighboring stations.
1042 This allows a station to maintain a cache of nearby access points
1043 so that roaming between access points can be done without
1044 a lengthy scan operation.
1045 Background scanning is done only when a station is not busy and
1046 any outbound traffic will cancel a scan operation.
1047 Background scanning should never cause packets to be lost though
1048 there may be some small latency if outbound traffic interrupts a
1050 By default background scanning is enabled if the device is capable.
1051 To disable background scanning, use
1053 Background scanning is controlled by the
1058 Background scanning must be enabled for roaming; this is an artifact
1059 of the current implementation and may not be required in the future.
1060 .It Cm bgscanidle Ar idletime
1061 Set the minimum time a station must be idle (not transmitting or
1062 receiving frames) before a background scan is initiated.
1065 parameter is specified in milliseconds.
1066 By default a station must be idle at least 250 milliseconds before
1067 a background scan is initiated.
1068 The idle time may not be set to less than 100 milliseconds.
1069 .It Cm bgscanintvl Ar interval
1070 Set the interval at which background scanning is attempted.
1073 parameter is specified in seconds.
1074 By default a background scan is considered every 300 seconds (5 minutes).
1077 may not be set to less than 15 seconds.
1078 .It Cm bintval Ar interval
1079 Set the interval at which beacon frames are sent when operating in
1083 parameter is specified in TU's (1024 usecs).
1084 By default beacon frames are transmitted every 100 TU's.
1085 .It Cm bmissthreshold Ar count
1086 Set the number of consecutive missed beacons at which the station
1087 will attempt to roam (i.e., search for a new access point).
1090 parameter must be in the range 1 to 255; though the
1091 upper bound may be reduced according to device capabilities.
1092 The default threshold is 7 consecutive missed beacons; but
1093 this may be overridden by the device driver.
1094 Another name for the
1098 .It Cm bssid Ar address
1099 Specify the MAC address of the access point to use when operating
1100 as a station in a BSS network.
1101 This overrides any automatic selection done by the system.
1102 To disable a previously selected access point, supply
1107 This option is useful when more than one access point uses the same SSID.
1108 Another name for the
1113 Enable packet bursting.
1114 Packet bursting is a transmission technique whereby the wireless
1115 medium is acquired once to send multiple frames and the interframe
1117 This technique can significantly increase throughput by reducing
1118 transmission overhead.
1119 Packet bursting is supported by the 802.11e QoS specification
1120 and some devices that do not support QoS may still be capable.
1121 By default packet bursting is enabled if a device is capable
1123 To disable packet bursting, use
1125 .It Cm chanlist Ar channels
1126 Set the desired channels to use when scanning for access
1127 points, neighbors in an IBSS network, or looking for unoccupied
1128 channels when operating as an access point.
1129 The set of channels is specified as a comma-separated list with
1130 each element in the list representing either a single channel number or a range
1133 Channel numbers must be in the range 1 to 255 and be permissible
1134 according to the operating characteristics of the device.
1135 .It Cm channel Ar number
1136 Set a single desired channel.
1137 Channels range from 1 to 255, but the exact selection available
1138 depends on the region your adaptor was manufactured for.
1144 will clear any desired channel and, if the device is marked up,
1145 force a scan for a channel to operate on.
1146 Alternatively the frequency, in megahertz, may be specified
1147 instead of the channel number.
1149 When there are several ways to use a channel the channel
1150 number/frequency may be appended with attributes to clarify.
1151 For example, if a device is capable of operating on channel 6
1152 with 802.11n and 802.11g then one can specify that g-only use
1153 should be used by specifying ``6:g''.
1154 Similarly the channel width can be specified by appending it
1155 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1156 These attributes can be combined as in: ``6:ht/40''.
1157 The full set of flags specified following a ``:'' are:
1163 (Atheros Dynamic Turbo mode),
1171 (Atheros Static Turbo mode),
1174 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1175 The full set of channel widths following a '/' are:
1177 (5MHz aka quarter-rate channel),
1179 (10MHz aka half-rate channel),
1181 (20MHz mostly for use in specifying ht20),
1184 (40MHz mostly for use in specifying ht40).
1186 a 40MHz HT channel specification may include the location
1187 of the extension channel by appending ``+'' or ``-'' for above and below,
1188 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1189 with the center channel at frequency 2437 and the extension channel above.
1190 .It Cm country Ar name
1191 Set the country code to use in calculating the regulatory constraints
1193 In particular the set of available channels, how the wireless device
1194 will operation on the channels, and the maximum transmit power that
1195 can be used on a channel are defined by this setting.
1196 Country/Region codes are specified as a 2-character abbreviation
1197 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1198 e.g., "ES" and "Spain".
1199 The set of country codes are taken from
1200 .Pa /etc/regdomain.xml
1202 be viewed with the ``list countries'' request.
1203 Note that not all devices support changing the country code from a default
1204 setting; typically stored in EEPROM.
1212 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1213 DFS embodies several facilities including detection of overlapping
1214 radar signals, dynamic transmit power control, and channel selection
1215 according to a least-congested criteria.
1216 DFS support is mandatory for some 5GHz frequencies in certain
1217 locales (e.g., ETSI).
1218 By default DFS is enabled according to the regulatory definitions
1220 .Pa /etc/regdomain.xml
1221 and the current country code, regdomain,
1223 Note the underlying device (and driver) must support radar detection
1224 for full DFS support to work.
1225 To be fully compliant with the local regulatory agency frequencies that
1226 require DFS should not be used unless it is fully supported.
1229 to disable this functionality for testing.
1231 Enable support for the 802.11d specification (default).
1232 When this support is enabled in station mode, beacon frames that advertise
1233 a country code different than the currently configured country code will
1234 cause an event to be dispatched to user applications.
1235 This event can be used by the station to adopt that country code and
1236 operate according to the associated regulatory constraints.
1237 When operating as an access point with 802.11d enabled the beacon and
1238 probe response frames transmitted will advertise the current regulatory
1240 To disable 802.11d use
1243 Enable 802.11h support including spectrum management.
1244 When 802.11h is enabled beacon and probe response frames will have
1245 the SpectrumMgt bit set in the capabilities field and
1246 country and power constraint information elements will be present.
1247 802.11h support also includes handling Channel Switch Announcements (CSA)
1248 which are a mechanism to coordinate channel changes by an access point.
1249 By default 802.11h is enabled if the device is capable.
1250 To disable 802.11h use
1252 .It Cm deftxkey Ar index
1253 Set the default key to use for transmission.
1254 Typically this is only set when using WEP encryption.
1255 Note that you must set a default transmit key
1256 for the system to know which key to use in encrypting outbound traffic.
1259 is an alias for this request; it is provided for backwards compatibility.
1260 .It Cm dtimperiod Ar period
1263 period for transmitting buffered multicast data frames when
1264 operating in ap mode.
1267 specifies the number of beacon intervals between DTIM
1268 and must be in the range 1 to 15.
1269 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1271 Enable the use of quiet IE.
1272 Hostap will use this to silence other
1273 stations to reduce interference for radar detection when
1274 operating on 5GHz frequency and doth support is enabled.
1277 to disable this functionality.
1278 .It Cm quiet_period Ar period
1281 to the number of beacon intervals between the start of regularly
1282 scheduled quiet intervals defined by Quiet element.
1283 .It Cm quiet_count Ar count
1286 to the number of TBTTs until the beacon interval during which the
1287 next quiet interval shall start.
1288 A value of 1 indicates the quiet
1289 interval will start during the beacon interval starting at the next
1291 A value 0 is reserved.
1292 .It Cm quiet_offset Ar offset
1295 to the offset of the start of the quiet interval from the TBTT
1296 specified by the Quiet count, expressed in TUs.
1299 shall be less than one beacon interval.
1300 .It Cm quiet_duration Ar dur
1303 to the duration of the Quiet interval, expressed in TUs.
1304 The value should be less than beacon interval.
1306 Enable the use of Atheros Dynamic Turbo mode when communicating with
1307 another Dynamic Turbo-capable station.
1308 Dynamic Turbo mode is an Atheros-specific mechanism by which
1309 stations switch between normal 802.11 operation and a ``boosted''
1310 mode in which a 40MHz wide channel is used for communication.
1311 Stations using Dynamic Turbo mode operate boosted only when the
1312 channel is free of non-dturbo stations; when a non-dturbo station
1313 is identified on the channel all stations will automatically drop
1314 back to normal operation.
1315 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1316 Note that turbo mode (dynamic or static) is only allowed on some
1317 channels depending on the regulatory constraints; use the
1319 command to identify the channels where turbo mode may be used.
1320 To disable Dynamic Turbo mode use
1323 Enable Dynamic WDS (DWDS) support.
1324 DWDS is a facility by which 4-address traffic can be carried between
1325 stations operating in infrastructure mode.
1326 A station first associates to an access point and authenticates using
1327 normal procedures (e.g., WPA).
1328 Then 4-address frames are passed to carry traffic for stations
1329 operating on either side of the wireless link.
1330 DWDS extends the normal WDS mechanism by leveraging existing security
1331 protocols and eliminating static binding.
1333 When DWDS is enabled on an access point 4-address frames received from
1334 an authorized station will generate a ``DWDS discovery'' event to user
1336 This event should be used to create a WDS interface that is bound
1337 to the remote station (and usually plumbed into a bridge).
1338 Once the WDS interface is up and running 4-address traffic then logically
1339 flows through that interface.
1341 When DWDS is enabled on a station, traffic with a destination address
1342 different from the peer station are encapsulated in a 4-address frame
1343 and transmitted to the peer.
1344 All 4-address traffic uses the security information of the stations
1345 (e.g., cryptographic keys).
1346 A station is associated using 802.11n facilities may transport
1347 4-address traffic using these same mechanisms; this depends on available
1348 resources and capabilities of the device.
1349 The DWDS implementation guards against layer 2 routing loops of
1352 Enable the use of Atheros Fast Frames when communicating with
1353 another Fast Frames-capable station.
1354 Fast Frames are an encapsulation technique by which two 802.3
1355 frames are transmitted in a single 802.11 frame.
1356 This can noticeably improve throughput but requires that the
1357 receiving station understand how to decapsulate the frame.
1358 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1359 protocol extension so enabling use is safe when communicating with
1360 non-Atheros devices.
1361 By default, use of fast frames is enabled if the device is capable.
1362 To explicitly disable fast frames, use
1364 .It Cm fragthreshold Ar length
1365 Set the threshold for which transmitted frames are broken into fragments.
1368 argument is the frame size in bytes and must be in the range 256 to 2346.
1376 disables transmit fragmentation.
1377 Not all adapters honor the fragmentation threshold.
1379 When operating as an access point, do not broadcast the SSID
1380 in beacon frames or respond to probe request frames unless
1381 they are directed to the ap (i.e., they include the ap's SSID).
1382 By default, the SSID is included in beacon frames and
1383 undirected probe request frames are answered.
1384 To re-enable the broadcast of the SSID etc., use
1387 Enable use of High Throughput (HT) when using 802.11n (default).
1388 The 802.11n specification includes mechanisms for operation
1389 on 20MHz and 40MHz wide channels using different signalling mechanisms
1390 than specified in 802.11b, 802.11g, and 802.11a.
1391 Stations negotiate use of these facilities, termed HT20 and HT40,
1392 when they associate.
1393 To disable all use of 802.11n use
1395 To disable use of HT20 (e.g., to force only HT40 use) use
1397 To disable use of HT40 use
1400 HT configuration is used to ``auto promote'' operation
1401 when several choices are available.
1402 For example, if a station associates to an 11n-capable access point
1403 it controls whether the station uses legacy operation, HT20, or HT40.
1404 When an 11n-capable device is setup as an access point and
1405 Auto Channel Selection is used to locate a channel to operate on,
1406 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1407 on the selected channel.
1408 If a fixed channel is specified for a station then HT configuration can
1409 be given as part of the channel specification; e.g., 6:ht/20 to setup
1410 HT20 operation on channel 6.
1412 Enable use of compatibility support for pre-802.11n devices (default).
1413 The 802.11n protocol specification went through several incompatible iterations.
1414 Some vendors implemented 11n support to older specifications that
1415 will not interoperate with a purely 11n-compliant station.
1416 In particular the information elements included in management frames
1417 for old devices are different.
1418 When compatibility support is enabled both standard and compatible data
1420 Stations that associate using the compatibility mechanisms are flagged
1422 To disable compatibility support use
1424 .It Cm htprotmode Ar technique
1425 For interfaces operating in 802.11n, use the specified
1427 for protecting HT frames in a mixed legacy/HT network.
1428 The set of valid techniques is
1433 Technique names are case insensitive.
1435 Enable inactivity processing for stations associated to an
1436 access point (default).
1437 When operating as an access point the 802.11 layer monitors
1438 the activity of each associated station.
1439 When a station is inactive for 5 minutes it will send several
1440 ``probe frames'' to see if the station is still present.
1441 If no response is received then the station is deauthenticated.
1442 Applications that prefer to handle this work can disable this
1446 Set the location to use in calculating regulatory constraints.
1447 The location is also advertised in beacon and probe response frames
1448 when 802.11d is enabled with
1457 Display the list of channels available for use taking into account
1458 any restrictions set with the
1461 See the description of
1463 for more information.
1465 Display the adaptor's capabilities, including the operating
1468 Display the list of channels available for use.
1469 Channels are shown with their IEEE channel number, equivalent
1470 frequency, and usage modes.
1471 Channels identified as
1476 Channels identified as
1478 may be used only for Atheros' Static Turbo mode
1480 . Cm mediaopt turbo ) .
1481 Channels marked with a
1483 have a regulatory constraint that they be passively scanned.
1484 This means a station is not permitted to transmit on the channel until
1485 it identifies the channel is being used for 802.11 communication;
1486 typically by hearing a beacon frame from an access point operating
1489 is another way of requesting this information.
1490 By default a compacted list of channels is displayed; if the
1492 option is specified then all channels are shown.
1493 .It Cm list countries
1494 Display the set of country codes and regulatory domains that can be
1495 used in regulatory configuration.
1497 Display the current MAC Access Control List state.
1498 Each address is prefixed with a character that indicates the
1499 current policy applied to it:
1501 indicates the address is allowed access,
1503 indicates the address is denied access,
1505 indicates the address is present but the current policy open
1506 (so the ACL is not consulted).
1508 Displays the mesh routing table, used for forwarding packets on a mesh
1510 .It Cm list regdomain
1511 Display the current regulatory settings including the available channels
1512 and transmit power caps.
1514 Display the parameters that govern roaming operation.
1516 Display the parameters that govern transmit operation.
1518 Display the transmit power caps for each channel.
1520 Display the access points and/or ad-hoc neighbors
1521 located in the vicinity.
1522 This information may be updated automatically by the adapter
1525 request or through background scanning.
1526 Depending on the capabilities of the stations the following
1527 flags can be included in the output:
1534 Poll request capability.
1536 DSSS/OFDM capability.
1538 Extended Service Set (ESS).
1540 Independent Basic Service Set (IBSS).
1543 The station requires authentication.
1545 Robust Secure Network (RSN).
1548 Indicates that the station is doing short preamble to optionally
1549 improve throughput performance with 802.11g and 802.11b.
1551 Pollable capability.
1553 Short slot time capability.
1556 By default interesting information elements captured from the neighboring
1557 stations are displayed at the end of each row.
1558 Possible elements include:
1560 (station supports WME),
1562 (station supports WPA),
1564 (station supports WPS),
1566 (station supports 802.11i/RSN),
1568 (station supports 802.11n/HT communication),
1570 (station supports Atheros protocol extensions),
1572 (station supports unknown vendor-specific extensions).
1575 flag is used all the information elements and their
1576 contents will be shown.
1579 flag also enables display of long SSIDs.
1582 command is another way of requesting this information.
1584 When operating as an access point display the stations that are
1585 currently associated.
1586 When operating in ad-hoc mode display stations identified as
1587 neighbors in the IBSS.
1588 When operating in mesh mode display stations identified as
1589 neighbors in the MBSS.
1590 When operating in station mode display the access point.
1591 Capabilities advertised by the stations are described under
1595 The following flags can be included in the output:
1599 Indicates that the station is permitted to send/receive data frames.
1601 Extended Rate Phy (ERP).
1602 Indicates that the station is operating in an 802.11g network
1603 using extended transmit rates.
1605 High Throughput (HT).
1606 Indicates that the station is using HT transmit rates.
1609 follows immediately after then the station associated
1610 using deprecated mechanisms supported only when
1615 Indicates that the station is operating in power save mode.
1617 Quality of Service (QoS).
1618 Indicates that the station is using QoS encapsulation for
1620 QoS encapsulation is enabled only when WME mode is enabled.
1622 Short GI in HT 40MHz mode enabled.
1625 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1627 Transitional Security Network (TSN).
1628 Indicates that the station associated using TSN; see also
1632 Wi-Fi Protected Setup (WPS).
1633 Indicates that the station associated using WPS.
1635 Short GI in HT 20MHz mode enabled.
1638 By default information elements received from associated stations
1639 are displayed in a short form; the
1641 flag causes this information to be displayed symbolically.
1643 Display the current channel parameters to use when operating in WME mode.
1646 option is specified then both channel and BSS parameters are displayed
1647 for each AC (first channel, then BSS).
1648 When WME mode is enabled for an adaptor this information will be
1649 displayed with the regular status; this command is mostly useful
1650 for examining parameters when WME mode is disabled.
1651 See the description of the
1653 directive for information on the various parameters.
1654 .It Cm maxretry Ar count
1655 Set the maximum number of tries to use in sending unicast frames.
1656 The default setting is 6 but drivers may override this with a value
1658 .It Cm mcastrate Ar rate
1659 Set the rate for transmitting multicast/broadcast frames.
1660 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1661 This rate should be valid for the current operating conditions;
1662 if an invalid rate is specified drivers are free to chose an
1664 .It Cm mgtrate Ar rate
1665 Set the rate for transmitting management and/or control frames.
1666 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1668 Set the location to use in calculating regulatory constraints.
1669 The location is also advertised in beacon and probe response frames
1670 when 802.11d is enabled with
1679 Enable powersave operation.
1680 When operating as a client, the station will conserve power by
1681 periodically turning off the radio and listening for
1682 messages from the access point telling it there are packets waiting.
1683 The station must then retrieve the packets.
1684 Not all devices support power save operation as a client.
1685 The 802.11 specification requires that all access points support
1686 power save but some drivers do not.
1689 to disable powersave operation when operating as a client.
1690 .It Cm powersavesleep Ar sleep
1691 Set the desired max powersave sleep time in TU's (1024 usecs).
1692 By default the max powersave sleep time is 100 TU's.
1693 .It Cm protmode Ar technique
1694 For interfaces operating in 802.11g, use the specified
1696 for protecting OFDM frames in a mixed 11b/11g network.
1697 The set of valid techniques is
1703 Technique names are case insensitive.
1704 Not all devices support
1706 as a protection technique.
1708 When operating as an access point in 802.11g mode allow only
1709 11g-capable stations to associate (11b-only stations are not
1710 permitted to associate).
1711 To allow both 11g and 11b-only stations to associate, use
1714 When operating as an access point in 802.11n mode allow only
1715 HT-capable stations to associate (legacy stations are not
1716 permitted to associate).
1717 To allow both HT and legacy stations to associate, use
1719 .It Cm regdomain Ar sku
1720 Set the regulatory domain to use in calculating the regulatory constraints
1722 In particular the set of available channels, how the wireless device
1723 will operation on the channels, and the maximum transmit power that
1724 can be used on a channel are defined by this setting.
1725 Regdomain codes (SKU's) are taken from
1726 .Pa /etc/regdomain.xml
1728 be viewed with the ``list countries'' request.
1729 Note that not all devices support changing the regdomain from a default
1730 setting; typically stored in EEPROM.
1738 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1740 Note that RIFS must be supported by both the station and access point
1744 .It Cm roam:rate Ar rate
1745 Set the threshold for controlling roaming when operating in a BSS.
1748 parameter specifies the transmit rate in megabits
1749 at which roaming should be considered.
1750 If the current transmit rate drops below this setting and background scanning
1751 is enabled, then the system will check if a more desirable access point is
1752 available and switch over to it.
1753 The current scan cache contents are used if they are considered
1754 valid according to the
1756 parameter; otherwise a background scan operation is triggered before
1757 any selection occurs.
1758 Each channel type has a separate rate threshold; the default values are:
1759 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1760 .It Cm roam:rssi Ar rssi
1761 Set the threshold for controlling roaming when operating in a BSS.
1764 parameter specifies the receive signal strength in dBm units
1765 at which roaming should be considered.
1766 If the current rssi drops below this setting and background scanning
1767 is enabled, then the system will check if a more desirable access point is
1768 available and switch over to it.
1769 The current scan cache contents are used if they are considered
1770 valid according to the
1772 parameter; otherwise a background scan operation is triggered before
1773 any selection occurs.
1774 Each channel type has a separate rssi threshold; the default values are
1776 .It Cm roaming Ar mode
1777 When operating as a station, control how the system will
1778 behave when communication with the current access point
1782 argument may be one of
1784 (leave it to the hardware device to decide),
1786 (handle either in the device or the operating system\[em]as appropriate),
1788 (do nothing until explicitly instructed).
1789 By default, the device is left to handle this if it is
1790 capable; otherwise, the operating system will automatically
1791 attempt to reestablish communication.
1792 Manual mode is used by applications such as
1793 .Xr wpa_supplicant 8
1794 that want to control the selection of an access point.
1795 .It Cm rtsthreshold Ar length
1796 Set the threshold for which
1797 transmitted frames are preceded by transmission of an
1803 is the frame size in bytes and must be in the range 1 to 2346.
1811 disables transmission of RTS frames.
1812 Not all adapters support setting the RTS threshold.
1814 Initiate a scan of neighboring stations, wait for it to complete, and
1815 display all stations found.
1816 Only the super-user can initiate a scan.
1819 for information on the display.
1820 By default a background scan is done; otherwise a foreground
1821 scan is done and the station may roam to a different access point.
1824 request can be used to show recent scan results without
1825 initiating a new scan.
1826 .It Cm scanvalid Ar threshold
1827 Set the maximum time the scan cache contents are considered valid;
1828 i.e., will be used without first triggering a scan operation to
1832 parameter is specified in seconds and defaults to 60 seconds.
1833 The minimum setting for
1836 One should take care setting this threshold; if it is set too low
1837 then attempts to roam to another access point may trigger unnecessary
1838 background scan operations.
1840 Enable use of Short Guard Interval when operating in 802.11n
1842 NB: this currently enables Short GI on both HT40 and HT20 channels.
1843 To disable Short GI use
1846 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1847 when operating in 802.11n.
1848 A station operating with Static SMPS maintains only a single
1849 receive chain active (this can significantly reduce power consumption).
1853 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1854 when operating in 802.11n.
1855 A station operating with Dynamic SMPS maintains only a single
1856 receive chain active but switches to multiple receive chains when it
1857 receives an RTS frame (this can significantly reduce power consumption).
1858 Note that stations cannot distinguish between RTS/CTS intended to
1859 enable multiple receive chains and those used for other purposes.
1863 Set the desired Service Set Identifier (aka network name).
1864 The SSID is a string up to 32 characters
1865 in length and may be specified as either a normal string or in
1866 hexadecimal when preceded by
1868 Additionally, the SSID may be cleared by setting it to
1870 .It Cm tdmaslot Ar slot
1871 When operating with TDMA, use the specified
1876 is a number between 0 and the maximum number of slots in the BSS.
1877 Note that a station configured as slot 0 is a master and
1878 will broadcast beacon frames advertising the BSS;
1879 stations configured to use other slots will always
1880 scan to locate a master before they ever transmit.
1884 .It Cm tdmaslotcnt Ar cnt
1885 When operating with TDMA, setup a BSS with
1888 The slot count may be at most 8.
1889 The current implementation is only tested with two stations
1890 (i.e., point to point applications).
1891 This setting is only meaningful when a station is configured as slot 0;
1892 other stations adopt this setting from the BSS they join.
1896 .It Cm tdmaslotlen Ar len
1897 When operating with TDMA, setup a BSS such that each station has a slot
1900 The slot length must be at least 150 microseconds (1/8 TU)
1901 and no more than 65 milliseconds.
1902 Note that setting too small a slot length may result in poor channel
1903 bandwidth utilization due to factors such as timer granularity and
1905 This setting is only meaningful when a station is configured as slot 0;
1906 other stations adopt this setting from the BSS they join.
1909 is set to 10 milliseconds.
1910 .It Cm tdmabintval Ar intval
1911 When operating with TDMA, setup a BSS such that beacons are transmitted every
1913 superframes to synchronize the TDMA slot timing.
1914 A superframe is defined as the number of slots times the slot length; e.g.,
1915 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1916 The beacon interval may not be zero.
1919 causes the timers to be resynchronized more often; this can be help if
1920 significant timer drift is observed.
1925 When operating as an access point with WPA/802.11i allow legacy
1926 stations to associate using static key WEP and open authentication.
1927 To disallow legacy station use of WEP, use
1929 .It Cm txpower Ar power
1930 Set the power used to transmit frames.
1933 argument is specified in .5 dBm units.
1934 Out of range values are truncated.
1935 Typically only a few discreet power settings are available and
1936 the driver will use the setting closest to the specified value.
1937 Not all adapters support changing the transmit power.
1938 .It Cm ucastrate Ar rate
1939 Set a fixed rate for transmitting unicast frames.
1940 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1941 This rate should be valid for the current operating conditions;
1942 if an invalid rate is specified drivers are free to chose an
1944 .It Cm wepmode Ar mode
1945 Set the desired WEP mode.
1946 Not all adapters support all modes.
1947 The set of valid modes is
1953 mode explicitly tells the adaptor to allow association with access
1954 points which allow both encrypted and unencrypted traffic.
1957 means that the access point must only allow encrypted connections.
1960 is generally another name for
1962 Modes are case insensitive.
1963 .It Cm weptxkey Ar index
1964 Set the WEP key to be used for transmission.
1965 This is the same as setting the default transmission key with
1967 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1968 Set the selected WEP key.
1971 is not given, key 1 is set.
1972 A WEP key will be either 5 or 13
1973 characters (40 or 104 bits) depending on the local network and the
1974 capabilities of the adaptor.
1975 It may be specified either as a plain
1976 string or as a string of hexadecimal digits preceded by
1978 For maximum portability, hex keys are recommended;
1979 the mapping of text keys to WEP encryption is usually driver-specific.
1982 drivers do this mapping differently to
1984 A key may be cleared by setting it to
1986 If WEP is supported then there are at least four keys.
1987 Some adapters support more than four keys.
1988 If that is the case, then the first four keys
1989 (1-4) will be the standard temporary keys and any others will be adaptor
1990 specific keys such as permanent keys stored in NVRAM.
1992 Note that you must set a default transmit key with
1994 for the system to know which key to use in encrypting outbound traffic.
1996 Enable Wireless Multimedia Extensions (WME) support, if available,
1997 for the specified interface.
1998 WME is a subset of the IEEE 802.11e standard to support the
1999 efficient communication of realtime and multimedia data.
2000 To disable WME support, use
2002 Another name for this parameter is
2005 The following parameters are meaningful only when WME support is in use.
2006 Parameters are specified per-AC (Access Category) and
2007 split into those that are used by a station when acting
2008 as an access point and those for client stations in the BSS.
2009 The latter are received from the access point and may not be changed
2011 The following Access Categories are recognized:
2013 .Bl -tag -width ".Cm AC_BK" -compact
2017 best effort delivery,
2032 AC parameters are case-insensitive.
2033 Traffic classification is done in the operating system using the
2034 vlan priority associated with data frames or the
2035 ToS (Type of Service) indication in IP-encapsulated frames.
2036 If neither information is present, traffic is assigned to the
2037 Best Effort (BE) category.
2038 .Bl -tag -width indent
2040 Set the ACK policy for QoS transmissions by the local station;
2041 this controls whether or not data frames transmitted by a station
2042 require an ACK response from the receiving station.
2043 To disable waiting for an ACK use
2045 This parameter is applied only to the local station.
2047 Enable the Admission Control Mandatory (ACM) mechanism
2048 for transmissions by the local station.
2049 To disable the ACM use
2051 On stations in a BSS this parameter is read-only and indicates
2052 the setting received from the access point.
2053 NB: ACM is not supported right now.
2054 .It Cm aifs Ar ac Ar count
2055 Set the Arbitration Inter Frame Spacing (AIFS)
2056 channel access parameter to use for transmissions
2057 by the local station.
2058 On stations in a BSS this parameter is read-only and indicates
2059 the setting received from the access point.
2060 .It Cm cwmin Ar ac Ar count
2061 Set the CWmin channel access parameter to use for transmissions
2062 by the local station.
2063 On stations in a BSS this parameter is read-only and indicates
2064 the setting received from the access point.
2065 .It Cm cwmax Ar ac Ar count
2066 Set the CWmax channel access parameter to use for transmissions
2067 by the local station.
2068 On stations in a BSS this parameter is read-only and indicates
2069 the setting received from the access point.
2070 .It Cm txoplimit Ar ac Ar limit
2071 Set the Transmission Opportunity Limit channel access parameter
2072 to use for transmissions by the local station.
2073 This parameter defines an interval of time when a WME station
2074 has the right to initiate transmissions onto the wireless medium.
2075 On stations in a BSS this parameter is read-only and indicates
2076 the setting received from the access point.
2077 .It Cm bss:aifs Ar ac Ar count
2078 Set the AIFS channel access parameter to send to stations in a BSS.
2079 This parameter is meaningful only when operating in ap mode.
2080 .It Cm bss:cwmin Ar ac Ar count
2081 Set the CWmin channel access parameter to send to stations in a BSS.
2082 This parameter is meaningful only when operating in ap mode.
2083 .It Cm bss:cwmax Ar ac Ar count
2084 Set the CWmax channel access parameter to send to stations in a BSS.
2085 This parameter is meaningful only when operating in ap mode.
2086 .It Cm bss:txoplimit Ar ac Ar limit
2087 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2088 This parameter is meaningful only when operating in ap mode.
2091 Enable Wireless Privacy Subscriber support.
2092 Note that WPS support requires a WPS-capable supplicant.
2093 To disable this function use
2097 The following parameters support an optional access control list
2098 feature available with some adapters when operating in ap mode; see
2100 This facility allows an access point to accept/deny association
2101 requests based on the MAC address of the station.
2102 Note that this feature does not significantly enhance security
2103 as MAC address spoofing is easy to do.
2104 .Bl -tag -width indent
2105 .It Cm mac:add Ar address
2106 Add the specified MAC address to the database.
2107 Depending on the policy setting association requests from the
2108 specified station will be allowed or denied.
2110 Set the ACL policy to permit association only by
2111 stations registered in the database.
2112 .It Cm mac:del Ar address
2113 Delete the specified MAC address from the database.
2115 Set the ACL policy to deny association only by
2116 stations registered in the database.
2117 .It Cm mac:kick Ar address
2118 Force the specified station to be deauthenticated.
2119 This typically is done to block a station after updating the
2122 Set the ACL policy to allow all stations to associate.
2124 Delete all entries in the database.
2126 Set the ACL policy to permit association only by
2127 stations approved by a RADIUS server.
2128 Note that this feature requires the
2130 program be configured to do the right thing
2131 as it handles the RADIUS processing
2132 (and marks stations as authorized).
2135 The following parameters are related to a wireless interface operating in mesh
2137 .Bl -tag -width indent
2138 .It Cm meshid Ar meshid
2139 Set the desired Mesh Identifier.
2140 The Mesh ID is a string up to 32 characters in length.
2141 A mesh interface must have a Mesh Identifier specified
2142 to reach an operational state.
2143 .It Cm meshttl Ar ttl
2144 Set the desired ``time to live'' for mesh forwarded packets;
2145 this is the number of hops a packet may be forwarded before
2147 The default setting for
2151 Enable or disable peering with neighbor mesh stations.
2152 Stations must peer before any data packets can be exchanged.
2157 Enable or disable forwarding packets by a mesh interface.
2162 This attribute specifies whether or not the mesh STA activates mesh gate
2167 .It Cm meshmetric Ar protocol
2170 as the link metric protocol used on a mesh network.
2171 The default protocol is called
2173 The mesh interface will restart after changing this setting.
2174 .It Cm meshpath Ar protocol
2177 as the path selection protocol used on a mesh network.
2178 The only available protocol at the moment is called
2180 (Hybrid Wireless Mesh Protocol).
2181 The mesh interface will restart after changing this setting.
2182 .It Cm hwmprootmode Ar mode
2183 Stations on a mesh network can operate as ``root nodes.''
2184 Root nodes try to find paths to all mesh nodes and advertise themselves
2186 When there is a root mesh node on a network, other mesh nodes can setup
2187 paths between themselves faster because they can use the root node
2188 to find the destination.
2189 This path may not be the best, but on-demand
2190 routing will eventually find the best path.
2191 The following modes are recognized:
2193 .Bl -tag -width ".Cm PROACTIVE" -compact
2197 Send broadcast path requests every two seconds.
2198 Nodes on the mesh without a path to this root mesh station with try to
2199 discover a path to us.
2201 Send broadcast path requests every two seconds and every node must reply
2202 with a path reply even if it already has a path to this root mesh station.
2204 Send broadcast root announcement (RANN) frames.
2205 Nodes on the mesh without a path to this root mesh station with try to
2206 discover a path to us.
2212 .It Cm hwmpmaxhops Ar cnt
2213 Set the maximum number of hops allowed in an HMWP path to
2215 The default setting for
2220 The following parameters are for compatibility with other systems:
2221 .Bl -tag -width indent
2223 Another name for the
2229 .It Cm stationname Ar name
2230 Set the name of this station.
2231 The station name is not part of the IEEE 802.11
2232 protocol though some interfaces support it.
2234 seems to be meaningful to identical or virtually identical equipment.
2235 Setting the station name is identical in syntax to setting the SSID.
2242 Another way of saying
2248 Another way of saying
2254 Another way of saying:
2255 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2261 .Ar n : k1 , k2 , k3 , k4
2264 Another way of saying
2265 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2270 Another way of saying
2277 The following parameters are specific to bridge interfaces:
2278 .Bl -tag -width indent
2279 .It Cm addm Ar interface
2280 Add the interface named by
2282 as a member of the bridge.
2283 The interface is put into promiscuous mode
2284 so that it can receive every packet sent on the network.
2285 .It Cm deletem Ar interface
2286 Remove the interface named by
2289 Promiscuous mode is disabled on the interface when
2290 it is removed from the bridge.
2291 .It Cm maxaddr Ar size
2292 Set the size of the bridge address cache to
2294 The default is 2000 entries.
2295 .It Cm timeout Ar seconds
2296 Set the timeout of address cache entries to
2301 is zero, then address cache entries will not be expired.
2302 The default is 1200 seconds.
2304 Display the addresses that have been learned by the bridge.
2305 .It Cm static Ar interface-name Ar address
2306 Add a static entry into the address cache pointing to
2307 .Ar interface-name .
2308 Static entries are never aged out of the cache or re-placed, even if the
2309 address is seen on a different interface.
2310 .It Cm deladdr Ar address
2313 from the address cache.
2315 Delete all dynamically-learned addresses from the address cache.
2317 Delete all addresses, including static addresses, from the address cache.
2318 .It Cm discover Ar interface
2319 Mark an interface as a
2322 When the bridge has no address cache entry
2323 (either dynamic or static)
2324 for the destination address of a packet,
2325 the bridge will forward the packet to all
2326 member interfaces marked as
2328 This is the default for all interfaces added to a bridge.
2329 .It Cm -discover Ar interface
2332 attribute on a member interface.
2333 For packets without the
2335 attribute, the only packets forwarded on the interface are broadcast
2336 or multicast packets and packets for which the destination address
2337 is known to be on the interface's segment.
2338 .It Cm learn Ar interface
2339 Mark an interface as a
2342 When a packet arrives on such an interface, the source
2343 address of the packet is entered into the address cache as being a
2344 destination address on the interface's segment.
2345 This is the default for all interfaces added to a bridge.
2346 .It Cm -learn Ar interface
2349 attribute on a member interface.
2350 .It Cm sticky Ar interface
2351 Mark an interface as a
2354 Dynamically learned address entries are treated at static once entered into
2356 Sticky entries are never aged out of the cache or replaced, even if the
2357 address is seen on a different interface.
2358 .It Cm -sticky Ar interface
2361 attribute on a member interface.
2362 .It Cm private Ar interface
2363 Mark an interface as a
2366 A private interface does not forward any traffic to any other port that is also
2367 a private interface.
2368 .It Cm -private Ar interface
2371 attribute on a member interface.
2372 .It Cm span Ar interface
2373 Add the interface named by
2375 as a span port on the bridge.
2376 Span ports transmit a copy of every frame received by the bridge.
2377 This is most useful for snooping a bridged network passively on
2378 another host connected to one of the span ports of the bridge.
2379 .It Cm -span Ar interface
2380 Delete the interface named by
2382 from the list of span ports of the bridge.
2383 .It Cm stp Ar interface
2384 Enable Spanning Tree protocol on
2388 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2389 Spanning Tree is used to detect and remove loops in a network topology.
2390 .It Cm -stp Ar interface
2391 Disable Spanning Tree protocol on
2393 This is the default for all interfaces added to a bridge.
2394 .It Cm edge Ar interface
2398 An edge port connects directly to end stations cannot create bridging
2399 loops in the network, this allows it to transition straight to forwarding.
2400 .It Cm -edge Ar interface
2401 Disable edge status on
2403 .It Cm autoedge Ar interface
2406 to automatically detect edge status.
2407 This is the default for all interfaces added to a bridge.
2408 .It Cm -autoedge Ar interface
2409 Disable automatic edge status on
2411 .It Cm ptp Ar interface
2414 as a point to point link.
2415 This is required for straight transitions to forwarding and
2416 should be enabled on a direct link to another RSTP capable switch.
2417 .It Cm -ptp Ar interface
2418 Disable point to point link status on
2420 This should be disabled for a half duplex link and for an interface
2421 connected to a shared network segment,
2422 like a hub or a wireless network.
2423 .It Cm autoptp Ar interface
2424 Automatically detect the point to point status on
2426 by checking the full duplex link status.
2427 This is the default for interfaces added to the bridge.
2428 .It Cm -autoptp Ar interface
2429 Disable automatic point to point link detection on
2431 .It Cm maxage Ar seconds
2432 Set the time that a Spanning Tree protocol configuration is valid.
2433 The default is 20 seconds.
2434 The minimum is 6 seconds and the maximum is 40 seconds.
2435 .It Cm fwddelay Ar seconds
2436 Set the time that must pass before an interface begins forwarding
2437 packets when Spanning Tree is enabled.
2438 The default is 15 seconds.
2439 The minimum is 4 seconds and the maximum is 30 seconds.
2440 .It Cm hellotime Ar seconds
2441 Set the time between broadcasting of Spanning Tree protocol
2442 configuration messages.
2443 The hello time may only be changed when operating in legacy stp mode.
2444 The default is 2 seconds.
2445 The minimum is 1 second and the maximum is 2 seconds.
2446 .It Cm priority Ar value
2447 Set the bridge priority for Spanning Tree.
2448 The default is 32768.
2449 The minimum is 0 and the maximum is 61440.
2450 .It Cm proto Ar value
2451 Set the Spanning Tree protocol.
2452 The default is rstp.
2453 The available options are stp and rstp.
2454 .It Cm holdcnt Ar value
2455 Set the transmit hold count for Spanning Tree.
2456 This is the number of packets transmitted before being rate limited.
2458 The minimum is 1 and the maximum is 10.
2459 .It Cm ifpriority Ar interface Ar value
2460 Set the Spanning Tree priority of
2465 The minimum is 0 and the maximum is 240.
2466 .It Cm ifpathcost Ar interface Ar value
2467 Set the Spanning Tree path cost of
2471 The default is calculated from the link speed.
2472 To change a previously selected path cost back to automatic, set the
2474 The minimum is 1 and the maximum is 200000000.
2475 .It Cm ifmaxaddr Ar interface Ar size
2476 Set the maximum number of hosts allowed from an interface, packets with unknown
2477 source addresses are dropped until an existing host cache entry expires or is
2479 Set to 0 to disable.
2482 The following parameters are specific to lagg interfaces:
2483 .Bl -tag -width indent
2484 .It Cm laggtype Ar type
2485 When creating a lagg interface the type can be specified as either
2489 If not specified ethernet is the default lagg type.
2490 .It Cm laggport Ar interface
2491 Add the interface named by
2493 as a port of the aggregation interface.
2494 .It Cm -laggport Ar interface
2495 Remove the interface named by
2497 from the aggregation interface.
2498 .It Cm laggproto Ar proto
2499 Set the aggregation protocol.
2502 The available options are
2510 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2511 Set the packet layers to hash for aggregation protocols which load balance.
2514 The options can be combined using commas.
2516 .Bl -tag -width ".Cm l2" -compact
2518 src/dst mac address and optional vlan number.
2520 src/dst address for IPv4 or IPv6.
2522 src/dst port for TCP/UDP/SCTP.
2525 Enable local hash computation for RSS hash on the interface.
2530 modes will use the RSS hash from the network card if available
2531 to avoid computing one, this may give poor traffic distribution
2532 if the hash is invalid or uses less of the protocol header information.
2534 disables use of RSS hash from the network card.
2535 The default value can be set via the
2536 .Va net.link.lagg.default_use_flowid
2547 Use the RSS hash from the network card if available.
2548 .It Cm flowid_shift Ar number
2549 Set a shift parameter for RSS local hash computation.
2550 Hash is calculated by using flowid bits in a packet header mbuf
2551 which are shifted by the number of this parameter.
2553 Enable selection of egress ports based on the native
2555 domain for the packets being transmitted.
2556 This is currently only implemented for lacp mode.
2559 hardware, running a kernel compiled with the
2561 option, and when interfaces from multiple
2563 domains are ports of the aggregation interface.
2565 Disable selection of egress ports based on the native
2567 domain for the packets being transmitted.
2568 .It Cm lacp_fast_timeout
2569 Enable lacp fast-timeout on the interface.
2570 .It Cm -lacp_fast_timeout
2571 Disable lacp fast-timeout on the interface.
2573 Enable lacp strict compliance on the interface.
2574 The default value can be set via the
2575 .Va net.link.lagg.lacp.default_strict_mode
2586 Disable lacp strict compliance on the interface.
2587 .It Cm rr_limit Ar number
2588 Configure a stride for an interface in round-robin mode.
2589 The default stride is 1.
2592 The following parameters apply to IP tunnel interfaces,
2594 .Bl -tag -width indent
2595 .It Cm tunnel Ar src_addr dest_addr
2596 Configure the physical source and destination address for IP tunnel
2602 are interpreted as the outer source/destination for the encapsulating
2605 Unconfigure the physical source and destination address for IP tunnel
2606 interfaces previously configured with
2609 Another name for the
2612 .It Cm accept_rev_ethip_ver
2613 Set a flag to accept both correct EtherIP packets and ones
2614 with reversed version field.
2616 This is for backward compatibility with
2618 6.2, 6.3, 7.0, and 7.1.
2619 .It Cm -accept_rev_ethip_ver
2621 .Cm accept_rev_ethip_ver .
2622 .It Cm ignore_source
2623 Set a flag to accept encapsulated packets destined to this host
2624 independently from source address.
2625 This may be useful for hosts, that receive encapsulated packets
2626 from the load balancers.
2627 .It Cm -ignore_source
2630 .It Cm send_rev_ethip_ver
2631 Set a flag to send EtherIP packets with reversed version
2632 field intentionally.
2633 Disabled by default.
2634 This is for backward compatibility with
2636 6.2, 6.3, 7.0, and 7.1.
2637 .It Cm -send_rev_ethip_ver
2639 .Cm send_rev_ethip_ver .
2642 The following parameters apply to GRE tunnel interfaces,
2644 .Bl -tag -width indent
2645 .It Cm tunnel Ar src_addr dest_addr
2646 Configure the physical source and destination address for GRE tunnel
2652 are interpreted as the outer source/destination for the encapsulating
2655 Unconfigure the physical source and destination address for GRE tunnel
2656 interfaces previously configured with
2659 Another name for the
2662 .It Cm grekey Ar key
2663 Configure the GRE key to be used for outgoing packets.
2665 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2666 This command will result in a four byte MTU reduction on the interface.
2669 The following parameters are specific to
2672 .Bl -tag -width indent
2673 .It Cm syncdev Ar iface
2674 Use the specified interface
2675 to send and receive pfsync state synchronisation messages.
2677 Stop sending pfsync state synchronisation messages over the network.
2678 .It Cm syncpeer Ar peer_address
2679 Make the pfsync link point-to-point rather than using
2680 multicast to broadcast the state synchronisation messages.
2681 The peer_address is the IP address of the other host taking part in
2684 Broadcast the packets using multicast.
2686 Set the maximum number of updates for a single state which
2687 can be collapsed into one.
2688 This is an 8-bit number; the default value is 128.
2690 Defer transmission of the first packet in a state until a peer has
2691 acknowledged that the associated state has been inserted.
2693 Do not defer the first packet in a state.
2694 This is the default.
2697 The following parameters are specific to
2700 .Bl -tag -width indent
2701 .It Cm vlan Ar vlan_tag
2702 Set the VLAN tag value to
2704 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2705 or 802.1ad VLAN header for packets sent from the
2712 must both be set at the same time.
2713 .It Cm vlanproto Ar vlan_proto
2714 Set the VLAN encapsulation protocol to
2716 Supported encapsulation protocols are currently
2720 The default encapsulation protocol is
2722 .It Cm vlanpcp Ar priority_code_point
2725 is an 3-bit field which refers to the IEEE 802.1p
2726 class of service and maps to the frame priority level.
2728 Values in order of priority are:
2730 .Pq Dv Background (lowest) ,
2732 .Pq Dv Best effort (default) ,
2734 .Pq Dv Excellent effort ,
2736 .Pq Dv Critical applications ,
2738 .Pq Dv Video, < 100ms latency ,
2740 .Pq Dv Video, < 10ms latency ,
2742 .Pq Dv Internetwork control ,
2744 .Pq Dv Network control (highest) .
2745 .It Cm vlandev Ar iface
2746 Associate the physical interface
2751 Packets transmitted through the
2754 diverted to the specified physical interface
2756 with 802.1Q VLAN encapsulation.
2757 Packets with 802.1Q encapsulation received
2758 by the parent interface with the correct VLAN Identifier will be diverted to
2764 interface is assigned a
2765 copy of the parent interface's flags and the parent's Ethernet address.
2770 must both be set at the same time.
2773 interface already has
2774 a physical interface associated with it, this command will fail.
2776 change the association to another physical interface, the existing
2777 association must be cleared first.
2779 Note: if the hardware tagging capability
2780 is set on the parent interface, the
2783 interface's behavior changes:
2786 interface recognizes that the
2787 parent interface supports insertion and extraction of VLAN tags on its
2788 own (usually in firmware) and that it should pass packets to and from
2789 the parent unaltered.
2790 .It Fl vlandev Op Ar iface
2793 pseudo device, disassociate the parent interface from it.
2794 This breaks the link between the
2796 interface and its parent,
2797 clears its VLAN Identifier, flags and its link address and shuts the interface
2801 argument is useless and hence deprecated.
2804 The following parameters are used to configure
2807 .Bl -tag -width indent
2808 .It Cm vxlanid Ar identifier
2809 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2810 virtual network segment membership of the interface.
2811 .It Cm vxlanlocal Ar address
2812 The source address used in the encapsulating IPv4/IPv6 header.
2813 The address should already be assigned to an existing interface.
2814 When the interface is configured in unicast mode, the listening socket
2815 is bound to this address.
2816 .It Cm vxlanremote Ar address
2817 The interface can be configured in a unicast, or point-to-point, mode
2818 to create a tunnel between two hosts.
2819 This is the IP address of the remote end of the tunnel.
2820 .It Cm vxlangroup Ar address
2821 The interface can be configured in a multicast mode
2822 to create a virtual network of hosts.
2823 This is the IP multicast group address the interface will join.
2824 .It Cm vxlanlocalport Ar port
2825 The port number the interface will listen on.
2826 The default port number is 4789.
2827 .It Cm vxlanremoteport Ar port
2828 The destination port number used in the encapsulating IPv4/IPv6 header.
2829 The remote host should be listening on this port.
2830 The default port number is 4789.
2831 Note some other implementations, such as Linux,
2832 do not default to the IANA assigned port,
2833 but instead listen on port 8472.
2834 .It Cm vxlanportrange Ar low high
2835 The range of source ports used in the encapsulating IPv4/IPv6 header.
2836 The port selected within the range is based on a hash of the inner frame.
2837 A range is useful to provide entropy within the outer IP header
2838 for more effective load balancing.
2839 The default range is between the
2842 .Va net.inet.ip.portrange.first
2844 .Va net.inet.ip.portrange.last
2845 .It Cm vxlantimeout Ar timeout
2846 The maximum time, in seconds, before an entry in the forwarding table
2848 The default is 1200 seconds (20 minutes).
2849 .It Cm vxlanmaxaddr Ar max
2850 The maximum number of entries in the forwarding table.
2851 The default is 2000.
2852 .It Cm vxlandev Ar dev
2853 When the interface is configured in multicast mode, the
2855 interface is used to transmit IP multicast packets.
2856 .It Cm vxlanttl Ar ttl
2857 The TTL used in the encapsulating IPv4/IPv6 header.
2860 The source IP address and inner source Ethernet MAC address of
2861 received packets are used to dynamically populate the forwarding table.
2862 When in multicast mode, an entry in the forwarding table allows the
2863 interface to send the frame directly to the remote host instead of
2864 broadcasting the frame to the multicast group.
2865 This is the default.
2867 The forwarding table is not populated by received packets.
2869 Delete all dynamically-learned addresses from the forwarding table.
2870 .It Cm vxlanflushall
2871 Delete all addresses, including static addresses, from the forwarding table.
2874 The following parameters are used to configure
2876 protocol on an interface:
2877 .Bl -tag -width indent
2879 Set the virtual host ID.
2880 This is a required setting to initiate
2882 If the virtual host ID does not exist yet, it is created and attached to the
2883 interface, otherwise configuration of an existing vhid is adjusted.
2886 keyword is supplied along with an
2890 address, then this address is configured to be run under control of the
2892 Whenever a last address that refers to a particular vhid is removed from an
2893 interface, the vhid is automatically removed from interface and destroyed.
2894 Any other configuration parameters for the
2896 protocol should be supplied along with the
2899 Acceptable values for vhid are 1 to 255.
2900 .It Cm advbase Ar seconds
2901 Specifies the base of the advertisement interval in seconds.
2902 The acceptable values are 1 to 255.
2903 The default value is 1.
2904 .It Cm advskew Ar interval
2905 Specifies the skew to add to the base advertisement interval to
2906 make one host advertise slower than another host.
2907 It is specified in 1/256 of seconds.
2908 The acceptable values are 1 to 254.
2909 The default value is 0.
2910 .It Cm pass Ar phrase
2911 Set the authentication key to
2913 .It Cm state Ar MASTER|BACKUP
2914 Forcibly change state of a given vhid.
2919 utility displays the current configuration for a network interface
2920 when no optional parameters are supplied.
2921 If a protocol family is specified,
2923 will report only the details specific to that protocol family.
2927 flag is passed before an interface name,
2929 will display the capability list and all
2930 of the supported media for the specified interface.
2933 flag is supplied, address lifetime is displayed for IPv6 addresses,
2934 as time offset string.
2938 flag may be used instead of an interface name.
2941 to display information about all interfaces in the system.
2944 flag limits this to interfaces that are down,
2946 limits this to interfaces that are up,
2948 limits this to members of the specified group of interfaces, and
2950 excludes members of the specified group from the list.
2955 flags may be specified to apply both conditions.
2958 should be specified as later override previous ones
2962 may contain shell patterns in which case it should be quoted.
2963 When no arguments are given,
2969 flag may be used to list all available interfaces on the system, with
2970 no other additional information.
2973 is specified, only interfaces of that type will be listed.
2975 will list only Ethernet adapters, excluding the loopback interface.
2976 Use of this flag is mutually exclusive
2977 with all other flags and commands, except for
2979 (only list interfaces that are down)
2982 (only list interfaces that are up).
2986 flag may be used to get more verbose status for an interface.
2990 flag may be used to list all of the interface cloners available on
2991 the system, with no additional information.
2992 Use of this flag is mutually exclusive with all other flags and commands.
2996 flag causes keying information for the interface, if available, to be
2998 For example, the values of 802.11 WEP keys and
3000 passphrases will be printed, if accessible to the current user.
3001 This information is not printed by default, as it may be considered
3004 If the network interface driver is not present in the kernel then
3006 will attempt to load it.
3009 flag disables this behavior.
3011 Only the super-user may modify the configuration of a network interface.
3013 Assign the IPv4 address
3015 with a network mask of
3019 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3021 Add the IPv4 address
3023 with the CIDR network prefix
3029 as a synonym for the canonical form of the option
3031 .Dl # ifconfig em0 inet 192.0.2.45/28 add
3033 Remove the IPv4 address
3037 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3039 Enable IPv6 functionality of the interface:
3040 .Dl # ifconfig em0 inet6 -ifdisabled
3042 Add the IPv6 address
3043 .Li 2001:DB8:DBDB::123/48
3046 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3047 Note that lower case hexadecimal IPv6 addresses are acceptable.
3049 Remove the IPv6 address added in the above example,
3052 character as shorthand for the network prefix,
3055 as a synonym for the canonical form of the option
3057 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
3059 Configure a single CARP redundant address on igb0, and then switch it
3061 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3062 .Dl # ifconfig igb0 vhid 1 state master
3064 Configure the interface
3066 to use 100baseTX, full duplex Ethernet media options:
3067 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3069 Label the em0 interface as an uplink:
3070 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3072 Create the software network interface
3074 .Dl # ifconfig gif1 create
3076 Destroy the software network interface
3078 .Dl # ifconfig gif1 destroy
3080 Display available wireless networks using
3082 .Dl # ifconfig wlan0 list scan
3084 Display inet and inet6 address subnet masks in CIDR notation
3085 .Dl # ifconfig -f inet:cidr,inet6:cidr
3087 Display interfaces that are up with the exception of loopback
3088 .Dl # ifconfig -a -u -G lo
3090 Messages indicating the specified interface does not exist, the
3091 requested address is unknown, or the user is not privileged and
3092 tried to alter an interface's configuration.
3115 Basic IPv6 node operation requires a link-local address on each
3116 interface configured for IPv6.
3117 Normally, such an address is automatically configured by the
3118 kernel on each interface added to the system or enabled; this behavior may
3119 be disabled by setting per-interface flag
3120 .Cm -auto_linklocal .
3121 The default value of this flag is 1 and can be disabled by using the sysctl
3123 .Va net.inet6.ip6.auto_linklocal .
3125 Do not configure IPv6 addresses with no link-local address by using
3127 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob