1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
39 .Op Fl f Ar type Ns Cm \&: Ns Ar format Ns Op Cm \&, Ns Ar type Ns Cm \& : Ns Ar format ...
59 .Op Fl [gG] Ar groupname
82 utility is used to assign an address
83 to a network interface and/or configure
84 network interface parameters.
87 utility must be used at boot time to define the network address
88 of each interface present on a machine; it may also be used at
89 a later time to redefine an interface's address
90 or other operating parameters.
92 The following options are available:
93 .Bl -tag -width indent
95 For the DARPA-Internet family,
96 the address is either a host name present in the host name data
99 or a DARPA Internet address expressed in the Internet standard
102 It is also possible to use the CIDR notation (also known as the
103 slash notation) to include the netmask.
104 That is, one can specify an address like
109 family, it is also possible to specify the prefix length using the slash
114 parameter below for more information.
115 .\" For the Xerox Network Systems(tm) family,
117 .\" .Ar net:a.b.c.d.e.f ,
120 .\" is the assigned network number (in decimal),
121 .\" and each of the six bytes of the host number,
125 .\" are specified in hexadecimal.
126 .\" The host number may be omitted on IEEE 802 protocol
127 .\" (Ethernet, FDDI, and Token Ring) interfaces,
128 .\" which use the hardware physical address,
129 .\" and on interfaces other than the first.
130 .\" For the ISO family, addresses are specified as a long hexadecimal string,
131 .\" as in the Xerox family.
132 .\" However, two consecutive dots imply a zero
133 .\" byte, and the dots are optional, if the user wishes to (carefully)
134 .\" count out long strings of digits in network byte order.
139 is specified as a series of colon-separated hex digits.
140 This can be used to, for example,
141 set a new MAC address on an Ethernet interface, though the
142 mechanism used is not Ethernet specific.
145 keyword to set a randomly generated MAC address.
146 A randomly-generated MAC address might be the same as one already in use
148 Such duplications are extremely unlikely.
149 If the interface is already
150 up when this option is used, it will be briefly brought down and
151 then brought back up again in order to ensure that the receive
152 filter in the underlying Ethernet hardware is properly reprogrammed.
153 .It Ar address_family
156 which affects interpretation of the remaining parameters.
157 Since an interface can receive transmissions in differing protocols
158 with different naming schemes, specifying the address family is recommended.
159 The address or protocol families currently
165 The default if available is
178 address family has special meaning and is no longer synonymous with
184 will list only Ethernet interfaces, excluding all other interface types,
185 including the loopback interface.
187 Specify the address of the correspondent on the other end
188 of a point to point link.
191 parameter is a string of the form
196 List the interfaces in the given group.
201 can be controlled using the
205 environment variable.
206 The format is specified as a comma separated list of
211 section for more information.
217 .Bl -tag -width ether
219 Adjust the display of inet and inet6 addresses
220 .Bl -tag -width default
222 Display inet and inet6 addresses in the default format,
225 Display inet and inet6 addresses as fully qualified domain names
228 Display inet and inet6 addresses as unqualified hostnames
230 Display inet and inet6 addresses in numeric format
233 Adjust the display of link-level ethernet (MAC) addresses
234 .Bl -tag -width default
236 Separate address segments with a colon
238 Separate address segments with a dash
240 Display ethernet addresses in the default format,
244 Adjust the display of inet address subnet masks:
245 .Bl -tag -width default
247 Display subnet masks in CIDR notation, for example:
249 10.0.0.0/8 or 203.0.113.224/26
251 Display subnet masks in the default format,
254 Display subnet masks in dotted quad notation, for example:
256 255.255.0.0 or 255.255.255.192
258 Display subnet masks in hexadecimal, for example:
260 0xffff0000 or 0xffffffc0
263 Adjust the display of inet6 address prefixes (subnet masks):
264 .Bl -tag -width default
266 Display subnet prefix in CIDR notation, for example:
268 ::1/128 or fe80::1%lo0/64
270 Display subnet prefix in the default format
273 Display subnet prefix in integer format, for example:
279 The following parameters may be set with
281 .Bl -tag -width indent
286 Introduced for compatibility
290 Establish an additional network address for this interface.
291 This is sometimes useful when changing network numbers, and
292 one wishes to accept packets addressed to the old interface.
293 If the address is on the same subnet as the first network address
294 for this interface, a non-conflicting netmask must be given.
299 Remove the network address specified.
300 This would be used if you incorrectly specified an alias, or it
301 was no longer needed.
302 If you have incorrectly set an NS address having the side effect
303 of specifying the host portion, removing all NS addresses will
304 allow you to respecify the host portion.
307 Specify that the address configured is an anycast address.
308 Based on the current specification,
309 only routers may configure anycast addresses.
310 Anycast address will not be used as source address of any of outgoing
313 Enable the use of the Address Resolution Protocol
316 between network level addresses and link level addresses (default).
317 This is currently implemented for mapping between DARPA Internet addresses
318 and IEEE 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
320 Disable the use of the Address Resolution Protocol
323 If the Address Resolution Protocol is enabled,
324 the host will only reply to requests for its addresses,
325 and will never send any requests.
327 If the Address Resolution Protocol is enabled,
328 the host will perform normally,
329 sending out requests and listening for replies.
332 Specify the address to use to represent broadcasts to the
334 The default broadcast address is the address with a host part of all 1's.
336 Enable driver dependent debugging code; usually, this turns on
337 extra console error logging.
339 Disable driver dependent debugging code.
341 Put interface into permanently promiscuous mode.
343 Disable permanently promiscuous mode.
348 .It Cm description Ar value , Cm descr Ar value
349 Specify a description of the interface.
350 This can be used to label interfaces in situations where they may
351 otherwise be difficult to distinguish.
352 .It Cm -description , Cm -descr
353 Clear the interface description.
357 When an interface is marked
359 the system will not attempt to
360 transmit messages through that interface.
361 If possible, the interface will be reset to disable reception as well.
362 This action does not automatically disable routes using the interface.
363 .It Cm group Ar groupname
364 Assign the interface to a
366 Any interface can be in multiple groups.
368 Cloned interfaces are members of their interface family group by default.
369 For example, a PPP interface such as
371 is a member of the PPP interface family group,
373 .\" The interface(s) the default route(s) point to are members of the
376 .It Cm -group Ar groupname
377 Remove the interface from the given
382 (lowermost 64bit of an IPv6 address)
384 .It Cm fib Ar fib_number
385 Specify interface FIB.
388 is assigned to all frames or packets received on that interface.
389 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
390 the default FIB (0) irrespective of the parent interface's FIB.
391 The kernel needs to be tuned to support more than the default FIB
394 kernel configuration option, or the
397 .It Cm tunnelfib Ar fib_number
401 is assigned to all packets encapsulated by tunnel interface, e.g.,
405 .It Cm maclabel Ar label
406 If Mandatory Access Control support is enabled in the kernel,
410 .\" .Xr maclabel 7 ) .
412 If the driver supports the media selection system, set the media type
415 Some interfaces support the mutually exclusive use of one of several
416 different physical media connectors.
417 For example, a 10Mbit/s Ethernet
418 interface might support the use of either AUI
419 or twisted pair connectors.
420 Setting the media type to
422 would change the currently active connector to the AUI port.
425 would activate twisted pair.
426 Refer to the interfaces' driver
427 specific documentation or man page for a complete list of the
429 .It Cm mediaopt Ar opts
430 If the driver supports the media selection system, set the specified
431 media options on the interface.
435 is a comma delimited list of options to apply to the interface.
436 Refer to the interfaces' driver specific man page for a complete
437 list of available options.
438 .It Fl mediaopt Ar opts
439 If the driver supports the media selection system, disable the
440 specified media options on the interface.
442 If the driver supports the media selection system, set the specified
443 operating mode on the interface to
445 For IEEE 802.11 wireless interfaces that support multiple operating modes
446 this directive is used to select between 802.11a
454 Set if the driver supports TX rate limiting.
455 .It Cm inst Ar minst , Cm instance Ar minst
456 Set the media instance to
458 This is useful for devices which have multiple physical layer interfaces
461 Set the interface name to
463 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
464 If the driver supports user-configurable checksum offloading,
465 enable receive (or transmit) checksum offloading on the interface.
466 The feature can be turned on selectively per protocol family.
468 .Cm rxcsum6 , txcsum6
474 Some drivers may not be able to enable these flags independently
475 of each other, so setting one may also set the other.
476 The driver will offload as much checksum work as it can reliably
477 support, the exact level of offloading varies between drivers.
478 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
479 If the driver supports user-configurable checksum offloading,
480 disable receive (or transmit) checksum offloading on the interface.
481 The feature can be turned off selectively per protocol family.
483 .Fl rxcsum6 , txcsum6
489 These settings may not always be independent of each other.
491 If the driver supports
493 segmentation offloading, enable TSO on the interface.
494 Some drivers may not be able to support TSO for
498 packets, so they may enable only one of them.
500 If the driver supports
502 segmentation offloading, disable TSO on the interface.
503 It will always disable TSO for
508 If the driver supports
510 segmentation offloading for
514 use one of these to selectively enabled it only for one protocol family.
516 If the driver supports
518 segmentation offloading for
522 use one of these to selectively disable it only for one protocol family.
524 If the driver supports
526 large receive offloading, enable LRO on the interface.
528 If the driver supports
530 large receive offloading, disable LRO on the interface.
531 .It Cm wol , wol_ucast , wol_mcast , wol_magic
532 Enable Wake On Lan (WOL) support, if available.
533 WOL is a facility whereby a machine in a low power state may be woken
534 in response to a received packet.
535 There are three types of packets that may wake a system:
536 ucast (directed solely to the machine's mac address),
537 mcast (directed to a broadcast or multicast address),
539 magic (unicast or multicast frames with a ``magic contents'').
540 Not all devices support WOL, those that do indicate the mechanisms
541 they support in their capabilities.
543 is a synonym for enabling all available WOL mechanisms.
546 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
547 If the driver offers user-configurable VLAN support, enable
548 reception of extended frames, tag processing in hardware,
549 frame filtering in hardware, checksum offloading, or TSO on VLAN,
551 Note that this must be configured on a physical interface associated with
556 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwtso
557 If the driver offers user-configurable VLAN support, disable
558 reception of extended frames, tag processing in hardware,
559 frame filtering in hardware, or TSO on VLAN,
561 .It Cm vxlanhwcsum , vxlanhwtso
562 If the driver offers user-configurable VXLAN support, enable inner checksum
563 offloading (receive and transmit) or TSO on VXLAN, respectively.
564 Note that this must be configured on a physical interface associated with
569 The physical interface is either the interface specified as the vxlandev
570 or the interface hosting the vxlanlocal address.
571 The driver will offload as much checksum work and TSO as it can reliably
572 support, the exact level of offloading may vary between drivers.
573 .It Fl vxlanhwcsum , vxlanhwtso
574 If the driver offers user-configurable VXLAN support, disable checksum
575 offloading (receive and transmit) or TSO on VXLAN, respectively.
577 Move the interface to the
579 specified by name or JID.
580 If the jail has a virtual network stack, the interface will disappear
581 from the current environment and become visible to the jail.
583 Reclaim the interface from the
585 specified by name or JID.
586 If the jail has a virtual network stack, the interface will disappear
587 from the jail, and become visible to the current network environment.
591 feature and disable interrupts on the interface, if driver supports
596 feature and enable interrupt mode on the interface.
598 Create the specified network pseudo-device.
599 If the interface is given without a unit number, try to create a new
600 device with an arbitrary unit number.
601 If creation of an arbitrary device is successful, the new device name is
602 printed to standard output unless the interface is renamed or destroyed
607 Destroy the specified network pseudo-device.
612 Included for Solaris compatibility.
617 Included for Solaris compatibility.
619 Set the routing metric of the interface to
622 The routing metric is used by the routing protocol
624 Higher metrics have the effect of making a route
625 less favorable; metrics are counted as additional hops
626 to the destination network or host.
628 Set the maximum transmission unit of the interface to
630 default is interface specific.
631 The MTU is used to limit the size of packets that are transmitted on an
633 Not all interfaces support setting the MTU, and some interfaces have
635 .It Cm netmask Ar mask
638 Specify how much of the address to reserve for subdividing
639 networks into sub-networks.
640 The mask includes the network part of the local address
641 and the subnet part, which is taken from the host field of the address.
642 The mask can be specified as a single hexadecimal number
645 with a dot-notation Internet address,
646 or with a pseudo-network name listed in the network table
648 The mask contains 1's for the bit positions in the 32-bit address
649 which are to be used for the network and subnet parts,
650 and 0's for the host part.
651 The mask should contain at least the standard network portion,
652 and the subnet field should be contiguous with the network
655 The netmask can also be specified in CIDR notation after the address.
658 option above for more information.
659 .It Cm prefixlen Ar len
663 bits are reserved for subdividing networks into sub-networks.
666 must be integer, and for syntactical reason it must be between 0 to 128.
667 It is almost always 64 under the current IPv6 assignment rule.
668 If the parameter is omitted, 64 is used.
670 The prefix can also be specified using the slash notation after the address.
673 option above for more information.
678 Introduced for compatibility
682 .It Cm link Op Cm 0 No - Cm 2
684 Enable special processing of the link level of the interface.
685 These three options are interface specific in actual effect, however,
686 they are in general used to select special modes of operation.
688 of this is to enable SLIP compression, or to select the connector type
689 for some Ethernet cards.
690 Refer to the man page for the specific driver
691 for more information.
693 .It Fl link Op Cm 0 No - Cm 2
695 Disable special processing at the link level with the specified interface.
697 Put the interface in monitor mode.
698 No packets are transmitted, and received packets are discarded after
702 Take the interface out of monitor mode.
706 This may be used to enable an interface after an
708 It happens automatically when setting the first address on an interface.
709 If the interface was reset when previously marked down,
710 the hardware will be re-initialized.
713 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
714 Note that the address family keyword
717 .Bl -tag -width indent
719 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
723 .Va net.inet6.ip6.accept_rtadv
724 controls whether this flag is set by default or not.
729 Set a flag to control whether routers from which the system accepts
730 Router Advertisement messages will be added to the Default Router List
734 flag is disabled, this flag has no effect.
738 .Va net.inet6.ip6.no_radr
739 controls whether this flag is set by default or not.
743 .It Cm auto_linklocal
744 Set a flag to perform automatic link-local address configuration when
745 the interface becomes available.
749 .Va net.inet6.ip6.auto_linklocal
750 controls whether this flag is set by default or not.
751 .It Cm -auto_linklocal
755 Set the specified interface as the default route when there is no
761 Set a flag to disable all of IPv6 network communications on the
763 Note that if there are already configured IPv6
764 addresses on that interface, all of them are marked as
766 and DAD will be performed when this flag is cleared.
770 When this flag is cleared and
772 flag is enabled, automatic configuration of a link-local address is
775 Set a flag to enable Neighbor Unreachability Detection.
779 .It Cm no_prefer_iface
780 Set a flag to not honor rule 5 of source address selection in RFC 3484.
781 In practice this means the address on the outgoing interface will not be
782 preferred, effectively yielding the decision to the address selection
783 policy table, configurable with
785 .It Cm -no_prefer_iface
787 .Cm no_prefer_iface .
789 Set a flag to disable Duplicate Address Detection.
795 The following parameters are specific for IPv6 addresses.
796 Note that the address family keyword
799 .Bl -tag -width indent
801 Set the IPv6 autoconfigured address bit.
803 Clear the IPv6 autoconfigured address bit.
805 Set the IPv6 deprecated address bit.
807 Clear the IPv6 deprecated address bit.
809 Set preferred lifetime for the address.
811 Set a flag to prefer address as a candidate of the source address for
813 .It Cm -prefer_source
817 Set valid lifetime for the address.
820 The following parameters are specific to cloning
821 IEEE 802.11 wireless interfaces with the
824 .Bl -tag -width indent
825 .It Cm wlandev Ar device
828 as the parent for the cloned device.
829 .It Cm wlanmode Ar mode
830 Specify the operating mode for this cloned device.
848 The operating mode of a cloned interface cannot be changed.
851 mode is actually implemented as an
853 interface with special properties.
854 .It Cm wlanbssid Ar bssid
855 The 802.11 mac address to use for the bssid.
856 This must be specified at create time for a legacy
859 .It Cm wlanaddr Ar address
860 The local mac address.
861 If this is not specified then a mac address will automatically be assigned
862 to the cloned device.
863 Typically this address is the same as the address of the parent device
866 parameter is specified then the driver will craft a unique address for
867 the device (if supported).
871 device as operating in ``legacy mode''.
874 devices have a fixed peer relationship and do not, for example, roam
875 if their peer stops communicating.
876 For completeness a Dynamic WDS (DWDS) interface may marked as
879 Request a unique local mac address for the cloned device.
880 This is only possible if the device supports multiple mac addresses.
881 To force use of the parent's mac address use
884 Mark the cloned interface as depending on hardware support to
885 track received beacons.
886 To have beacons tracked in software use
892 can also be used to indicate no beacons should
893 be transmitted; this can be useful when creating a WDS configuration but
895 interfaces can only be created as companions to an access point.
898 The following parameters are specific to IEEE 802.11 wireless interfaces
902 .Bl -tag -width indent
904 Enable sending and receiving AMPDU frames when using 802.11n (default).
905 The 802.11n specification states a compliant station must be capable
906 of receiving AMPDU frames but transmission is optional.
909 to disable all use of AMPDU with 802.11n.
910 For testing and/or to work around interoperability problems one can use
914 to control use of AMPDU in one direction.
915 .It Cm ampdudensity Ar density
916 Set the AMPDU density parameter used when operating with 802.11n.
917 This parameter controls the inter-packet gap for AMPDU frames.
918 The sending device normally controls this setting but a receiving station
919 may request wider gaps.
922 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
925 is treated the same as 0.
926 .It Cm ampdulimit Ar limit
927 Set the limit on packet size for receiving AMPDU frames when operating
931 are 8192, 16384, 32768, and 65536 but one can also specify
932 just the unique prefix: 8, 16, 32, 64.
933 Note the sender may limit the size of AMPDU frames to be less
934 than the maximum specified by the receiving station.
936 Enable sending and receiving AMSDU frames when using 802.11n.
937 By default AMSDU is received but not transmitted.
940 to disable all use of AMSDU with 802.11n.
941 For testing and/or to work around interoperability problems one can use
945 to control use of AMSDU in one direction.
946 .It Cm amsdulimit Ar limit
947 Set the limit on packet size for sending and receiving AMSDU frames
948 when operating with 802.11n.
951 are 7935 and 3839 (bytes).
952 Note the sender may limit the size of AMSDU frames to be less
953 than the maximum specified by the receiving station.
954 Note also that devices are not required to support the 7935 limit,
955 only 3839 is required by the specification and the larger value
956 may require more memory to be dedicated to support functionality
959 When operating as an access point, pass packets between
960 wireless clients directly (default).
961 To instead let them pass up through the
962 system and be forwarded using some other mechanism, use
964 Disabling the internal bridging
965 is useful when traffic is to be processed with
967 .It Cm authmode Ar mode
968 Set the desired authentication mode in infrastructure mode.
969 Not all adapters support all modes.
972 .Cm none , open , shared
978 (IEEE WPA/WPA2/802.11i).
983 modes are only useful when using an authentication service
984 (a supplicant for client operation or an authenticator when
985 operating as an access point).
986 Modes are case insensitive.
988 Enable background scanning when operating as a station.
989 Background scanning is a technique whereby a station associated to
990 an access point will temporarily leave the channel to scan for
991 neighboring stations.
992 This allows a station to maintain a cache of nearby access points
993 so that roaming between access points can be done without
994 a lengthy scan operation.
995 Background scanning is done only when a station is not busy and
996 any outbound traffic will cancel a scan operation.
997 Background scanning should never cause packets to be lost though
998 there may be some small latency if outbound traffic interrupts a
1000 By default background scanning is enabled if the device is capable.
1001 To disable background scanning, use
1003 Background scanning is controlled by the
1008 Background scanning must be enabled for roaming; this is an artifact
1009 of the current implementation and may not be required in the future.
1010 .It Cm bgscanidle Ar idletime
1011 Set the minimum time a station must be idle (not transmitting or
1012 receiving frames) before a background scan is initiated.
1015 parameter is specified in milliseconds.
1016 By default a station must be idle at least 250 milliseconds before
1017 a background scan is initiated.
1018 The idle time may not be set to less than 100 milliseconds.
1019 .It Cm bgscanintvl Ar interval
1020 Set the interval at which background scanning is attempted.
1023 parameter is specified in seconds.
1024 By default a background scan is considered every 300 seconds (5 minutes).
1027 may not be set to less than 15 seconds.
1028 .It Cm bintval Ar interval
1029 Set the interval at which beacon frames are sent when operating in
1033 parameter is specified in TU's (1024 usecs).
1034 By default beacon frames are transmitted every 100 TU's.
1035 .It Cm bmissthreshold Ar count
1036 Set the number of consecutive missed beacons at which the station
1037 will attempt to roam (i.e., search for a new access point).
1040 parameter must be in the range 1 to 255; though the
1041 upper bound may be reduced according to device capabilities.
1042 The default threshold is 7 consecutive missed beacons; but
1043 this may be overridden by the device driver.
1044 Another name for the
1048 .It Cm bssid Ar address
1049 Specify the MAC address of the access point to use when operating
1050 as a station in a BSS network.
1051 This overrides any automatic selection done by the system.
1052 To disable a previously selected access point, supply
1057 This option is useful when more than one access point uses the same SSID.
1058 Another name for the
1063 Enable packet bursting.
1064 Packet bursting is a transmission technique whereby the wireless
1065 medium is acquired once to send multiple frames and the interframe
1067 This technique can significantly increase throughput by reducing
1068 transmission overhead.
1069 Packet bursting is supported by the 802.11e QoS specification
1070 and some devices that do not support QoS may still be capable.
1071 By default packet bursting is enabled if a device is capable
1073 To disable packet bursting, use
1075 .It Cm chanlist Ar channels
1076 Set the desired channels to use when scanning for access
1077 points, neighbors in an IBSS network, or looking for unoccupied
1078 channels when operating as an access point.
1079 The set of channels is specified as a comma-separated list with
1080 each element in the list representing either a single channel number or a range
1083 Channel numbers must be in the range 1 to 255 and be permissible
1084 according to the operating characteristics of the device.
1085 .It Cm channel Ar number
1086 Set a single desired channel.
1087 Channels range from 1 to 255, but the exact selection available
1088 depends on the region your adaptor was manufactured for.
1094 will clear any desired channel and, if the device is marked up,
1095 force a scan for a channel to operate on.
1096 Alternatively the frequency, in megahertz, may be specified
1097 instead of the channel number.
1099 When there are several ways to use a channel the channel
1100 number/frequency may be appended with attributes to clarify.
1101 For example, if a device is capable of operating on channel 6
1102 with 802.11n and 802.11g then one can specify that g-only use
1103 should be used by specifying ``6:g''.
1104 Similarly the channel width can be specified by appending it
1105 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1106 These attributes can be combined as in: ``6:ht/40''.
1107 The full set of flags specified following a ``:'' are:
1113 (Atheros Dynamic Turbo mode),
1121 (Atheros Static Turbo mode),
1124 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1125 The full set of channel widths following a '/' are:
1127 (5MHz aka quarter-rate channel),
1129 (10MHz aka half-rate channel),
1131 (20MHz mostly for use in specifying ht20),
1134 (40MHz mostly for use in specifying ht40).
1136 a 40MHz HT channel specification may include the location
1137 of the extension channel by appending ``+'' or ``-'' for above and below,
1138 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1139 with the center channel at frequency 2437 and the extension channel above.
1140 .It Cm country Ar name
1141 Set the country code to use in calculating the regulatory constraints
1143 In particular the set of available channels, how the wireless device
1144 will operation on the channels, and the maximum transmit power that
1145 can be used on a channel are defined by this setting.
1146 Country/Region codes are specified as a 2-character abbreviation
1147 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1148 e.g., "ES" and "Spain".
1149 The set of country codes are taken from
1150 .Pa /etc/regdomain.xml
1152 be viewed with the ``list countries'' request.
1153 Note that not all devices support changing the country code from a default
1154 setting; typically stored in EEPROM.
1162 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1163 DFS embodies several facilities including detection of overlapping
1164 radar signals, dynamic transmit power control, and channel selection
1165 according to a least-congested criteria.
1166 DFS support is mandatory for some 5GHz frequencies in certain
1167 locales (e.g., ETSI).
1168 By default DFS is enabled according to the regulatory definitions
1170 .Pa /etc/regdomain.xml
1171 and the current country code, regdomain,
1173 Note the underlying device (and driver) must support radar detection
1174 for full DFS support to work.
1175 To be fully compliant with the local regulatory agency frequencies that
1176 require DFS should not be used unless it is fully supported.
1179 to disable this functionality for testing.
1181 Enable support for the 802.11d specification (default).
1182 When this support is enabled in station mode, beacon frames that advertise
1183 a country code different than the currently configured country code will
1184 cause an event to be dispatched to user applications.
1185 This event can be used by the station to adopt that country code and
1186 operate according to the associated regulatory constraints.
1187 When operating as an access point with 802.11d enabled the beacon and
1188 probe response frames transmitted will advertise the current regulatory
1190 To disable 802.11d use
1193 Enable 802.11h support including spectrum management.
1194 When 802.11h is enabled beacon and probe response frames will have
1195 the SpectrumMgt bit set in the capabilities field and
1196 country and power constraint information elements will be present.
1197 802.11h support also includes handling Channel Switch Announcements (CSA)
1198 which are a mechanism to coordinate channel changes by an access point.
1199 By default 802.11h is enabled if the device is capable.
1200 To disable 802.11h use
1202 .It Cm deftxkey Ar index
1203 Set the default key to use for transmission.
1204 Typically this is only set when using WEP encryption.
1205 Note that you must set a default transmit key
1206 for the system to know which key to use in encrypting outbound traffic.
1209 is an alias for this request; it is provided for backwards compatibility.
1210 .It Cm dtimperiod Ar period
1213 period for transmitting buffered multicast data frames when
1214 operating in ap mode.
1217 specifies the number of beacon intervals between DTIM
1218 and must be in the range 1 to 15.
1219 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1221 Enable the use of quiet IE.
1222 Hostap will use this to silence other
1223 stations to reduce interference for radar detection when
1224 operating on 5GHz frequency and doth support is enabled.
1227 to disable this functionality.
1228 .It Cm quiet_period Ar period
1231 to the number of beacon intervals between the start of regularly
1232 scheduled quiet intervals defined by Quiet element.
1233 .It Cm quiet_count Ar count
1236 to the number of TBTTs until the beacon interval during which the
1237 next quiet interval shall start.
1238 A value of 1 indicates the quiet
1239 interval will start during the beacon interval starting at the next
1241 A value 0 is reserved.
1242 .It Cm quiet_offset Ar offset
1245 to the offset of the start of the quiet interval from the TBTT
1246 specified by the Quiet count, expressed in TUs.
1249 shall be less than one beacon interval.
1250 .It Cm quiet_duration Ar dur
1253 to the duration of the Quiet interval, expressed in TUs.
1254 The value should be less than beacon interval.
1256 Enable the use of Atheros Dynamic Turbo mode when communicating with
1257 another Dynamic Turbo-capable station.
1258 Dynamic Turbo mode is an Atheros-specific mechanism by which
1259 stations switch between normal 802.11 operation and a ``boosted''
1260 mode in which a 40MHz wide channel is used for communication.
1261 Stations using Dynamic Turbo mode operate boosted only when the
1262 channel is free of non-dturbo stations; when a non-dturbo station
1263 is identified on the channel all stations will automatically drop
1264 back to normal operation.
1265 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1266 Note that turbo mode (dynamic or static) is only allowed on some
1267 channels depending on the regulatory constraints; use the
1269 command to identify the channels where turbo mode may be used.
1270 To disable Dynamic Turbo mode use
1273 Enable Dynamic WDS (DWDS) support.
1274 DWDS is a facility by which 4-address traffic can be carried between
1275 stations operating in infrastructure mode.
1276 A station first associates to an access point and authenticates using
1277 normal procedures (e.g., WPA).
1278 Then 4-address frames are passed to carry traffic for stations
1279 operating on either side of the wireless link.
1280 DWDS extends the normal WDS mechanism by leveraging existing security
1281 protocols and eliminating static binding.
1283 When DWDS is enabled on an access point 4-address frames received from
1284 an authorized station will generate a ``DWDS discovery'' event to user
1286 This event should be used to create a WDS interface that is bound
1287 to the remote station (and usually plumbed into a bridge).
1288 Once the WDS interface is up and running 4-address traffic then logically
1289 flows through that interface.
1291 When DWDS is enabled on a station, traffic with a destination address
1292 different from the peer station are encapsulated in a 4-address frame
1293 and transmitted to the peer.
1294 All 4-address traffic uses the security information of the stations
1295 (e.g., cryptographic keys).
1296 A station is associated using 802.11n facilities may transport
1297 4-address traffic using these same mechanisms; this depends on available
1298 resources and capabilities of the device.
1299 The DWDS implementation guards against layer 2 routing loops of
1302 Enable the use of Atheros Fast Frames when communicating with
1303 another Fast Frames-capable station.
1304 Fast Frames are an encapsulation technique by which two 802.3
1305 frames are transmitted in a single 802.11 frame.
1306 This can noticeably improve throughput but requires that the
1307 receiving station understand how to decapsulate the frame.
1308 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1309 protocol extension so enabling use is safe when communicating with
1310 non-Atheros devices.
1311 By default, use of fast frames is enabled if the device is capable.
1312 To explicitly disable fast frames, use
1314 .It Cm fragthreshold Ar length
1315 Set the threshold for which transmitted frames are broken into fragments.
1318 argument is the frame size in bytes and must be in the range 256 to 2346.
1326 disables transmit fragmentation.
1327 Not all adapters honor the fragmentation threshold.
1329 When operating as an access point, do not broadcast the SSID
1330 in beacon frames or respond to probe request frames unless
1331 they are directed to the ap (i.e., they include the ap's SSID).
1332 By default, the SSID is included in beacon frames and
1333 undirected probe request frames are answered.
1334 To re-enable the broadcast of the SSID etc., use
1337 Enable use of High Throughput (HT) when using 802.11n (default).
1338 The 802.11n specification includes mechanisms for operation
1339 on 20MHz and 40MHz wide channels using different signalling mechanisms
1340 than specified in 802.11b, 802.11g, and 802.11a.
1341 Stations negotiate use of these facilities, termed HT20 and HT40,
1342 when they associate.
1343 To disable all use of 802.11n use
1345 To disable use of HT20 (e.g., to force only HT40 use) use
1347 To disable use of HT40 use
1350 HT configuration is used to ``auto promote'' operation
1351 when several choices are available.
1352 For example, if a station associates to an 11n-capable access point
1353 it controls whether the station uses legacy operation, HT20, or HT40.
1354 When an 11n-capable device is setup as an access point and
1355 Auto Channel Selection is used to locate a channel to operate on,
1356 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1357 on the selected channel.
1358 If a fixed channel is specified for a station then HT configuration can
1359 be given as part of the channel specification; e.g., 6:ht/20 to setup
1360 HT20 operation on channel 6.
1362 Enable use of compatibility support for pre-802.11n devices (default).
1363 The 802.11n protocol specification went through several incompatible iterations.
1364 Some vendors implemented 11n support to older specifications that
1365 will not interoperate with a purely 11n-compliant station.
1366 In particular the information elements included in management frames
1367 for old devices are different.
1368 When compatibility support is enabled both standard and compatible data
1370 Stations that associate using the compatibility mechanisms are flagged
1372 To disable compatibility support use
1374 .It Cm htprotmode Ar technique
1375 For interfaces operating in 802.11n, use the specified
1377 for protecting HT frames in a mixed legacy/HT network.
1378 The set of valid techniques is
1383 Technique names are case insensitive.
1385 Enable inactivity processing for stations associated to an
1386 access point (default).
1387 When operating as an access point the 802.11 layer monitors
1388 the activity of each associated station.
1389 When a station is inactive for 5 minutes it will send several
1390 ``probe frames'' to see if the station is still present.
1391 If no response is received then the station is deauthenticated.
1392 Applications that prefer to handle this work can disable this
1396 Set the location to use in calculating regulatory constraints.
1397 The location is also advertised in beacon and probe response frames
1398 when 802.11d is enabled with
1407 Display the list of channels available for use taking into account
1408 any restrictions set with the
1411 See the description of
1413 for more information.
1415 Display the adaptor's capabilities, including the operating
1418 Display the list of channels available for use.
1419 Channels are shown with their IEEE channel number, equivalent
1420 frequency, and usage modes.
1421 Channels identified as
1426 Channels identified as
1428 may be used only for Atheros' Static Turbo mode
1430 . Cm mediaopt turbo ) .
1431 Channels marked with a
1433 have a regulatory constraint that they be passively scanned.
1434 This means a station is not permitted to transmit on the channel until
1435 it identifies the channel is being used for 802.11 communication;
1436 typically by hearing a beacon frame from an access point operating
1439 is another way of requesting this information.
1440 By default a compacted list of channels is displayed; if the
1442 option is specified then all channels are shown.
1443 .It Cm list countries
1444 Display the set of country codes and regulatory domains that can be
1445 used in regulatory configuration.
1447 Display the current MAC Access Control List state.
1448 Each address is prefixed with a character that indicates the
1449 current policy applied to it:
1451 indicates the address is allowed access,
1453 indicates the address is denied access,
1455 indicates the address is present but the current policy open
1456 (so the ACL is not consulted).
1458 Displays the mesh routing table, used for forwarding packets on a mesh
1460 .It Cm list regdomain
1461 Display the current regulatory settings including the available channels
1462 and transmit power caps.
1464 Display the parameters that govern roaming operation.
1466 Display the parameters that govern transmit operation.
1468 Display the transmit power caps for each channel.
1470 Display the access points and/or ad-hoc neighbors
1471 located in the vicinity.
1472 This information may be updated automatically by the adapter
1475 request or through background scanning.
1476 Depending on the capabilities of the stations the following
1477 flags can be included in the output:
1484 Poll request capability.
1486 DSSS/OFDM capability.
1488 Extended Service Set (ESS).
1490 Independent Basic Service Set (IBSS).
1493 The station requires authentication.
1495 Robust Secure Network (RSN).
1498 Indicates that the station is doing short preamble to optionally
1499 improve throughput performance with 802.11g and 802.11b.
1501 Pollable capability.
1503 Short slot time capability.
1506 By default interesting information elements captured from the neighboring
1507 stations are displayed at the end of each row.
1508 Possible elements include:
1510 (station supports WME),
1512 (station supports WPA),
1514 (station supports WPS),
1516 (station supports 802.11i/RSN),
1518 (station supports 802.11n/HT communication),
1520 (station supports Atheros protocol extensions),
1522 (station supports unknown vendor-specific extensions).
1525 flag is used all the information elements and their
1526 contents will be shown.
1529 flag also enables display of long SSIDs.
1532 command is another way of requesting this information.
1534 When operating as an access point display the stations that are
1535 currently associated.
1536 When operating in ad-hoc mode display stations identified as
1537 neighbors in the IBSS.
1538 When operating in mesh mode display stations identified as
1539 neighbors in the MBSS.
1540 When operating in station mode display the access point.
1541 Capabilities advertised by the stations are described under
1545 The following flags can be included in the output:
1549 Indicates that the station is permitted to send/receive data frames.
1551 Extended Rate Phy (ERP).
1552 Indicates that the station is operating in an 802.11g network
1553 using extended transmit rates.
1555 High Throughput (HT).
1556 Indicates that the station is using HT transmit rates.
1559 follows immediately after then the station associated
1560 using deprecated mechanisms supported only when
1565 Indicates that the station is operating in power save mode.
1567 Quality of Service (QoS).
1568 Indicates that the station is using QoS encapsulation for
1570 QoS encapsulation is enabled only when WME mode is enabled.
1572 Short GI in HT 40MHz mode enabled.
1575 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1577 Transitional Security Network (TSN).
1578 Indicates that the station associated using TSN; see also
1582 Wi-Fi Protected Setup (WPS).
1583 Indicates that the station associated using WPS.
1585 Short GI in HT 20MHz mode enabled.
1588 By default information elements received from associated stations
1589 are displayed in a short form; the
1591 flag causes this information to be displayed symbolically.
1593 Display the current channel parameters to use when operating in WME mode.
1596 option is specified then both channel and BSS parameters are displayed
1597 for each AC (first channel, then BSS).
1598 When WME mode is enabled for an adaptor this information will be
1599 displayed with the regular status; this command is mostly useful
1600 for examining parameters when WME mode is disabled.
1601 See the description of the
1603 directive for information on the various parameters.
1604 .It Cm maxretry Ar count
1605 Set the maximum number of tries to use in sending unicast frames.
1606 The default setting is 6 but drivers may override this with a value
1608 .It Cm mcastrate Ar rate
1609 Set the rate for transmitting multicast/broadcast frames.
1610 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1611 This rate should be valid for the current operating conditions;
1612 if an invalid rate is specified drivers are free to chose an
1614 .It Cm mgtrate Ar rate
1615 Set the rate for transmitting management and/or control frames.
1616 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1618 Set the location to use in calculating regulatory constraints.
1619 The location is also advertised in beacon and probe response frames
1620 when 802.11d is enabled with
1629 Enable powersave operation.
1630 When operating as a client, the station will conserve power by
1631 periodically turning off the radio and listening for
1632 messages from the access point telling it there are packets waiting.
1633 The station must then retrieve the packets.
1634 Not all devices support power save operation as a client.
1635 The 802.11 specification requires that all access points support
1636 power save but some drivers do not.
1639 to disable powersave operation when operating as a client.
1640 .It Cm powersavesleep Ar sleep
1641 Set the desired max powersave sleep time in TU's (1024 usecs).
1642 By default the max powersave sleep time is 100 TU's.
1643 .It Cm protmode Ar technique
1644 For interfaces operating in 802.11g, use the specified
1646 for protecting OFDM frames in a mixed 11b/11g network.
1647 The set of valid techniques is
1653 Technique names are case insensitive.
1654 Not all devices support
1656 as a protection technique.
1658 When operating as an access point in 802.11g mode allow only
1659 11g-capable stations to associate (11b-only stations are not
1660 permitted to associate).
1661 To allow both 11g and 11b-only stations to associate, use
1664 When operating as an access point in 802.11n mode allow only
1665 HT-capable stations to associate (legacy stations are not
1666 permitted to associate).
1667 To allow both HT and legacy stations to associate, use
1669 .It Cm regdomain Ar sku
1670 Set the regulatory domain to use in calculating the regulatory constraints
1672 In particular the set of available channels, how the wireless device
1673 will operation on the channels, and the maximum transmit power that
1674 can be used on a channel are defined by this setting.
1675 Regdomain codes (SKU's) are taken from
1676 .Pa /etc/regdomain.xml
1678 be viewed with the ``list countries'' request.
1679 Note that not all devices support changing the regdomain from a default
1680 setting; typically stored in EEPROM.
1688 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1690 Note that RIFS must be supported by both the station and access point
1694 .It Cm roam:rate Ar rate
1695 Set the threshold for controlling roaming when operating in a BSS.
1698 parameter specifies the transmit rate in megabits
1699 at which roaming should be considered.
1700 If the current transmit rate drops below this setting and background scanning
1701 is enabled, then the system will check if a more desirable access point is
1702 available and switch over to it.
1703 The current scan cache contents are used if they are considered
1704 valid according to the
1706 parameter; otherwise a background scan operation is triggered before
1707 any selection occurs.
1708 Each channel type has a separate rate threshold; the default values are:
1709 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1710 .It Cm roam:rssi Ar rssi
1711 Set the threshold for controlling roaming when operating in a BSS.
1714 parameter specifies the receive signal strength in dBm units
1715 at which roaming should be considered.
1716 If the current rssi drops below this setting and background scanning
1717 is enabled, then the system will check if a more desirable access point is
1718 available and switch over to it.
1719 The current scan cache contents are used if they are considered
1720 valid according to the
1722 parameter; otherwise a background scan operation is triggered before
1723 any selection occurs.
1724 Each channel type has a separate rssi threshold; the default values are
1726 .It Cm roaming Ar mode
1727 When operating as a station, control how the system will
1728 behave when communication with the current access point
1732 argument may be one of
1734 (leave it to the hardware device to decide),
1736 (handle either in the device or the operating system\[em]as appropriate),
1738 (do nothing until explicitly instructed).
1739 By default, the device is left to handle this if it is
1740 capable; otherwise, the operating system will automatically
1741 attempt to reestablish communication.
1742 Manual mode is used by applications such as
1743 .Xr wpa_supplicant 8
1744 that want to control the selection of an access point.
1745 .It Cm rtsthreshold Ar length
1746 Set the threshold for which
1747 transmitted frames are preceded by transmission of an
1753 is the frame size in bytes and must be in the range 1 to 2346.
1761 disables transmission of RTS frames.
1762 Not all adapters support setting the RTS threshold.
1764 Initiate a scan of neighboring stations, wait for it to complete, and
1765 display all stations found.
1766 Only the super-user can initiate a scan.
1769 for information on the display.
1770 By default a background scan is done; otherwise a foreground
1771 scan is done and the station may roam to a different access point.
1774 request can be used to show recent scan results without
1775 initiating a new scan.
1776 .It Cm scanvalid Ar threshold
1777 Set the maximum time the scan cache contents are considered valid;
1778 i.e., will be used without first triggering a scan operation to
1782 parameter is specified in seconds and defaults to 60 seconds.
1783 The minimum setting for
1786 One should take care setting this threshold; if it is set too low
1787 then attempts to roam to another access point may trigger unnecessary
1788 background scan operations.
1790 Enable use of Short Guard Interval when operating in 802.11n
1792 NB: this currently enables Short GI on both HT40 and HT20 channels.
1793 To disable Short GI use
1796 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1797 when operating in 802.11n.
1798 A station operating with Static SMPS maintains only a single
1799 receive chain active (this can significantly reduce power consumption).
1803 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1804 when operating in 802.11n.
1805 A station operating with Dynamic SMPS maintains only a single
1806 receive chain active but switches to multiple receive chains when it
1807 receives an RTS frame (this can significantly reduce power consumption).
1808 Note that stations cannot distinguish between RTS/CTS intended to
1809 enable multiple receive chains and those used for other purposes.
1813 Set the desired Service Set Identifier (aka network name).
1814 The SSID is a string up to 32 characters
1815 in length and may be specified as either a normal string or in
1816 hexadecimal when preceded by
1818 Additionally, the SSID may be cleared by setting it to
1820 .It Cm tdmaslot Ar slot
1821 When operating with TDMA, use the specified
1826 is a number between 0 and the maximum number of slots in the BSS.
1827 Note that a station configured as slot 0 is a master and
1828 will broadcast beacon frames advertising the BSS;
1829 stations configured to use other slots will always
1830 scan to locate a master before they ever transmit.
1834 .It Cm tdmaslotcnt Ar cnt
1835 When operating with TDMA, setup a BSS with
1838 The slot count may be at most 8.
1839 The current implementation is only tested with two stations
1840 (i.e., point to point applications).
1841 This setting is only meaningful when a station is configured as slot 0;
1842 other stations adopt this setting from the BSS they join.
1846 .It Cm tdmaslotlen Ar len
1847 When operating with TDMA, setup a BSS such that each station has a slot
1850 The slot length must be at least 150 microseconds (1/8 TU)
1851 and no more than 65 milliseconds.
1852 Note that setting too small a slot length may result in poor channel
1853 bandwidth utilization due to factors such as timer granularity and
1855 This setting is only meaningful when a station is configured as slot 0;
1856 other stations adopt this setting from the BSS they join.
1859 is set to 10 milliseconds.
1860 .It Cm tdmabintval Ar intval
1861 When operating with TDMA, setup a BSS such that beacons are transmitted every
1863 superframes to synchronize the TDMA slot timing.
1864 A superframe is defined as the number of slots times the slot length; e.g.,
1865 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1866 The beacon interval may not be zero.
1869 causes the timers to be resynchronized more often; this can be help if
1870 significant timer drift is observed.
1875 When operating as an access point with WPA/802.11i allow legacy
1876 stations to associate using static key WEP and open authentication.
1877 To disallow legacy station use of WEP, use
1879 .It Cm txpower Ar power
1880 Set the power used to transmit frames.
1883 argument is specified in .5 dBm units.
1884 Out of range values are truncated.
1885 Typically only a few discreet power settings are available and
1886 the driver will use the setting closest to the specified value.
1887 Not all adapters support changing the transmit power.
1888 .It Cm ucastrate Ar rate
1889 Set a fixed rate for transmitting unicast frames.
1890 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1891 This rate should be valid for the current operating conditions;
1892 if an invalid rate is specified drivers are free to chose an
1894 .It Cm wepmode Ar mode
1895 Set the desired WEP mode.
1896 Not all adapters support all modes.
1897 The set of valid modes is
1903 mode explicitly tells the adaptor to allow association with access
1904 points which allow both encrypted and unencrypted traffic.
1907 means that the access point must only allow encrypted connections.
1910 is generally another name for
1912 Modes are case insensitive.
1913 .It Cm weptxkey Ar index
1914 Set the WEP key to be used for transmission.
1915 This is the same as setting the default transmission key with
1917 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1918 Set the selected WEP key.
1921 is not given, key 1 is set.
1922 A WEP key will be either 5 or 13
1923 characters (40 or 104 bits) depending on the local network and the
1924 capabilities of the adaptor.
1925 It may be specified either as a plain
1926 string or as a string of hexadecimal digits preceded by
1928 For maximum portability, hex keys are recommended;
1929 the mapping of text keys to WEP encryption is usually driver-specific.
1930 In particular, the Windows drivers do this mapping differently to
1932 A key may be cleared by setting it to
1934 If WEP is supported then there are at least four keys.
1935 Some adapters support more than four keys.
1936 If that is the case, then the first four keys
1937 (1-4) will be the standard temporary keys and any others will be adaptor
1938 specific keys such as permanent keys stored in NVRAM.
1940 Note that you must set a default transmit key with
1942 for the system to know which key to use in encrypting outbound traffic.
1944 Enable Wireless Multimedia Extensions (WME) support, if available,
1945 for the specified interface.
1946 WME is a subset of the IEEE 802.11e standard to support the
1947 efficient communication of realtime and multimedia data.
1948 To disable WME support, use
1950 Another name for this parameter is
1953 The following parameters are meaningful only when WME support is in use.
1954 Parameters are specified per-AC (Access Category) and
1955 split into those that are used by a station when acting
1956 as an access point and those for client stations in the BSS.
1957 The latter are received from the access point and may not be changed
1959 The following Access Categories are recognized:
1961 .Bl -tag -width ".Cm AC_BK" -compact
1965 best effort delivery,
1980 AC parameters are case-insensitive.
1981 Traffic classification is done in the operating system using the
1982 vlan priority associated with data frames or the
1983 ToS (Type of Service) indication in IP-encapsulated frames.
1984 If neither information is present, traffic is assigned to the
1985 Best Effort (BE) category.
1986 .Bl -tag -width indent
1988 Set the ACK policy for QoS transmissions by the local station;
1989 this controls whether or not data frames transmitted by a station
1990 require an ACK response from the receiving station.
1991 To disable waiting for an ACK use
1993 This parameter is applied only to the local station.
1995 Enable the Admission Control Mandatory (ACM) mechanism
1996 for transmissions by the local station.
1997 To disable the ACM use
1999 On stations in a BSS this parameter is read-only and indicates
2000 the setting received from the access point.
2001 NB: ACM is not supported right now.
2002 .It Cm aifs Ar ac Ar count
2003 Set the Arbitration Inter Frame Spacing (AIFS)
2004 channel access parameter to use for transmissions
2005 by the local station.
2006 On stations in a BSS this parameter is read-only and indicates
2007 the setting received from the access point.
2008 .It Cm cwmin Ar ac Ar count
2009 Set the CWmin channel access parameter to use for transmissions
2010 by the local station.
2011 On stations in a BSS this parameter is read-only and indicates
2012 the setting received from the access point.
2013 .It Cm cwmax Ar ac Ar count
2014 Set the CWmax channel access parameter to use for transmissions
2015 by the local station.
2016 On stations in a BSS this parameter is read-only and indicates
2017 the setting received from the access point.
2018 .It Cm txoplimit Ar ac Ar limit
2019 Set the Transmission Opportunity Limit channel access parameter
2020 to use for transmissions by the local station.
2021 This parameter defines an interval of time when a WME station
2022 has the right to initiate transmissions onto the wireless medium.
2023 On stations in a BSS this parameter is read-only and indicates
2024 the setting received from the access point.
2025 .It Cm bss:aifs Ar ac Ar count
2026 Set the AIFS channel access parameter to send to stations in a BSS.
2027 This parameter is meaningful only when operating in ap mode.
2028 .It Cm bss:cwmin Ar ac Ar count
2029 Set the CWmin channel access parameter to send to stations in a BSS.
2030 This parameter is meaningful only when operating in ap mode.
2031 .It Cm bss:cwmax Ar ac Ar count
2032 Set the CWmax channel access parameter to send to stations in a BSS.
2033 This parameter is meaningful only when operating in ap mode.
2034 .It Cm bss:txoplimit Ar ac Ar limit
2035 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2036 This parameter is meaningful only when operating in ap mode.
2039 Enable Wireless Privacy Subscriber support.
2040 Note that WPS support requires a WPS-capable supplicant.
2041 To disable this function use
2045 The following parameters support an optional access control list
2046 feature available with some adapters when operating in ap mode; see
2048 This facility allows an access point to accept/deny association
2049 requests based on the MAC address of the station.
2050 Note that this feature does not significantly enhance security
2051 as MAC address spoofing is easy to do.
2052 .Bl -tag -width indent
2053 .It Cm mac:add Ar address
2054 Add the specified MAC address to the database.
2055 Depending on the policy setting association requests from the
2056 specified station will be allowed or denied.
2058 Set the ACL policy to permit association only by
2059 stations registered in the database.
2060 .It Cm mac:del Ar address
2061 Delete the specified MAC address from the database.
2063 Set the ACL policy to deny association only by
2064 stations registered in the database.
2065 .It Cm mac:kick Ar address
2066 Force the specified station to be deauthenticated.
2067 This typically is done to block a station after updating the
2070 Set the ACL policy to allow all stations to associate.
2072 Delete all entries in the database.
2074 Set the ACL policy to permit association only by
2075 stations approved by a RADIUS server.
2076 Note that this feature requires the
2078 program be configured to do the right thing
2079 as it handles the RADIUS processing
2080 (and marks stations as authorized).
2083 The following parameters are related to a wireless interface operating in mesh
2085 .Bl -tag -width indent
2086 .It Cm meshid Ar meshid
2087 Set the desired Mesh Identifier.
2088 The Mesh ID is a string up to 32 characters in length.
2089 A mesh interface must have a Mesh Identifier specified
2090 to reach an operational state.
2091 .It Cm meshttl Ar ttl
2092 Set the desired ``time to live'' for mesh forwarded packets;
2093 this is the number of hops a packet may be forwarded before
2095 The default setting for
2099 Enable or disable peering with neighbor mesh stations.
2100 Stations must peer before any data packets can be exchanged.
2105 Enable or disable forwarding packets by a mesh interface.
2110 This attribute specifies whether or not the mesh STA activates mesh gate
2115 .It Cm meshmetric Ar protocol
2118 as the link metric protocol used on a mesh network.
2119 The default protocol is called
2121 The mesh interface will restart after changing this setting.
2122 .It Cm meshpath Ar protocol
2125 as the path selection protocol used on a mesh network.
2126 The only available protocol at the moment is called
2128 (Hybrid Wireless Mesh Protocol).
2129 The mesh interface will restart after changing this setting.
2130 .It Cm hwmprootmode Ar mode
2131 Stations on a mesh network can operate as ``root nodes.''
2132 Root nodes try to find paths to all mesh nodes and advertise themselves
2134 When there is a root mesh node on a network, other mesh nodes can setup
2135 paths between themselves faster because they can use the root node
2136 to find the destination.
2137 This path may not be the best, but on-demand
2138 routing will eventually find the best path.
2139 The following modes are recognized:
2141 .Bl -tag -width ".Cm PROACTIVE" -compact
2145 Send broadcast path requests every two seconds.
2146 Nodes on the mesh without a path to this root mesh station with try to
2147 discover a path to us.
2149 Send broadcast path requests every two seconds and every node must reply
2150 with a path reply even if it already has a path to this root mesh station.
2152 Send broadcast root announcement (RANN) frames.
2153 Nodes on the mesh without a path to this root mesh station with try to
2154 discover a path to us.
2160 .It Cm hwmpmaxhops Ar cnt
2161 Set the maximum number of hops allowed in an HMWP path to
2163 The default setting for
2168 The following parameters are for compatibility with other systems:
2169 .Bl -tag -width indent
2171 Another name for the
2177 .It Cm stationname Ar name
2178 Set the name of this station.
2179 The station name is not part of the IEEE 802.11
2180 protocol though some interfaces support it.
2182 seems to be meaningful to identical or virtually identical equipment.
2183 Setting the station name is identical in syntax to setting the SSID.
2190 Another way of saying
2196 Another way of saying
2202 Another way of saying:
2203 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2209 .Ar n : k1 , k2 , k3 , k4
2212 Another way of saying
2213 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2218 Another way of saying
2225 The following parameters are specific to bridge interfaces:
2226 .Bl -tag -width indent
2227 .It Cm addm Ar interface
2228 Add the interface named by
2230 as a member of the bridge.
2231 The interface is put into promiscuous mode
2232 so that it can receive every packet sent on the network.
2233 .It Cm deletem Ar interface
2234 Remove the interface named by
2237 Promiscuous mode is disabled on the interface when
2238 it is removed from the bridge.
2239 .It Cm maxaddr Ar size
2240 Set the size of the bridge address cache to
2242 The default is 2000 entries.
2243 .It Cm timeout Ar seconds
2244 Set the timeout of address cache entries to
2249 is zero, then address cache entries will not be expired.
2250 The default is 1200 seconds.
2252 Display the addresses that have been learned by the bridge.
2253 .It Cm static Ar interface-name Ar address
2254 Add a static entry into the address cache pointing to
2255 .Ar interface-name .
2256 Static entries are never aged out of the cache or re-placed, even if the
2257 address is seen on a different interface.
2258 .It Cm deladdr Ar address
2261 from the address cache.
2263 Delete all dynamically-learned addresses from the address cache.
2265 Delete all addresses, including static addresses, from the address cache.
2266 .It Cm discover Ar interface
2267 Mark an interface as a
2270 When the bridge has no address cache entry
2271 (either dynamic or static)
2272 for the destination address of a packet,
2273 the bridge will forward the packet to all
2274 member interfaces marked as
2276 This is the default for all interfaces added to a bridge.
2277 .It Cm -discover Ar interface
2280 attribute on a member interface.
2281 For packets without the
2283 attribute, the only packets forwarded on the interface are broadcast
2284 or multicast packets and packets for which the destination address
2285 is known to be on the interface's segment.
2286 .It Cm learn Ar interface
2287 Mark an interface as a
2290 When a packet arrives on such an interface, the source
2291 address of the packet is entered into the address cache as being a
2292 destination address on the interface's segment.
2293 This is the default for all interfaces added to a bridge.
2294 .It Cm -learn Ar interface
2297 attribute on a member interface.
2298 .It Cm sticky Ar interface
2299 Mark an interface as a
2302 Dynamically learned address entries are treated at static once entered into
2304 Sticky entries are never aged out of the cache or replaced, even if the
2305 address is seen on a different interface.
2306 .It Cm -sticky Ar interface
2309 attribute on a member interface.
2310 .It Cm private Ar interface
2311 Mark an interface as a
2314 A private interface does not forward any traffic to any other port that is also
2315 a private interface.
2316 .It Cm -private Ar interface
2319 attribute on a member interface.
2320 .It Cm span Ar interface
2321 Add the interface named by
2323 as a span port on the bridge.
2324 Span ports transmit a copy of every frame received by the bridge.
2325 This is most useful for snooping a bridged network passively on
2326 another host connected to one of the span ports of the bridge.
2327 .It Cm -span Ar interface
2328 Delete the interface named by
2330 from the list of span ports of the bridge.
2331 .It Cm stp Ar interface
2332 Enable Spanning Tree protocol on
2336 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2337 Spanning Tree is used to detect and remove loops in a network topology.
2338 .It Cm -stp Ar interface
2339 Disable Spanning Tree protocol on
2341 This is the default for all interfaces added to a bridge.
2342 .It Cm edge Ar interface
2346 An edge port connects directly to end stations cannot create bridging
2347 loops in the network, this allows it to transition straight to forwarding.
2348 .It Cm -edge Ar interface
2349 Disable edge status on
2351 .It Cm autoedge Ar interface
2354 to automatically detect edge status.
2355 This is the default for all interfaces added to a bridge.
2356 .It Cm -autoedge Ar interface
2357 Disable automatic edge status on
2359 .It Cm ptp Ar interface
2362 as a point to point link.
2363 This is required for straight transitions to forwarding and
2364 should be enabled on a direct link to another RSTP capable switch.
2365 .It Cm -ptp Ar interface
2366 Disable point to point link status on
2368 This should be disabled for a half duplex link and for an interface
2369 connected to a shared network segment,
2370 like a hub or a wireless network.
2371 .It Cm autoptp Ar interface
2372 Automatically detect the point to point status on
2374 by checking the full duplex link status.
2375 This is the default for interfaces added to the bridge.
2376 .It Cm -autoptp Ar interface
2377 Disable automatic point to point link detection on
2379 .It Cm maxage Ar seconds
2380 Set the time that a Spanning Tree protocol configuration is valid.
2381 The default is 20 seconds.
2382 The minimum is 6 seconds and the maximum is 40 seconds.
2383 .It Cm fwddelay Ar seconds
2384 Set the time that must pass before an interface begins forwarding
2385 packets when Spanning Tree is enabled.
2386 The default is 15 seconds.
2387 The minimum is 4 seconds and the maximum is 30 seconds.
2388 .It Cm hellotime Ar seconds
2389 Set the time between broadcasting of Spanning Tree protocol
2390 configuration messages.
2391 The hello time may only be changed when operating in legacy stp mode.
2392 The default is 2 seconds.
2393 The minimum is 1 second and the maximum is 2 seconds.
2394 .It Cm priority Ar value
2395 Set the bridge priority for Spanning Tree.
2396 The default is 32768.
2397 The minimum is 0 and the maximum is 61440.
2398 .It Cm proto Ar value
2399 Set the Spanning Tree protocol.
2400 The default is rstp.
2401 The available options are stp and rstp.
2402 .It Cm holdcnt Ar value
2403 Set the transmit hold count for Spanning Tree.
2404 This is the number of packets transmitted before being rate limited.
2406 The minimum is 1 and the maximum is 10.
2407 .It Cm ifpriority Ar interface Ar value
2408 Set the Spanning Tree priority of
2413 The minimum is 0 and the maximum is 240.
2414 .It Cm ifpathcost Ar interface Ar value
2415 Set the Spanning Tree path cost of
2419 The default is calculated from the link speed.
2420 To change a previously selected path cost back to automatic, set the
2422 The minimum is 1 and the maximum is 200000000.
2423 .It Cm ifmaxaddr Ar interface Ar size
2424 Set the maximum number of hosts allowed from an interface, packets with unknown
2425 source addresses are dropped until an existing host cache entry expires or is
2427 Set to 0 to disable.
2430 The following parameters are specific to lagg interfaces:
2431 .Bl -tag -width indent
2432 .It Cm laggtype Ar type
2433 When creating a lagg interface the type can be specified as either
2437 If not specified ethernet is the default lagg type.
2438 .It Cm laggport Ar interface
2439 Add the interface named by
2441 as a port of the aggregation interface.
2442 .It Cm -laggport Ar interface
2443 Remove the interface named by
2445 from the aggregation interface.
2446 .It Cm laggproto Ar proto
2447 Set the aggregation protocol.
2450 The available options are
2458 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2459 Set the packet layers to hash for aggregation protocols which load balance.
2462 The options can be combined using commas.
2464 .Bl -tag -width ".Cm l2" -compact
2466 src/dst mac address and optional vlan number.
2468 src/dst address for IPv4 or IPv6.
2470 src/dst port for TCP/UDP/SCTP.
2473 Enable local hash computation for RSS hash on the interface.
2478 modes will use the RSS hash from the network card if available
2479 to avoid computing one, this may give poor traffic distribution
2480 if the hash is invalid or uses less of the protocol header information.
2482 disables use of RSS hash from the network card.
2483 The default value can be set via the
2484 .Va net.link.lagg.default_use_flowid
2495 Use the RSS hash from the network card if available.
2496 .It Cm flowid_shift Ar number
2497 Set a shift parameter for RSS local hash computation.
2498 Hash is calculated by using flowid bits in a packet header mbuf
2499 which are shifted by the number of this parameter.
2500 .It Cm lacp_fast_timeout
2501 Enable lacp fast-timeout on the interface.
2502 .It Cm -lacp_fast_timeout
2503 Disable lacp fast-timeout on the interface.
2505 Enable lacp strict compliance on the interface.
2506 The default value can be set via the
2507 .Va net.link.lagg.lacp.default_strict_mode
2518 Disable lacp strict compliance on the interface.
2519 .It Cm rr_limit Ar number
2520 Configure a stride for an interface in round-robin mode.
2521 The default stride is 1.
2524 The following parameters apply to IP tunnel interfaces,
2526 .Bl -tag -width indent
2527 .It Cm tunnel Ar src_addr dest_addr
2528 Configure the physical source and destination address for IP tunnel
2534 are interpreted as the outer source/destination for the encapsulating
2537 Unconfigure the physical source and destination address for IP tunnel
2538 interfaces previously configured with
2541 Another name for the
2544 .It Cm accept_rev_ethip_ver
2545 Set a flag to accept both correct EtherIP packets and ones
2546 with reversed version field.
2548 This is for backward compatibility with
2550 6.2, 6.3, 7.0, and 7.1.
2551 .It Cm -accept_rev_ethip_ver
2553 .Cm accept_rev_ethip_ver .
2554 .It Cm ignore_source
2555 Set a flag to accept encapsulated packets destined to this host
2556 independently from source address.
2557 This may be useful for hosts, that receive encapsulated packets
2558 from the load balancers.
2559 .It Cm -ignore_source
2562 .It Cm send_rev_ethip_ver
2563 Set a flag to send EtherIP packets with reversed version
2564 field intentionally.
2565 Disabled by default.
2566 This is for backward compatibility with
2568 6.2, 6.3, 7.0, and 7.1.
2569 .It Cm -send_rev_ethip_ver
2571 .Cm send_rev_ethip_ver .
2574 The following parameters apply to GRE tunnel interfaces,
2576 .Bl -tag -width indent
2577 .It Cm tunnel Ar src_addr dest_addr
2578 Configure the physical source and destination address for GRE tunnel
2584 are interpreted as the outer source/destination for the encapsulating
2587 Unconfigure the physical source and destination address for GRE tunnel
2588 interfaces previously configured with
2591 Another name for the
2594 .It Cm grekey Ar key
2595 Configure the GRE key to be used for outgoing packets.
2597 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2598 This command will result in a four byte MTU reduction on the interface.
2601 The following parameters are specific to
2604 .Bl -tag -width indent
2605 .It Cm syncdev Ar iface
2606 Use the specified interface
2607 to send and receive pfsync state synchronisation messages.
2609 Stop sending pfsync state synchronisation messages over the network.
2610 .It Cm syncpeer Ar peer_address
2611 Make the pfsync link point-to-point rather than using
2612 multicast to broadcast the state synchronisation messages.
2613 The peer_address is the IP address of the other host taking part in
2616 Broadcast the packets using multicast.
2618 Set the maximum number of updates for a single state which
2619 can be collapsed into one.
2620 This is an 8-bit number; the default value is 128.
2622 Defer transmission of the first packet in a state until a peer has
2623 acknowledged that the associated state has been inserted.
2625 Do not defer the first packet in a state.
2626 This is the default.
2629 The following parameters are specific to
2632 .Bl -tag -width indent
2633 .It Cm vlan Ar vlan_tag
2634 Set the VLAN tag value to
2636 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2637 VLAN header for packets sent from the
2644 must both be set at the same time.
2645 .It Cm vlanpcp Ar priority_code_point
2648 is an 3-bit field which refers to the IEEE 802.1p
2649 class of service and maps to the frame priority level.
2651 Values in order of priority are:
2653 .Pq Dv Background (lowest) ,
2655 .Pq Dv Best effort (default) ,
2657 .Pq Dv Excellent effort ,
2659 .Pq Dv Critical applications ,
2661 .Pq Dv Video, < 100ms latency and jitter ,
2663 .Pq Dv Voice, < 10ms latency and jitter ,
2665 .Pq Dv Internetwork control ,
2667 .Pq Dv Network control (highest) .
2668 .It Cm vlandev Ar iface
2669 Associate the physical interface
2674 Packets transmitted through the
2677 diverted to the specified physical interface
2679 with 802.1Q VLAN encapsulation.
2680 Packets with 802.1Q encapsulation received
2681 by the parent interface with the correct VLAN Identifier will be diverted to
2687 interface is assigned a
2688 copy of the parent interface's flags and the parent's Ethernet address.
2693 must both be set at the same time.
2696 interface already has
2697 a physical interface associated with it, this command will fail.
2699 change the association to another physical interface, the existing
2700 association must be cleared first.
2702 Note: if the hardware tagging capability
2703 is set on the parent interface, the
2706 interface's behavior changes:
2709 interface recognizes that the
2710 parent interface supports insertion and extraction of VLAN tags on its
2711 own (usually in firmware) and that it should pass packets to and from
2712 the parent unaltered.
2713 .It Fl vlandev Op Ar iface
2716 pseudo device, disassociate the parent interface from it.
2717 This breaks the link between the
2719 interface and its parent,
2720 clears its VLAN Identifier, flags and its link address and shuts the interface
2724 argument is useless and hence deprecated.
2727 The following parameters are used to configure
2730 .Bl -tag -width indent
2731 .It Cm vxlanid Ar identifier
2732 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2733 virtual network segment membership of the interface.
2734 .It Cm vxlanlocal Ar address
2735 The source address used in the encapsulating IPv4/IPv6 header.
2736 The address should already be assigned to an existing interface.
2737 When the interface is configured in unicast mode, the listening socket
2738 is bound to this address.
2739 .It Cm vxlanremote Ar address
2740 The interface can be configured in a unicast, or point-to-point, mode
2741 to create a tunnel between two hosts.
2742 This is the IP address of the remote end of the tunnel.
2743 .It Cm vxlangroup Ar address
2744 The interface can be configured in a multicast mode
2745 to create a virtual network of hosts.
2746 This is the IP multicast group address the interface will join.
2747 .It Cm vxlanlocalport Ar port
2748 The port number the interface will listen on.
2749 The default port number is 4789.
2750 .It Cm vxlanremoteport Ar port
2751 The destination port number used in the encapsulating IPv4/IPv6 header.
2752 The remote host should be listening on this port.
2753 The default port number is 4789.
2754 Note some other implementations, such as Linux,
2755 do not default to the IANA assigned port,
2756 but instead listen on port 8472.
2757 .It Cm vxlanportrange Ar low high
2758 The range of source ports used in the encapsulating IPv4/IPv6 header.
2759 The port selected within the range is based on a hash of the inner frame.
2760 A range is useful to provide entropy within the outer IP header
2761 for more effective load balancing.
2762 The default range is between the
2765 .Va net.inet.ip.portrange.first
2767 .Va net.inet.ip.portrange.last
2768 .It Cm vxlantimeout Ar timeout
2769 The maximum time, in seconds, before an entry in the forwarding table
2771 The default is 1200 seconds (20 minutes).
2772 .It Cm vxlanmaxaddr Ar max
2773 The maximum number of entries in the forwarding table.
2774 The default is 2000.
2775 .It Cm vxlandev Ar dev
2776 When the interface is configured in multicast mode, the
2778 interface is used to transmit IP multicast packets.
2779 .It Cm vxlanttl Ar ttl
2780 The TTL used in the encapsulating IPv4/IPv6 header.
2783 The source IP address and inner source Ethernet MAC address of
2784 received packets are used to dynamically populate the forwarding table.
2785 When in multicast mode, an entry in the forwarding table allows the
2786 interface to send the frame directly to the remote host instead of
2787 broadcasting the frame to the multicast group.
2788 This is the default.
2790 The forwarding table is not populated by received packets.
2792 Delete all dynamically-learned addresses from the forwarding table.
2793 .It Cm vxlanflushall
2794 Delete all addresses, including static addresses, from the forwarding table.
2797 The following parameters are used to configure
2799 protocol on an interface:
2800 .Bl -tag -width indent
2802 Set the virtual host ID.
2803 This is a required setting to initiate
2805 If the virtual host ID does not exist yet, it is created and attached to the
2806 interface, otherwise configuration of an existing vhid is adjusted.
2809 keyword is supplied along with an
2813 address, then this address is configured to be run under control of the
2815 Whenever a last address that refers to a particular vhid is removed from an
2816 interface, the vhid is automatically removed from interface and destroyed.
2817 Any other configuration parameters for the
2819 protocol should be supplied along with the
2822 Acceptable values for vhid are 1 to 255.
2823 .It Cm advbase Ar seconds
2824 Specifies the base of the advertisement interval in seconds.
2825 The acceptable values are 1 to 255.
2826 The default value is 1.
2827 .It Cm advskew Ar interval
2828 Specifies the skew to add to the base advertisement interval to
2829 make one host advertise slower than another host.
2830 It is specified in 1/256 of seconds.
2831 The acceptable values are 1 to 254.
2832 The default value is 0.
2833 .It Cm pass Ar phrase
2834 Set the authentication key to
2836 .It Cm state Ar MASTER|BACKUP
2837 Forcibly change state of a given vhid.
2842 utility displays the current configuration for a network interface
2843 when no optional parameters are supplied.
2844 If a protocol family is specified,
2846 will report only the details specific to that protocol family.
2850 flag is passed before an interface name,
2852 will display the capability list and all
2853 of the supported media for the specified interface.
2856 flag is supplied, address lifetime is displayed for IPv6 addresses,
2857 as time offset string.
2861 flag may be used instead of an interface name.
2864 to display information about all interfaces in the system.
2867 flag limits this to interfaces that are down,
2869 limits this to interfaces that are up,
2870 limits this to interfaces that are up,
2872 limits this to members of the specified group of interfaces, and
2874 excludes members of the specified group from the list.
2879 flags may be specified to apply both conditions.
2882 should be specified as later override previous ones
2886 may contain shell patterns in which case it should be quoted.
2887 When no arguments are given,
2893 flag may be used to list all available interfaces on the system, with
2894 no other additional information.
2897 is specified, only interfaces of that type will be listed.
2899 will list only Ethernet adapters, excluding the loopback interface.
2900 Use of this flag is mutually exclusive
2901 with all other flags and commands, except for
2903 (only list interfaces that are down)
2906 (only list interfaces that are up).
2910 flag may be used to get more verbose status for an interface.
2914 flag may be used to list all of the interface cloners available on
2915 the system, with no additional information.
2916 Use of this flag is mutually exclusive with all other flags and commands.
2920 flag causes keying information for the interface, if available, to be
2922 For example, the values of 802.11 WEP keys and
2924 passphrases will be printed, if accessible to the current user.
2925 This information is not printed by default, as it may be considered
2928 If the network interface driver is not present in the kernel then
2930 will attempt to load it.
2933 flag disables this behavior.
2935 Only the super-user may modify the configuration of a network interface.
2937 Assign the IPv4 address
2939 with a network mask of
2943 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2945 Add the IPv4 address
2947 with the CIDR network prefix
2953 as a synonym for the canonical form of the option
2955 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2957 Remove the IPv4 address
2961 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2963 Enable IPv6 functionality of the interface:
2964 .Dl # ifconfig em0 inet6 -ifdisabled
2966 Add the IPv6 address
2967 .Li 2001:DB8:DBDB::123/48
2970 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2971 Note that lower case hexadecimal IPv6 addresses are acceptable.
2973 Remove the IPv6 address added in the above example,
2976 character as shorthand for the network prefix,
2979 as a synonym for the canonical form of the option
2981 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2983 Configure a single CARP redundant address on igb0, and then switch it
2985 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2986 .Dl # ifconfig igb0 vhid 1 state master
2988 Configure the interface
2990 to use 100baseTX, full duplex Ethernet media options:
2991 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2993 Label the em0 interface as an uplink:
2994 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2996 Create the software network interface
2998 .Dl # ifconfig gif1 create
3000 Destroy the software network interface
3002 .Dl # ifconfig gif1 destroy
3004 Display available wireless networks using
3006 .Dl # ifconfig wlan0 list scan
3008 Display inet and inet6 address subnet masks in CIDR notation
3009 .Dl # ifconfig -f inet:cidr,inet6:cidr
3011 Display interfaces that are up with the exception of loopback
3012 .Dl # ifconfig -a -u -G lo
3014 Messages indicating the specified interface does not exist, the
3015 requested address is unknown, or the user is not privileged and
3016 tried to alter an interface's configuration.
3039 Basic IPv6 node operation requires a link-local address on each
3040 interface configured for IPv6.
3041 Normally, such an address is automatically configured by the
3042 kernel on each interface added to the system or enabled; this behavior may
3043 be disabled by setting per-interface flag
3044 .Cm -auto_linklocal .
3045 The default value of this flag is 1 and can be disabled by using the sysctl
3047 .Va net.inet6.ip6.auto_linklocal .
3049 Do not configure IPv6 addresses with no link-local address by using
3051 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob