1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
39 .Op Fl f Ar type:format Ns Op Ar ,type:format
81 utility is used to assign an address
82 to a network interface and/or configure
83 network interface parameters.
86 utility must be used at boot time to define the network address
87 of each interface present on a machine; it may also be used at
88 a later time to redefine an interface's address
89 or other operating parameters.
91 The following options are available:
92 .Bl -tag -width indent
95 .Tn DARPA Ns -Internet
97 the address is either a host name present in the host name data
102 Internet address expressed in the Internet standard
105 It is also possible to use the CIDR notation (also known as the
106 slash notation) to include the netmask.
107 That is, one can specify an address like
112 family, it is also possible to specify the prefix length using the slash
117 parameter below for more information.
118 .\" For the Xerox Network Systems(tm) family,
120 .\" .Ar net:a.b.c.d.e.f ,
123 .\" is the assigned network number (in decimal),
124 .\" and each of the six bytes of the host number,
128 .\" are specified in hexadecimal.
129 .\" The host number may be omitted on IEEE 802 protocol
130 .\" (Ethernet, FDDI, and Token Ring) interfaces,
131 .\" which use the hardware physical address,
132 .\" and on interfaces other than the first.
135 .\" family, addresses are specified as a long hexadecimal string,
136 .\" as in the Xerox family.
137 .\" However, two consecutive dots imply a zero
138 .\" byte, and the dots are optional, if the user wishes to (carefully)
139 .\" count out long strings of digits in network byte order.
144 is specified as a series of colon-separated hex digits.
145 This can be used to, for example,
146 set a new MAC address on an Ethernet interface, though the
147 mechanism used is not Ethernet specific.
150 keyword to set a randomly generated MAC address.
151 A randomly-generated MAC address might be the same as one already in use
153 Such duplications are extremely unlikely.
154 If the interface is already
155 up when this option is used, it will be briefly brought down and
156 then brought back up again in order to ensure that the receive
157 filter in the underlying Ethernet hardware is properly reprogrammed.
158 .It Ar address_family
161 which affects interpretation of the remaining parameters.
162 Since an interface can receive transmissions in differing protocols
163 with different naming schemes, specifying the address family is recommended.
164 The address or protocol families currently
170 The default if available is
183 address family has special meaning and is no longer synonymous with
189 will list only Ethernet interfaces, excluding all other interface types,
190 including the loopback interface.
192 Specify the address of the correspondent on the other end
193 of a point to point link.
196 parameter is a string of the form
201 List the interfaces in the given group.
206 can be controlled using the
210 environment variable.
211 The format is specified as a comma separated list of
216 section for more information.
222 .Bl -tag -width ether
224 Adjust the display of inet and inet6 addresses
225 .Bl -tag -width default
227 Display inet and inet6 addresses in the default format,
230 Display inet and inet6 addresses as fully qualified domain names
233 Display inet and inet6 addresses as unqualified hostnames
235 Display inet and inet6 addresses in numeric format
238 Adjust the display of link-level ethernet (MAC) addresses
239 .Bl -tag -width default
241 Separate address segments with a colon
243 Separate address segments with a dash
245 Display ethernet addresses in the default format,
249 Adjust the display of inet address subnet masks:
250 .Bl -tag -width default
252 Display subnet masks in CIDR notation, for example:
254 10.0.0.0/8 or 203.0.113.224/26
256 Display subnet masks in the default format,
259 Display subnet masks in dotted quad notation, for example:
261 255.255.0.0 or 255.255.255.192
263 Display subnet masks in hexadecimal, for example:
265 0xffff0000 or 0xffffffc0
268 Adjust the display of inet6 address prefixes (subnet masks):
269 .Bl -tag -width default
271 Display subnet prefix in CIDR notation, for example:
273 ::1/128 or fe80::1%lo0/64
275 Display subnet prefix in the default format
278 Display subnet prefix in integer format, for example:
284 The following parameters may be set with
286 .Bl -tag -width indent
291 Introduced for compatibility
295 Establish an additional network address for this interface.
296 This is sometimes useful when changing network numbers, and
297 one wishes to accept packets addressed to the old interface.
298 If the address is on the same subnet as the first network address
299 for this interface, a non-conflicting netmask must be given.
304 Remove the network address specified.
305 This would be used if you incorrectly specified an alias, or it
306 was no longer needed.
307 If you have incorrectly set an NS address having the side effect
308 of specifying the host portion, removing all NS addresses will
309 allow you to respecify the host portion.
312 Specify that the address configured is an anycast address.
313 Based on the current specification,
314 only routers may configure anycast addresses.
315 Anycast address will not be used as source address of any of outgoing
318 Enable the use of the Address Resolution Protocol
321 between network level addresses and link level addresses (default).
322 This is currently implemented for mapping between
327 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
329 Disable the use of the Address Resolution Protocol
332 If the Address Resolution Protocol is enabled,
333 the host will only reply to requests for its addresses,
334 and will never send any requests.
336 If the Address Resolution Protocol is enabled,
337 the host will perform normally,
338 sending out requests and listening for replies.
341 Specify the address to use to represent broadcasts to the
343 The default broadcast address is the address with a host part of all 1's.
345 Enable driver dependent debugging code; usually, this turns on
346 extra console error logging.
348 Disable driver dependent debugging code.
350 Put interface into permanently promiscuous mode.
352 Disable permanently promiscuous mode.
357 .It Cm description Ar value , Cm descr Ar value
358 Specify a description of the interface.
359 This can be used to label interfaces in situations where they may
360 otherwise be difficult to distinguish.
361 .It Cm -description , Cm -descr
362 Clear the interface description.
366 When an interface is marked
368 the system will not attempt to
369 transmit messages through that interface.
370 If possible, the interface will be reset to disable reception as well.
371 This action does not automatically disable routes using the interface.
372 .It Cm group Ar groupname
373 Assign the interface to a
375 Any interface can be in multiple groups.
377 Cloned interfaces are members of their interface family group by default.
378 For example, a PPP interface such as
380 is a member of the PPP interface family group,
382 .\" The interface(s) the default route(s) point to are members of the
385 .It Cm -group Ar groupname
386 Remove the interface from the given
391 (lowermost 64bit of an IPv6 address)
393 .It Cm fib Ar fib_number
394 Specify interface FIB.
397 is assigned to all frames or packets received on that interface.
398 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
399 the default FIB (0) irrespective of the parent interface's FIB.
400 The kernel needs to be tuned to support more than the default FIB
403 kernel configuration option, or the
406 .It Cm tunnelfib Ar fib_number
410 is assigned to all packets encapsulated by tunnel interface, e.g.,
414 .It Cm maclabel Ar label
415 If Mandatory Access Control support is enabled in the kernel,
419 .\" .Xr maclabel 7 ) .
421 If the driver supports the media selection system, set the media type
424 Some interfaces support the mutually exclusive use of one of several
425 different physical media connectors.
426 For example, a 10Mbit/s Ethernet
427 interface might support the use of either
429 or twisted pair connectors.
430 Setting the media type to
432 would change the currently active connector to the AUI port.
435 would activate twisted pair.
436 Refer to the interfaces' driver
437 specific documentation or man page for a complete list of the
439 .It Cm mediaopt Ar opts
440 If the driver supports the media selection system, set the specified
441 media options on the interface.
445 is a comma delimited list of options to apply to the interface.
446 Refer to the interfaces' driver specific man page for a complete
447 list of available options.
448 .It Fl mediaopt Ar opts
449 If the driver supports the media selection system, disable the
450 specified media options on the interface.
452 If the driver supports the media selection system, set the specified
453 operating mode on the interface to
455 For IEEE 802.11 wireless interfaces that support multiple operating modes
456 this directive is used to select between 802.11a
464 Set if the driver supports TX rate limiting.
465 .It Cm inst Ar minst , Cm instance Ar minst
466 Set the media instance to
468 This is useful for devices which have multiple physical layer interfaces
471 Set the interface name to
473 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
474 If the driver supports user-configurable checksum offloading,
475 enable receive (or transmit) checksum offloading on the interface.
476 The feature can be turned on selectively per protocol family.
478 .Cm rxcsum6 , txcsum6
484 Some drivers may not be able to enable these flags independently
485 of each other, so setting one may also set the other.
486 The driver will offload as much checksum work as it can reliably
487 support, the exact level of offloading varies between drivers.
488 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
489 If the driver supports user-configurable checksum offloading,
490 disable receive (or transmit) checksum offloading on the interface.
491 The feature can be turned off selectively per protocol family.
493 .Fl rxcsum6 , txcsum6
499 These settings may not always be independent of each other.
501 If the driver supports
503 segmentation offloading, enable TSO on the interface.
504 Some drivers may not be able to support TSO for
508 packets, so they may enable only one of them.
510 If the driver supports
512 segmentation offloading, disable TSO on the interface.
513 It will always disable TSO for
518 If the driver supports
520 segmentation offloading for
524 use one of these to selectively enabled it only for one protocol family.
526 If the driver supports
528 segmentation offloading for
532 use one of these to selectively disable it only for one protocol family.
534 If the driver supports
536 large receive offloading, enable LRO on the interface.
538 If the driver supports
540 large receive offloading, disable LRO on the interface.
542 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
543 segments the encrypted record into one or more
549 If the driver supports transmit TLS offload,
550 enable transmit TLS offload on the interface.
551 Some drivers may not be able to support transmit TLS offload for
555 packets, so they may enable only one of them.
557 If the driver supports transmit TLS offload,
558 disable transmit TLS offload on the interface.
559 It will always disable TLS for
564 If the driver supports unmapped network buffers,
565 enable them on the interface.
567 If the driver supports unmapped network buffers,
568 disable them on the interface.
569 .It Cm wol , wol_ucast , wol_mcast , wol_magic
570 Enable Wake On Lan (WOL) support, if available.
571 WOL is a facility whereby a machine in a low power state may be woken
572 in response to a received packet.
573 There are three types of packets that may wake a system:
574 ucast (directed solely to the machine's mac address),
575 mcast (directed to a broadcast or multicast address),
577 magic (unicast or multicast frames with a ``magic contents'').
578 Not all devices support WOL, those that do indicate the mechanisms
579 they support in their capabilities.
581 is a synonym for enabling all available WOL mechanisms.
584 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
585 If the driver offers user-configurable VLAN support, enable
586 reception of extended frames, tag processing in hardware,
587 frame filtering in hardware, checksum offloading, or TSO on VLAN,
589 Note that this must be issued on a physical interface associated with
594 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
595 If the driver offers user-configurable VLAN support, disable
596 reception of extended frames, tag processing in hardware,
597 frame filtering in hardware, or TSO on VLAN,
600 Move the interface to the
602 specified by name or JID.
603 If the jail has a virtual network stack, the interface will disappear
604 from the current environment and become visible to the jail.
606 Reclaim the interface from the
608 specified by name or JID.
609 If the jail has a virtual network stack, the interface will disappear
610 from the jail, and become visible to the current network environment.
614 feature and disable interrupts on the interface, if driver supports
619 feature and enable interrupt mode on the interface.
621 Create the specified network pseudo-device.
622 If the interface is given without a unit number, try to create a new
623 device with an arbitrary unit number.
624 If creation of an arbitrary device is successful, the new device name is
625 printed to standard output unless the interface is renamed or destroyed
630 Destroy the specified network pseudo-device.
646 Set the routing metric of the interface to
649 The routing metric is used by the routing protocol
651 Higher metrics have the effect of making a route
652 less favorable; metrics are counted as additional hops
653 to the destination network or host.
655 Set the maximum transmission unit of the interface to
657 default is interface specific.
658 The MTU is used to limit the size of packets that are transmitted on an
660 Not all interfaces support setting the MTU, and some interfaces have
662 .It Cm netmask Ar mask
665 Specify how much of the address to reserve for subdividing
666 networks into sub-networks.
667 The mask includes the network part of the local address
668 and the subnet part, which is taken from the host field of the address.
669 The mask can be specified as a single hexadecimal number
672 with a dot-notation Internet address,
673 or with a pseudo-network name listed in the network table
675 The mask contains 1's for the bit positions in the 32-bit address
676 which are to be used for the network and subnet parts,
677 and 0's for the host part.
678 The mask should contain at least the standard network portion,
679 and the subnet field should be contiguous with the network
682 The netmask can also be specified in CIDR notation after the address.
685 option above for more information.
686 .It Cm prefixlen Ar len
690 bits are reserved for subdividing networks into sub-networks.
693 must be integer, and for syntactical reason it must be between 0 to 128.
694 It is almost always 64 under the current IPv6 assignment rule.
695 If the parameter is omitted, 64 is used.
697 The prefix can also be specified using the slash notation after the address.
700 option above for more information.
705 Introduced for compatibility
709 .It Cm link Op Cm 0 No - Cm 2
711 Enable special processing of the link level of the interface.
712 These three options are interface specific in actual effect, however,
713 they are in general used to select special modes of operation.
715 of this is to enable SLIP compression, or to select the connector type
716 for some Ethernet cards.
717 Refer to the man page for the specific driver
718 for more information.
720 .It Fl link Op Cm 0 No - Cm 2
722 Disable special processing at the link level with the specified interface.
724 Put the interface in monitor mode.
725 No packets are transmitted, and received packets are discarded after
729 Take the interface out of monitor mode.
730 .It Cm pcp Ar priority_code_point
733 is an 3-bit field which refers to the IEEE 802.1p
734 class of service and maps to the frame priority level.
736 Stop tagging packets on the interface w/ the priority code point.
740 This may be used to enable an interface after an
742 It happens automatically when setting the first address on an interface.
743 If the interface was reset when previously marked down,
744 the hardware will be re-initialized.
747 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
748 Note that the address family keyword
751 .Bl -tag -width indent
753 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
757 .Va net.inet6.ip6.accept_rtadv
758 controls whether this flag is set by default or not.
763 Set a flag to control whether routers from which the system accepts
764 Router Advertisement messages will be added to the Default Router List
768 flag is disabled, this flag has no effect.
772 .Va net.inet6.ip6.no_radr
773 controls whether this flag is set by default or not.
777 .It Cm auto_linklocal
778 Set a flag to perform automatic link-local address configuration when
779 the interface becomes available.
783 .Va net.inet6.ip6.auto_linklocal
784 controls whether this flag is set by default or not.
785 .It Cm -auto_linklocal
789 Set the specified interface as the default route when there is no
795 Set a flag to disable all of IPv6 network communications on the
797 Note that if there are already configured IPv6
798 addresses on that interface, all of them are marked as
800 and DAD will be performed when this flag is cleared.
804 When this flag is cleared and
806 flag is enabled, automatic configuration of a link-local address is
809 Set a flag to enable Neighbor Unreachability Detection.
813 .It Cm no_prefer_iface
814 Set a flag to not honor rule 5 of source address selection in RFC 3484.
815 In practice this means the address on the outgoing interface will not be
816 preferred, effectively yielding the decision to the address selection
817 policy table, configurable with
819 .It Cm -no_prefer_iface
821 .Cm no_prefer_iface .
823 Set a flag to disable Duplicate Address Detection.
829 The following parameters are specific for IPv6 addresses.
830 Note that the address family keyword
833 .Bl -tag -width indent
835 Set the IPv6 autoconfigured address bit.
837 Clear the IPv6 autoconfigured address bit.
839 Set the IPv6 deprecated address bit.
841 Clear the IPv6 deprecated address bit.
843 Set preferred lifetime for the address.
845 Set a flag to prefer address as a candidate of the source address for
847 .It Cm -prefer_source
851 Set valid lifetime for the address.
854 The following parameters are specific to cloning
855 IEEE 802.11 wireless interfaces with the
858 .Bl -tag -width indent
859 .It Cm wlandev Ar device
862 as the parent for the cloned device.
863 .It Cm wlanmode Ar mode
864 Specify the operating mode for this cloned device.
882 The operating mode of a cloned interface cannot be changed.
885 mode is actually implemented as an
887 interface with special properties.
888 .It Cm wlanbssid Ar bssid
889 The 802.11 mac address to use for the bssid.
890 This must be specified at create time for a legacy
893 .It Cm wlanaddr Ar address
894 The local mac address.
895 If this is not specified then a mac address will automatically be assigned
896 to the cloned device.
897 Typically this address is the same as the address of the parent device
900 parameter is specified then the driver will craft a unique address for
901 the device (if supported).
905 device as operating in ``legacy mode''.
908 devices have a fixed peer relationship and do not, for example, roam
909 if their peer stops communicating.
910 For completeness a Dynamic WDS (DWDS) interface may marked as
913 Request a unique local mac address for the cloned device.
914 This is only possible if the device supports multiple mac addresses.
915 To force use of the parent's mac address use
918 Mark the cloned interface as depending on hardware support to
919 track received beacons.
920 To have beacons tracked in software use
926 can also be used to indicate no beacons should
927 be transmitted; this can be useful when creating a WDS configuration but
929 interfaces can only be created as companions to an access point.
932 The following parameters are specific to IEEE 802.11 wireless interfaces
936 .Bl -tag -width indent
938 Enable sending and receiving AMPDU frames when using 802.11n (default).
939 The 802.11n specification states a compliant station must be capable
940 of receiving AMPDU frames but transmission is optional.
943 to disable all use of AMPDU with 802.11n.
944 For testing and/or to work around interoperability problems one can use
948 to control use of AMPDU in one direction.
949 .It Cm ampdudensity Ar density
950 Set the AMPDU density parameter used when operating with 802.11n.
951 This parameter controls the inter-packet gap for AMPDU frames.
952 The sending device normally controls this setting but a receiving station
953 may request wider gaps.
956 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
959 is treated the same as 0.
960 .It Cm ampdulimit Ar limit
961 Set the limit on packet size for receiving AMPDU frames when operating
965 are 8192, 16384, 32768, and 65536 but one can also specify
966 just the unique prefix: 8, 16, 32, 64.
967 Note the sender may limit the size of AMPDU frames to be less
968 than the maximum specified by the receiving station.
970 Enable sending and receiving AMSDU frames when using 802.11n.
971 By default AMSDU is received but not transmitted.
974 to disable all use of AMSDU with 802.11n.
975 For testing and/or to work around interoperability problems one can use
979 to control use of AMSDU in one direction.
980 .It Cm amsdulimit Ar limit
981 Set the limit on packet size for sending and receiving AMSDU frames
982 when operating with 802.11n.
985 are 7935 and 3839 (bytes).
986 Note the sender may limit the size of AMSDU frames to be less
987 than the maximum specified by the receiving station.
988 Note also that devices are not required to support the 7935 limit,
989 only 3839 is required by the specification and the larger value
990 may require more memory to be dedicated to support functionality
993 When operating as an access point, pass packets between
994 wireless clients directly (default).
995 To instead let them pass up through the
996 system and be forwarded using some other mechanism, use
998 Disabling the internal bridging
999 is useful when traffic is to be processed with
1001 .It Cm authmode Ar mode
1002 Set the desired authentication mode in infrastructure mode.
1003 Not all adapters support all modes.
1006 .Cm none , open , shared
1012 (IEEE WPA/WPA2/802.11i).
1017 modes are only useful when using an authentication service
1018 (a supplicant for client operation or an authenticator when
1019 operating as an access point).
1020 Modes are case insensitive.
1022 Enable background scanning when operating as a station.
1023 Background scanning is a technique whereby a station associated to
1024 an access point will temporarily leave the channel to scan for
1025 neighboring stations.
1026 This allows a station to maintain a cache of nearby access points
1027 so that roaming between access points can be done without
1028 a lengthy scan operation.
1029 Background scanning is done only when a station is not busy and
1030 any outbound traffic will cancel a scan operation.
1031 Background scanning should never cause packets to be lost though
1032 there may be some small latency if outbound traffic interrupts a
1034 By default background scanning is enabled if the device is capable.
1035 To disable background scanning, use
1037 Background scanning is controlled by the
1042 Background scanning must be enabled for roaming; this is an artifact
1043 of the current implementation and may not be required in the future.
1044 .It Cm bgscanidle Ar idletime
1045 Set the minimum time a station must be idle (not transmitting or
1046 receiving frames) before a background scan is initiated.
1049 parameter is specified in milliseconds.
1050 By default a station must be idle at least 250 milliseconds before
1051 a background scan is initiated.
1052 The idle time may not be set to less than 100 milliseconds.
1053 .It Cm bgscanintvl Ar interval
1054 Set the interval at which background scanning is attempted.
1057 parameter is specified in seconds.
1058 By default a background scan is considered every 300 seconds (5 minutes).
1061 may not be set to less than 15 seconds.
1062 .It Cm bintval Ar interval
1063 Set the interval at which beacon frames are sent when operating in
1067 parameter is specified in TU's (1024 usecs).
1068 By default beacon frames are transmitted every 100 TU's.
1069 .It Cm bmissthreshold Ar count
1070 Set the number of consecutive missed beacons at which the station
1071 will attempt to roam (i.e., search for a new access point).
1074 parameter must be in the range 1 to 255; though the
1075 upper bound may be reduced according to device capabilities.
1076 The default threshold is 7 consecutive missed beacons; but
1077 this may be overridden by the device driver.
1078 Another name for the
1082 .It Cm bssid Ar address
1083 Specify the MAC address of the access point to use when operating
1084 as a station in a BSS network.
1085 This overrides any automatic selection done by the system.
1086 To disable a previously selected access point, supply
1091 This option is useful when more than one access point uses the same SSID.
1092 Another name for the
1097 Enable packet bursting.
1098 Packet bursting is a transmission technique whereby the wireless
1099 medium is acquired once to send multiple frames and the interframe
1101 This technique can significantly increase throughput by reducing
1102 transmission overhead.
1103 Packet bursting is supported by the 802.11e QoS specification
1104 and some devices that do not support QoS may still be capable.
1105 By default packet bursting is enabled if a device is capable
1107 To disable packet bursting, use
1109 .It Cm chanlist Ar channels
1110 Set the desired channels to use when scanning for access
1111 points, neighbors in an IBSS network, or looking for unoccupied
1112 channels when operating as an access point.
1113 The set of channels is specified as a comma-separated list with
1114 each element in the list representing either a single channel number or a range
1117 Channel numbers must be in the range 1 to 255 and be permissible
1118 according to the operating characteristics of the device.
1119 .It Cm channel Ar number
1120 Set a single desired channel.
1121 Channels range from 1 to 255, but the exact selection available
1122 depends on the region your adaptor was manufactured for.
1128 will clear any desired channel and, if the device is marked up,
1129 force a scan for a channel to operate on.
1130 Alternatively the frequency, in megahertz, may be specified
1131 instead of the channel number.
1133 When there are several ways to use a channel the channel
1134 number/frequency may be appended with attributes to clarify.
1135 For example, if a device is capable of operating on channel 6
1136 with 802.11n and 802.11g then one can specify that g-only use
1137 should be used by specifying ``6:g''.
1138 Similarly the channel width can be specified by appending it
1139 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1140 These attributes can be combined as in: ``6:ht/40''.
1141 The full set of flags specified following a ``:'' are:
1147 (Atheros Dynamic Turbo mode),
1155 (Atheros Static Turbo mode),
1158 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1159 The full set of channel widths following a '/' are:
1161 (5MHz aka quarter-rate channel),
1163 (10MHz aka half-rate channel),
1165 (20MHz mostly for use in specifying ht20),
1168 (40MHz mostly for use in specifying ht40).
1170 a 40MHz HT channel specification may include the location
1171 of the extension channel by appending ``+'' or ``-'' for above and below,
1172 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1173 with the center channel at frequency 2437 and the extension channel above.
1174 .It Cm country Ar name
1175 Set the country code to use in calculating the regulatory constraints
1177 In particular the set of available channels, how the wireless device
1178 will operation on the channels, and the maximum transmit power that
1179 can be used on a channel are defined by this setting.
1180 Country/Region codes are specified as a 2-character abbreviation
1181 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1182 e.g., "ES" and "Spain".
1183 The set of country codes are taken from
1184 .Pa /etc/regdomain.xml
1186 be viewed with the ``list countries'' request.
1187 Note that not all devices support changing the country code from a default
1188 setting; typically stored in EEPROM.
1196 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1197 DFS embodies several facilities including detection of overlapping
1198 radar signals, dynamic transmit power control, and channel selection
1199 according to a least-congested criteria.
1200 DFS support is mandatory for some 5GHz frequencies in certain
1201 locales (e.g., ETSI).
1202 By default DFS is enabled according to the regulatory definitions
1204 .Pa /etc/regdomain.xml
1205 and the current country code, regdomain,
1207 Note the underlying device (and driver) must support radar detection
1208 for full DFS support to work.
1209 To be fully compliant with the local regulatory agency frequencies that
1210 require DFS should not be used unless it is fully supported.
1213 to disable this functionality for testing.
1215 Enable support for the 802.11d specification (default).
1216 When this support is enabled in station mode, beacon frames that advertise
1217 a country code different than the currently configured country code will
1218 cause an event to be dispatched to user applications.
1219 This event can be used by the station to adopt that country code and
1220 operate according to the associated regulatory constraints.
1221 When operating as an access point with 802.11d enabled the beacon and
1222 probe response frames transmitted will advertise the current regulatory
1224 To disable 802.11d use
1227 Enable 802.11h support including spectrum management.
1228 When 802.11h is enabled beacon and probe response frames will have
1229 the SpectrumMgt bit set in the capabilities field and
1230 country and power constraint information elements will be present.
1231 802.11h support also includes handling Channel Switch Announcements (CSA)
1232 which are a mechanism to coordinate channel changes by an access point.
1233 By default 802.11h is enabled if the device is capable.
1234 To disable 802.11h use
1236 .It Cm deftxkey Ar index
1237 Set the default key to use for transmission.
1238 Typically this is only set when using WEP encryption.
1239 Note that you must set a default transmit key
1240 for the system to know which key to use in encrypting outbound traffic.
1243 is an alias for this request; it is provided for backwards compatibility.
1244 .It Cm dtimperiod Ar period
1247 period for transmitting buffered multicast data frames when
1248 operating in ap mode.
1251 specifies the number of beacon intervals between DTIM
1252 and must be in the range 1 to 15.
1253 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1255 Enable the use of quiet IE.
1256 Hostap will use this to silence other
1257 stations to reduce interference for radar detection when
1258 operating on 5GHz frequency and doth support is enabled.
1261 to disable this functionality.
1262 .It Cm quiet_period Ar period
1265 to the number of beacon intervals between the start of regularly
1266 scheduled quiet intervals defined by Quiet element.
1267 .It Cm quiet_count Ar count
1270 to the number of TBTTs until the beacon interval during which the
1271 next quiet interval shall start.
1272 A value of 1 indicates the quiet
1273 interval will start during the beacon interval starting at the next
1275 A value 0 is reserved.
1276 .It Cm quiet_offset Ar offset
1279 to the offset of the start of the quiet interval from the TBTT
1280 specified by the Quiet count, expressed in TUs.
1283 shall be less than one beacon interval.
1284 .It Cm quiet_duration Ar dur
1287 to the duration of the Quiet interval, expressed in TUs.
1288 The value should be less than beacon interval.
1290 Enable the use of Atheros Dynamic Turbo mode when communicating with
1291 another Dynamic Turbo-capable station.
1292 Dynamic Turbo mode is an Atheros-specific mechanism by which
1293 stations switch between normal 802.11 operation and a ``boosted''
1294 mode in which a 40MHz wide channel is used for communication.
1295 Stations using Dynamic Turbo mode operate boosted only when the
1296 channel is free of non-dturbo stations; when a non-dturbo station
1297 is identified on the channel all stations will automatically drop
1298 back to normal operation.
1299 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1300 Note that turbo mode (dynamic or static) is only allowed on some
1301 channels depending on the regulatory constraints; use the
1303 command to identify the channels where turbo mode may be used.
1304 To disable Dynamic Turbo mode use
1307 Enable Dynamic WDS (DWDS) support.
1308 DWDS is a facility by which 4-address traffic can be carried between
1309 stations operating in infrastructure mode.
1310 A station first associates to an access point and authenticates using
1311 normal procedures (e.g., WPA).
1312 Then 4-address frames are passed to carry traffic for stations
1313 operating on either side of the wireless link.
1314 DWDS extends the normal WDS mechanism by leveraging existing security
1315 protocols and eliminating static binding.
1317 When DWDS is enabled on an access point 4-address frames received from
1318 an authorized station will generate a ``DWDS discovery'' event to user
1320 This event should be used to create a WDS interface that is bound
1321 to the remote station (and usually plumbed into a bridge).
1322 Once the WDS interface is up and running 4-address traffic then logically
1323 flows through that interface.
1325 When DWDS is enabled on a station, traffic with a destination address
1326 different from the peer station are encapsulated in a 4-address frame
1327 and transmitted to the peer.
1328 All 4-address traffic uses the security information of the stations
1329 (e.g., cryptographic keys).
1330 A station is associated using 802.11n facilities may transport
1331 4-address traffic using these same mechanisms; this depends on available
1332 resources and capabilities of the device.
1333 The DWDS implementation guards against layer 2 routing loops of
1336 Enable the use of Atheros Fast Frames when communicating with
1337 another Fast Frames-capable station.
1338 Fast Frames are an encapsulation technique by which two 802.3
1339 frames are transmitted in a single 802.11 frame.
1340 This can noticeably improve throughput but requires that the
1341 receiving station understand how to decapsulate the frame.
1342 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1343 protocol extension so enabling use is safe when communicating with
1344 non-Atheros devices.
1345 By default, use of fast frames is enabled if the device is capable.
1346 To explicitly disable fast frames, use
1348 .It Cm fragthreshold Ar length
1349 Set the threshold for which transmitted frames are broken into fragments.
1352 argument is the frame size in bytes and must be in the range 256 to 2346.
1360 disables transmit fragmentation.
1361 Not all adapters honor the fragmentation threshold.
1363 When operating as an access point, do not broadcast the SSID
1364 in beacon frames or respond to probe request frames unless
1365 they are directed to the ap (i.e., they include the ap's SSID).
1366 By default, the SSID is included in beacon frames and
1367 undirected probe request frames are answered.
1368 To re-enable the broadcast of the SSID etc., use
1371 Enable use of High Throughput (HT) when using 802.11n (default).
1372 The 802.11n specification includes mechanisms for operation
1373 on 20MHz and 40MHz wide channels using different signalling mechanisms
1374 than specified in 802.11b, 802.11g, and 802.11a.
1375 Stations negotiate use of these facilities, termed HT20 and HT40,
1376 when they associate.
1377 To disable all use of 802.11n use
1379 To disable use of HT20 (e.g., to force only HT40 use) use
1381 To disable use of HT40 use
1384 HT configuration is used to ``auto promote'' operation
1385 when several choices are available.
1386 For example, if a station associates to an 11n-capable access point
1387 it controls whether the station uses legacy operation, HT20, or HT40.
1388 When an 11n-capable device is setup as an access point and
1389 Auto Channel Selection is used to locate a channel to operate on,
1390 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1391 on the selected channel.
1392 If a fixed channel is specified for a station then HT configuration can
1393 be given as part of the channel specification; e.g., 6:ht/20 to setup
1394 HT20 operation on channel 6.
1396 Enable use of compatibility support for pre-802.11n devices (default).
1397 The 802.11n protocol specification went through several incompatible iterations.
1398 Some vendors implemented 11n support to older specifications that
1399 will not interoperate with a purely 11n-compliant station.
1400 In particular the information elements included in management frames
1401 for old devices are different.
1402 When compatibility support is enabled both standard and compatible data
1404 Stations that associate using the compatibility mechanisms are flagged
1406 To disable compatibility support use
1408 .It Cm htprotmode Ar technique
1409 For interfaces operating in 802.11n, use the specified
1411 for protecting HT frames in a mixed legacy/HT network.
1412 The set of valid techniques is
1417 Technique names are case insensitive.
1419 Enable inactivity processing for stations associated to an
1420 access point (default).
1421 When operating as an access point the 802.11 layer monitors
1422 the activity of each associated station.
1423 When a station is inactive for 5 minutes it will send several
1424 ``probe frames'' to see if the station is still present.
1425 If no response is received then the station is deauthenticated.
1426 Applications that prefer to handle this work can disable this
1430 Set the location to use in calculating regulatory constraints.
1431 The location is also advertised in beacon and probe response frames
1432 when 802.11d is enabled with
1441 Display the list of channels available for use taking into account
1442 any restrictions set with the
1445 See the description of
1447 for more information.
1449 Display the adaptor's capabilities, including the operating
1452 Display the list of channels available for use.
1453 Channels are shown with their IEEE channel number, equivalent
1454 frequency, and usage modes.
1455 Channels identified as
1460 Channels identified as
1462 may be used only for Atheros' Static Turbo mode
1464 . Cm mediaopt turbo ) .
1465 Channels marked with a
1467 have a regulatory constraint that they be passively scanned.
1468 This means a station is not permitted to transmit on the channel until
1469 it identifies the channel is being used for 802.11 communication;
1470 typically by hearing a beacon frame from an access point operating
1473 is another way of requesting this information.
1474 By default a compacted list of channels is displayed; if the
1476 option is specified then all channels are shown.
1477 .It Cm list countries
1478 Display the set of country codes and regulatory domains that can be
1479 used in regulatory configuration.
1481 Display the current MAC Access Control List state.
1482 Each address is prefixed with a character that indicates the
1483 current policy applied to it:
1485 indicates the address is allowed access,
1487 indicates the address is denied access,
1489 indicates the address is present but the current policy open
1490 (so the ACL is not consulted).
1492 Displays the mesh routing table, used for forwarding packets on a mesh
1494 .It Cm list regdomain
1495 Display the current regulatory settings including the available channels
1496 and transmit power caps.
1498 Display the parameters that govern roaming operation.
1500 Display the parameters that govern transmit operation.
1502 Display the transmit power caps for each channel.
1504 Display the access points and/or ad-hoc neighbors
1505 located in the vicinity.
1506 This information may be updated automatically by the adapter
1509 request or through background scanning.
1510 Depending on the capabilities of the stations the following
1511 flags can be included in the output:
1515 Indicates that the station is permitted to send/receive data frames.
1517 Extended Rate Phy (ERP).
1518 Indicates that the station is operating in an 802.11g network
1519 using extended transmit rates.
1521 High Throughput (HT).
1522 Indicates that the station is using HT transmit rates.
1523 If a `+' follows immediately after then the station associated
1524 using deprecated mechanisms supported only when
1529 Indicates that the station is operating in power save mode.
1531 Quality of Service (QoS).
1532 Indicates that the station is using QoS encapsulation for
1534 QoS encapsulation is enabled only when WME mode is enabled.
1537 Indicates that the station is doing short preamble to optionally
1538 improve throughput performance with 802.11g and 802.11b.
1540 Transitional Security Network (TSN).
1541 Indicates that the station associated using TSN; see also
1545 Wi-Fi Protected Setup (WPS).
1546 Indicates that the station associated using WPS.
1549 By default interesting information elements captured from the neighboring
1550 stations are displayed at the end of each row.
1551 Possible elements include:
1553 (station supports WME),
1555 (station supports WPA),
1557 (station supports WPS),
1559 (station supports 802.11i/RSN),
1561 (station supports 802.11n/HT communication),
1563 (station supports Atheros protocol extensions),
1565 (station supports unknown vendor-specific extensions).
1568 flag is used all the information elements and their
1569 contents will be shown.
1572 flag also enables display of long SSIDs.
1575 command is another way of requesting this information.
1577 When operating as an access point display the stations that are
1578 currently associated.
1579 When operating in ad-hoc mode display stations identified as
1580 neighbors in the IBSS.
1581 When operating in mesh mode display stations identified as
1582 neighbors in the MBSS.
1583 When operating in station mode display the access point.
1584 Capabilities advertised by the stations are described under
1588 Depending on the capabilities of the stations the following
1589 flags can be included in the output:
1593 Indicates that the station is permitted to send/receive data frames.
1595 Extended Rate Phy (ERP).
1596 Indicates that the station is operating in an 802.11g network
1597 using extended transmit rates.
1599 High Throughput (HT).
1600 Indicates that the station is using HT transmit rates.
1601 If a `+' follows immediately after then the station associated
1602 using deprecated mechanisms supported only when
1607 Indicates that the station is operating in power save mode.
1609 Quality of Service (QoS).
1610 Indicates that the station is using QoS encapsulation for
1612 QoS encapsulation is enabled only when WME mode is enabled.
1615 Indicates that the station is doing short preamble to optionally
1616 improve throughput performance with 802.11g and 802.11b.
1618 Transitional Security Network (TSN).
1619 Indicates that the station associated using TSN; see also
1623 Wi-Fi Protected Setup (WPS).
1624 Indicates that the station associated using WPS.
1627 By default information elements received from associated stations
1628 are displayed in a short form; the
1630 flag causes this information to be displayed symbolically.
1632 Display the current channel parameters to use when operating in WME mode.
1635 option is specified then both channel and BSS parameters are displayed
1636 for each AC (first channel, then BSS).
1637 When WME mode is enabled for an adaptor this information will be
1638 displayed with the regular status; this command is mostly useful
1639 for examining parameters when WME mode is disabled.
1640 See the description of the
1642 directive for information on the various parameters.
1643 .It Cm maxretry Ar count
1644 Set the maximum number of tries to use in sending unicast frames.
1645 The default setting is 6 but drivers may override this with a value
1647 .It Cm mcastrate Ar rate
1648 Set the rate for transmitting multicast/broadcast frames.
1649 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1650 This rate should be valid for the current operating conditions;
1651 if an invalid rate is specified drivers are free to chose an
1653 .It Cm mgtrate Ar rate
1654 Set the rate for transmitting management and/or control frames.
1655 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1657 Set the location to use in calculating regulatory constraints.
1658 The location is also advertised in beacon and probe response frames
1659 when 802.11d is enabled with
1668 Enable powersave operation.
1669 When operating as a client, the station will conserve power by
1670 periodically turning off the radio and listening for
1671 messages from the access point telling it there are packets waiting.
1672 The station must then retrieve the packets.
1673 Not all devices support power save operation as a client.
1674 The 802.11 specification requires that all access points support
1675 power save but some drivers do not.
1678 to disable powersave operation when operating as a client.
1679 .It Cm powersavesleep Ar sleep
1680 Set the desired max powersave sleep time in TU's (1024 usecs).
1681 By default the max powersave sleep time is 100 TU's.
1682 .It Cm protmode Ar technique
1683 For interfaces operating in 802.11g, use the specified
1685 for protecting OFDM frames in a mixed 11b/11g network.
1686 The set of valid techniques is
1692 Technique names are case insensitive.
1693 Not all devices support
1695 as a protection technique.
1697 When operating as an access point in 802.11g mode allow only
1698 11g-capable stations to associate (11b-only stations are not
1699 permitted to associate).
1700 To allow both 11g and 11b-only stations to associate, use
1703 When operating as an access point in 802.11n mode allow only
1704 HT-capable stations to associate (legacy stations are not
1705 permitted to associate).
1706 To allow both HT and legacy stations to associate, use
1708 .It Cm regdomain Ar sku
1709 Set the regulatory domain to use in calculating the regulatory constraints
1711 In particular the set of available channels, how the wireless device
1712 will operation on the channels, and the maximum transmit power that
1713 can be used on a channel are defined by this setting.
1714 Regdomain codes (SKU's) are taken from
1715 .Pa /etc/regdomain.xml
1717 be viewed with the ``list countries'' request.
1718 Note that not all devices support changing the regdomain from a default
1719 setting; typically stored in EEPROM.
1727 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1729 Note that RIFS must be supported by both the station and access point
1733 .It Cm roam:rate Ar rate
1734 Set the threshold for controlling roaming when operating in a BSS.
1737 parameter specifies the transmit rate in megabits
1738 at which roaming should be considered.
1739 If the current transmit rate drops below this setting and background scanning
1740 is enabled, then the system will check if a more desirable access point is
1741 available and switch over to it.
1742 The current scan cache contents are used if they are considered
1743 valid according to the
1745 parameter; otherwise a background scan operation is triggered before
1746 any selection occurs.
1747 Each channel type has a separate rate threshold; the default values are:
1748 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1749 .It Cm roam:rssi Ar rssi
1750 Set the threshold for controlling roaming when operating in a BSS.
1753 parameter specifies the receive signal strength in dBm units
1754 at which roaming should be considered.
1755 If the current rssi drops below this setting and background scanning
1756 is enabled, then the system will check if a more desirable access point is
1757 available and switch over to it.
1758 The current scan cache contents are used if they are considered
1759 valid according to the
1761 parameter; otherwise a background scan operation is triggered before
1762 any selection occurs.
1763 Each channel type has a separate rssi threshold; the default values are
1765 .It Cm roaming Ar mode
1766 When operating as a station, control how the system will
1767 behave when communication with the current access point
1771 argument may be one of
1773 (leave it to the hardware device to decide),
1775 (handle either in the device or the operating system\[em]as appropriate),
1777 (do nothing until explicitly instructed).
1778 By default, the device is left to handle this if it is
1779 capable; otherwise, the operating system will automatically
1780 attempt to reestablish communication.
1781 Manual mode is used by applications such as
1782 .Xr wpa_supplicant 8
1783 that want to control the selection of an access point.
1784 .It Cm rtsthreshold Ar length
1785 Set the threshold for which
1786 transmitted frames are preceded by transmission of an
1792 is the frame size in bytes and must be in the range 1 to 2346.
1800 disables transmission of RTS frames.
1801 Not all adapters support setting the RTS threshold.
1803 Initiate a scan of neighboring stations, wait for it to complete, and
1804 display all stations found.
1805 Only the super-user can initiate a scan.
1808 for information on the display.
1809 By default a background scan is done; otherwise a foreground
1810 scan is done and the station may roam to a different access point.
1813 request can be used to show recent scan results without
1814 initiating a new scan.
1815 .It Cm scanvalid Ar threshold
1816 Set the maximum time the scan cache contents are considered valid;
1817 i.e., will be used without first triggering a scan operation to
1821 parameter is specified in seconds and defaults to 60 seconds.
1822 The minimum setting for
1825 One should take care setting this threshold; if it is set too low
1826 then attempts to roam to another access point may trigger unnecessary
1827 background scan operations.
1829 Enable use of Short Guard Interval when operating in 802.11n
1831 NB: this currently enables Short GI on both HT40 and HT20 channels.
1832 To disable Short GI use
1835 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1836 when operating in 802.11n.
1837 A station operating with Static SMPS maintains only a single
1838 receive chain active (this can significantly reduce power consumption).
1842 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1843 when operating in 802.11n.
1844 A station operating with Dynamic SMPS maintains only a single
1845 receive chain active but switches to multiple receive chains when it
1846 receives an RTS frame (this can significantly reduce power consumption).
1847 Note that stations cannot distinguish between RTS/CTS intended to
1848 enable multiple receive chains and those used for other purposes.
1852 Set the desired Service Set Identifier (aka network name).
1853 The SSID is a string up to 32 characters
1854 in length and may be specified as either a normal string or in
1855 hexadecimal when preceded by
1857 Additionally, the SSID may be cleared by setting it to
1859 .It Cm tdmaslot Ar slot
1860 When operating with TDMA, use the specified
1865 is a number between 0 and the maximum number of slots in the BSS.
1866 Note that a station configured as slot 0 is a master and
1867 will broadcast beacon frames advertising the BSS;
1868 stations configured to use other slots will always
1869 scan to locate a master before they ever transmit.
1873 .It Cm tdmaslotcnt Ar cnt
1874 When operating with TDMA, setup a BSS with
1877 The slot count may be at most 8.
1878 The current implementation is only tested with two stations
1879 (i.e., point to point applications).
1880 This setting is only meaningful when a station is configured as slot 0;
1881 other stations adopt this setting from the BSS they join.
1885 .It Cm tdmaslotlen Ar len
1886 When operating with TDMA, setup a BSS such that each station has a slot
1889 The slot length must be at least 150 microseconds (1/8 TU)
1890 and no more than 65 milliseconds.
1891 Note that setting too small a slot length may result in poor channel
1892 bandwidth utilization due to factors such as timer granularity and
1894 This setting is only meaningful when a station is configured as slot 0;
1895 other stations adopt this setting from the BSS they join.
1898 is set to 10 milliseconds.
1899 .It Cm tdmabintval Ar intval
1900 When operating with TDMA, setup a BSS such that beacons are transmitted every
1902 superframes to synchronize the TDMA slot timing.
1903 A superframe is defined as the number of slots times the slot length; e.g.,
1904 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1905 The beacon interval may not be zero.
1908 causes the timers to be resynchronized more often; this can be help if
1909 significant timer drift is observed.
1914 When operating as an access point with WPA/802.11i allow legacy
1915 stations to associate using static key WEP and open authentication.
1916 To disallow legacy station use of WEP, use
1918 .It Cm txpower Ar power
1919 Set the power used to transmit frames.
1922 argument is specified in .5 dBm units.
1923 Out of range values are truncated.
1924 Typically only a few discreet power settings are available and
1925 the driver will use the setting closest to the specified value.
1926 Not all adapters support changing the transmit power.
1927 .It Cm ucastrate Ar rate
1928 Set a fixed rate for transmitting unicast frames.
1929 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1930 This rate should be valid for the current operating conditions;
1931 if an invalid rate is specified drivers are free to chose an
1933 .It Cm wepmode Ar mode
1934 Set the desired WEP mode.
1935 Not all adapters support all modes.
1936 The set of valid modes is
1942 mode explicitly tells the adaptor to allow association with access
1943 points which allow both encrypted and unencrypted traffic.
1946 means that the access point must only allow encrypted connections.
1949 is generally another name for
1951 Modes are case insensitive.
1952 .It Cm weptxkey Ar index
1953 Set the WEP key to be used for transmission.
1954 This is the same as setting the default transmission key with
1956 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1957 Set the selected WEP key.
1960 is not given, key 1 is set.
1961 A WEP key will be either 5 or 13
1962 characters (40 or 104 bits) depending on the local network and the
1963 capabilities of the adaptor.
1964 It may be specified either as a plain
1965 string or as a string of hexadecimal digits preceded by
1967 For maximum portability, hex keys are recommended;
1968 the mapping of text keys to WEP encryption is usually driver-specific.
1971 drivers do this mapping differently to
1973 A key may be cleared by setting it to
1975 If WEP is supported then there are at least four keys.
1976 Some adapters support more than four keys.
1977 If that is the case, then the first four keys
1978 (1-4) will be the standard temporary keys and any others will be adaptor
1979 specific keys such as permanent keys stored in NVRAM.
1981 Note that you must set a default transmit key with
1983 for the system to know which key to use in encrypting outbound traffic.
1985 Enable Wireless Multimedia Extensions (WME) support, if available,
1986 for the specified interface.
1987 WME is a subset of the IEEE 802.11e standard to support the
1988 efficient communication of realtime and multimedia data.
1989 To disable WME support, use
1991 Another name for this parameter is
1994 The following parameters are meaningful only when WME support is in use.
1995 Parameters are specified per-AC (Access Category) and
1996 split into those that are used by a station when acting
1997 as an access point and those for client stations in the BSS.
1998 The latter are received from the access point and may not be changed
2000 The following Access Categories are recognized:
2002 .Bl -tag -width ".Cm AC_BK" -compact
2006 best effort delivery,
2021 AC parameters are case-insensitive.
2022 Traffic classification is done in the operating system using the
2023 vlan priority associated with data frames or the
2024 ToS (Type of Service) indication in IP-encapsulated frames.
2025 If neither information is present, traffic is assigned to the
2026 Best Effort (BE) category.
2027 .Bl -tag -width indent
2029 Set the ACK policy for QoS transmissions by the local station;
2030 this controls whether or not data frames transmitted by a station
2031 require an ACK response from the receiving station.
2032 To disable waiting for an ACK use
2034 This parameter is applied only to the local station.
2036 Enable the Admission Control Mandatory (ACM) mechanism
2037 for transmissions by the local station.
2038 To disable the ACM use
2040 On stations in a BSS this parameter is read-only and indicates
2041 the setting received from the access point.
2042 NB: ACM is not supported right now.
2043 .It Cm aifs Ar ac Ar count
2044 Set the Arbitration Inter Frame Spacing (AIFS)
2045 channel access parameter to use for transmissions
2046 by the local station.
2047 On stations in a BSS this parameter is read-only and indicates
2048 the setting received from the access point.
2049 .It Cm cwmin Ar ac Ar count
2050 Set the CWmin channel access parameter to use for transmissions
2051 by the local station.
2052 On stations in a BSS this parameter is read-only and indicates
2053 the setting received from the access point.
2054 .It Cm cwmax Ar ac Ar count
2055 Set the CWmax channel access parameter to use for transmissions
2056 by the local station.
2057 On stations in a BSS this parameter is read-only and indicates
2058 the setting received from the access point.
2059 .It Cm txoplimit Ar ac Ar limit
2060 Set the Transmission Opportunity Limit channel access parameter
2061 to use for transmissions by the local station.
2062 This parameter defines an interval of time when a WME station
2063 has the right to initiate transmissions onto the wireless medium.
2064 On stations in a BSS this parameter is read-only and indicates
2065 the setting received from the access point.
2066 .It Cm bss:aifs Ar ac Ar count
2067 Set the AIFS channel access parameter to send to stations in a BSS.
2068 This parameter is meaningful only when operating in ap mode.
2069 .It Cm bss:cwmin Ar ac Ar count
2070 Set the CWmin channel access parameter to send to stations in a BSS.
2071 This parameter is meaningful only when operating in ap mode.
2072 .It Cm bss:cwmax Ar ac Ar count
2073 Set the CWmax channel access parameter to send to stations in a BSS.
2074 This parameter is meaningful only when operating in ap mode.
2075 .It Cm bss:txoplimit Ar ac Ar limit
2076 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2077 This parameter is meaningful only when operating in ap mode.
2080 Enable Wireless Privacy Subscriber support.
2081 Note that WPS support requires a WPS-capable supplicant.
2082 To disable this function use
2086 The following parameters support an optional access control list
2087 feature available with some adapters when operating in ap mode; see
2089 This facility allows an access point to accept/deny association
2090 requests based on the MAC address of the station.
2091 Note that this feature does not significantly enhance security
2092 as MAC address spoofing is easy to do.
2093 .Bl -tag -width indent
2094 .It Cm mac:add Ar address
2095 Add the specified MAC address to the database.
2096 Depending on the policy setting association requests from the
2097 specified station will be allowed or denied.
2099 Set the ACL policy to permit association only by
2100 stations registered in the database.
2101 .It Cm mac:del Ar address
2102 Delete the specified MAC address from the database.
2104 Set the ACL policy to deny association only by
2105 stations registered in the database.
2106 .It Cm mac:kick Ar address
2107 Force the specified station to be deauthenticated.
2108 This typically is done to block a station after updating the
2111 Set the ACL policy to allow all stations to associate.
2113 Delete all entries in the database.
2115 Set the ACL policy to permit association only by
2116 stations approved by a RADIUS server.
2117 Note that this feature requires the
2119 program be configured to do the right thing
2120 as it handles the RADIUS processing
2121 (and marks stations as authorized).
2124 The following parameters are related to a wireless interface operating in mesh
2126 .Bl -tag -width indent
2127 .It Cm meshid Ar meshid
2128 Set the desired Mesh Identifier.
2129 The Mesh ID is a string up to 32 characters in length.
2130 A mesh interface must have a Mesh Identifier specified
2131 to reach an operational state.
2132 .It Cm meshttl Ar ttl
2133 Set the desired ``time to live'' for mesh forwarded packets;
2134 this is the number of hops a packet may be forwarded before
2136 The default setting for
2140 Enable or disable peering with neighbor mesh stations.
2141 Stations must peer before any data packets can be exchanged.
2146 Enable or disable forwarding packets by a mesh interface.
2151 This attribute specifies whether or not the mesh STA activates mesh gate
2156 .It Cm meshmetric Ar protocol
2159 as the link metric protocol used on a mesh network.
2160 The default protocol is called
2162 The mesh interface will restart after changing this setting.
2163 .It Cm meshpath Ar protocol
2166 as the path selection protocol used on a mesh network.
2167 The only available protocol at the moment is called
2169 (Hybrid Wireless Mesh Protocol).
2170 The mesh interface will restart after changing this setting.
2171 .It Cm hwmprootmode Ar mode
2172 Stations on a mesh network can operate as ``root nodes.''
2173 Root nodes try to find paths to all mesh nodes and advertise themselves
2175 When there is a root mesh node on a network, other mesh nodes can setup
2176 paths between themselves faster because they can use the root node
2177 to find the destination.
2178 This path may not be the best, but on-demand
2179 routing will eventually find the best path.
2180 The following modes are recognized:
2182 .Bl -tag -width ".Cm PROACTIVE" -compact
2186 Send broadcast path requests every two seconds.
2187 Nodes on the mesh without a path to this root mesh station with try to
2188 discover a path to us.
2190 Send broadcast path requests every two seconds and every node must reply
2191 with a path reply even if it already has a path to this root mesh station.
2193 Send broadcast root announcement (RANN) frames.
2194 Nodes on the mesh without a path to this root mesh station with try to
2195 discover a path to us.
2201 .It Cm hwmpmaxhops Ar cnt
2202 Set the maximum number of hops allowed in an HMWP path to
2204 The default setting for
2209 The following parameters are for compatibility with other systems:
2210 .Bl -tag -width indent
2212 Another name for the
2218 .It Cm stationname Ar name
2219 Set the name of this station.
2220 The station name is not part of the IEEE 802.11
2221 protocol though some interfaces support it.
2223 seems to be meaningful to identical or virtually identical equipment.
2224 Setting the station name is identical in syntax to setting the SSID.
2231 Another way of saying
2237 Another way of saying
2243 Another way of saying:
2244 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2250 .Ar n : k1 , k2 , k3 , k4
2253 Another way of saying
2254 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2259 Another way of saying
2266 The following parameters are specific to bridge interfaces:
2267 .Bl -tag -width indent
2268 .It Cm addm Ar interface
2269 Add the interface named by
2271 as a member of the bridge.
2272 The interface is put into promiscuous mode
2273 so that it can receive every packet sent on the network.
2274 .It Cm deletem Ar interface
2275 Remove the interface named by
2278 Promiscuous mode is disabled on the interface when
2279 it is removed from the bridge.
2280 .It Cm maxaddr Ar size
2281 Set the size of the bridge address cache to
2283 The default is 2000 entries.
2284 .It Cm timeout Ar seconds
2285 Set the timeout of address cache entries to
2290 is zero, then address cache entries will not be expired.
2291 The default is 1200 seconds.
2293 Display the addresses that have been learned by the bridge.
2294 .It Cm static Ar interface-name Ar address
2295 Add a static entry into the address cache pointing to
2296 .Ar interface-name .
2297 Static entries are never aged out of the cache or re-placed, even if the
2298 address is seen on a different interface.
2299 .It Cm deladdr Ar address
2302 from the address cache.
2304 Delete all dynamically-learned addresses from the address cache.
2306 Delete all addresses, including static addresses, from the address cache.
2307 .It Cm discover Ar interface
2308 Mark an interface as a
2311 When the bridge has no address cache entry
2312 (either dynamic or static)
2313 for the destination address of a packet,
2314 the bridge will forward the packet to all
2315 member interfaces marked as
2317 This is the default for all interfaces added to a bridge.
2318 .It Cm -discover Ar interface
2321 attribute on a member interface.
2322 For packets without the
2324 attribute, the only packets forwarded on the interface are broadcast
2325 or multicast packets and packets for which the destination address
2326 is known to be on the interface's segment.
2327 .It Cm learn Ar interface
2328 Mark an interface as a
2331 When a packet arrives on such an interface, the source
2332 address of the packet is entered into the address cache as being a
2333 destination address on the interface's segment.
2334 This is the default for all interfaces added to a bridge.
2335 .It Cm -learn Ar interface
2338 attribute on a member interface.
2339 .It Cm sticky Ar interface
2340 Mark an interface as a
2343 Dynamically learned address entries are treated at static once entered into
2345 Sticky entries are never aged out of the cache or replaced, even if the
2346 address is seen on a different interface.
2347 .It Cm -sticky Ar interface
2350 attribute on a member interface.
2351 .It Cm private Ar interface
2352 Mark an interface as a
2355 A private interface does not forward any traffic to any other port that is also
2356 a private interface.
2357 .It Cm -private Ar interface
2360 attribute on a member interface.
2361 .It Cm span Ar interface
2362 Add the interface named by
2364 as a span port on the bridge.
2365 Span ports transmit a copy of every frame received by the bridge.
2366 This is most useful for snooping a bridged network passively on
2367 another host connected to one of the span ports of the bridge.
2368 .It Cm -span Ar interface
2369 Delete the interface named by
2371 from the list of span ports of the bridge.
2372 .It Cm stp Ar interface
2373 Enable Spanning Tree protocol on
2377 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2378 Spanning Tree is used to detect and remove loops in a network topology.
2379 .It Cm -stp Ar interface
2380 Disable Spanning Tree protocol on
2382 This is the default for all interfaces added to a bridge.
2383 .It Cm edge Ar interface
2387 An edge port connects directly to end stations cannot create bridging
2388 loops in the network, this allows it to transition straight to forwarding.
2389 .It Cm -edge Ar interface
2390 Disable edge status on
2392 .It Cm autoedge Ar interface
2395 to automatically detect edge status.
2396 This is the default for all interfaces added to a bridge.
2397 .It Cm -autoedge Ar interface
2398 Disable automatic edge status on
2400 .It Cm ptp Ar interface
2403 as a point to point link.
2404 This is required for straight transitions to forwarding and
2405 should be enabled on a direct link to another RSTP capable switch.
2406 .It Cm -ptp Ar interface
2407 Disable point to point link status on
2409 This should be disabled for a half duplex link and for an interface
2410 connected to a shared network segment,
2411 like a hub or a wireless network.
2412 .It Cm autoptp Ar interface
2413 Automatically detect the point to point status on
2415 by checking the full duplex link status.
2416 This is the default for interfaces added to the bridge.
2417 .It Cm -autoptp Ar interface
2418 Disable automatic point to point link detection on
2420 .It Cm maxage Ar seconds
2421 Set the time that a Spanning Tree protocol configuration is valid.
2422 The default is 20 seconds.
2423 The minimum is 6 seconds and the maximum is 40 seconds.
2424 .It Cm fwddelay Ar seconds
2425 Set the time that must pass before an interface begins forwarding
2426 packets when Spanning Tree is enabled.
2427 The default is 15 seconds.
2428 The minimum is 4 seconds and the maximum is 30 seconds.
2429 .It Cm hellotime Ar seconds
2430 Set the time between broadcasting of Spanning Tree protocol
2431 configuration messages.
2432 The hello time may only be changed when operating in legacy stp mode.
2433 The default is 2 seconds.
2434 The minimum is 1 second and the maximum is 2 seconds.
2435 .It Cm priority Ar value
2436 Set the bridge priority for Spanning Tree.
2437 The default is 32768.
2438 The minimum is 0 and the maximum is 61440.
2439 .It Cm proto Ar value
2440 Set the Spanning Tree protocol.
2441 The default is rstp.
2442 The available options are stp and rstp.
2443 .It Cm holdcnt Ar value
2444 Set the transmit hold count for Spanning Tree.
2445 This is the number of packets transmitted before being rate limited.
2447 The minimum is 1 and the maximum is 10.
2448 .It Cm ifpriority Ar interface Ar value
2449 Set the Spanning Tree priority of
2454 The minimum is 0 and the maximum is 240.
2455 .It Cm ifpathcost Ar interface Ar value
2456 Set the Spanning Tree path cost of
2460 The default is calculated from the link speed.
2461 To change a previously selected path cost back to automatic, set the
2463 The minimum is 1 and the maximum is 200000000.
2464 .It Cm ifmaxaddr Ar interface Ar size
2465 Set the maximum number of hosts allowed from an interface, packets with unknown
2466 source addresses are dropped until an existing host cache entry expires or is
2468 Set to 0 to disable.
2471 The following parameters are specific to lagg interfaces:
2472 .Bl -tag -width indent
2473 .It Cm laggport Ar interface
2474 Add the interface named by
2476 as a port of the aggregation interface.
2477 .It Cm -laggport Ar interface
2478 Remove the interface named by
2480 from the aggregation interface.
2481 .It Cm laggproto Ar proto
2482 Set the aggregation protocol.
2485 The available options are
2493 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2494 Set the packet layers to hash for aggregation protocols which load balance.
2497 The options can be combined using commas.
2499 .Bl -tag -width ".Cm l2" -compact
2501 src/dst mac address and optional vlan number.
2503 src/dst address for IPv4 or IPv6.
2505 src/dst port for TCP/UDP/SCTP.
2508 Enable local hash computation for RSS hash on the interface.
2513 modes will use the RSS hash from the network card if available
2514 to avoid computing one, this may give poor traffic distribution
2515 if the hash is invalid or uses less of the protocol header information.
2517 disables use of RSS hash from the network card.
2518 The default value can be set via the
2519 .Va net.link.lagg.default_use_flowid
2530 Use the RSS hash from the network card if available.
2531 .It Cm flowid_shift Ar number
2532 Set a shift parameter for RSS local hash computation.
2533 Hash is calculated by using flowid bits in a packet header mbuf
2534 which are shifted by the number of this parameter.
2536 Enable selection of egress ports based on the native
2538 domain for the packets being transmitted.
2539 This is currently only implemented for lacp mode.
2542 hardware, running a kernel compiled with the
2544 option, and when interfaces from multiple
2546 domains are ports of the aggregation interface.
2548 Disable selection of egress ports based on the native
2550 domain for the packets being transmitted.
2551 .It Cm lacp_fast_timeout
2552 Enable lacp fast-timeout on the interface.
2553 .It Cm -lacp_fast_timeout
2554 Disable lacp fast-timeout on the interface.
2556 Enable lacp strict compliance on the interface.
2557 The default value can be set via the
2558 .Va net.link.lagg.lacp.default_strict_mode
2569 Disable lacp strict compliance on the interface.
2570 .It Cm rr_limit Ar number
2571 Configure a stride for an interface in round-robin mode.
2572 The default stride is 1.
2575 The following parameters apply to IP tunnel interfaces,
2577 .Bl -tag -width indent
2578 .It Cm tunnel Ar src_addr dest_addr
2579 Configure the physical source and destination address for IP tunnel
2585 are interpreted as the outer source/destination for the encapsulating
2588 Unconfigure the physical source and destination address for IP tunnel
2589 interfaces previously configured with
2592 Another name for the
2595 .It Cm accept_rev_ethip_ver
2596 Set a flag to accept both correct EtherIP packets and ones
2597 with reversed version field.
2599 This is for backward compatibility with
2601 6.2, 6.3, 7.0, and 7.1.
2602 .It Cm -accept_rev_ethip_ver
2604 .Cm accept_rev_ethip_ver .
2605 .It Cm ignore_source
2606 Set a flag to accept encapsulated packets destined to this host
2607 independently from source address.
2608 This may be useful for hosts, that receive encapsulated packets
2609 from the load balancers.
2610 .It Cm -ignore_source
2613 .It Cm send_rev_ethip_ver
2614 Set a flag to send EtherIP packets with reversed version
2615 field intentionally.
2616 Disabled by default.
2617 This is for backward compatibility with
2619 6.2, 6.3, 7.0, and 7.1.
2620 .It Cm -send_rev_ethip_ver
2622 .Cm send_rev_ethip_ver .
2625 The following parameters apply to GRE tunnel interfaces,
2627 .Bl -tag -width indent
2628 .It Cm tunnel Ar src_addr dest_addr
2629 Configure the physical source and destination address for GRE tunnel
2635 are interpreted as the outer source/destination for the encapsulating
2638 Unconfigure the physical source and destination address for GRE tunnel
2639 interfaces previously configured with
2642 Another name for the
2645 .It Cm grekey Ar key
2646 Configure the GRE key to be used for outgoing packets.
2648 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2649 This command will result in a four byte MTU reduction on the interface.
2652 The following parameters are specific to
2655 .Bl -tag -width indent
2656 .It Cm syncdev Ar iface
2657 Use the specified interface
2658 to send and receive pfsync state synchronisation messages.
2660 Stop sending pfsync state synchronisation messages over the network.
2661 .It Cm syncpeer Ar peer_address
2662 Make the pfsync link point-to-point rather than using
2663 multicast to broadcast the state synchronisation messages.
2664 The peer_address is the IP address of the other host taking part in
2667 Broadcast the packets using multicast.
2669 Set the maximum number of updates for a single state which
2670 can be collapsed into one.
2671 This is an 8-bit number; the default value is 128.
2673 Defer transmission of the first packet in a state until a peer has
2674 acknowledged that the associated state has been inserted.
2676 Do not defer the first packet in a state.
2677 This is the default.
2680 The following parameters are specific to
2683 .Bl -tag -width indent
2684 .It Cm vlan Ar vlan_tag
2685 Set the VLAN tag value to
2687 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2688 VLAN header for packets sent from the
2695 must both be set at the same time.
2696 .It Cm vlanpcp Ar priority_code_point
2699 is an 3-bit field which refers to the IEEE 802.1p
2700 class of service and maps to the frame priority level.
2702 Values in order of priority are:
2704 .Pq Dv Background (lowest) ,
2706 .Pq Dv Best effort (default) ,
2708 .Pq Dv Excellent effort ,
2710 .Pq Dv Critical applications ,
2712 .Pq Dv Video, < 100ms latency ,
2714 .Pq Dv Video, < 10ms latency ,
2716 .Pq Dv Internetwork control ,
2718 .Pq Dv Network control (highest) .
2719 .It Cm vlandev Ar iface
2720 Associate the physical interface
2725 Packets transmitted through the
2728 diverted to the specified physical interface
2730 with 802.1Q VLAN encapsulation.
2731 Packets with 802.1Q encapsulation received
2732 by the parent interface with the correct VLAN Identifier will be diverted to
2738 interface is assigned a
2739 copy of the parent interface's flags and the parent's Ethernet address.
2744 must both be set at the same time.
2747 interface already has
2748 a physical interface associated with it, this command will fail.
2750 change the association to another physical interface, the existing
2751 association must be cleared first.
2753 Note: if the hardware tagging capability
2754 is set on the parent interface, the
2757 interface's behavior changes:
2760 interface recognizes that the
2761 parent interface supports insertion and extraction of VLAN tags on its
2762 own (usually in firmware) and that it should pass packets to and from
2763 the parent unaltered.
2764 .It Fl vlandev Op Ar iface
2767 pseudo device, disassociate the parent interface from it.
2768 This breaks the link between the
2770 interface and its parent,
2771 clears its VLAN Identifier, flags and its link address and shuts the interface
2775 argument is useless and hence deprecated.
2778 The following parameters are used to configure
2781 .Bl -tag -width indent
2782 .It Cm vxlanid Ar identifier
2783 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2784 virtual network segment membership of the interface.
2785 .It Cm vxlanlocal Ar address
2786 The source address used in the encapsulating IPv4/IPv6 header.
2787 The address should already be assigned to an existing interface.
2788 When the interface is configured in unicast mode, the listening socket
2789 is bound to this address.
2790 .It Cm vxlanremote Ar address
2791 The interface can be configured in a unicast, or point-to-point, mode
2792 to create a tunnel between two hosts.
2793 This is the IP address of the remote end of the tunnel.
2794 .It Cm vxlangroup Ar address
2795 The interface can be configured in a multicast mode
2796 to create a virtual network of hosts.
2797 This is the IP multicast group address the interface will join.
2798 .It Cm vxlanlocalport Ar port
2799 The port number the interface will listen on.
2800 The default port number is 4789.
2801 .It Cm vxlanremoteport Ar port
2802 The destination port number used in the encapsulating IPv4/IPv6 header.
2803 The remote host should be listening on this port.
2804 The default port number is 4789.
2805 Note some other implementations, such as Linux,
2806 do not default to the IANA assigned port,
2807 but instead listen on port 8472.
2808 .It Cm vxlanportrange Ar low high
2809 The range of source ports used in the encapsulating IPv4/IPv6 header.
2810 The port selected within the range is based on a hash of the inner frame.
2811 A range is useful to provide entropy within the outer IP header
2812 for more effective load balancing.
2813 The default range is between the
2816 .Va net.inet.ip.portrange.first
2818 .Va net.inet.ip.portrange.last
2819 .It Cm vxlantimeout Ar timeout
2820 The maximum time, in seconds, before an entry in the forwarding table
2822 The default is 1200 seconds (20 minutes).
2823 .It Cm vxlanmaxaddr Ar max
2824 The maximum number of entries in the forwarding table.
2825 The default is 2000.
2826 .It Cm vxlandev Ar dev
2827 When the interface is configured in multicast mode, the
2829 interface is used to transmit IP multicast packets.
2830 .It Cm vxlanttl Ar ttl
2831 The TTL used in the encapsulating IPv4/IPv6 header.
2834 The source IP address and inner source Ethernet MAC address of
2835 received packets are used to dynamically populate the forwarding table.
2836 When in multicast mode, an entry in the forwarding table allows the
2837 interface to send the frame directly to the remote host instead of
2838 broadcasting the frame to the multicast group.
2839 This is the default.
2841 The forwarding table is not populated by received packets.
2843 Delete all dynamically-learned addresses from the forwarding table.
2844 .It Cm vxlanflushall
2845 Delete all addresses, including static addresses, from the forwarding table.
2848 The following parameters are used to configure
2850 protocol on an interface:
2851 .Bl -tag -width indent
2853 Set the virtual host ID.
2854 This is a required setting to initiate
2856 If the virtual host ID does not exist yet, it is created and attached to the
2857 interface, otherwise configuration of an existing vhid is adjusted.
2860 keyword is supplied along with an
2864 address, then this address is configured to be run under control of the
2866 Whenever a last address that refers to a particular vhid is removed from an
2867 interface, the vhid is automatically removed from interface and destroyed.
2868 Any other configuration parameters for the
2870 protocol should be supplied along with the
2873 Acceptable values for vhid are 1 to 255.
2874 .It Cm advbase Ar seconds
2875 Specifies the base of the advertisement interval in seconds.
2876 The acceptable values are 1 to 255.
2877 The default value is 1.
2878 .It Cm advskew Ar interval
2879 Specifies the skew to add to the base advertisement interval to
2880 make one host advertise slower than another host.
2881 It is specified in 1/256 of seconds.
2882 The acceptable values are 1 to 254.
2883 The default value is 0.
2884 .It Cm pass Ar phrase
2885 Set the authentication key to
2887 .It Cm state Ar MASTER|BACKUP
2888 Forcibly change state of a given vhid.
2893 utility displays the current configuration for a network interface
2894 when no optional parameters are supplied.
2895 If a protocol family is specified,
2897 will report only the details specific to that protocol family.
2901 flag is passed before an interface name,
2903 will display the capability list and all
2904 of the supported media for the specified interface.
2907 flag is supplied, address lifetime is displayed for IPv6 addresses,
2908 as time offset string.
2912 flag may be used instead of an interface name.
2915 to display information about all interfaces in the system.
2918 flag limits this to interfaces that are down, and
2920 limits this to interfaces that are up.
2921 When no arguments are given,
2927 flag may be used to list all available interfaces on the system, with
2928 no other additional information.
2931 is specified, only interfaces of that type will be listed.
2933 will list only Ethernet adapters, excluding the loopback interface.
2934 Use of this flag is mutually exclusive
2935 with all other flags and commands, except for
2937 (only list interfaces that are down)
2940 (only list interfaces that are up).
2944 flag may be used to get more verbose status for an interface.
2948 flag may be used to list all of the interface cloners available on
2949 the system, with no additional information.
2950 Use of this flag is mutually exclusive with all other flags and commands.
2954 flag causes keying information for the interface, if available, to be
2956 For example, the values of 802.11 WEP keys and
2958 passphrases will be printed, if accessible to the current user.
2959 This information is not printed by default, as it may be considered
2962 If the network interface driver is not present in the kernel then
2964 will attempt to load it.
2967 flag disables this behavior.
2969 Only the super-user may modify the configuration of a network interface.
2971 Assign the IPv4 address
2973 with a network mask of
2977 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
2979 Add the IPv4 address
2981 with the CIDR network prefix
2987 as a synonym for the canonical form of the option
2989 .Dl # ifconfig em0 inet 192.0.2.45/28 add
2991 Remove the IPv4 address
2995 .Dl # ifconfig em0 inet 192.0.2.45 -alias
2997 Enable IPv6 functionality of the interface:
2998 .Dl # ifconfig em0 inet6 -ifdisabled
3000 Add the IPv6 address
3001 .Li 2001:DB8:DBDB::123/48
3004 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3005 Note that lower case hexadecimal IPv6 addresses are acceptable.
3007 Remove the IPv6 address added in the above example,
3010 character as shorthand for the network prefix,
3013 as a synonym for the canonical form of the option
3015 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
3017 Configure a single CARP redundant address on igb0, and then switch it
3019 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3020 .Dl # ifconfig igb0 vhid 1 state master
3022 Configure the interface
3024 to use 100baseTX, full duplex Ethernet media options:
3025 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3027 Label the em0 interface as an uplink:
3028 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3030 Create the software network interface
3032 .Dl # ifconfig gif1 create
3034 Destroy the software network interface
3036 .Dl # ifconfig gif1 destroy
3038 Display available wireless networks using
3040 .Dl # ifconfig wlan0 list scan
3042 Display inet and inet6 address subnet masks in CIDR notation
3043 .Dl # ifconfig -f inet:cidr,inet6:cidr
3045 Messages indicating the specified interface does not exist, the
3046 requested address is unknown, or the user is not privileged and
3047 tried to alter an interface's configuration.
3070 Basic IPv6 node operation requires a link-local address on each
3071 interface configured for IPv6.
3072 Normally, such an address is automatically configured by the
3073 kernel on each interface added to the system or enabled; this behavior may
3074 be disabled by setting per-interface flag
3075 .Cm -auto_linklocal .
3076 The default value of this flag is 1 and can be disabled by using the sysctl
3078 .Va net.inet6.ip6.auto_linklocal .
3080 Do not configure IPv6 addresses with no link-local address by using
3082 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob