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 Enable use of rate limiting (packet pacing) for TLS offload.
567 Disable use of rate limiting for TLS offload.
569 If the driver supports unmapped network buffers,
570 enable them on the interface.
572 If the driver supports unmapped network buffers,
573 disable them on the interface.
574 .It Cm wol , wol_ucast , wol_mcast , wol_magic
575 Enable Wake On Lan (WOL) support, if available.
576 WOL is a facility whereby a machine in a low power state may be woken
577 in response to a received packet.
578 There are three types of packets that may wake a system:
579 ucast (directed solely to the machine's mac address),
580 mcast (directed to a broadcast or multicast address),
582 magic (unicast or multicast frames with a ``magic contents'').
583 Not all devices support WOL, those that do indicate the mechanisms
584 they support in their capabilities.
586 is a synonym for enabling all available WOL mechanisms.
589 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
590 If the driver offers user-configurable VLAN support, enable
591 reception of extended frames, tag processing in hardware,
592 frame filtering in hardware, checksum offloading, or TSO on VLAN,
594 Note that this must be configured on a physical interface associated with
599 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
600 If the driver offers user-configurable VLAN support, disable
601 reception of extended frames, tag processing in hardware,
602 frame filtering in hardware, or TSO on VLAN,
604 .It Cm vxlanhwcsum , vxlanhwtso
605 If the driver offers user-configurable VXLAN support, enable inner checksum
606 offloading (receive and transmit) or TSO on VXLAN, respectively.
607 Note that this must be configured on a physical interface associated with
612 The physical interface is either the interface specified as the vxlandev
613 or the interface hosting the vxlanlocal address.
614 The driver will offload as much checksum work and TSO as it can reliably
615 support, the exact level of offloading may vary between drivers.
616 .It Fl vxlanhwcsum , vxlanhwtso
617 If the driver offers user-configurable VXLAN support, disable checksum
618 offloading (receive and transmit) or TSO on VXLAN, respectively.
620 Move the interface to the
622 specified by name or JID.
623 If the jail has a virtual network stack, the interface will disappear
624 from the current environment and become visible to the jail.
626 Reclaim the interface from the
628 specified by name or JID.
629 If the jail has a virtual network stack, the interface will disappear
630 from the jail, and become visible to the current network environment.
634 feature and disable interrupts on the interface, if driver supports
639 feature and enable interrupt mode on the interface.
641 Create the specified network pseudo-device.
642 If the interface is given without a unit number, try to create a new
643 device with an arbitrary unit number.
644 If creation of an arbitrary device is successful, the new device name is
645 printed to standard output unless the interface is renamed or destroyed
650 Destroy the specified network pseudo-device.
666 Set the routing metric of the interface to
669 The routing metric is used by the routing protocol
671 Higher metrics have the effect of making a route
672 less favorable; metrics are counted as additional hops
673 to the destination network or host.
675 Set the maximum transmission unit of the interface to
677 default is interface specific.
678 The MTU is used to limit the size of packets that are transmitted on an
680 Not all interfaces support setting the MTU, and some interfaces have
682 .It Cm netmask Ar mask
685 Specify how much of the address to reserve for subdividing
686 networks into sub-networks.
687 The mask includes the network part of the local address
688 and the subnet part, which is taken from the host field of the address.
689 The mask can be specified as a single hexadecimal number
692 with a dot-notation Internet address,
693 or with a pseudo-network name listed in the network table
695 The mask contains 1's for the bit positions in the 32-bit address
696 which are to be used for the network and subnet parts,
697 and 0's for the host part.
698 The mask should contain at least the standard network portion,
699 and the subnet field should be contiguous with the network
702 The netmask can also be specified in CIDR notation after the address.
705 option above for more information.
706 .It Cm prefixlen Ar len
710 bits are reserved for subdividing networks into sub-networks.
713 must be integer, and for syntactical reason it must be between 0 to 128.
714 It is almost always 64 under the current IPv6 assignment rule.
715 If the parameter is omitted, 64 is used.
717 The prefix can also be specified using the slash notation after the address.
720 option above for more information.
725 Introduced for compatibility
729 .It Cm link Op Cm 0 No - Cm 2
731 Enable special processing of the link level of the interface.
732 These three options are interface specific in actual effect, however,
733 they are in general used to select special modes of operation.
735 of this is to enable SLIP compression, or to select the connector type
736 for some Ethernet cards.
737 Refer to the man page for the specific driver
738 for more information.
740 .It Fl link Op Cm 0 No - Cm 2
742 Disable special processing at the link level with the specified interface.
744 Put the interface in monitor mode.
745 No packets are transmitted, and received packets are discarded after
749 Take the interface out of monitor mode.
750 .It Cm pcp Ar priority_code_point
753 is an 3-bit field which refers to the IEEE 802.1p
754 class of service and maps to the frame priority level.
756 Stop tagging packets on the interface w/ the priority code point.
760 This may be used to enable an interface after an
762 It happens automatically when setting the first address on an interface.
763 If the interface was reset when previously marked down,
764 the hardware will be re-initialized.
767 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
768 Note that the address family keyword
771 .Bl -tag -width indent
773 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
777 .Va net.inet6.ip6.accept_rtadv
778 controls whether this flag is set by default or not.
783 Set a flag to control whether routers from which the system accepts
784 Router Advertisement messages will be added to the Default Router List
788 flag is disabled, this flag has no effect.
792 .Va net.inet6.ip6.no_radr
793 controls whether this flag is set by default or not.
797 .It Cm auto_linklocal
798 Set a flag to perform automatic link-local address configuration when
799 the interface becomes available.
803 .Va net.inet6.ip6.auto_linklocal
804 controls whether this flag is set by default or not.
805 .It Cm -auto_linklocal
809 Set the specified interface as the default route when there is no
815 Set a flag to disable all of IPv6 network communications on the
817 Note that if there are already configured IPv6
818 addresses on that interface, all of them are marked as
820 and DAD will be performed when this flag is cleared.
824 When this flag is cleared and
826 flag is enabled, automatic configuration of a link-local address is
829 Set a flag to enable Neighbor Unreachability Detection.
833 .It Cm no_prefer_iface
834 Set a flag to not honor rule 5 of source address selection in RFC 3484.
835 In practice this means the address on the outgoing interface will not be
836 preferred, effectively yielding the decision to the address selection
837 policy table, configurable with
839 .It Cm -no_prefer_iface
841 .Cm no_prefer_iface .
843 Set a flag to disable Duplicate Address Detection.
849 The following parameters are specific for IPv6 addresses.
850 Note that the address family keyword
853 .Bl -tag -width indent
855 Set the IPv6 autoconfigured address bit.
857 Clear the IPv6 autoconfigured address bit.
859 Set the IPv6 deprecated address bit.
861 Clear the IPv6 deprecated address bit.
863 Set preferred lifetime for the address.
865 Set a flag to prefer address as a candidate of the source address for
867 .It Cm -prefer_source
871 Set valid lifetime for the address.
874 The following parameters are specific to cloning
875 IEEE 802.11 wireless interfaces with the
878 .Bl -tag -width indent
879 .It Cm wlandev Ar device
882 as the parent for the cloned device.
883 .It Cm wlanmode Ar mode
884 Specify the operating mode for this cloned device.
902 The operating mode of a cloned interface cannot be changed.
905 mode is actually implemented as an
907 interface with special properties.
908 .It Cm wlanbssid Ar bssid
909 The 802.11 mac address to use for the bssid.
910 This must be specified at create time for a legacy
913 .It Cm wlanaddr Ar address
914 The local mac address.
915 If this is not specified then a mac address will automatically be assigned
916 to the cloned device.
917 Typically this address is the same as the address of the parent device
920 parameter is specified then the driver will craft a unique address for
921 the device (if supported).
925 device as operating in ``legacy mode''.
928 devices have a fixed peer relationship and do not, for example, roam
929 if their peer stops communicating.
930 For completeness a Dynamic WDS (DWDS) interface may marked as
933 Request a unique local mac address for the cloned device.
934 This is only possible if the device supports multiple mac addresses.
935 To force use of the parent's mac address use
938 Mark the cloned interface as depending on hardware support to
939 track received beacons.
940 To have beacons tracked in software use
946 can also be used to indicate no beacons should
947 be transmitted; this can be useful when creating a WDS configuration but
949 interfaces can only be created as companions to an access point.
952 The following parameters are specific to IEEE 802.11 wireless interfaces
956 .Bl -tag -width indent
958 Enable sending and receiving AMPDU frames when using 802.11n (default).
959 The 802.11n specification states a compliant station must be capable
960 of receiving AMPDU frames but transmission is optional.
963 to disable all use of AMPDU with 802.11n.
964 For testing and/or to work around interoperability problems one can use
968 to control use of AMPDU in one direction.
969 .It Cm ampdudensity Ar density
970 Set the AMPDU density parameter used when operating with 802.11n.
971 This parameter controls the inter-packet gap for AMPDU frames.
972 The sending device normally controls this setting but a receiving station
973 may request wider gaps.
976 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
979 is treated the same as 0.
980 .It Cm ampdulimit Ar limit
981 Set the limit on packet size for receiving AMPDU frames when operating
985 are 8192, 16384, 32768, and 65536 but one can also specify
986 just the unique prefix: 8, 16, 32, 64.
987 Note the sender may limit the size of AMPDU frames to be less
988 than the maximum specified by the receiving station.
990 Enable sending and receiving AMSDU frames when using 802.11n.
991 By default AMSDU is received but not transmitted.
994 to disable all use of AMSDU with 802.11n.
995 For testing and/or to work around interoperability problems one can use
999 to control use of AMSDU in one direction.
1000 .It Cm amsdulimit Ar limit
1001 Set the limit on packet size for sending and receiving AMSDU frames
1002 when operating with 802.11n.
1005 are 7935 and 3839 (bytes).
1006 Note the sender may limit the size of AMSDU frames to be less
1007 than the maximum specified by the receiving station.
1008 Note also that devices are not required to support the 7935 limit,
1009 only 3839 is required by the specification and the larger value
1010 may require more memory to be dedicated to support functionality
1011 that is rarely used.
1013 When operating as an access point, pass packets between
1014 wireless clients directly (default).
1015 To instead let them pass up through the
1016 system and be forwarded using some other mechanism, use
1018 Disabling the internal bridging
1019 is useful when traffic is to be processed with
1021 .It Cm authmode Ar mode
1022 Set the desired authentication mode in infrastructure mode.
1023 Not all adapters support all modes.
1026 .Cm none , open , shared
1032 (IEEE WPA/WPA2/802.11i).
1037 modes are only useful when using an authentication service
1038 (a supplicant for client operation or an authenticator when
1039 operating as an access point).
1040 Modes are case insensitive.
1042 Enable background scanning when operating as a station.
1043 Background scanning is a technique whereby a station associated to
1044 an access point will temporarily leave the channel to scan for
1045 neighboring stations.
1046 This allows a station to maintain a cache of nearby access points
1047 so that roaming between access points can be done without
1048 a lengthy scan operation.
1049 Background scanning is done only when a station is not busy and
1050 any outbound traffic will cancel a scan operation.
1051 Background scanning should never cause packets to be lost though
1052 there may be some small latency if outbound traffic interrupts a
1054 By default background scanning is enabled if the device is capable.
1055 To disable background scanning, use
1057 Background scanning is controlled by the
1062 Background scanning must be enabled for roaming; this is an artifact
1063 of the current implementation and may not be required in the future.
1064 .It Cm bgscanidle Ar idletime
1065 Set the minimum time a station must be idle (not transmitting or
1066 receiving frames) before a background scan is initiated.
1069 parameter is specified in milliseconds.
1070 By default a station must be idle at least 250 milliseconds before
1071 a background scan is initiated.
1072 The idle time may not be set to less than 100 milliseconds.
1073 .It Cm bgscanintvl Ar interval
1074 Set the interval at which background scanning is attempted.
1077 parameter is specified in seconds.
1078 By default a background scan is considered every 300 seconds (5 minutes).
1081 may not be set to less than 15 seconds.
1082 .It Cm bintval Ar interval
1083 Set the interval at which beacon frames are sent when operating in
1087 parameter is specified in TU's (1024 usecs).
1088 By default beacon frames are transmitted every 100 TU's.
1089 .It Cm bmissthreshold Ar count
1090 Set the number of consecutive missed beacons at which the station
1091 will attempt to roam (i.e., search for a new access point).
1094 parameter must be in the range 1 to 255; though the
1095 upper bound may be reduced according to device capabilities.
1096 The default threshold is 7 consecutive missed beacons; but
1097 this may be overridden by the device driver.
1098 Another name for the
1102 .It Cm bssid Ar address
1103 Specify the MAC address of the access point to use when operating
1104 as a station in a BSS network.
1105 This overrides any automatic selection done by the system.
1106 To disable a previously selected access point, supply
1111 This option is useful when more than one access point uses the same SSID.
1112 Another name for the
1117 Enable packet bursting.
1118 Packet bursting is a transmission technique whereby the wireless
1119 medium is acquired once to send multiple frames and the interframe
1121 This technique can significantly increase throughput by reducing
1122 transmission overhead.
1123 Packet bursting is supported by the 802.11e QoS specification
1124 and some devices that do not support QoS may still be capable.
1125 By default packet bursting is enabled if a device is capable
1127 To disable packet bursting, use
1129 .It Cm chanlist Ar channels
1130 Set the desired channels to use when scanning for access
1131 points, neighbors in an IBSS network, or looking for unoccupied
1132 channels when operating as an access point.
1133 The set of channels is specified as a comma-separated list with
1134 each element in the list representing either a single channel number or a range
1137 Channel numbers must be in the range 1 to 255 and be permissible
1138 according to the operating characteristics of the device.
1139 .It Cm channel Ar number
1140 Set a single desired channel.
1141 Channels range from 1 to 255, but the exact selection available
1142 depends on the region your adaptor was manufactured for.
1148 will clear any desired channel and, if the device is marked up,
1149 force a scan for a channel to operate on.
1150 Alternatively the frequency, in megahertz, may be specified
1151 instead of the channel number.
1153 When there are several ways to use a channel the channel
1154 number/frequency may be appended with attributes to clarify.
1155 For example, if a device is capable of operating on channel 6
1156 with 802.11n and 802.11g then one can specify that g-only use
1157 should be used by specifying ``6:g''.
1158 Similarly the channel width can be specified by appending it
1159 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1160 These attributes can be combined as in: ``6:ht/40''.
1161 The full set of flags specified following a ``:'' are:
1167 (Atheros Dynamic Turbo mode),
1175 (Atheros Static Turbo mode),
1178 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1179 The full set of channel widths following a '/' are:
1181 (5MHz aka quarter-rate channel),
1183 (10MHz aka half-rate channel),
1185 (20MHz mostly for use in specifying ht20),
1188 (40MHz mostly for use in specifying ht40).
1190 a 40MHz HT channel specification may include the location
1191 of the extension channel by appending ``+'' or ``-'' for above and below,
1192 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1193 with the center channel at frequency 2437 and the extension channel above.
1194 .It Cm country Ar name
1195 Set the country code to use in calculating the regulatory constraints
1197 In particular the set of available channels, how the wireless device
1198 will operation on the channels, and the maximum transmit power that
1199 can be used on a channel are defined by this setting.
1200 Country/Region codes are specified as a 2-character abbreviation
1201 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1202 e.g., "ES" and "Spain".
1203 The set of country codes are taken from
1204 .Pa /etc/regdomain.xml
1206 be viewed with the ``list countries'' request.
1207 Note that not all devices support changing the country code from a default
1208 setting; typically stored in EEPROM.
1216 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1217 DFS embodies several facilities including detection of overlapping
1218 radar signals, dynamic transmit power control, and channel selection
1219 according to a least-congested criteria.
1220 DFS support is mandatory for some 5GHz frequencies in certain
1221 locales (e.g., ETSI).
1222 By default DFS is enabled according to the regulatory definitions
1224 .Pa /etc/regdomain.xml
1225 and the current country code, regdomain,
1227 Note the underlying device (and driver) must support radar detection
1228 for full DFS support to work.
1229 To be fully compliant with the local regulatory agency frequencies that
1230 require DFS should not be used unless it is fully supported.
1233 to disable this functionality for testing.
1235 Enable support for the 802.11d specification (default).
1236 When this support is enabled in station mode, beacon frames that advertise
1237 a country code different than the currently configured country code will
1238 cause an event to be dispatched to user applications.
1239 This event can be used by the station to adopt that country code and
1240 operate according to the associated regulatory constraints.
1241 When operating as an access point with 802.11d enabled the beacon and
1242 probe response frames transmitted will advertise the current regulatory
1244 To disable 802.11d use
1247 Enable 802.11h support including spectrum management.
1248 When 802.11h is enabled beacon and probe response frames will have
1249 the SpectrumMgt bit set in the capabilities field and
1250 country and power constraint information elements will be present.
1251 802.11h support also includes handling Channel Switch Announcements (CSA)
1252 which are a mechanism to coordinate channel changes by an access point.
1253 By default 802.11h is enabled if the device is capable.
1254 To disable 802.11h use
1256 .It Cm deftxkey Ar index
1257 Set the default key to use for transmission.
1258 Typically this is only set when using WEP encryption.
1259 Note that you must set a default transmit key
1260 for the system to know which key to use in encrypting outbound traffic.
1263 is an alias for this request; it is provided for backwards compatibility.
1264 .It Cm dtimperiod Ar period
1267 period for transmitting buffered multicast data frames when
1268 operating in ap mode.
1271 specifies the number of beacon intervals between DTIM
1272 and must be in the range 1 to 15.
1273 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1275 Enable the use of quiet IE.
1276 Hostap will use this to silence other
1277 stations to reduce interference for radar detection when
1278 operating on 5GHz frequency and doth support is enabled.
1281 to disable this functionality.
1282 .It Cm quiet_period Ar period
1285 to the number of beacon intervals between the start of regularly
1286 scheduled quiet intervals defined by Quiet element.
1287 .It Cm quiet_count Ar count
1290 to the number of TBTTs until the beacon interval during which the
1291 next quiet interval shall start.
1292 A value of 1 indicates the quiet
1293 interval will start during the beacon interval starting at the next
1295 A value 0 is reserved.
1296 .It Cm quiet_offset Ar offset
1299 to the offset of the start of the quiet interval from the TBTT
1300 specified by the Quiet count, expressed in TUs.
1303 shall be less than one beacon interval.
1304 .It Cm quiet_duration Ar dur
1307 to the duration of the Quiet interval, expressed in TUs.
1308 The value should be less than beacon interval.
1310 Enable the use of Atheros Dynamic Turbo mode when communicating with
1311 another Dynamic Turbo-capable station.
1312 Dynamic Turbo mode is an Atheros-specific mechanism by which
1313 stations switch between normal 802.11 operation and a ``boosted''
1314 mode in which a 40MHz wide channel is used for communication.
1315 Stations using Dynamic Turbo mode operate boosted only when the
1316 channel is free of non-dturbo stations; when a non-dturbo station
1317 is identified on the channel all stations will automatically drop
1318 back to normal operation.
1319 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1320 Note that turbo mode (dynamic or static) is only allowed on some
1321 channels depending on the regulatory constraints; use the
1323 command to identify the channels where turbo mode may be used.
1324 To disable Dynamic Turbo mode use
1327 Enable Dynamic WDS (DWDS) support.
1328 DWDS is a facility by which 4-address traffic can be carried between
1329 stations operating in infrastructure mode.
1330 A station first associates to an access point and authenticates using
1331 normal procedures (e.g., WPA).
1332 Then 4-address frames are passed to carry traffic for stations
1333 operating on either side of the wireless link.
1334 DWDS extends the normal WDS mechanism by leveraging existing security
1335 protocols and eliminating static binding.
1337 When DWDS is enabled on an access point 4-address frames received from
1338 an authorized station will generate a ``DWDS discovery'' event to user
1340 This event should be used to create a WDS interface that is bound
1341 to the remote station (and usually plumbed into a bridge).
1342 Once the WDS interface is up and running 4-address traffic then logically
1343 flows through that interface.
1345 When DWDS is enabled on a station, traffic with a destination address
1346 different from the peer station are encapsulated in a 4-address frame
1347 and transmitted to the peer.
1348 All 4-address traffic uses the security information of the stations
1349 (e.g., cryptographic keys).
1350 A station is associated using 802.11n facilities may transport
1351 4-address traffic using these same mechanisms; this depends on available
1352 resources and capabilities of the device.
1353 The DWDS implementation guards against layer 2 routing loops of
1356 Enable the use of Atheros Fast Frames when communicating with
1357 another Fast Frames-capable station.
1358 Fast Frames are an encapsulation technique by which two 802.3
1359 frames are transmitted in a single 802.11 frame.
1360 This can noticeably improve throughput but requires that the
1361 receiving station understand how to decapsulate the frame.
1362 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1363 protocol extension so enabling use is safe when communicating with
1364 non-Atheros devices.
1365 By default, use of fast frames is enabled if the device is capable.
1366 To explicitly disable fast frames, use
1368 .It Cm fragthreshold Ar length
1369 Set the threshold for which transmitted frames are broken into fragments.
1372 argument is the frame size in bytes and must be in the range 256 to 2346.
1380 disables transmit fragmentation.
1381 Not all adapters honor the fragmentation threshold.
1383 When operating as an access point, do not broadcast the SSID
1384 in beacon frames or respond to probe request frames unless
1385 they are directed to the ap (i.e., they include the ap's SSID).
1386 By default, the SSID is included in beacon frames and
1387 undirected probe request frames are answered.
1388 To re-enable the broadcast of the SSID etc., use
1391 Enable use of High Throughput (HT) when using 802.11n (default).
1392 The 802.11n specification includes mechanisms for operation
1393 on 20MHz and 40MHz wide channels using different signalling mechanisms
1394 than specified in 802.11b, 802.11g, and 802.11a.
1395 Stations negotiate use of these facilities, termed HT20 and HT40,
1396 when they associate.
1397 To disable all use of 802.11n use
1399 To disable use of HT20 (e.g., to force only HT40 use) use
1401 To disable use of HT40 use
1404 HT configuration is used to ``auto promote'' operation
1405 when several choices are available.
1406 For example, if a station associates to an 11n-capable access point
1407 it controls whether the station uses legacy operation, HT20, or HT40.
1408 When an 11n-capable device is setup as an access point and
1409 Auto Channel Selection is used to locate a channel to operate on,
1410 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1411 on the selected channel.
1412 If a fixed channel is specified for a station then HT configuration can
1413 be given as part of the channel specification; e.g., 6:ht/20 to setup
1414 HT20 operation on channel 6.
1416 Enable use of compatibility support for pre-802.11n devices (default).
1417 The 802.11n protocol specification went through several incompatible iterations.
1418 Some vendors implemented 11n support to older specifications that
1419 will not interoperate with a purely 11n-compliant station.
1420 In particular the information elements included in management frames
1421 for old devices are different.
1422 When compatibility support is enabled both standard and compatible data
1424 Stations that associate using the compatibility mechanisms are flagged
1426 To disable compatibility support use
1428 .It Cm htprotmode Ar technique
1429 For interfaces operating in 802.11n, use the specified
1431 for protecting HT frames in a mixed legacy/HT network.
1432 The set of valid techniques is
1437 Technique names are case insensitive.
1439 Enable inactivity processing for stations associated to an
1440 access point (default).
1441 When operating as an access point the 802.11 layer monitors
1442 the activity of each associated station.
1443 When a station is inactive for 5 minutes it will send several
1444 ``probe frames'' to see if the station is still present.
1445 If no response is received then the station is deauthenticated.
1446 Applications that prefer to handle this work can disable this
1450 Set the location to use in calculating regulatory constraints.
1451 The location is also advertised in beacon and probe response frames
1452 when 802.11d is enabled with
1461 Display the list of channels available for use taking into account
1462 any restrictions set with the
1465 See the description of
1467 for more information.
1469 Display the adaptor's capabilities, including the operating
1472 Display the list of channels available for use.
1473 Channels are shown with their IEEE channel number, equivalent
1474 frequency, and usage modes.
1475 Channels identified as
1480 Channels identified as
1482 may be used only for Atheros' Static Turbo mode
1484 . Cm mediaopt turbo ) .
1485 Channels marked with a
1487 have a regulatory constraint that they be passively scanned.
1488 This means a station is not permitted to transmit on the channel until
1489 it identifies the channel is being used for 802.11 communication;
1490 typically by hearing a beacon frame from an access point operating
1493 is another way of requesting this information.
1494 By default a compacted list of channels is displayed; if the
1496 option is specified then all channels are shown.
1497 .It Cm list countries
1498 Display the set of country codes and regulatory domains that can be
1499 used in regulatory configuration.
1501 Display the current MAC Access Control List state.
1502 Each address is prefixed with a character that indicates the
1503 current policy applied to it:
1505 indicates the address is allowed access,
1507 indicates the address is denied access,
1509 indicates the address is present but the current policy open
1510 (so the ACL is not consulted).
1512 Displays the mesh routing table, used for forwarding packets on a mesh
1514 .It Cm list regdomain
1515 Display the current regulatory settings including the available channels
1516 and transmit power caps.
1518 Display the parameters that govern roaming operation.
1520 Display the parameters that govern transmit operation.
1522 Display the transmit power caps for each channel.
1524 Display the access points and/or ad-hoc neighbors
1525 located in the vicinity.
1526 This information may be updated automatically by the adapter
1529 request or through background scanning.
1530 Depending on the capabilities of the stations the following
1531 flags can be included in the output:
1538 Poll request capability.
1540 DSSS/OFDM capability.
1542 Extended Service Set (ESS).
1544 Independent Basic Service Set (IBSS).
1547 The station requires authentication.
1549 Robust Secure Network (RSN).
1552 Indicates that the station is doing short preamble to optionally
1553 improve throughput performance with 802.11g and 802.11b.
1555 Pollable capability.
1557 Short slot time capability.
1560 By default interesting information elements captured from the neighboring
1561 stations are displayed at the end of each row.
1562 Possible elements include:
1564 (station supports WME),
1566 (station supports WPA),
1568 (station supports WPS),
1570 (station supports 802.11i/RSN),
1572 (station supports 802.11n/HT communication),
1574 (station supports Atheros protocol extensions),
1576 (station supports unknown vendor-specific extensions).
1579 flag is used all the information elements and their
1580 contents will be shown.
1583 flag also enables display of long SSIDs.
1586 command is another way of requesting this information.
1588 When operating as an access point display the stations that are
1589 currently associated.
1590 When operating in ad-hoc mode display stations identified as
1591 neighbors in the IBSS.
1592 When operating in mesh mode display stations identified as
1593 neighbors in the MBSS.
1594 When operating in station mode display the access point.
1595 Capabilities advertised by the stations are described under
1599 The following flags can be included in the output:
1603 Indicates that the station is permitted to send/receive data frames.
1605 Extended Rate Phy (ERP).
1606 Indicates that the station is operating in an 802.11g network
1607 using extended transmit rates.
1609 High Throughput (HT).
1610 Indicates that the station is using HT transmit rates.
1613 follows immediately after then the station associated
1614 using deprecated mechanisms supported only when
1619 Indicates that the station is operating in power save mode.
1621 Quality of Service (QoS).
1622 Indicates that the station is using QoS encapsulation for
1624 QoS encapsulation is enabled only when WME mode is enabled.
1626 Short GI in HT 40MHz mode enabled.
1629 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1631 Transitional Security Network (TSN).
1632 Indicates that the station associated using TSN; see also
1636 Wi-Fi Protected Setup (WPS).
1637 Indicates that the station associated using WPS.
1639 Short GI in HT 20MHz mode enabled.
1642 By default information elements received from associated stations
1643 are displayed in a short form; the
1645 flag causes this information to be displayed symbolically.
1647 Display the current channel parameters to use when operating in WME mode.
1650 option is specified then both channel and BSS parameters are displayed
1651 for each AC (first channel, then BSS).
1652 When WME mode is enabled for an adaptor this information will be
1653 displayed with the regular status; this command is mostly useful
1654 for examining parameters when WME mode is disabled.
1655 See the description of the
1657 directive for information on the various parameters.
1658 .It Cm maxretry Ar count
1659 Set the maximum number of tries to use in sending unicast frames.
1660 The default setting is 6 but drivers may override this with a value
1662 .It Cm mcastrate Ar rate
1663 Set the rate for transmitting multicast/broadcast frames.
1664 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1665 This rate should be valid for the current operating conditions;
1666 if an invalid rate is specified drivers are free to chose an
1668 .It Cm mgtrate Ar rate
1669 Set the rate for transmitting management and/or control frames.
1670 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1672 Set the location to use in calculating regulatory constraints.
1673 The location is also advertised in beacon and probe response frames
1674 when 802.11d is enabled with
1683 Enable powersave operation.
1684 When operating as a client, the station will conserve power by
1685 periodically turning off the radio and listening for
1686 messages from the access point telling it there are packets waiting.
1687 The station must then retrieve the packets.
1688 Not all devices support power save operation as a client.
1689 The 802.11 specification requires that all access points support
1690 power save but some drivers do not.
1693 to disable powersave operation when operating as a client.
1694 .It Cm powersavesleep Ar sleep
1695 Set the desired max powersave sleep time in TU's (1024 usecs).
1696 By default the max powersave sleep time is 100 TU's.
1697 .It Cm protmode Ar technique
1698 For interfaces operating in 802.11g, use the specified
1700 for protecting OFDM frames in a mixed 11b/11g network.
1701 The set of valid techniques is
1707 Technique names are case insensitive.
1708 Not all devices support
1710 as a protection technique.
1712 When operating as an access point in 802.11g mode allow only
1713 11g-capable stations to associate (11b-only stations are not
1714 permitted to associate).
1715 To allow both 11g and 11b-only stations to associate, use
1718 When operating as an access point in 802.11n mode allow only
1719 HT-capable stations to associate (legacy stations are not
1720 permitted to associate).
1721 To allow both HT and legacy stations to associate, use
1723 .It Cm regdomain Ar sku
1724 Set the regulatory domain to use in calculating the regulatory constraints
1726 In particular the set of available channels, how the wireless device
1727 will operation on the channels, and the maximum transmit power that
1728 can be used on a channel are defined by this setting.
1729 Regdomain codes (SKU's) are taken from
1730 .Pa /etc/regdomain.xml
1732 be viewed with the ``list countries'' request.
1733 Note that not all devices support changing the regdomain from a default
1734 setting; typically stored in EEPROM.
1742 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1744 Note that RIFS must be supported by both the station and access point
1748 .It Cm roam:rate Ar rate
1749 Set the threshold for controlling roaming when operating in a BSS.
1752 parameter specifies the transmit rate in megabits
1753 at which roaming should be considered.
1754 If the current transmit rate drops below this setting and background scanning
1755 is enabled, then the system will check if a more desirable access point is
1756 available and switch over to it.
1757 The current scan cache contents are used if they are considered
1758 valid according to the
1760 parameter; otherwise a background scan operation is triggered before
1761 any selection occurs.
1762 Each channel type has a separate rate threshold; the default values are:
1763 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1764 .It Cm roam:rssi Ar rssi
1765 Set the threshold for controlling roaming when operating in a BSS.
1768 parameter specifies the receive signal strength in dBm units
1769 at which roaming should be considered.
1770 If the current rssi drops below this setting and background scanning
1771 is enabled, then the system will check if a more desirable access point is
1772 available and switch over to it.
1773 The current scan cache contents are used if they are considered
1774 valid according to the
1776 parameter; otherwise a background scan operation is triggered before
1777 any selection occurs.
1778 Each channel type has a separate rssi threshold; the default values are
1780 .It Cm roaming Ar mode
1781 When operating as a station, control how the system will
1782 behave when communication with the current access point
1786 argument may be one of
1788 (leave it to the hardware device to decide),
1790 (handle either in the device or the operating system\[em]as appropriate),
1792 (do nothing until explicitly instructed).
1793 By default, the device is left to handle this if it is
1794 capable; otherwise, the operating system will automatically
1795 attempt to reestablish communication.
1796 Manual mode is used by applications such as
1797 .Xr wpa_supplicant 8
1798 that want to control the selection of an access point.
1799 .It Cm rtsthreshold Ar length
1800 Set the threshold for which
1801 transmitted frames are preceded by transmission of an
1807 is the frame size in bytes and must be in the range 1 to 2346.
1815 disables transmission of RTS frames.
1816 Not all adapters support setting the RTS threshold.
1818 Initiate a scan of neighboring stations, wait for it to complete, and
1819 display all stations found.
1820 Only the super-user can initiate a scan.
1823 for information on the display.
1824 By default a background scan is done; otherwise a foreground
1825 scan is done and the station may roam to a different access point.
1828 request can be used to show recent scan results without
1829 initiating a new scan.
1830 .It Cm scanvalid Ar threshold
1831 Set the maximum time the scan cache contents are considered valid;
1832 i.e., will be used without first triggering a scan operation to
1836 parameter is specified in seconds and defaults to 60 seconds.
1837 The minimum setting for
1840 One should take care setting this threshold; if it is set too low
1841 then attempts to roam to another access point may trigger unnecessary
1842 background scan operations.
1844 Enable use of Short Guard Interval when operating in 802.11n
1846 NB: this currently enables Short GI on both HT40 and HT20 channels.
1847 To disable Short GI use
1850 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1851 when operating in 802.11n.
1852 A station operating with Static SMPS maintains only a single
1853 receive chain active (this can significantly reduce power consumption).
1857 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1858 when operating in 802.11n.
1859 A station operating with Dynamic SMPS maintains only a single
1860 receive chain active but switches to multiple receive chains when it
1861 receives an RTS frame (this can significantly reduce power consumption).
1862 Note that stations cannot distinguish between RTS/CTS intended to
1863 enable multiple receive chains and those used for other purposes.
1867 Set the desired Service Set Identifier (aka network name).
1868 The SSID is a string up to 32 characters
1869 in length and may be specified as either a normal string or in
1870 hexadecimal when preceded by
1872 Additionally, the SSID may be cleared by setting it to
1874 .It Cm tdmaslot Ar slot
1875 When operating with TDMA, use the specified
1880 is a number between 0 and the maximum number of slots in the BSS.
1881 Note that a station configured as slot 0 is a master and
1882 will broadcast beacon frames advertising the BSS;
1883 stations configured to use other slots will always
1884 scan to locate a master before they ever transmit.
1888 .It Cm tdmaslotcnt Ar cnt
1889 When operating with TDMA, setup a BSS with
1892 The slot count may be at most 8.
1893 The current implementation is only tested with two stations
1894 (i.e., point to point applications).
1895 This setting is only meaningful when a station is configured as slot 0;
1896 other stations adopt this setting from the BSS they join.
1900 .It Cm tdmaslotlen Ar len
1901 When operating with TDMA, setup a BSS such that each station has a slot
1904 The slot length must be at least 150 microseconds (1/8 TU)
1905 and no more than 65 milliseconds.
1906 Note that setting too small a slot length may result in poor channel
1907 bandwidth utilization due to factors such as timer granularity and
1909 This setting is only meaningful when a station is configured as slot 0;
1910 other stations adopt this setting from the BSS they join.
1913 is set to 10 milliseconds.
1914 .It Cm tdmabintval Ar intval
1915 When operating with TDMA, setup a BSS such that beacons are transmitted every
1917 superframes to synchronize the TDMA slot timing.
1918 A superframe is defined as the number of slots times the slot length; e.g.,
1919 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1920 The beacon interval may not be zero.
1923 causes the timers to be resynchronized more often; this can be help if
1924 significant timer drift is observed.
1929 When operating as an access point with WPA/802.11i allow legacy
1930 stations to associate using static key WEP and open authentication.
1931 To disallow legacy station use of WEP, use
1933 .It Cm txpower Ar power
1934 Set the power used to transmit frames.
1937 argument is specified in .5 dBm units.
1938 Out of range values are truncated.
1939 Typically only a few discreet power settings are available and
1940 the driver will use the setting closest to the specified value.
1941 Not all adapters support changing the transmit power.
1942 .It Cm ucastrate Ar rate
1943 Set a fixed rate for transmitting unicast frames.
1944 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1945 This rate should be valid for the current operating conditions;
1946 if an invalid rate is specified drivers are free to chose an
1948 .It Cm wepmode Ar mode
1949 Set the desired WEP mode.
1950 Not all adapters support all modes.
1951 The set of valid modes is
1957 mode explicitly tells the adaptor to allow association with access
1958 points which allow both encrypted and unencrypted traffic.
1961 means that the access point must only allow encrypted connections.
1964 is generally another name for
1966 Modes are case insensitive.
1967 .It Cm weptxkey Ar index
1968 Set the WEP key to be used for transmission.
1969 This is the same as setting the default transmission key with
1971 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1972 Set the selected WEP key.
1975 is not given, key 1 is set.
1976 A WEP key will be either 5 or 13
1977 characters (40 or 104 bits) depending on the local network and the
1978 capabilities of the adaptor.
1979 It may be specified either as a plain
1980 string or as a string of hexadecimal digits preceded by
1982 For maximum portability, hex keys are recommended;
1983 the mapping of text keys to WEP encryption is usually driver-specific.
1986 drivers do this mapping differently to
1988 A key may be cleared by setting it to
1990 If WEP is supported then there are at least four keys.
1991 Some adapters support more than four keys.
1992 If that is the case, then the first four keys
1993 (1-4) will be the standard temporary keys and any others will be adaptor
1994 specific keys such as permanent keys stored in NVRAM.
1996 Note that you must set a default transmit key with
1998 for the system to know which key to use in encrypting outbound traffic.
2000 Enable Wireless Multimedia Extensions (WME) support, if available,
2001 for the specified interface.
2002 WME is a subset of the IEEE 802.11e standard to support the
2003 efficient communication of realtime and multimedia data.
2004 To disable WME support, use
2006 Another name for this parameter is
2009 The following parameters are meaningful only when WME support is in use.
2010 Parameters are specified per-AC (Access Category) and
2011 split into those that are used by a station when acting
2012 as an access point and those for client stations in the BSS.
2013 The latter are received from the access point and may not be changed
2015 The following Access Categories are recognized:
2017 .Bl -tag -width ".Cm AC_BK" -compact
2021 best effort delivery,
2036 AC parameters are case-insensitive.
2037 Traffic classification is done in the operating system using the
2038 vlan priority associated with data frames or the
2039 ToS (Type of Service) indication in IP-encapsulated frames.
2040 If neither information is present, traffic is assigned to the
2041 Best Effort (BE) category.
2042 .Bl -tag -width indent
2044 Set the ACK policy for QoS transmissions by the local station;
2045 this controls whether or not data frames transmitted by a station
2046 require an ACK response from the receiving station.
2047 To disable waiting for an ACK use
2049 This parameter is applied only to the local station.
2051 Enable the Admission Control Mandatory (ACM) mechanism
2052 for transmissions by the local station.
2053 To disable the ACM use
2055 On stations in a BSS this parameter is read-only and indicates
2056 the setting received from the access point.
2057 NB: ACM is not supported right now.
2058 .It Cm aifs Ar ac Ar count
2059 Set the Arbitration Inter Frame Spacing (AIFS)
2060 channel access parameter to use for transmissions
2061 by the local station.
2062 On stations in a BSS this parameter is read-only and indicates
2063 the setting received from the access point.
2064 .It Cm cwmin Ar ac Ar count
2065 Set the CWmin channel access parameter to use for transmissions
2066 by the local station.
2067 On stations in a BSS this parameter is read-only and indicates
2068 the setting received from the access point.
2069 .It Cm cwmax Ar ac Ar count
2070 Set the CWmax channel access parameter to use for transmissions
2071 by the local station.
2072 On stations in a BSS this parameter is read-only and indicates
2073 the setting received from the access point.
2074 .It Cm txoplimit Ar ac Ar limit
2075 Set the Transmission Opportunity Limit channel access parameter
2076 to use for transmissions by the local station.
2077 This parameter defines an interval of time when a WME station
2078 has the right to initiate transmissions onto the wireless medium.
2079 On stations in a BSS this parameter is read-only and indicates
2080 the setting received from the access point.
2081 .It Cm bss:aifs Ar ac Ar count
2082 Set the AIFS channel access parameter to send to stations in a BSS.
2083 This parameter is meaningful only when operating in ap mode.
2084 .It Cm bss:cwmin Ar ac Ar count
2085 Set the CWmin channel access parameter to send to stations in a BSS.
2086 This parameter is meaningful only when operating in ap mode.
2087 .It Cm bss:cwmax Ar ac Ar count
2088 Set the CWmax channel access parameter to send to stations in a BSS.
2089 This parameter is meaningful only when operating in ap mode.
2090 .It Cm bss:txoplimit Ar ac Ar limit
2091 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2092 This parameter is meaningful only when operating in ap mode.
2095 Enable Wireless Privacy Subscriber support.
2096 Note that WPS support requires a WPS-capable supplicant.
2097 To disable this function use
2101 The following parameters support an optional access control list
2102 feature available with some adapters when operating in ap mode; see
2104 This facility allows an access point to accept/deny association
2105 requests based on the MAC address of the station.
2106 Note that this feature does not significantly enhance security
2107 as MAC address spoofing is easy to do.
2108 .Bl -tag -width indent
2109 .It Cm mac:add Ar address
2110 Add the specified MAC address to the database.
2111 Depending on the policy setting association requests from the
2112 specified station will be allowed or denied.
2114 Set the ACL policy to permit association only by
2115 stations registered in the database.
2116 .It Cm mac:del Ar address
2117 Delete the specified MAC address from the database.
2119 Set the ACL policy to deny association only by
2120 stations registered in the database.
2121 .It Cm mac:kick Ar address
2122 Force the specified station to be deauthenticated.
2123 This typically is done to block a station after updating the
2126 Set the ACL policy to allow all stations to associate.
2128 Delete all entries in the database.
2130 Set the ACL policy to permit association only by
2131 stations approved by a RADIUS server.
2132 Note that this feature requires the
2134 program be configured to do the right thing
2135 as it handles the RADIUS processing
2136 (and marks stations as authorized).
2139 The following parameters are related to a wireless interface operating in mesh
2141 .Bl -tag -width indent
2142 .It Cm meshid Ar meshid
2143 Set the desired Mesh Identifier.
2144 The Mesh ID is a string up to 32 characters in length.
2145 A mesh interface must have a Mesh Identifier specified
2146 to reach an operational state.
2147 .It Cm meshttl Ar ttl
2148 Set the desired ``time to live'' for mesh forwarded packets;
2149 this is the number of hops a packet may be forwarded before
2151 The default setting for
2155 Enable or disable peering with neighbor mesh stations.
2156 Stations must peer before any data packets can be exchanged.
2161 Enable or disable forwarding packets by a mesh interface.
2166 This attribute specifies whether or not the mesh STA activates mesh gate
2171 .It Cm meshmetric Ar protocol
2174 as the link metric protocol used on a mesh network.
2175 The default protocol is called
2177 The mesh interface will restart after changing this setting.
2178 .It Cm meshpath Ar protocol
2181 as the path selection protocol used on a mesh network.
2182 The only available protocol at the moment is called
2184 (Hybrid Wireless Mesh Protocol).
2185 The mesh interface will restart after changing this setting.
2186 .It Cm hwmprootmode Ar mode
2187 Stations on a mesh network can operate as ``root nodes.''
2188 Root nodes try to find paths to all mesh nodes and advertise themselves
2190 When there is a root mesh node on a network, other mesh nodes can setup
2191 paths between themselves faster because they can use the root node
2192 to find the destination.
2193 This path may not be the best, but on-demand
2194 routing will eventually find the best path.
2195 The following modes are recognized:
2197 .Bl -tag -width ".Cm PROACTIVE" -compact
2201 Send broadcast path requests every two seconds.
2202 Nodes on the mesh without a path to this root mesh station with try to
2203 discover a path to us.
2205 Send broadcast path requests every two seconds and every node must reply
2206 with a path reply even if it already has a path to this root mesh station.
2208 Send broadcast root announcement (RANN) frames.
2209 Nodes on the mesh without a path to this root mesh station with try to
2210 discover a path to us.
2216 .It Cm hwmpmaxhops Ar cnt
2217 Set the maximum number of hops allowed in an HMWP path to
2219 The default setting for
2224 The following parameters are for compatibility with other systems:
2225 .Bl -tag -width indent
2227 Another name for the
2233 .It Cm stationname Ar name
2234 Set the name of this station.
2235 The station name is not part of the IEEE 802.11
2236 protocol though some interfaces support it.
2238 seems to be meaningful to identical or virtually identical equipment.
2239 Setting the station name is identical in syntax to setting the SSID.
2246 Another way of saying
2252 Another way of saying
2258 Another way of saying:
2259 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2265 .Ar n : k1 , k2 , k3 , k4
2268 Another way of saying
2269 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2274 Another way of saying
2281 The following parameters are specific to bridge interfaces:
2282 .Bl -tag -width indent
2283 .It Cm addm Ar interface
2284 Add the interface named by
2286 as a member of the bridge.
2287 The interface is put into promiscuous mode
2288 so that it can receive every packet sent on the network.
2289 .It Cm deletem Ar interface
2290 Remove the interface named by
2293 Promiscuous mode is disabled on the interface when
2294 it is removed from the bridge.
2295 .It Cm maxaddr Ar size
2296 Set the size of the bridge address cache to
2298 The default is 2000 entries.
2299 .It Cm timeout Ar seconds
2300 Set the timeout of address cache entries to
2305 is zero, then address cache entries will not be expired.
2306 The default is 1200 seconds.
2308 Display the addresses that have been learned by the bridge.
2309 .It Cm static Ar interface-name Ar address
2310 Add a static entry into the address cache pointing to
2311 .Ar interface-name .
2312 Static entries are never aged out of the cache or re-placed, even if the
2313 address is seen on a different interface.
2314 .It Cm deladdr Ar address
2317 from the address cache.
2319 Delete all dynamically-learned addresses from the address cache.
2321 Delete all addresses, including static addresses, from the address cache.
2322 .It Cm discover Ar interface
2323 Mark an interface as a
2326 When the bridge has no address cache entry
2327 (either dynamic or static)
2328 for the destination address of a packet,
2329 the bridge will forward the packet to all
2330 member interfaces marked as
2332 This is the default for all interfaces added to a bridge.
2333 .It Cm -discover Ar interface
2336 attribute on a member interface.
2337 For packets without the
2339 attribute, the only packets forwarded on the interface are broadcast
2340 or multicast packets and packets for which the destination address
2341 is known to be on the interface's segment.
2342 .It Cm learn Ar interface
2343 Mark an interface as a
2346 When a packet arrives on such an interface, the source
2347 address of the packet is entered into the address cache as being a
2348 destination address on the interface's segment.
2349 This is the default for all interfaces added to a bridge.
2350 .It Cm -learn Ar interface
2353 attribute on a member interface.
2354 .It Cm sticky Ar interface
2355 Mark an interface as a
2358 Dynamically learned address entries are treated at static once entered into
2360 Sticky entries are never aged out of the cache or replaced, even if the
2361 address is seen on a different interface.
2362 .It Cm -sticky Ar interface
2365 attribute on a member interface.
2366 .It Cm private Ar interface
2367 Mark an interface as a
2370 A private interface does not forward any traffic to any other port that is also
2371 a private interface.
2372 .It Cm -private Ar interface
2375 attribute on a member interface.
2376 .It Cm span Ar interface
2377 Add the interface named by
2379 as a span port on the bridge.
2380 Span ports transmit a copy of every frame received by the bridge.
2381 This is most useful for snooping a bridged network passively on
2382 another host connected to one of the span ports of the bridge.
2383 .It Cm -span Ar interface
2384 Delete the interface named by
2386 from the list of span ports of the bridge.
2387 .It Cm stp Ar interface
2388 Enable Spanning Tree protocol on
2392 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2393 Spanning Tree is used to detect and remove loops in a network topology.
2394 .It Cm -stp Ar interface
2395 Disable Spanning Tree protocol on
2397 This is the default for all interfaces added to a bridge.
2398 .It Cm edge Ar interface
2402 An edge port connects directly to end stations cannot create bridging
2403 loops in the network, this allows it to transition straight to forwarding.
2404 .It Cm -edge Ar interface
2405 Disable edge status on
2407 .It Cm autoedge Ar interface
2410 to automatically detect edge status.
2411 This is the default for all interfaces added to a bridge.
2412 .It Cm -autoedge Ar interface
2413 Disable automatic edge status on
2415 .It Cm ptp Ar interface
2418 as a point to point link.
2419 This is required for straight transitions to forwarding and
2420 should be enabled on a direct link to another RSTP capable switch.
2421 .It Cm -ptp Ar interface
2422 Disable point to point link status on
2424 This should be disabled for a half duplex link and for an interface
2425 connected to a shared network segment,
2426 like a hub or a wireless network.
2427 .It Cm autoptp Ar interface
2428 Automatically detect the point to point status on
2430 by checking the full duplex link status.
2431 This is the default for interfaces added to the bridge.
2432 .It Cm -autoptp Ar interface
2433 Disable automatic point to point link detection on
2435 .It Cm maxage Ar seconds
2436 Set the time that a Spanning Tree protocol configuration is valid.
2437 The default is 20 seconds.
2438 The minimum is 6 seconds and the maximum is 40 seconds.
2439 .It Cm fwddelay Ar seconds
2440 Set the time that must pass before an interface begins forwarding
2441 packets when Spanning Tree is enabled.
2442 The default is 15 seconds.
2443 The minimum is 4 seconds and the maximum is 30 seconds.
2444 .It Cm hellotime Ar seconds
2445 Set the time between broadcasting of Spanning Tree protocol
2446 configuration messages.
2447 The hello time may only be changed when operating in legacy stp mode.
2448 The default is 2 seconds.
2449 The minimum is 1 second and the maximum is 2 seconds.
2450 .It Cm priority Ar value
2451 Set the bridge priority for Spanning Tree.
2452 The default is 32768.
2453 The minimum is 0 and the maximum is 61440.
2454 .It Cm proto Ar value
2455 Set the Spanning Tree protocol.
2456 The default is rstp.
2457 The available options are stp and rstp.
2458 .It Cm holdcnt Ar value
2459 Set the transmit hold count for Spanning Tree.
2460 This is the number of packets transmitted before being rate limited.
2462 The minimum is 1 and the maximum is 10.
2463 .It Cm ifpriority Ar interface Ar value
2464 Set the Spanning Tree priority of
2469 The minimum is 0 and the maximum is 240.
2470 .It Cm ifpathcost Ar interface Ar value
2471 Set the Spanning Tree path cost of
2475 The default is calculated from the link speed.
2476 To change a previously selected path cost back to automatic, set the
2478 The minimum is 1 and the maximum is 200000000.
2479 .It Cm ifmaxaddr Ar interface Ar size
2480 Set the maximum number of hosts allowed from an interface, packets with unknown
2481 source addresses are dropped until an existing host cache entry expires or is
2483 Set to 0 to disable.
2486 The following parameters are specific to lagg interfaces:
2487 .Bl -tag -width indent
2488 .It Cm laggtype Ar type
2489 When creating a lagg interface the type can be specified as either
2493 If not specified ethernet is the default lagg type.
2494 .It Cm laggport Ar interface
2495 Add the interface named by
2497 as a port of the aggregation interface.
2498 .It Cm -laggport Ar interface
2499 Remove the interface named by
2501 from the aggregation interface.
2502 .It Cm laggproto Ar proto
2503 Set the aggregation protocol.
2506 The available options are
2514 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2515 Set the packet layers to hash for aggregation protocols which load balance.
2518 The options can be combined using commas.
2520 .Bl -tag -width ".Cm l2" -compact
2522 src/dst mac address and optional vlan number.
2524 src/dst address for IPv4 or IPv6.
2526 src/dst port for TCP/UDP/SCTP.
2529 Enable local hash computation for RSS hash on the interface.
2534 modes will use the RSS hash from the network card if available
2535 to avoid computing one, this may give poor traffic distribution
2536 if the hash is invalid or uses less of the protocol header information.
2538 disables use of RSS hash from the network card.
2539 The default value can be set via the
2540 .Va net.link.lagg.default_use_flowid
2551 Use the RSS hash from the network card if available.
2552 .It Cm flowid_shift Ar number
2553 Set a shift parameter for RSS local hash computation.
2554 Hash is calculated by using flowid bits in a packet header mbuf
2555 which are shifted by the number of this parameter.
2557 Enable selection of egress ports based on the native
2559 domain for the packets being transmitted.
2560 This is currently only implemented for lacp mode.
2563 hardware, running a kernel compiled with the
2565 option, and when interfaces from multiple
2567 domains are ports of the aggregation interface.
2569 Disable selection of egress ports based on the native
2571 domain for the packets being transmitted.
2572 .It Cm lacp_fast_timeout
2573 Enable lacp fast-timeout on the interface.
2574 .It Cm -lacp_fast_timeout
2575 Disable lacp fast-timeout on the interface.
2577 Enable lacp strict compliance on the interface.
2578 The default value can be set via the
2579 .Va net.link.lagg.lacp.default_strict_mode
2590 Disable lacp strict compliance on the interface.
2591 .It Cm rr_limit Ar number
2592 Configure a stride for an interface in round-robin mode.
2593 The default stride is 1.
2596 The following parameters apply to IP tunnel interfaces,
2598 .Bl -tag -width indent
2599 .It Cm tunnel Ar src_addr dest_addr
2600 Configure the physical source and destination address for IP tunnel
2606 are interpreted as the outer source/destination for the encapsulating
2609 Unconfigure the physical source and destination address for IP tunnel
2610 interfaces previously configured with
2613 Another name for the
2616 .It Cm accept_rev_ethip_ver
2617 Set a flag to accept both correct EtherIP packets and ones
2618 with reversed version field.
2620 This is for backward compatibility with
2622 6.2, 6.3, 7.0, and 7.1.
2623 .It Cm -accept_rev_ethip_ver
2625 .Cm accept_rev_ethip_ver .
2626 .It Cm ignore_source
2627 Set a flag to accept encapsulated packets destined to this host
2628 independently from source address.
2629 This may be useful for hosts, that receive encapsulated packets
2630 from the load balancers.
2631 .It Cm -ignore_source
2634 .It Cm send_rev_ethip_ver
2635 Set a flag to send EtherIP packets with reversed version
2636 field intentionally.
2637 Disabled by default.
2638 This is for backward compatibility with
2640 6.2, 6.3, 7.0, and 7.1.
2641 .It Cm -send_rev_ethip_ver
2643 .Cm send_rev_ethip_ver .
2646 The following parameters apply to GRE tunnel interfaces,
2648 .Bl -tag -width indent
2649 .It Cm tunnel Ar src_addr dest_addr
2650 Configure the physical source and destination address for GRE tunnel
2656 are interpreted as the outer source/destination for the encapsulating
2659 Unconfigure the physical source and destination address for GRE tunnel
2660 interfaces previously configured with
2663 Another name for the
2666 .It Cm grekey Ar key
2667 Configure the GRE key to be used for outgoing packets.
2669 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2670 This command will result in a four byte MTU reduction on the interface.
2673 The following parameters are specific to
2676 .Bl -tag -width indent
2677 .It Cm syncdev Ar iface
2678 Use the specified interface
2679 to send and receive pfsync state synchronisation messages.
2681 Stop sending pfsync state synchronisation messages over the network.
2682 .It Cm syncpeer Ar peer_address
2683 Make the pfsync link point-to-point rather than using
2684 multicast to broadcast the state synchronisation messages.
2685 The peer_address is the IP address of the other host taking part in
2688 Broadcast the packets using multicast.
2690 Set the maximum number of updates for a single state which
2691 can be collapsed into one.
2692 This is an 8-bit number; the default value is 128.
2694 Defer transmission of the first packet in a state until a peer has
2695 acknowledged that the associated state has been inserted.
2697 Do not defer the first packet in a state.
2698 This is the default.
2701 The following parameters are specific to
2704 .Bl -tag -width indent
2705 .It Cm vlan Ar vlan_tag
2706 Set the VLAN tag value to
2708 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2709 or 802.1ad VLAN header for packets sent from the
2716 must both be set at the same time.
2717 .It Cm vlanproto Ar vlan_proto
2718 Set the VLAN encapsulation protocol to
2720 Supported encapsulation protocols are currently
2724 The default encapsulation protocol is
2726 .It Cm vlanpcp Ar priority_code_point
2729 is an 3-bit field which refers to the IEEE 802.1p
2730 class of service and maps to the frame priority level.
2732 Values in order of priority are:
2734 .Pq Dv Background (lowest) ,
2736 .Pq Dv Best effort (default) ,
2738 .Pq Dv Excellent effort ,
2740 .Pq Dv Critical applications ,
2742 .Pq Dv Video, < 100ms latency ,
2744 .Pq Dv Video, < 10ms latency ,
2746 .Pq Dv Internetwork control ,
2748 .Pq Dv Network control (highest) .
2749 .It Cm vlandev Ar iface
2750 Associate the physical interface
2755 Packets transmitted through the
2758 diverted to the specified physical interface
2760 with 802.1Q VLAN encapsulation.
2761 Packets with 802.1Q encapsulation received
2762 by the parent interface with the correct VLAN Identifier will be diverted to
2768 interface is assigned a
2769 copy of the parent interface's flags and the parent's Ethernet address.
2774 must both be set at the same time.
2777 interface already has
2778 a physical interface associated with it, this command will fail.
2780 change the association to another physical interface, the existing
2781 association must be cleared first.
2783 Note: if the hardware tagging capability
2784 is set on the parent interface, the
2787 interface's behavior changes:
2790 interface recognizes that the
2791 parent interface supports insertion and extraction of VLAN tags on its
2792 own (usually in firmware) and that it should pass packets to and from
2793 the parent unaltered.
2794 .It Fl vlandev Op Ar iface
2797 pseudo device, disassociate the parent interface from it.
2798 This breaks the link between the
2800 interface and its parent,
2801 clears its VLAN Identifier, flags and its link address and shuts the interface
2805 argument is useless and hence deprecated.
2808 The following parameters are used to configure
2811 .Bl -tag -width indent
2812 .It Cm vxlanid Ar identifier
2813 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2814 virtual network segment membership of the interface.
2815 .It Cm vxlanlocal Ar address
2816 The source address used in the encapsulating IPv4/IPv6 header.
2817 The address should already be assigned to an existing interface.
2818 When the interface is configured in unicast mode, the listening socket
2819 is bound to this address.
2820 .It Cm vxlanremote Ar address
2821 The interface can be configured in a unicast, or point-to-point, mode
2822 to create a tunnel between two hosts.
2823 This is the IP address of the remote end of the tunnel.
2824 .It Cm vxlangroup Ar address
2825 The interface can be configured in a multicast mode
2826 to create a virtual network of hosts.
2827 This is the IP multicast group address the interface will join.
2828 .It Cm vxlanlocalport Ar port
2829 The port number the interface will listen on.
2830 The default port number is 4789.
2831 .It Cm vxlanremoteport Ar port
2832 The destination port number used in the encapsulating IPv4/IPv6 header.
2833 The remote host should be listening on this port.
2834 The default port number is 4789.
2835 Note some other implementations, such as Linux,
2836 do not default to the IANA assigned port,
2837 but instead listen on port 8472.
2838 .It Cm vxlanportrange Ar low high
2839 The range of source ports used in the encapsulating IPv4/IPv6 header.
2840 The port selected within the range is based on a hash of the inner frame.
2841 A range is useful to provide entropy within the outer IP header
2842 for more effective load balancing.
2843 The default range is between the
2846 .Va net.inet.ip.portrange.first
2848 .Va net.inet.ip.portrange.last
2849 .It Cm vxlantimeout Ar timeout
2850 The maximum time, in seconds, before an entry in the forwarding table
2852 The default is 1200 seconds (20 minutes).
2853 .It Cm vxlanmaxaddr Ar max
2854 The maximum number of entries in the forwarding table.
2855 The default is 2000.
2856 .It Cm vxlandev Ar dev
2857 When the interface is configured in multicast mode, the
2859 interface is used to transmit IP multicast packets.
2860 .It Cm vxlanttl Ar ttl
2861 The TTL used in the encapsulating IPv4/IPv6 header.
2864 The source IP address and inner source Ethernet MAC address of
2865 received packets are used to dynamically populate the forwarding table.
2866 When in multicast mode, an entry in the forwarding table allows the
2867 interface to send the frame directly to the remote host instead of
2868 broadcasting the frame to the multicast group.
2869 This is the default.
2871 The forwarding table is not populated by received packets.
2873 Delete all dynamically-learned addresses from the forwarding table.
2874 .It Cm vxlanflushall
2875 Delete all addresses, including static addresses, from the forwarding table.
2878 The following parameters are used to configure
2880 protocol on an interface:
2881 .Bl -tag -width indent
2883 Set the virtual host ID.
2884 This is a required setting to initiate
2886 If the virtual host ID does not exist yet, it is created and attached to the
2887 interface, otherwise configuration of an existing vhid is adjusted.
2890 keyword is supplied along with an
2894 address, then this address is configured to be run under control of the
2896 Whenever a last address that refers to a particular vhid is removed from an
2897 interface, the vhid is automatically removed from interface and destroyed.
2898 Any other configuration parameters for the
2900 protocol should be supplied along with the
2903 Acceptable values for vhid are 1 to 255.
2904 .It Cm advbase Ar seconds
2905 Specifies the base of the advertisement interval in seconds.
2906 The acceptable values are 1 to 255.
2907 The default value is 1.
2908 .It Cm advskew Ar interval
2909 Specifies the skew to add to the base advertisement interval to
2910 make one host advertise slower than another host.
2911 It is specified in 1/256 of seconds.
2912 The acceptable values are 1 to 254.
2913 The default value is 0.
2914 .It Cm pass Ar phrase
2915 Set the authentication key to
2917 .It Cm state Ar MASTER|BACKUP
2918 Forcibly change state of a given vhid.
2923 utility displays the current configuration for a network interface
2924 when no optional parameters are supplied.
2925 If a protocol family is specified,
2927 will report only the details specific to that protocol family.
2931 flag is passed before an interface name,
2933 will display the capability list and all
2934 of the supported media for the specified interface.
2937 flag is supplied, address lifetime is displayed for IPv6 addresses,
2938 as time offset string.
2942 flag may be used instead of an interface name.
2945 to display information about all interfaces in the system.
2948 flag limits this to interfaces that are down,
2950 limits this to interfaces that are up,
2952 limits this to members of the specified group of interfaces, and
2954 excludes members of the specified group from the list.
2959 flags may be specified to apply both conditions.
2962 should be specified as later override previous ones
2966 may contain shell patterns in which case it should be quoted.
2967 When no arguments are given,
2973 flag may be used to list all available interfaces on the system, with
2974 no other additional information.
2977 is specified, only interfaces of that type will be listed.
2979 will list only Ethernet adapters, excluding the loopback interface.
2980 Use of this flag is mutually exclusive
2981 with all other flags and commands, except for
2983 (only list interfaces that are down)
2986 (only list interfaces that are up).
2990 flag may be used to get more verbose status for an interface.
2994 flag may be used to list all of the interface cloners available on
2995 the system, with no additional information.
2996 Use of this flag is mutually exclusive with all other flags and commands.
3000 flag causes keying information for the interface, if available, to be
3002 For example, the values of 802.11 WEP keys and
3004 passphrases will be printed, if accessible to the current user.
3005 This information is not printed by default, as it may be considered
3008 If the network interface driver is not present in the kernel then
3010 will attempt to load it.
3013 flag disables this behavior.
3015 Only the super-user may modify the configuration of a network interface.
3017 Assign the IPv4 address
3019 with a network mask of
3023 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3025 Add the IPv4 address
3027 with the CIDR network prefix
3033 as a synonym for the canonical form of the option
3035 .Dl # ifconfig em0 inet 192.0.2.45/28 add
3037 Remove the IPv4 address
3041 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3043 Enable IPv6 functionality of the interface:
3044 .Dl # ifconfig em0 inet6 -ifdisabled
3046 Add the IPv6 address
3047 .Li 2001:DB8:DBDB::123/48
3050 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3051 Note that lower case hexadecimal IPv6 addresses are acceptable.
3053 Remove the IPv6 address added in the above example,
3056 character as shorthand for the network prefix,
3059 as a synonym for the canonical form of the option
3061 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
3063 Configure a single CARP redundant address on igb0, and then switch it
3065 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3066 .Dl # ifconfig igb0 vhid 1 state master
3068 Configure the interface
3070 to use 100baseTX, full duplex Ethernet media options:
3071 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3073 Label the em0 interface as an uplink:
3074 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3076 Create the software network interface
3078 .Dl # ifconfig gif1 create
3080 Destroy the software network interface
3082 .Dl # ifconfig gif1 destroy
3084 Display available wireless networks using
3086 .Dl # ifconfig wlan0 list scan
3088 Display inet and inet6 address subnet masks in CIDR notation
3089 .Dl # ifconfig -f inet:cidr,inet6:cidr
3091 Display interfaces that are up with the exception of loopback
3092 .Dl # ifconfig -a -u -G lo
3094 Messages indicating the specified interface does not exist, the
3095 requested address is unknown, or the user is not privileged and
3096 tried to alter an interface's configuration.
3119 Basic IPv6 node operation requires a link-local address on each
3120 interface configured for IPv6.
3121 Normally, such an address is automatically configured by the
3122 kernel on each interface added to the system or enabled; this behavior may
3123 be disabled by setting per-interface flag
3124 .Cm -auto_linklocal .
3125 The default value of this flag is 1 and can be disabled by using the sysctl
3127 .Va net.inet6.ip6.auto_linklocal .
3129 Do not configure IPv6 addresses with no link-local address by using
3131 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob