1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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.\" 4. 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94 29.\" $FreeBSD$ 30.\" 31.Dd May 27, 2012 32.Dt IFCONFIG 8 33.Os 34.Sh NAME 35.Nm ifconfig 36.Nd configure network interface parameters 37.Sh SYNOPSIS 38.Nm 39.Op Fl L 40.Op Fl k 41.Op Fl m 42.Op Fl n 43.Ar interface 44.Op Cm create 45.Ar address_family 46.Oo 47.Ar address 48.Op Ar dest_address 49.Oc 50.Op Ar parameters 51.Nm 52.Ar interface 53.Cm destroy 54.Nm 55.Fl a 56.Op Fl L 57.Op Fl d 58.Op Fl m 59.Op Fl u 60.Op Fl v 61.Op Ar address_family 62.Nm 63.Fl l 64.Op Fl d 65.Op Fl u 66.Op Ar address_family 67.Nm 68.Op Fl L 69.Op Fl d 70.Op Fl k 71.Op Fl m 72.Op Fl u 73.Op Fl v 74.Op Fl C 75.Nm 76.Op Fl g Ar groupname 77.Sh DESCRIPTION 78The 79.Nm 80utility is used to assign an address 81to a network interface and/or configure 82network interface parameters. 83The 84.Nm 85utility must be used at boot time to define the network address 86of each interface present on a machine; it may also be used at 87a later time to redefine an interface's address 88or other operating parameters. 89.Pp 90The following options are available: 91.Bl -tag -width indent 92.It Ar address 93For the 94.Tn DARPA Ns -Internet 95family, 96the address is either a host name present in the host name data 97base, 98.Xr hosts 5 , 99or a 100.Tn DARPA 101Internet address expressed in the Internet standard 102.Dq dot notation . 103.Pp 104It is also possible to use the CIDR notation (also known as the 105slash notation) to include the netmask. 106That is, one can specify an address like 107.Li 192.168.0.1/16 . 108.Pp 109For the 110.Dq inet6 111family, it is also possible to specify the prefix length using the slash 112notation, like 113.Li ::1/128 . 114See the 115.Cm prefixlen 116parameter below for more information. 117.\" For the Xerox Network Systems(tm) family, 118.\" addresses are 119.\" .Ar net:a.b.c.d.e.f , 120.\" where 121.\" .Ar net 122.\" is the assigned network number (in decimal), 123.\" and each of the six bytes of the host number, 124.\" .Ar a 125.\" through 126.\" .Ar f , 127.\" are specified in hexadecimal. 128.\" The host number may be omitted on IEEE 802 protocol 129.\" (Ethernet, FDDI, and Token Ring) interfaces, 130.\" which use the hardware physical address, 131.\" and on interfaces other than the first. 132.\" For the 133.\" .Tn ISO 134.\" family, addresses are specified as a long hexadecimal string, 135.\" as in the Xerox family. 136.\" However, two consecutive dots imply a zero 137.\" byte, and the dots are optional, if the user wishes to (carefully) 138.\" count out long strings of digits in network byte order. 139.Pp 140The link-level 141.Pq Dq link 142address 143is specified as a series of colon-separated hex digits. 144This can be used to 145e.g.\& set a new MAC address on an ethernet interface, though the 146mechanism used is not ethernet-specific. 147If the interface is already 148up when this option is used, it will be briefly brought down and 149then brought back up again in order to ensure that the receive 150filter in the underlying ethernet hardware is properly reprogrammed. 151.It Ar address_family 152Specify the 153address family 154which affects interpretation of the remaining parameters. 155Since an interface can receive transmissions in differing protocols 156with different naming schemes, specifying the address family is recommended. 157The address or protocol families currently 158supported are 159.Dq inet , 160.Dq inet6 , 161.Dq atalk , 162.Dq ipx , 163.\" .Dq iso , 164and 165.Dq link . 166.\" and 167.\" .Dq ns . 168The default if available is 169.Dq inet 170or otherwise 171.Dq link . 172.Dq ether 173and 174.Dq lladdr 175are synonyms for 176.Dq link . 177.It Ar dest_address 178Specify the address of the correspondent on the other end 179of a point to point link. 180.It Ar interface 181This 182parameter is a string of the form 183.Dq name unit , 184for example, 185.Dq Li ed0 . 186.It Ar groupname 187List the interfaces in the given group. 188.El 189.Pp 190The following parameters may be set with 191.Nm : 192.Bl -tag -width indent 193.It Cm add 194Another name for the 195.Cm alias 196parameter. 197Introduced for compatibility 198with 199.Bsx . 200.It Cm alias 201Establish an additional network address for this interface. 202This is sometimes useful when changing network numbers, and 203one wishes to accept packets addressed to the old interface. 204If the address is on the same subnet as the first network address 205for this interface, a non-conflicting netmask must be given. 206Usually 207.Li 0xffffffff 208is most appropriate. 209.It Fl alias 210Remove the network address specified. 211This would be used if you incorrectly specified an alias, or it 212was no longer needed. 213If you have incorrectly set an NS address having the side effect 214of specifying the host portion, removing all NS addresses will 215allow you to respecify the host portion. 216.It Cm anycast 217(Inet6 only.) 218Specify that the address configured is an anycast address. 219Based on the current specification, 220only routers may configure anycast addresses. 221Anycast address will not be used as source address of any of outgoing 222IPv6 packets. 223.It Cm arp 224Enable the use of the Address Resolution Protocol 225.Pq Xr arp 4 226in mapping 227between network level addresses and link level addresses (default). 228This is currently implemented for mapping between 229.Tn DARPA 230Internet 231addresses and 232.Tn IEEE 233802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses). 234.It Fl arp 235Disable the use of the Address Resolution Protocol 236.Pq Xr arp 4 . 237.It Cm staticarp 238If the Address Resolution Protocol is enabled, 239the host will only reply to requests for its addresses, 240and will never send any requests. 241.It Fl staticarp 242If the Address Resolution Protocol is enabled, 243the host will perform normally, 244sending out requests and listening for replies. 245.It Cm broadcast 246(Inet only.) 247Specify the address to use to represent broadcasts to the 248network. 249The default broadcast address is the address with a host part of all 1's. 250.It Cm debug 251Enable driver dependent debugging code; usually, this turns on 252extra console error logging. 253.It Fl debug 254Disable driver dependent debugging code. 255.It Cm promisc 256Put interface into permanently promiscuous mode. 257.It Fl promisc 258Disable permanently promiscuous mode. 259.It Cm delete 260Another name for the 261.Fl alias 262parameter. 263.It Cm description Ar value , Cm descr Ar value 264Specify a description of the interface. 265This can be used to label interfaces in situations where they may 266otherwise be difficult to distinguish. 267.It Cm -description , Cm -descr 268Clear the interface description. 269.It Cm down 270Mark an interface 271.Dq down . 272When an interface is marked 273.Dq down , 274the system will not attempt to 275transmit messages through that interface. 276If possible, the interface will be reset to disable reception as well. 277This action does not automatically disable routes using the interface. 278.It Cm group Ar group-name 279Assign the interface to a 280.Dq group . 281Any interface can be in multiple groups. 282.Pp 283Cloned interfaces are members of their interface family group by default. 284For example, a PPP interface such as 285.Em ppp0 286is a member of the PPP interface family group, 287.Em ppp . 288.\" The interface(s) the default route(s) point to are members of the 289.\" .Em egress 290.\" interface group. 291.It Cm -group Ar group-name 292Remove the interface from the given 293.Dq group . 294.It Cm eui64 295(Inet6 only.) 296Fill interface index 297(lowermost 64bit of an IPv6 address) 298automatically. 299.It Cm fib Ar fib_number 300Specify interface FIB. 301A FIB 302.Ar fib_number 303is assigned to all frames or packets received on that interface. 304The FIB is not inherited, e.g. vlans or other sub-interfaces will use 305the default FIB (0) irrespective of the parent interface's FIB. 306The kernel needs to be tuned to support more than the default FIB 307using the 308.Va ROUTETABLES 309kernel configuration option, or the 310.Va net.fibs 311tunable. 312.It Cm ipdst 313This is used to specify an Internet host who is willing to receive 314IP packets encapsulating IPX packets bound for a remote network. 315An apparent point to point link is constructed, and 316the address specified will be taken as the IPX address and network 317of the destination. 318.It Cm maclabel Ar label 319If Mandatory Access Control support is enabled in the kernel, 320set the MAC label to 321.Ar label . 322.\" (see 323.\" .Xr maclabel 7 ) . 324.It Cm media Ar type 325If the driver supports the media selection system, set the media type 326of the interface to 327.Ar type . 328Some interfaces support the mutually exclusive use of one of several 329different physical media connectors. 330For example, a 10Mbit/s Ethernet 331interface might support the use of either 332.Tn AUI 333or twisted pair connectors. 334Setting the media type to 335.Cm 10base5/AUI 336would change the currently active connector to the AUI port. 337Setting it to 338.Cm 10baseT/UTP 339would activate twisted pair. 340Refer to the interfaces' driver 341specific documentation or man page for a complete list of the 342available types. 343.It Cm mediaopt Ar opts 344If the driver supports the media selection system, set the specified 345media options on the interface. 346The 347.Ar opts 348argument 349is a comma delimited list of options to apply to the interface. 350Refer to the interfaces' driver specific man page for a complete 351list of available options. 352.It Fl mediaopt Ar opts 353If the driver supports the media selection system, disable the 354specified media options on the interface. 355.It Cm mode Ar mode 356If the driver supports the media selection system, set the specified 357operating mode on the interface to 358.Ar mode . 359For IEEE 802.11 wireless interfaces that support multiple operating modes 360this directive is used to select between 802.11a 361.Pq Cm 11a , 362802.11b 363.Pq Cm 11b , 364and 802.11g 365.Pq Cm 11g 366operating modes. 367.It Cm inst Ar minst , Cm instance Ar minst 368Set the media instance to 369.Ar minst . 370This is useful for devices which have multiple physical layer interfaces 371.Pq PHYs . 372.It Cm name Ar name 373Set the interface name to 374.Ar name . 375.It Cm rxcsum , txcsum , rxcsum6 , txcsum6 376If the driver supports user-configurable checksum offloading, 377enable receive (or transmit) checksum offloading on the interface. 378The feature can be turned on selectively per protocol family. 379Use 380.Cm rxcsum6 , txcsum6 381for 382.Xr ip6 4 383or 384.Cm rxcsum , txcsum 385otherwise. 386Some drivers may not be able to enable these flags independently 387of each other, so setting one may also set the other. 388The driver will offload as much checksum work as it can reliably 389support, the exact level of offloading varies between drivers. 390.It Fl rxcsum , txcsum , rxcsum6 , txcsum6 391If the driver supports user-configurable checksum offloading, 392disable receive (or transmit) checksum offloading on the interface. 393The feature can be turned off selectively per protocol family. 394Use 395.Fl rxcsum6 , txcsum6 396for 397.Xr ip6 4 398or 399.Fl rxcsum , txcsum 400otherwise. 401These settings may not always be independent of each other. 402.It Cm tso 403If the driver supports 404.Xr tcp 4 405segmentation offloading, enable TSO on the interface. 406Some drivers may not be able to support TSO for 407.Xr ip 4 408and 409.Xr ip6 4 410packets, so they may enable only one of them. 411.It Fl tso 412If the driver supports 413.Xr tcp 4 414segmentation offloading, disable TSO on the interface. 415It will always disable TSO for 416.Xr ip 4 417and 418.Xr ip6 4 . 419.It Cm tso6 , tso4 420If the driver supports 421.Xr tcp 4 422segmentation offloading for 423.Xr ip6 4 424or 425.Xr ip 4 426use one of these to selectively enabled it only for one protocol family. 427.It Fl tso6 , tso4 428If the driver supports 429.Xr tcp 4 430segmentation offloading for 431.Xr ip6 4 432or 433.Xr ip 4 434use one of these to selectively disable it only for one protocol family. 435.It Cm lro 436If the driver supports 437.Xr tcp 4 438large receive offloading, enable LRO on the interface. 439.It Fl lro 440If the driver supports 441.Xr tcp 4 442large receive offloading, disable LRO on the interface. 443.It Cm wol , wol_ucast , wol_mcast , wol_magic 444Enable Wake On Lan (WOL) support, if available. 445WOL is a facility whereby a machine in a low power state may be woken 446in response to a received packet. 447There are three types of packets that may wake a system: 448ucast (directed solely to the machine's mac address), 449mcast (directed to a broadcast or multicast address), 450or 451magic (unicast or multicast frames with a ``magic contents''). 452Not all devices support WOL, those that do indicate the mechanisms 453they support in their capabilities. 454.Cm wol 455is a synonym for enabling all available WOL mechanisms. 456To disable WOL use 457.Fl wol . 458.It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso 459If the driver offers user-configurable VLAN support, enable 460reception of extended frames, tag processing in hardware, 461frame filtering in hardware, checksum offloading, or TSO on VLAN, 462respectively. 463Note that this must be issued on a physical interface associated with 464.Xr vlan 4 , 465not on a 466.Xr vlan 4 467interface itself. 468.It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso 469If the driver offers user-configurable VLAN support, disable 470reception of extended frames, tag processing in hardware, 471frame filtering in hardware, or TSO on VLAN, 472respectively. 473.It Cm vnet Ar jail 474Move the interface to the 475.Xr jail 8 , 476specified by name or JID. 477If the jail has a virtual network stack, the interface will disappear 478from the current environment and become visible to the jail. 479.It Fl vnet Ar jail 480Reclaim the interface from the 481.Xr jail 8 , 482specified by name or JID. 483If the jail has a virtual network stack, the interface will disappear 484from the jail, and become visible to the current network environment. 485.It Cm polling 486Turn on 487.Xr polling 4 488feature and disable interrupts on the interface, if driver supports 489this mode. 490.It Fl polling 491Turn off 492.Xr polling 4 493feature and enable interrupt mode on the interface. 494.It Cm create 495Create the specified network pseudo-device. 496If the interface is given without a unit number, try to create a new 497device with an arbitrary unit number. 498If creation of an arbitrary device is successful, the new device name is 499printed to standard output unless the interface is renamed or destroyed 500in the same 501.Nm 502invocation. 503.It Cm destroy 504Destroy the specified network pseudo-device. 505.It Cm plumb 506Another name for the 507.Cm create 508parameter. 509Included for 510.Tn Solaris 511compatibility. 512.It Cm unplumb 513Another name for the 514.Cm destroy 515parameter. 516Included for 517.Tn Solaris 518compatibility. 519.It Cm metric Ar n 520Set the routing metric of the interface to 521.Ar n , 522default 0. 523The routing metric is used by the routing protocol 524.Pq Xr routed 8 . 525Higher metrics have the effect of making a route 526less favorable; metrics are counted as additional hops 527to the destination network or host. 528.It Cm mtu Ar n 529Set the maximum transmission unit of the interface to 530.Ar n , 531default is interface specific. 532The MTU is used to limit the size of packets that are transmitted on an 533interface. 534Not all interfaces support setting the MTU, and some interfaces have 535range restrictions. 536.It Cm netmask Ar mask 537.\" (Inet and ISO.) 538(Inet only.) 539Specify how much of the address to reserve for subdividing 540networks into sub-networks. 541The mask includes the network part of the local address 542and the subnet part, which is taken from the host field of the address. 543The mask can be specified as a single hexadecimal number 544with a leading 545.Ql 0x , 546with a dot-notation Internet address, 547or with a pseudo-network name listed in the network table 548.Xr networks 5 . 549The mask contains 1's for the bit positions in the 32-bit address 550which are to be used for the network and subnet parts, 551and 0's for the host part. 552The mask should contain at least the standard network portion, 553and the subnet field should be contiguous with the network 554portion. 555.Pp 556The netmask can also be specified in CIDR notation after the address. 557See the 558.Ar address 559option above for more information. 560.It Cm prefixlen Ar len 561(Inet6 only.) 562Specify that 563.Ar len 564bits are reserved for subdividing networks into sub-networks. 565The 566.Ar len 567must be integer, and for syntactical reason it must be between 0 to 128. 568It is almost always 64 under the current IPv6 assignment rule. 569If the parameter is omitted, 64 is used. 570.Pp 571The prefix can also be specified using the slash notation after the address. 572See the 573.Ar address 574option above for more information. 575.\" see 576.\" Xr eon 5 . 577.\" .It Cm nsellength Ar n 578.\" .Pf ( Tn ISO 579.\" only) 580.\" This specifies a trailing number of bytes for a received 581.\" .Tn NSAP 582.\" used for local identification, the remaining leading part of which is 583.\" taken to be the 584.\" .Tn NET 585.\" (Network Entity Title). 586.\" The default value is 1, which is conformant to US 587.\" .Tn GOSIP . 588.\" When an ISO address is set in an ifconfig command, 589.\" it is really the 590.\" .Tn NSAP 591.\" which is being specified. 592.\" For example, in 593.\" .Tn US GOSIP , 594.\" 20 hex digits should be 595.\" specified in the 596.\" .Tn ISO NSAP 597.\" to be assigned to the interface. 598.\" There is some evidence that a number different from 1 may be useful 599.\" for 600.\" .Tn AFI 601.\" 37 type addresses. 602.It Cm range Ar netrange 603Under appletalk, set the interface to respond to a 604.Ar netrange 605of the form 606.Ar startnet Ns - Ns Ar endnet . 607Appletalk uses this scheme instead of 608netmasks though 609.Fx 610implements it internally as a set of netmasks. 611.It Cm remove 612Another name for the 613.Fl alias 614parameter. 615Introduced for compatibility 616with 617.Bsx . 618.It Cm phase 619The argument following this specifies the version (phase) of the 620Appletalk network attached to the interface. 621Values of 1 or 2 are permitted. 622.Sm off 623.It Cm link Op Cm 0 No - Cm 2 624.Sm on 625Enable special processing of the link level of the interface. 626These three options are interface specific in actual effect, however, 627they are in general used to select special modes of operation. 628An example 629of this is to enable SLIP compression, or to select the connector type 630for some Ethernet cards. 631Refer to the man page for the specific driver 632for more information. 633.Sm off 634.It Fl link Op Cm 0 No - Cm 2 635.Sm on 636Disable special processing at the link level with the specified interface. 637.It Cm monitor 638Put the interface in monitor mode. 639No packets are transmitted, and received packets are discarded after 640.Xr bpf 4 641processing. 642.It Fl monitor 643Take the interface out of monitor mode. 644.It Cm up 645Mark an interface 646.Dq up . 647This may be used to enable an interface after an 648.Dq Nm Cm down . 649It happens automatically when setting the first address on an interface. 650If the interface was reset when previously marked down, 651the hardware will be re-initialized. 652.El 653.Pp 654The following parameters are for ICMPv6 Neighbor Discovery Protocol. 655Note that the address family keyword 656.Dq Li inet6 657is needed for them: 658.Bl -tag -width indent 659.It Cm accept_rtadv 660Set a flag to enable accepting ICMPv6 Router Advertisement messages. 661The 662.Xr sysctl 8 663variable 664.Va net.inet6.ip6.accept_rtadv 665controls whether this flag is set by default or not. 666.It Cm -accept_rtadv 667Clear a flag 668.Cm accept_rtadv . 669.It Cm no_radr 670Set a flag to control whether routers from which the system accepts 671Router Advertisement messages will be added to the Default Router List 672or not. 673When the 674.Cm accept_rtadv 675flag is disabled, this flag has no effect. 676The 677.Xr sysctl 8 678variable 679.Va net.inet6.ip6.no_radr 680controls whether this flag is set by default or not. 681.It Cm -no_radr 682Clear a flag 683.Cm no_radr . 684.It Cm auto_linklocal 685Set a flag to perform automatic link-local address configuration when 686the interface becomes available. 687The 688.Xr sysctl 8 689variable 690.Va net.inet6.ip6.auto_linklocal 691controls whether this flag is set by default or not. 692.It Cm -auto_linklocal 693Clear a flag 694.Cm auto_linklocal . 695.It Cm defaultif 696Set the specified interface as the default route when there is no 697default router. 698.It Cm -defaultif 699Clear a flag 700.Cm defaultif . 701.It Cm ifdisabled 702Set a flag to disable all of IPv6 network communications on the 703specified interface. Note that if there are already configured IPv6 704addresses on that interface, all of them are marked as 705.Dq tentative 706and DAD will be performed when this flag is cleared. 707.It Cm -ifdisabled 708Clear a flag 709.Cm ifdisabled . 710When this flag is cleared and 711.Cm auto_linklocal 712flag is enabled, automatic configuration of a link-local address is 713performed. 714.It Cm nud 715Set a flag to enable Neighbor Unreachability Detection. 716.It Cm -nud 717Clear a flag 718.Cm nud . 719.It Cm prefer_source 720Set a flag to prefer addresses on the interface as candidates of the 721source address for outgoing packets. 722.It Cm -prefer_source 723Clear a flag 724.Cm prefer_source . 725.El 726.Pp 727The following parameters are specific to cloning 728IEEE 802.11 wireless interfaces with the 729.Cm create 730request: 731.Bl -tag -width indent 732.It Cm wlandev Ar device 733Use 734.Ar device 735as the parent for the cloned device. 736.It Cm wlanmode Ar mode 737Specify the operating mode for this cloned device. 738.Ar mode 739is one of 740.Cm sta , 741.Cm ahdemo 742(or 743.Cm adhoc-demo ), 744.Cm ibss , 745(or 746.Cm adhoc ), 747.Cm ap , 748(or 749.Cm hostap ), 750.Cm wds , 751.Cm tdma , 752.Cm mesh , 753and 754.Cm monitor . 755The operating mode of a cloned interface cannot be changed. 756The 757.Cm tdma 758mode is actually implemented as an 759.Cm adhoc-demo 760interface with special properties. 761.It Cm wlanbssid Ar bssid 762The 802.11 mac address to use for the bssid. 763This must be specified at create time for a legacy 764.Cm wds 765device. 766.It Cm wlanaddr Ar address 767The local mac address. 768If this is not specified then a mac address will automatically be assigned 769to the cloned device. 770Typically this address is the same as the address of the parent device 771but if the 772.Cm bssid 773parameter is specified then the driver will craft a unique address for 774the device (if supported). 775.It Cm wdslegacy 776Mark a 777.Cm wds 778device as operating in ``legacy mode''. 779Legacy 780.Cm wds 781devices have a fixed peer relationship and do not, for example, roam 782if their peer stops communicating. 783For completeness a Dynamic WDS (DWDS) interface may marked as 784.Fl wdslegacy . 785.It Cm bssid 786Request a unique local mac address for the cloned device. 787This is only possible if the device supports multiple mac addresses. 788To force use of the parent's mac address use 789.Fl bssid . 790.It Cm beacons 791Mark the cloned interface as depending on hardware support to 792track received beacons. 793To have beacons tracked in software use 794.Fl beacons . 795For 796.Cm hostap 797mode 798.Fl beacons 799can also be used to indicate no beacons should 800be transmitted; this can be useful when creating a WDS configuration but 801.Cm wds 802interfaces can only be created as companions to an access point. 803.El 804.Pp 805The following parameters are specific to IEEE 802.11 wireless interfaces 806cloned with a 807.Cm create 808operation: 809.Bl -tag -width indent 810.It Cm ampdu 811Enable sending and receiving AMPDU frames when using 802.11n (default). 812The 802.11n specification states a compliant station must be capable 813of receiving AMPDU frames but transmission is optional. 814Use 815.Fl ampdu 816to disable all use of AMPDU with 802.11n. 817For testing and/or to work around interoperability problems one can use 818.Cm ampdutx 819and 820.Cm ampdurx 821to control use of AMPDU in one direction. 822.It Cm ampdudensity Ar density 823Set the AMPDU density parameter used when operating with 802.11n. 824This parameter controls the inter-packet gap for AMPDU frames. 825The sending device normally controls this setting but a receiving station 826may request wider gaps. 827Legal values for 828.Ar density 829are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds). 830A value of 831.Cm - 832is treated the same as 0. 833.It Cm ampdulimit Ar limit 834Set the limit on packet size for receiving AMPDU frames when operating 835with 802.11n. 836Legal values for 837.Ar limit 838are 8192, 16384, 32768, and 65536 but one can also specify 839just the unique prefix: 8, 16, 32, 64. 840Note the sender may limit the size of AMPDU frames to be less 841than the maximum specified by the receiving station. 842.It Cm amsdu 843Enable sending and receiving AMSDU frames when using 802.11n. 844By default AMSDU is received but not transmitted. 845Use 846.Fl amsdu 847to disable all use of AMSDU with 802.11n. 848For testing and/or to work around interoperability problems one can use 849.Cm amsdutx 850and 851.Cm amsdurx 852to control use of AMSDU in one direction. 853.It Cm amsdulimit Ar limit 854Set the limit on packet size for sending and receiving AMSDU frames 855when operating with 802.11n. 856Legal values for 857.Ar limit 858are 7935 and 3839 (bytes). 859Note the sender may limit the size of AMSDU frames to be less 860than the maximum specified by the receiving station. 861Note also that devices are not required to support the 7935 limit, 862only 3839 is required by the specification and the larger value 863may require more memory to be dedicated to support functionality 864that is rarely used. 865.It Cm apbridge 866When operating as an access point, pass packets between 867wireless clients directly (default). 868To instead let them pass up through the 869system and be forwarded using some other mechanism, use 870.Fl apbridge . 871Disabling the internal bridging 872is useful when traffic is to be processed with 873packet filtering. 874.It Cm authmode Ar mode 875Set the desired authentication mode in infrastructure mode. 876Not all adapters support all modes. 877The set of 878valid modes is 879.Cm none , open , shared 880(shared key), 881.Cm 8021x 882(IEEE 802.1x), 883and 884.Cm wpa 885(IEEE WPA/WPA2/802.11i). 886The 887.Cm 8021x 888and 889.Cm wpa 890modes are only useful when using an authentication service 891(a supplicant for client operation or an authenticator when 892operating as an access point). 893Modes are case insensitive. 894.It Cm bgscan 895Enable background scanning when operating as a station. 896Background scanning is a technique whereby a station associated to 897an access point will temporarily leave the channel to scan for 898neighboring stations. 899This allows a station to maintain a cache of nearby access points 900so that roaming between access points can be done without 901a lengthy scan operation. 902Background scanning is done only when a station is not busy and 903any outbound traffic will cancel a scan operation. 904Background scanning should never cause packets to be lost though 905there may be some small latency if outbound traffic interrupts a 906scan operation. 907By default background scanning is enabled if the device is capable. 908To disable background scanning, use 909.Fl bgscan . 910Background scanning is controlled by the 911.Cm bgscanidle 912and 913.Cm bgscanintvl 914parameters. 915Background scanning must be enabled for roaming; this is an artifact 916of the current implementation and may not be required in the future. 917.It Cm bgscanidle Ar idletime 918Set the minimum time a station must be idle (not transmitting or 919receiving frames) before a background scan is initiated. 920The 921.Ar idletime 922parameter is specified in milliseconds. 923By default a station must be idle at least 250 milliseconds before 924a background scan is initiated. 925The idle time may not be set to less than 100 milliseconds. 926.It Cm bgscanintvl Ar interval 927Set the interval at which background scanning is attempted. 928The 929.Ar interval 930parameter is specified in seconds. 931By default a background scan is considered every 300 seconds (5 minutes). 932The 933.Ar interval 934may not be set to less than 15 seconds. 935.It Cm bintval Ar interval 936Set the interval at which beacon frames are sent when operating in 937ad-hoc or ap mode. 938The 939.Ar interval 940parameter is specified in TU's (1024 usecs). 941By default beacon frames are transmitted every 100 TU's. 942.It Cm bmissthreshold Ar count 943Set the number of consecutive missed beacons at which the station 944will attempt to roam (i.e., search for a new access point). 945The 946.Ar count 947parameter must be in the range 1 to 255; though the 948upper bound may be reduced according to device capabilities. 949The default threshold is 7 consecutive missed beacons; but 950this may be overridden by the device driver. 951Another name for the 952.Cm bmissthreshold 953parameter is 954.Cm bmiss . 955.It Cm bssid Ar address 956Specify the MAC address of the access point to use when operating 957as a station in a BSS network. 958This overrides any automatic selection done by the system. 959To disable a previously selected access point, supply 960.Cm any , none , 961or 962.Cm - 963for the address. 964This option is useful when more than one access point uses the same SSID. 965Another name for the 966.Cm bssid 967parameter is 968.Cm ap . 969.It Cm burst 970Enable packet bursting. 971Packet bursting is a transmission technique whereby the wireless 972medium is acquired once to send multiple frames and the interframe 973spacing is reduced. 974This technique can significantly increase throughput by reducing 975transmission overhead. 976Packet bursting is supported by the 802.11e QoS specification 977and some devices that do not support QoS may still be capable. 978By default packet bursting is enabled if a device is capable 979of doing it. 980To disable packet bursting, use 981.Fl burst . 982.It Cm chanlist Ar channels 983Set the desired channels to use when scanning for access 984points, neighbors in an IBSS network, or looking for unoccupied 985channels when operating as an access point. 986The set of channels is specified as a comma-separated list with 987each element in the list representing either a single channel number or a range 988of the form 989.Dq Li a-b . 990Channel numbers must be in the range 1 to 255 and be permissible 991according to the operating characteristics of the device. 992.It Cm channel Ar number 993Set a single desired channel. 994Channels range from 1 to 255, but the exact selection available 995depends on the region your adaptor was manufactured for. 996Setting 997the channel to 998.Li any , 999or 1000.Cm - 1001will clear any desired channel and, if the device is marked up, 1002force a scan for a channel to operate on. 1003Alternatively the frequency, in megahertz, may be specified 1004instead of the channel number. 1005.Pp 1006When there are several ways to use a channel the channel 1007number/frequency may be appended with attributes to clarify. 1008For example, if a device is capable of operating on channel 6 1009with 802.11n and 802.11g then one can specify that g-only use 1010should be used by specifying ``6:g''. 1011Similarly the channel width can be specified by appending it 1012with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel, 1013These attributes can be combined as in: ``6:ht/40''. 1014The full set of flags specified following a ``:'' are: 1015.Cm a 1016(802.11a), 1017.Cm b 1018(802.11b), 1019.Cm d 1020(Atheros Dynamic Turbo mode), 1021.Cm g 1022(802.11g), 1023.Cm h 1024or 1025.Cm n 1026(802.11n aka HT), 1027.Cm s 1028(Atheros Static Turbo mode), 1029and 1030.Cm t 1031(Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt''). 1032The full set of channel widths following a '/' are: 1033.Cm 5 1034(5MHz aka quarter-rate channel), 1035.Cm 10 1036(10MHz aka half-rate channel), 1037.Cm 20 1038(20MHz mostly for use in specifying ht20), 1039and 1040.Cm 40 1041(40MHz mostly for use in specifying ht40). 1042In addition, 1043a 40MHz HT channel specification may include the location 1044of the extension channel by appending ``+'' or ``-'' for above and below, 1045respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation 1046with the center channel at frequency 2437 and the extension channel above. 1047.It Cm country Ar name 1048Set the country code to use in calculating the regulatory constraints 1049for operation. 1050In particular the set of available channels, how the wireless device 1051will operation on the channels, and the maximum transmit power that 1052can be used on a channel are defined by this setting. 1053Country/Region codes are specified as a 2-character abbreviation 1054defined by ISO 3166 or using a longer, but possibly ambiguous, spelling; 1055e.g. "ES" and "Spain". 1056The set of country codes are taken from /etc/regdomain.xml and can also 1057be viewed with the ``list countries'' request. 1058Note that not all devices support changing the country code from a default 1059setting; typically stored in EEPROM. 1060See also 1061.Cm regdomain , 1062.Cm indoor , 1063.Cm outdoor , 1064and 1065.Cm anywhere . 1066.It Cm dfs 1067Enable Dynamic Frequency Selection (DFS) as specified in 802.11h. 1068DFS embodies several facilities including detection of overlapping 1069radar signals, dynamic transmit power control, and channel selection 1070according to a least-congested criteria. 1071DFS support is mandatory for some 5GHz frequencies in certain 1072locales (e.g. ETSI). 1073By default DFS is enabled according to the regulatory definitions 1074specified in /etc/regdomain.xml and the current country code, regdomain, 1075and channel. 1076Note the underlying device (and driver) must support radar detection 1077for full DFS support to work. 1078To be fully compliant with the local regulatory agency frequencies that 1079require DFS should not be used unless it is fully supported. 1080Use 1081.Fl dfs 1082to disable this functionality for testing. 1083.It Cm dotd 1084Enable support for the 802.11d specification (default). 1085When this support is enabled in station mode, beacon frames that advertise 1086a country code different than the currently configured country code will 1087cause an event to be dispatched to user applications. 1088This event can be used by the station to adopt that country code and 1089operate according to the associated regulatory constraints. 1090When operating as an access point with 802.11d enabled the beacon and 1091probe response frames transmitted will advertise the current regulatory 1092domain settings. 1093To disable 802.11d use 1094.Fl dotd . 1095.It Cm doth 1096Enable 802.11h support including spectrum management. 1097When 802.11h is enabled beacon and probe response frames will have 1098the SpectrumMgt bit set in the capabilities field and 1099country and power constraint information elements will be present. 1100802.11h support also includes handling Channel Switch Announcements (CSA) 1101which are a mechanism to coordinate channel changes by an access point. 1102By default 802.11h is enabled if the device is capable. 1103To disable 802.11h use 1104.Fl doth . 1105.It Cm deftxkey Ar index 1106Set the default key to use for transmission. 1107Typically this is only set when using WEP encryption. 1108Note that you must set a default transmit key 1109for the system to know which key to use in encrypting outbound traffic. 1110The 1111.Cm weptxkey 1112is an alias for this request; it is provided for backwards compatibility. 1113.It Cm dtimperiod Ar period 1114Set the 1115DTIM 1116period for transmitting buffered multicast data frames when 1117operating in ap mode. 1118The 1119.Ar period 1120specifies the number of beacon intervals between DTIM 1121and must be in the range 1 to 15. 1122By default DTIM is 1 (i.e., DTIM occurs at each beacon). 1123.It Cm quiet 1124Enable the use of quiet IE. Hostap will use this to silent other 1125stations to reduce interference for radar detection when 1126operating on 5GHz frequency and doth support is enabled. 1127Use 1128.Fl quiet 1129to disable this functionality. 1130.It Cm quiet_period Ar period 1131Set the QUIET 1132.Ar period 1133to the number of beacon intervals between the start of regularly 1134scheduled quiet intervals defined by Quiet element. 1135.It Cm quiet_count Ar count 1136Set the QUIET 1137.Ar count 1138to the number of TBTTs until the beacon interval during which the 1139next quiet interval shall start. A value of 1 indicates the quiet 1140interval will start during the beacon interval starting at the next 1141TBTT. A value 0 is reserved. 1142.It Cm quiet_offset Ar offset 1143Set the QUIET 1144.Ar offset 1145to the offset of the start of the quiet interval from the TBTT 1146specified by the Quiet count, expressed in TUs. 1147The value of the 1148.Ar offset 1149shall be less than one beacon interval. 1150.It Cm quiet_duration Ar dur 1151Set the QUIET 1152.Ar dur 1153to the duration of the Quiet interval, expressed in TUs. 1154The value should be less than beacon interval. 1155.It Cm dturbo 1156Enable the use of Atheros Dynamic Turbo mode when communicating with 1157another Dynamic Turbo-capable station. 1158Dynamic Turbo mode is an Atheros-specific mechanism by which 1159stations switch between normal 802.11 operation and a ``boosted'' 1160mode in which a 40MHz wide channel is used for communication. 1161Stations using Dynamic Turbo mode operate boosted only when the 1162channel is free of non-dturbo stations; when a non-dturbo station 1163is identified on the channel all stations will automatically drop 1164back to normal operation. 1165By default, Dynamic Turbo mode is not enabled, even if the device is capable. 1166Note that turbo mode (dynamic or static) is only allowed on some 1167channels depending on the regulatory constraints; use the 1168.Cm list chan 1169command to identify the channels where turbo mode may be used. 1170To disable Dynamic Turbo mode use 1171.Fl dturbo . 1172.It Cm dwds 1173Enable Dynamic WDS (DWDS) support. 1174DWDS is a facility by which 4-address traffic can be carried between 1175stations operating in infrastructure mode. 1176A station first associates to an access point and authenticates using 1177normal procedures (e.g. WPA). 1178Then 4-address frames are passed to carry traffic for stations 1179operating on either side of the wireless link. 1180DWDS extends the normal WDS mechanism by leveraging existing security 1181protocols and eliminating static binding. 1182.Pp 1183When DWDS is enabled on an access point 4-address frames received from 1184an authorized station will generate a ``DWDS discovery'' event to user 1185applications. 1186This event should be used to create a WDS interface that is bound 1187to the remote station (and usually plumbed into a bridge). 1188Once the WDS interface is up and running 4-address traffic then logically 1189flows through that interface. 1190.Pp 1191When DWDS is enabled on a station, traffic with a destination address 1192different from the peer station are encapsulated in a 4-address frame 1193and transmitted to the peer. 1194All 4-address traffic uses the security information of the stations 1195(e.g. cryptographic keys). 1196A station is associated using 802.11n facilities may transport 11974-address traffic using these same mechanisms; this depends on available 1198resources and capabilities of the device. 1199The DWDS implementation guards against layer 2 routing loops of 1200multicast traffic. 1201.It Cm ff 1202Enable the use of Atheros Fast Frames when communicating with 1203another Fast Frames-capable station. 1204Fast Frames are an encapsulation technique by which two 802.3 1205frames are transmitted in a single 802.11 frame. 1206This can noticeably improve throughput but requires that the 1207receiving station understand how to decapsulate the frame. 1208Fast frame use is negotiated using the Atheros 802.11 vendor-specific 1209protocol extension so enabling use is safe when communicating with 1210non-Atheros devices. 1211By default, use of fast frames is enabled if the device is capable. 1212To explicitly disable fast frames, use 1213.Fl ff . 1214.It Cm fragthreshold Ar length 1215Set the threshold for which transmitted frames are broken into fragments. 1216The 1217.Ar length 1218argument is the frame size in bytes and must be in the range 256 to 2346. 1219Setting 1220.Ar length 1221to 1222.Li 2346 , 1223.Cm any , 1224or 1225.Cm - 1226disables transmit fragmentation. 1227Not all adapters honor the fragmentation threshold. 1228.It Cm hidessid 1229When operating as an access point, do not broadcast the SSID 1230in beacon frames or respond to probe request frames unless 1231they are directed to the ap (i.e., they include the ap's SSID). 1232By default, the SSID is included in beacon frames and 1233undirected probe request frames are answered. 1234To re-enable the broadcast of the SSID etc., use 1235.Fl hidessid . 1236.It Cm ht 1237Enable use of High Throughput (HT) when using 802.11n (default). 1238The 802.11n specification includes mechanisms for operation 1239on 20MHz and 40MHz wide channels using different signalling mechanisms 1240than specified in 802.11b, 802.11g, and 802.11a. 1241Stations negotiate use of these facilities, termed HT20 and HT40, 1242when they associate. 1243To disable all use of 802.11n use 1244.Fl ht . 1245To disable use of HT20 (e.g. to force only HT40 use) use 1246.Fl ht20 . 1247To disable use of HT40 use 1248.Fl ht40 . 1249.Pp 1250HT configuration is used to ``auto promote'' operation 1251when several choices are available. 1252For example, if a station associates to an 11n-capable access point 1253it controls whether the station uses legacy operation, HT20, or HT40. 1254When an 11n-capable device is setup as an access point and 1255Auto Channel Selection is used to locate a channel to operate on, 1256HT configuration controls whether legacy, HT20, or HT40 operation is setup 1257on the selected channel. 1258If a fixed channel is specified for a station then HT configuration can 1259be given as part of the channel specification; e.g. 6:ht/20 to setup 1260HT20 operation on channel 6. 1261.It Cm htcompat 1262Enable use of compatibility support for pre-802.11n devices (default). 1263The 802.11n protocol specification went through several incompatible iterations. 1264Some vendors implemented 11n support to older specifications that 1265will not interoperate with a purely 11n-compliant station. 1266In particular the information elements included in management frames 1267for old devices are different. 1268When compatibility support is enabled both standard and compatible data 1269will be provided. 1270Stations that associate using the compatibility mechanisms are flagged 1271in ``list sta''. 1272To disable compatibility support use 1273.Fl htcompat . 1274.It Cm htprotmode Ar technique 1275For interfaces operating in 802.11n, use the specified 1276.Ar technique 1277for protecting HT frames in a mixed legacy/HT network. 1278The set of valid techniques is 1279.Cm off , 1280and 1281.Cm rts 1282(RTS/CTS, default). 1283Technique names are case insensitive. 1284.It Cm inact 1285Enable inactivity processing for stations associated to an 1286access point (default). 1287When operating as an access point the 802.11 layer monitors 1288the activity of each associated station. 1289When a station is inactive for 5 minutes it will send several 1290``probe frames'' to see if the station is still present. 1291If no response is received then the station is deauthenticated. 1292Applications that prefer to handle this work can disable this 1293facility by using 1294.Fl inact . 1295.It Cm indoor 1296Set the location to use in calculating regulatory constraints. 1297The location is also advertised in beacon and probe response frames 1298when 802.11d is enabled with 1299.Cm dotd . 1300See also 1301.Cm outdoor , 1302.Cm anywhere , 1303.Cm country , 1304and 1305.Cm regdomain . 1306.It Cm list active 1307Display the list of channels available for use taking into account 1308any restrictions set with the 1309.Cm chanlist 1310directive. 1311See the description of 1312.Cm list chan 1313for more information. 1314.It Cm list caps 1315Display the adaptor's capabilities, including the operating 1316modes supported. 1317.It Cm list chan 1318Display the list of channels available for use. 1319Channels are shown with their IEEE channel number, equivalent 1320frequency, and usage modes. 1321Channels identified as 1322.Ql 11g 1323are also usable in 1324.Ql 11b 1325mode. 1326Channels identified as 1327.Ql 11a Turbo 1328may be used only for Atheros' Static Turbo mode 1329(specified with 1330. Cm mediaopt turbo ) . 1331Channels marked with a 1332.Ql * 1333have a regulatory constraint that they be passively scanned. 1334This means a station is not permitted to transmit on the channel until 1335it identifies the channel is being used for 802.11 communication; 1336typically by hearing a beacon frame from an access point operating 1337on the channel. 1338.Cm list freq 1339is another way of requesting this information. 1340By default a compacted list of channels is displayed; if the 1341.Fl v 1342option is specified then all channels are shown. 1343.It Cm list countries 1344Display the set of country codes and regulatory domains that can be 1345used in regulatory configuration. 1346.It Cm list mac 1347Display the current MAC Access Control List state. 1348Each address is prefixed with a character that indicates the 1349current policy applied to it: 1350.Ql + 1351indicates the address is allowed access, 1352.Ql - 1353indicates the address is denied access, 1354.Ql * 1355indicates the address is present but the current policy open 1356(so the ACL is not consulted). 1357.It Cm list mesh 1358Displays the mesh routing table, used for forwarding packets on a mesh 1359network. 1360.It Cm list regdomain 1361Display the current regulatory settings including the available channels 1362and transmit power caps. 1363.It Cm list roam 1364Display the parameters that govern roaming operation. 1365.It Cm list txparam 1366Display the parameters that govern transmit operation. 1367.It Cm list txpower 1368Display the transmit power caps for each channel. 1369.It Cm list scan 1370Display the access points and/or ad-hoc neighbors 1371located in the vicinity. 1372This information may be updated automatically by the adapter 1373with a 1374.Cm scan 1375request or through background scanning. 1376Depending on the capabilities of the stations the following 1377flags can be included in the output: 1378.Bl -tag -width 3n 1379.It Li A 1380Authorized. 1381Indicates that the station is permitted to send/receive data frames. 1382.It Li E 1383Extended Rate Phy (ERP). 1384Indicates that the station is operating in an 802.11g network 1385using extended transmit rates. 1386.It Li H 1387High Throughput (HT). 1388Indicates that the station is using HT transmit rates. 1389If a `+' follows immediately after then the station associated 1390using deprecated mechanisms supported only when 1391.Cm htcompat 1392is enabled. 1393.It Li P 1394Power Save. 1395Indicates that the station is operating in power save mode. 1396.It Li Q 1397Quality of Service (QoS). 1398Indicates that the station is using QoS encapsulation for 1399data frame. 1400QoS encapsulation is enabled only when WME mode is enabled. 1401.It Li S 1402Short Preamble. 1403Indicates that the station is doing short preamble to optionally 1404improve throughput performance with 802.11g and 802.11b. 1405.It Li T 1406Transitional Security Network (TSN). 1407Indicates that the station associated using TSN; see also 1408.Cm tsn 1409below. 1410.It Li W 1411Wi-Fi Protected Setup (WPS). 1412Indicates that the station associated using WPS. 1413.El 1414.Pp 1415By default interesting information elements captured from the neighboring 1416stations are displayed at the end of each row. 1417Possible elements include: 1418.Cm WME 1419(station supports WME), 1420.Cm WPA 1421(station supports WPA), 1422.Cm WPS 1423(station supports WPS), 1424.Cm RSN 1425(station supports 802.11i/RSN), 1426.Cm HTCAP 1427(station supports 802.11n/HT communication), 1428.Cm ATH 1429(station supports Atheros protocol extensions), 1430.Cm VEN 1431(station supports unknown vendor-specific extensions). 1432If the 1433.Fl v 1434flag is used all the information elements and their 1435contents will be shown. 1436Specifying the 1437.Fl v 1438flag also enables display of long SSIDs. 1439The 1440.Cm list ap 1441command is another way of requesting this information. 1442.It Cm list sta 1443When operating as an access point display the stations that are 1444currently associated. 1445When operating in ad-hoc mode display stations identified as 1446neighbors in the IBSS. 1447When operating in mesh mode display stations identified as 1448neighbors in the MBSS. 1449When operating in station mode display the access point. 1450Capabilities advertised by the stations are described under 1451the 1452.Cm scan 1453request. 1454Depending on the capabilities of the stations the following 1455flags can be included in the output: 1456.Bl -tag -width 3n 1457.It Li A 1458Authorized. 1459Indicates that the station is permitted to send/receive data frames. 1460.It Li E 1461Extended Rate Phy (ERP). 1462Indicates that the station is operating in an 802.11g network 1463using extended transmit rates. 1464.It Li H 1465High Throughput (HT). 1466Indicates that the station is using HT transmit rates. 1467If a `+' follows immediately after then the station associated 1468using deprecated mechanisms supported only when 1469.Cm htcompat 1470is enabled. 1471.It Li P 1472Power Save. 1473Indicates that the station is operating in power save mode. 1474.It Li Q 1475Quality of Service (QoS). 1476Indicates that the station is using QoS encapsulation for 1477data frame. 1478QoS encapsulation is enabled only when WME mode is enabled. 1479.It Li S 1480Short Preamble. 1481Indicates that the station is doing short preamble to optionally 1482improve throughput performance with 802.11g and 802.11b. 1483.It Li T 1484Transitional Security Network (TSN). 1485Indicates that the station associated using TSN; see also 1486.Cm tsn 1487below. 1488.It Li W 1489Wi-Fi Protected Setup (WPS). 1490Indicates that the station associated using WPS. 1491.El 1492.Pp 1493By default information elements received from associated stations 1494are displayed in a short form; the 1495.Fl v 1496flag causes this information to be displayed symbolically. 1497.It Cm list wme 1498Display the current channel parameters to use when operating in WME mode. 1499If the 1500.Fl v 1501option is specified then both channel and BSS parameters are displayed 1502for each AC (first channel, then BSS). 1503When WME mode is enabled for an adaptor this information will be 1504displayed with the regular status; this command is mostly useful 1505for examining parameters when WME mode is disabled. 1506See the description of the 1507.Cm wme 1508directive for information on the various parameters. 1509.It Cm maxretry Ar count 1510Set the maximum number of tries to use in sending unicast frames. 1511The default setting is 6 but drivers may override this with a value 1512they choose. 1513.It Cm mcastrate Ar rate 1514Set the rate for transmitting multicast/broadcast frames. 1515Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s. 1516This rate should be valid for the current operating conditions; 1517if an invalid rate is specified drivers are free to chose an 1518appropriate rate. 1519.It Cm mgtrate Ar rate 1520Set the rate for transmitting management and/or control frames. 1521Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s. 1522.It Cm outdoor 1523Set the location to use in calculating regulatory constraints. 1524The location is also advertised in beacon and probe response frames 1525when 802.11d is enabled with 1526.Cm dotd . 1527See also 1528.Cm anywhere , 1529.Cm country , 1530.Cm indoor , 1531and 1532.Cm regdomain . 1533.It Cm powersave 1534Enable powersave operation. 1535When operating as a client, the station will conserve power by 1536periodically turning off the radio and listening for 1537messages from the access point telling it there are packets waiting. 1538The station must then retrieve the packets. 1539Not all devices support power save operation as a client. 1540The 802.11 specification requires that all access points support 1541power save but some drivers do not. 1542Use 1543.Fl powersave 1544to disable powersave operation when operating as a client. 1545.It Cm powersavesleep Ar sleep 1546Set the desired max powersave sleep time in TU's (1024 usecs). 1547By default the max powersave sleep time is 100 TU's. 1548.It Cm protmode Ar technique 1549For interfaces operating in 802.11g, use the specified 1550.Ar technique 1551for protecting OFDM frames in a mixed 11b/11g network. 1552The set of valid techniques is 1553.Cm off , cts 1554(CTS to self), 1555and 1556.Cm rtscts 1557(RTS/CTS). 1558Technique names are case insensitive. 1559Not all devices support 1560.Cm cts 1561as a protection technique. 1562.It Cm pureg 1563When operating as an access point in 802.11g mode allow only 156411g-capable stations to associate (11b-only stations are not 1565permitted to associate). 1566To allow both 11g and 11b-only stations to associate, use 1567.Fl pureg . 1568.It Cm puren 1569When operating as an access point in 802.11n mode allow only 1570HT-capable stations to associate (legacy stations are not 1571permitted to associate). 1572To allow both HT and legacy stations to associate, use 1573.Fl puren . 1574.It Cm regdomain Ar sku 1575Set the regulatory domain to use in calculating the regulatory constraints 1576for operation. 1577In particular the set of available channels, how the wireless device 1578will operation on the channels, and the maximum transmit power that 1579can be used on a channel are defined by this setting. 1580Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also 1581be viewed with the ``list countries'' request. 1582Note that not all devices support changing the regdomain from a default 1583setting; typically stored in EEPROM. 1584See also 1585.Cm country , 1586.Cm indoor , 1587.Cm outdoor , 1588and 1589.Cm anywhere . 1590.It Cm rifs 1591Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n 1592on an HT channel. 1593Note that RIFS must be supported by both the station and access point 1594for it to be used. 1595To disable RIFS use 1596.Fl rifs . 1597.It Cm roam:rate Ar rate 1598Set the threshold for controlling roaming when operating in a BSS. 1599The 1600.Ar rate 1601parameter specifies the transmit rate in megabits 1602at which roaming should be considered. 1603If the current transmit rate drops below this setting and background scanning 1604is enabled, then the system will check if a more desirable access point is 1605available and switch over to it. 1606The current scan cache contents are used if they are considered 1607valid according to the 1608.Cm scanvalid 1609parameter; otherwise a background scan operation is triggered before 1610any selection occurs. 1611Each channel type has a separate rate threshold; the default values are: 161212 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng). 1613.It Cm roam:rssi Ar rssi 1614Set the threshold for controlling roaming when operating in a BSS. 1615The 1616.Ar rssi 1617parameter specifies the receive signal strength in dBm units 1618at which roaming should be considered. 1619If the current rssi drops below this setting and background scanning 1620is enabled, then the system will check if a more desirable access point is 1621available and switch over to it. 1622The current scan cache contents are used if they are considered 1623valid according to the 1624.Cm scanvalid 1625parameter; otherwise a background scan operation is triggered before 1626any selection occurs. 1627Each channel type has a separate rssi threshold; the default values are 1628all 7 dBm. 1629.It Cm roaming Ar mode 1630When operating as a station, control how the system will 1631behave when communication with the current access point 1632is broken. 1633The 1634.Ar mode 1635argument may be one of 1636.Cm device 1637(leave it to the hardware device to decide), 1638.Cm auto 1639(handle either in the device or the operating system\[em]as appropriate), 1640.Cm manual 1641(do nothing until explicitly instructed). 1642By default, the device is left to handle this if it is 1643capable; otherwise, the operating system will automatically 1644attempt to reestablish communication. 1645Manual mode is used by applications such as 1646.Xr wpa_supplicant 8 1647that want to control the selection of an access point. 1648.It Cm rtsthreshold Ar length 1649Set the threshold for which 1650transmitted frames are preceded by transmission of an 1651RTS 1652control frame. 1653The 1654.Ar length 1655argument 1656is the frame size in bytes and must be in the range 1 to 2346. 1657Setting 1658.Ar length 1659to 1660.Li 2346 , 1661.Cm any , 1662or 1663.Cm - 1664disables transmission of RTS frames. 1665Not all adapters support setting the RTS threshold. 1666.It Cm scan 1667Initiate a scan of neighboring stations, wait for it to complete, and 1668display all stations found. 1669Only the super-user can initiate a scan. 1670See 1671.Cm list scan 1672for information on the display. 1673By default a background scan is done; otherwise a foreground 1674scan is done and the station may roam to a different access point. 1675The 1676.Cm list scan 1677request can be used to show recent scan results without 1678initiating a new scan. 1679.It Cm scanvalid Ar threshold 1680Set the maximum time the scan cache contents are considered valid; 1681i.e. will be used without first triggering a scan operation to 1682refresh the data. 1683The 1684.Ar threshold 1685parameter is specified in seconds and defaults to 60 seconds. 1686The minimum setting for 1687.Ar threshold 1688is 10 seconds. 1689One should take care setting this threshold; if it is set too low 1690then attempts to roam to another access point may trigger unnecessary 1691background scan operations. 1692.It Cm shortgi 1693Enable use of Short Guard Interval when operating in 802.11n 1694on an HT channel. 1695NB: this currently enables Short GI on both HT40 and HT20 channels. 1696To disable Short GI use 1697.Fl shortgi . 1698.It Cm smps 1699Enable use of Static Spatial Multiplexing Power Save (SMPS) 1700when operating in 802.11n. 1701A station operating with Static SMPS maintains only a single 1702receive chain active (this can significantly reduce power consumption). 1703To disable SMPS use 1704.Fl smps . 1705.It Cm smpsdyn 1706Enable use of Dynamic Spatial Multiplexing Power Save (SMPS) 1707when operating in 802.11n. 1708A station operating with Dynamic SMPS maintains only a single 1709receive chain active but switches to multiple receive chains when it 1710receives an RTS frame (this can significantly reduce power consumption). 1711Note that stations cannot distinguish between RTS/CTS intended to 1712enable multiple receive chains and those used for other purposes. 1713To disable SMPS use 1714.Fl smps . 1715.It Cm ssid Ar ssid 1716Set the desired Service Set Identifier (aka network name). 1717The SSID is a string up to 32 characters 1718in length and may be specified as either a normal string or in 1719hexadecimal when preceded by 1720.Ql 0x . 1721Additionally, the SSID may be cleared by setting it to 1722.Ql - . 1723.It Cm tdmaslot Ar slot 1724When operating with TDMA, use the specified 1725.Ar slot 1726configuration. 1727The 1728.Ar slot 1729is a number between 0 and the maximum number of slots in the BSS. 1730Note that a station configured as slot 0 is a master and 1731will broadcast beacon frames advertising the BSS; 1732stations configured to use other slots will always 1733scan to locate a master before they ever transmit. 1734By default 1735.Cm tdmaslot 1736is set to 1. 1737.It Cm tdmaslotcnt Ar cnt 1738When operating with TDMA, setup a BSS with 1739.Ar cnt 1740slots. 1741The slot count may be at most 8. 1742The current implementation is only tested with two stations 1743(i.e. point to point applications). 1744This setting is only meaningful when a station is configured as slot 0; 1745other stations adopt this setting from the BSS they join. 1746By default 1747.Cm tdmaslotcnt 1748is set to 2. 1749.It Cm tdmaslotlen Ar len 1750When operating with TDMA, setup a BSS such that each station has a slot 1751.Ar len 1752microseconds long. 1753The slot length must be at least 150 microseconds (1/8 TU) 1754and no more than 65 milliseconds. 1755Note that setting too small a slot length may result in poor channel 1756bandwidth utilization due to factors such as timer granularity and 1757guard time. 1758This setting is only meaningful when a station is configured as slot 0; 1759other stations adopt this setting from the BSS they join. 1760By default 1761.Cm tdmaslotlen 1762is set to 10 milliseconds. 1763.It Cm tdmabintval Ar intval 1764When operating with TDMA, setup a BSS such that beacons are transmitted every 1765.Ar intval 1766superframes to synchronize the TDMA slot timing. 1767A superframe is defined as the number of slots times the slot length; e.g. 1768a BSS with two slots of 10 milliseconds has a 20 millisecond superframe. 1769The beacon interval may not be zero. 1770A lower setting of 1771.Cm tdmabintval 1772causes the timers to be resynchronized more often; this can be help if 1773significant timer drift is observed. 1774By default 1775.Cm tdmabintval 1776is set to 5. 1777.It Cm tsn 1778When operating as an access point with WPA/802.11i allow legacy 1779stations to associate using static key WEP and open authentication. 1780To disallow legacy station use of WEP, use 1781.Fl tsn . 1782.It Cm txpower Ar power 1783Set the power used to transmit frames. 1784The 1785.Ar power 1786argument is specified in .5 dBm units. 1787Out of range values are truncated. 1788Typically only a few discreet power settings are available and 1789the driver will use the setting closest to the specified value. 1790Not all adapters support changing the transmit power. 1791.It Cm ucastrate Ar rate 1792Set a fixed rate for transmitting unicast frames. 1793Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s. 1794This rate should be valid for the current operating conditions; 1795if an invalid rate is specified drivers are free to chose an 1796appropriate rate. 1797.It Cm wepmode Ar mode 1798Set the desired WEP mode. 1799Not all adapters support all modes. 1800The set of valid modes is 1801.Cm off , on , 1802and 1803.Cm mixed . 1804The 1805.Cm mixed 1806mode explicitly tells the adaptor to allow association with access 1807points which allow both encrypted and unencrypted traffic. 1808On these adapters, 1809.Cm on 1810means that the access point must only allow encrypted connections. 1811On other adapters, 1812.Cm on 1813is generally another name for 1814.Cm mixed . 1815Modes are case insensitive. 1816.It Cm weptxkey Ar index 1817Set the WEP key to be used for transmission. 1818This is the same as setting the default transmission key with 1819.Cm deftxkey . 1820.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key 1821Set the selected WEP key. 1822If an 1823.Ar index 1824is not given, key 1 is set. 1825A WEP key will be either 5 or 13 1826characters (40 or 104 bits) depending on the local network and the 1827capabilities of the adaptor. 1828It may be specified either as a plain 1829string or as a string of hexadecimal digits preceded by 1830.Ql 0x . 1831For maximum portability, hex keys are recommended; 1832the mapping of text keys to WEP encryption is usually driver-specific. 1833In particular, the 1834.Tn Windows 1835drivers do this mapping differently to 1836.Fx . 1837A key may be cleared by setting it to 1838.Ql - . 1839If WEP is supported then there are at least four keys. 1840Some adapters support more than four keys. 1841If that is the case, then the first four keys 1842(1-4) will be the standard temporary keys and any others will be adaptor 1843specific keys such as permanent keys stored in NVRAM. 1844.Pp 1845Note that you must set a default transmit key with 1846.Cm deftxkey 1847for the system to know which key to use in encrypting outbound traffic. 1848.It Cm wme 1849Enable Wireless Multimedia Extensions (WME) support, if available, 1850for the specified interface. 1851WME is a subset of the IEEE 802.11e standard to support the 1852efficient communication of realtime and multimedia data. 1853To disable WME support, use 1854.Fl wme . 1855Another name for this parameter is 1856.Cm wmm . 1857.Pp 1858The following parameters are meaningful only when WME support is in use. 1859Parameters are specified per-AC (Access Category) and 1860split into those that are used by a station when acting 1861as an access point and those for client stations in the BSS. 1862The latter are received from the access point and may not be changed 1863(at the station). 1864The following Access Categories are recognized: 1865.Pp 1866.Bl -tag -width ".Cm AC_BK" -compact 1867.It Cm AC_BE 1868(or 1869.Cm BE ) 1870best effort delivery, 1871.It Cm AC_BK 1872(or 1873.Cm BK ) 1874background traffic, 1875.It Cm AC_VI 1876(or 1877.Cm VI ) 1878video traffic, 1879.It Cm AC_VO 1880(or 1881.Cm VO ) 1882voice traffic. 1883.El 1884.Pp 1885AC parameters are case-insensitive. 1886Traffic classification is done in the operating system using the 1887vlan priority associated with data frames or the 1888ToS (Type of Service) indication in IP-encapsulated frames. 1889If neither information is present, traffic is assigned to the 1890Best Effort (BE) category. 1891.Bl -tag -width indent 1892.It Cm ack Ar ac 1893Set the ACK policy for QoS transmissions by the local station; 1894this controls whether or not data frames transmitted by a station 1895require an ACK response from the receiving station. 1896To disable waiting for an ACK use 1897.Fl ack . 1898This parameter is applied only to the local station. 1899.It Cm acm Ar ac 1900Enable the Admission Control Mandatory (ACM) mechanism 1901for transmissions by the local station. 1902To disable the ACM use 1903.Fl acm . 1904On stations in a BSS this parameter is read-only and indicates 1905the setting received from the access point. 1906NB: ACM is not supported right now. 1907.It Cm aifs Ar ac Ar count 1908Set the Arbitration Inter Frame Spacing (AIFS) 1909channel access parameter to use for transmissions 1910by the local station. 1911On stations in a BSS this parameter is read-only and indicates 1912the setting received from the access point. 1913.It Cm cwmin Ar ac Ar count 1914Set the CWmin channel access parameter to use for transmissions 1915by the local station. 1916On stations in a BSS this parameter is read-only and indicates 1917the setting received from the access point. 1918.It Cm cwmax Ar ac Ar count 1919Set the CWmax channel access parameter to use for transmissions 1920by the local station. 1921On stations in a BSS this parameter is read-only and indicates 1922the setting received from the access point. 1923.It Cm txoplimit Ar ac Ar limit 1924Set the Transmission Opportunity Limit channel access parameter 1925to use for transmissions by the local station. 1926This parameter defines an interval of time when a WME station 1927has the right to initiate transmissions onto the wireless medium. 1928On stations in a BSS this parameter is read-only and indicates 1929the setting received from the access point. 1930.It Cm bss:aifs Ar ac Ar count 1931Set the AIFS channel access parameter to send to stations in a BSS. 1932This parameter is meaningful only when operating in ap mode. 1933.It Cm bss:cwmin Ar ac Ar count 1934Set the CWmin channel access parameter to send to stations in a BSS. 1935This parameter is meaningful only when operating in ap mode. 1936.It Cm bss:cwmax Ar ac Ar count 1937Set the CWmax channel access parameter to send to stations in a BSS. 1938This parameter is meaningful only when operating in ap mode. 1939.It Cm bss:txoplimit Ar ac Ar limit 1940Set the TxOpLimit channel access parameter to send to stations in a BSS. 1941This parameter is meaningful only when operating in ap mode. 1942.El 1943.It Cm wps 1944Enable Wireless Privacy Subscriber support. 1945Note that WPS support requires a WPS-capable supplicant. 1946To disable this function use 1947.Fl wps . 1948.El 1949.Pp 1950The following parameters support an optional access control list 1951feature available with some adapters when operating in ap mode; see 1952.Xr wlan_acl 4 . 1953This facility allows an access point to accept/deny association 1954requests based on the MAC address of the station. 1955Note that this feature does not significantly enhance security 1956as MAC address spoofing is easy to do. 1957.Bl -tag -width indent 1958.It Cm mac:add Ar address 1959Add the specified MAC address to the database. 1960Depending on the policy setting association requests from the 1961specified station will be allowed or denied. 1962.It Cm mac:allow 1963Set the ACL policy to permit association only by 1964stations registered in the database. 1965.It Cm mac:del Ar address 1966Delete the specified MAC address from the database. 1967.It Cm mac:deny 1968Set the ACL policy to deny association only by 1969stations registered in the database. 1970.It Cm mac:kick Ar address 1971Force the specified station to be deauthenticated. 1972This typically is done to block a station after updating the 1973address database. 1974.It Cm mac:open 1975Set the ACL policy to allow all stations to associate. 1976.It Cm mac:flush 1977Delete all entries in the database. 1978.It Cm mac:radius 1979Set the ACL policy to permit association only by 1980stations approved by a RADIUS server. 1981Note that this feature requires the 1982.Xr hostapd 8 1983program be configured to do the right thing 1984as it handles the RADIUS processing 1985(and marks stations as authorized). 1986.El 1987.Pp 1988The following parameters are related to a wireless interface operating in mesh 1989mode: 1990.Bl -tag -width indent 1991.It Cm meshid Ar meshid 1992Set the desired Mesh Identifier. 1993The Mesh ID is a string up to 32 characters in length. 1994A mesh interface must have a Mesh Identifier specified 1995to reach an operational state. 1996.It Cm meshttl Ar ttl 1997Set the desired ``time to live'' for mesh forwarded packets; 1998this is the number of hops a packet may be forwarded before 1999it is discarded. 2000The default setting for 2001.Cm meshttl 2002is 31. 2003.It Cm meshpeering 2004Enable or disable peering with neighbor mesh stations. 2005Stations must peer before any data packets can be exchanged. 2006By default 2007.Cm meshpeering 2008is enabled. 2009.It Cm meshforward 2010Enable or disable forwarding packets by a mesh interface. 2011By default 2012.Cm meshforward 2013is enabled. 2014.It Cm meshgate 2015This attribute specifies whether or not the mesh STA activates mesh gate 2016announcements. 2017By default 2018.Cm meshgate 2019is disabled. 2020.It Cm meshmetric Ar protocol 2021Set the specified 2022.Ar protocol 2023as the link metric protocol used on a mesh network. 2024The default protocol is called 2025.Ar AIRTIME . 2026The mesh interface will restart after changing this setting. 2027.It Cm meshpath Ar protocol 2028Set the specified 2029.Ar protocol 2030as the path selection protocol used on a mesh network. 2031The only available protocol at the moment is called 2032.Ar HWMP 2033(Hybrid Wireless Mesh Protocol). 2034The mesh interface will restart after changing this setting. 2035.It Cm hwmprootmode Ar mode 2036Stations on a mesh network can operate as ``root nodes.'' 2037Root nodes try to find paths to all mesh nodes and advertise themselves 2038regularly. 2039When there is a root mesh node on a network, other mesh nodes can setup 2040paths between themselves faster because they can use the root node 2041to find the destination. 2042This path may not be the best, but on-demand 2043routing will eventually find the best path. 2044The following modes are recognized: 2045.Pp 2046.Bl -tag -width ".Cm PROACTIVE" -compact 2047.It Cm DISABLED 2048Disable root mode. 2049.It Cm NORMAL 2050Send broadcast path requests every two seconds. 2051Nodes on the mesh without a path to this root mesh station with try to 2052discover a path to us. 2053.It Cm PROACTIVE 2054Send broadcast path requests every two seconds and every node must reply with 2055with a path reply even if it already has a path to this root mesh station. 2056.It Cm RANN 2057Send broadcast root announcement (RANN) frames. 2058Nodes on the mesh without a path to this root mesh station with try to 2059discover a path to us. 2060.El 2061By default 2062.Cm hwmprootmode 2063is set to 2064.Ar DISABLED . 2065.It Cm hwmpmaxhops Ar cnt 2066Set the maximum number of hops allowed in an HMWP path to 2067.Ar cnt . 2068The default setting for 2069.Cm hwmpmaxhops 2070is 31. 2071.El 2072.Pp 2073The following parameters are for compatibility with other systems: 2074.Bl -tag -width indent 2075.It Cm nwid Ar ssid 2076Another name for the 2077.Cm ssid 2078parameter. 2079Included for 2080.Nx 2081compatibility. 2082.It Cm stationname Ar name 2083Set the name of this station. 2084The station name is not part of the IEEE 802.11 2085protocol though some interfaces support it. 2086As such it only 2087seems to be meaningful to identical or virtually identical equipment. 2088Setting the station name is identical in syntax to setting the SSID. 2089One can also use 2090.Cm station 2091for 2092.Bsx 2093compatibility. 2094.It Cm wep 2095Another way of saying 2096.Cm wepmode on . 2097Included for 2098.Bsx 2099compatibility. 2100.It Fl wep 2101Another way of saying 2102.Cm wepmode off . 2103Included for 2104.Bsx 2105compatibility. 2106.It Cm nwkey key 2107Another way of saying: 2108.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" . 2109Included for 2110.Nx 2111compatibility. 2112.It Cm nwkey Xo 2113.Sm off 2114.Ar n : k1 , k2 , k3 , k4 2115.Sm on 2116.Xc 2117Another way of saying 2118.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" . 2119Included for 2120.Nx 2121compatibility. 2122.It Fl nwkey 2123Another way of saying 2124.Cm wepmode off . 2125Included for 2126.Nx 2127compatibility. 2128.El 2129.Pp 2130The following parameters are specific to bridge interfaces: 2131.Bl -tag -width indent 2132.It Cm addm Ar interface 2133Add the interface named by 2134.Ar interface 2135as a member of the bridge. 2136The interface is put into promiscuous mode 2137so that it can receive every packet sent on the network. 2138.It Cm deletem Ar interface 2139Remove the interface named by 2140.Ar interface 2141from the bridge. 2142Promiscuous mode is disabled on the interface when 2143it is removed from the bridge. 2144.It Cm maxaddr Ar size 2145Set the size of the bridge address cache to 2146.Ar size . 2147The default is 2000 entries. 2148.It Cm timeout Ar seconds 2149Set the timeout of address cache entries to 2150.Ar seconds 2151seconds. 2152If 2153.Ar seconds 2154is zero, then address cache entries will not be expired. 2155The default is 1200 seconds. 2156.It Cm addr 2157Display the addresses that have been learned by the bridge. 2158.It Cm static Ar interface-name Ar address 2159Add a static entry into the address cache pointing to 2160.Ar interface-name . 2161Static entries are never aged out of the cache or re-placed, even if the 2162address is seen on a different interface. 2163.It Cm deladdr Ar address 2164Delete 2165.Ar address 2166from the address cache. 2167.It Cm flush 2168Delete all dynamically-learned addresses from the address cache. 2169.It Cm flushall 2170Delete all addresses, including static addresses, from the address cache. 2171.It Cm discover Ar interface 2172Mark an interface as a 2173.Dq discovering 2174interface. 2175When the bridge has no address cache entry 2176(either dynamic or static) 2177for the destination address of a packet, 2178the bridge will forward the packet to all 2179member interfaces marked as 2180.Dq discovering . 2181This is the default for all interfaces added to a bridge. 2182.It Cm -discover Ar interface 2183Clear the 2184.Dq discovering 2185attribute on a member interface. 2186For packets without the 2187.Dq discovering 2188attribute, the only packets forwarded on the interface are broadcast 2189or multicast packets and packets for which the destination address 2190is known to be on the interface's segment. 2191.It Cm learn Ar interface 2192Mark an interface as a 2193.Dq learning 2194interface. 2195When a packet arrives on such an interface, the source 2196address of the packet is entered into the address cache as being a 2197destination address on the interface's segment. 2198This is the default for all interfaces added to a bridge. 2199.It Cm -learn Ar interface 2200Clear the 2201.Dq learning 2202attribute on a member interface. 2203.It Cm sticky Ar interface 2204Mark an interface as a 2205.Dq sticky 2206interface. 2207Dynamically learned address entries are treated at static once entered into 2208the cache. 2209Sticky entries are never aged out of the cache or replaced, even if the 2210address is seen on a different interface. 2211.It Cm -sticky Ar interface 2212Clear the 2213.Dq sticky 2214attribute on a member interface. 2215.It Cm private Ar interface 2216Mark an interface as a 2217.Dq private 2218interface. 2219A private interface does not forward any traffic to any other port that is also 2220a private interface. 2221.It Cm -private Ar interface 2222Clear the 2223.Dq private 2224attribute on a member interface. 2225.It Cm span Ar interface 2226Add the interface named by 2227.Ar interface 2228as a span port on the bridge. 2229Span ports transmit a copy of every frame received by the bridge. 2230This is most useful for snooping a bridged network passively on 2231another host connected to one of the span ports of the bridge. 2232.It Cm -span Ar interface 2233Delete the interface named by 2234.Ar interface 2235from the list of span ports of the bridge. 2236.It Cm stp Ar interface 2237Enable Spanning Tree protocol on 2238.Ar interface . 2239The 2240.Xr if_bridge 4 2241driver has support for the IEEE 802.1D Spanning Tree protocol (STP). 2242Spanning Tree is used to detect and remove loops in a network topology. 2243.It Cm -stp Ar interface 2244Disable Spanning Tree protocol on 2245.Ar interface . 2246This is the default for all interfaces added to a bridge. 2247.It Cm edge Ar interface 2248Set 2249.Ar interface 2250as an edge port. 2251An edge port connects directly to end stations cannot create bridging 2252loops in the network, this allows it to transition straight to forwarding. 2253.It Cm -edge Ar interface 2254Disable edge status on 2255.Ar interface . 2256.It Cm autoedge Ar interface 2257Allow 2258.Ar interface 2259to automatically detect edge status. 2260This is the default for all interfaces added to a bridge. 2261.It Cm -autoedge Ar interface 2262Disable automatic edge status on 2263.Ar interface . 2264.It Cm ptp Ar interface 2265Set the 2266.Ar interface 2267as a point to point link. 2268This is required for straight transitions to forwarding and 2269should be enabled on a direct link to another RSTP capable switch. 2270.It Cm -ptp Ar interface 2271Disable point to point link status on 2272.Ar interface . 2273This should be disabled for a half duplex link and for an interface 2274connected to a shared network segment, 2275like a hub or a wireless network. 2276.It Cm autoptp Ar interface 2277Automatically detect the point to point status on 2278.Ar interface 2279by checking the full duplex link status. 2280This is the default for interfaces added to the bridge. 2281.It Cm -autoptp Ar interface 2282Disable automatic point to point link detection on 2283.Ar interface . 2284.It Cm maxage Ar seconds 2285Set the time that a Spanning Tree protocol configuration is valid. 2286The default is 20 seconds. 2287The minimum is 6 seconds and the maximum is 40 seconds. 2288.It Cm fwddelay Ar seconds 2289Set the time that must pass before an interface begins forwarding 2290packets when Spanning Tree is enabled. 2291The default is 15 seconds. 2292The minimum is 4 seconds and the maximum is 30 seconds. 2293.It Cm hellotime Ar seconds 2294Set the time between broadcasting of Spanning Tree protocol 2295configuration messages. 2296The hello time may only be changed when operating in legacy stp mode. 2297The default is 2 seconds. 2298The minimum is 1 second and the maximum is 2 seconds. 2299.It Cm priority Ar value 2300Set the bridge priority for Spanning Tree. 2301The default is 32768. 2302The minimum is 0 and the maximum is 61440. 2303.It Cm proto Ar value 2304Set the Spanning Tree protocol. 2305The default is rstp. 2306The available options are stp and rstp. 2307.It Cm holdcnt Ar value 2308Set the transmit hold count for Spanning Tree. 2309This is the number of packets transmitted before being rate limited. 2310The default is 6. 2311The minimum is 1 and the maximum is 10. 2312.It Cm ifpriority Ar interface Ar value 2313Set the Spanning Tree priority of 2314.Ar interface 2315to 2316.Ar value . 2317The default is 128. 2318The minimum is 0 and the maximum is 240. 2319.It Cm ifpathcost Ar interface Ar value 2320Set the Spanning Tree path cost of 2321.Ar interface 2322to 2323.Ar value . 2324The default is calculated from the link speed. 2325To change a previously selected path cost back to automatic, set the 2326cost to 0. 2327The minimum is 1 and the maximum is 200000000. 2328.It Cm ifmaxaddr Ar interface Ar size 2329Set the maximum number of hosts allowed from an interface, packets with unknown 2330source addresses are dropped until an existing host cache entry expires or is 2331removed. 2332Set to 0 to disable. 2333.El 2334.Pp 2335The following parameters are specific to lagg interfaces: 2336.Bl -tag -width indent 2337.It Cm laggport Ar interface 2338Add the interface named by 2339.Ar interface 2340as a port of the aggregation interface. 2341.It Cm -laggport Ar interface 2342Remove the interface named by 2343.Ar interface 2344from the aggregation interface. 2345.It Cm laggproto Ar proto 2346Set the aggregation protocol. 2347The default is failover. 2348The available options are failover, fec, lacp, loadbalance, roundrobin and 2349none. 2350.It Cm lagghash Ar option Ns Oo , Ns Ar option Oc 2351Set the packet layers to hash for aggregation protocols which load balance. 2352The default is 2353.Dq l2,l3,l4 . 2354The options can be combined using commas. 2355.Pp 2356.Bl -tag -width ".Cm l2" -compact 2357.It Cm l2 2358src/dst mac address and optional vlan number. 2359.It Cm l3 2360src/dst address for IPv4 or IPv6. 2361.It Cm l4 2362src/dst port for TCP/UDP/SCTP. 2363.El 2364.Pp 2365.El 2366.Pp 2367The following parameters are specific to IP tunnel interfaces, 2368.Xr gif 4 : 2369.Bl -tag -width indent 2370.It Cm tunnel Ar src_addr dest_addr 2371Configure the physical source and destination address for IP tunnel 2372interfaces. 2373The arguments 2374.Ar src_addr 2375and 2376.Ar dest_addr 2377are interpreted as the outer source/destination for the encapsulating 2378IPv4/IPv6 header. 2379.It Fl tunnel 2380Unconfigure the physical source and destination address for IP tunnel 2381interfaces previously configured with 2382.Cm tunnel . 2383.It Cm deletetunnel 2384Another name for the 2385.Fl tunnel 2386parameter. 2387.It Cm accept_rev_ethip_ver 2388Set a flag to accept both correct EtherIP packets and ones 2389with reversed version field. Enabled by default. 2390This is for backward compatibility with 2391.Fx 6.1 , 23926.2, 6.3, 7.0, and 7.1. 2393.It Cm -accept_rev_ethip_ver 2394Clear a flag 2395.Cm accept_rev_ethip_ver . 2396.It Cm send_rev_ethip_ver 2397Set a flag to send EtherIP packets with reversed version 2398field intentionally. Disabled by default. 2399This is for backward compatibility with 2400.Fx 6.1 , 24016.2, 6.3, 7.0, and 7.1. 2402.It Cm -send_rev_ethip_ver 2403Clear a flag 2404.Cm send_rev_ethip_ver . 2405.El 2406.Pp 2407The following parameters are specific to GRE tunnel interfaces, 2408.Xr gre 4 : 2409.Bl -tag -width indent 2410.It Cm grekey Ar key 2411Configure the GRE key to be used for outgoing packets. 2412Note that 2413.Xr gre 4 will always accept GRE packets with invalid or absent keys. 2414This command will result in a four byte MTU reduction on the interface. 2415.El 2416.Pp 2417The following parameters are specific to 2418.Xr pfsync 4 2419interfaces: 2420.Bl -tag -width indent 2421.It Cm syncdev Ar iface 2422Use the specified interface 2423to send and receive pfsync state synchronisation messages. 2424.It Fl syncdev 2425Stop sending pfsync state synchronisation messages over the network. 2426.It Cm syncpeer Ar peer_address 2427Make the pfsync link point-to-point rather than using 2428multicast to broadcast the state synchronisation messages. 2429The peer_address is the IP address of the other host taking part in 2430the pfsync cluster. 2431.It Fl syncpeer 2432Broadcast the packets using multicast. 2433.It Cm maxupd Ar n 2434Set the maximum number of updates for a single state which 2435can be collapsed into one. 2436This is an 8-bit number; the default value is 128. 2437.It Cm defer 2438Defer transmission of the first packet in a state until a peer has 2439acknowledged that the associated state has been inserted. 2440.It Fl defer 2441Do not defer the first packet in a state. 2442This is the default. 2443.El 2444.Pp 2445The following parameters are specific to 2446.Xr vlan 4 2447interfaces: 2448.Bl -tag -width indent 2449.It Cm vlan Ar vlan_tag 2450Set the VLAN tag value to 2451.Ar vlan_tag . 2452This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q 2453VLAN header for packets sent from the 2454.Xr vlan 4 2455interface. 2456Note that 2457.Cm vlan 2458and 2459.Cm vlandev 2460must both be set at the same time. 2461.It Cm vlandev Ar iface 2462Associate the physical interface 2463.Ar iface 2464with a 2465.Xr vlan 4 2466interface. 2467Packets transmitted through the 2468.Xr vlan 4 2469interface will be 2470diverted to the specified physical interface 2471.Ar iface 2472with 802.1Q VLAN encapsulation. 2473Packets with 802.1Q encapsulation received 2474by the parent interface with the correct VLAN Identifier will be diverted to 2475the associated 2476.Xr vlan 4 2477pseudo-interface. 2478The 2479.Xr vlan 4 2480interface is assigned a 2481copy of the parent interface's flags and the parent's ethernet address. 2482The 2483.Cm vlandev 2484and 2485.Cm vlan 2486must both be set at the same time. 2487If the 2488.Xr vlan 4 2489interface already has 2490a physical interface associated with it, this command will fail. 2491To 2492change the association to another physical interface, the existing 2493association must be cleared first. 2494.Pp 2495Note: if the hardware tagging capability 2496is set on the parent interface, the 2497.Xr vlan 4 2498pseudo 2499interface's behavior changes: 2500the 2501.Xr vlan 4 2502interface recognizes that the 2503parent interface supports insertion and extraction of VLAN tags on its 2504own (usually in firmware) and that it should pass packets to and from 2505the parent unaltered. 2506.It Fl vlandev Op Ar iface 2507If the driver is a 2508.Xr vlan 4 2509pseudo device, disassociate the parent interface from it. 2510This breaks the link between the 2511.Xr vlan 4 2512interface and its parent, 2513clears its VLAN Identifier, flags and its link address and shuts the interface 2514down. 2515The 2516.Ar iface 2517argument is useless and hence deprecated. 2518.El 2519.Pp 2520The following parameters are used to configure 2521.Xr carp 4 2522protocol on an interface: 2523.Bl -tag -width indent 2524.It Cm vhid Ar n 2525Set the virtual host ID. 2526This is a required setting to initiate 2527.Xr carp 4 . 2528If the virtual host ID doesn't exist yet, it is created and attached to the 2529interface, otherwise configuration of an existing vhid is adjusted. 2530If the 2531.Cm vhid 2532keyword is supplied along with an 2533.Dq inet6 2534or 2535.Dq inet 2536address, then this address is configured to be run under control of the 2537specified vhid. 2538Whenever a last address that refers to a particular vhid is removed from an 2539interface, the vhid is automatically removed from interface and destroyed. 2540Any other configuration parameters for the 2541.Xr carp 4 2542protocol should be supplied along with the 2543.Cm vhid 2544keyword. 2545Acceptable values for vhid are 1 to 255. 2546.It Cm advbase Ar seconds 2547Specifies the base of the advertisement interval in seconds. 2548The acceptable values are 1 to 255. 2549The default value is 1. 2550.It Cm advskew Ar interval 2551Specifies the skew to add to the base advertisement interval to 2552make one host advertise slower than another host. 2553It is specified in 1/256 of seconds. 2554The acceptable values are 1 to 254. 2555The default value is 0. 2556.It Cm pass Ar phrase 2557Set the authentication key to 2558.Ar phrase . 2559.It Cm state Ar MASTER|BACKUP 2560Forcibly change state of a given vhid. 2561.El 2562.Pp 2563The 2564.Nm 2565utility displays the current configuration for a network interface 2566when no optional parameters are supplied. 2567If a protocol family is specified, 2568.Nm 2569will report only the details specific to that protocol family. 2570.Pp 2571If the 2572.Fl m 2573flag is passed before an interface name, 2574.Nm 2575will display the capability list and all 2576of the supported media for the specified interface. 2577If 2578.Fl L 2579flag is supplied, address lifetime is displayed for IPv6 addresses, 2580as time offset string. 2581.Pp 2582Optionally, the 2583.Fl a 2584flag may be used instead of an interface name. 2585This flag instructs 2586.Nm 2587to display information about all interfaces in the system. 2588The 2589.Fl d 2590flag limits this to interfaces that are down, and 2591.Fl u 2592limits this to interfaces that are up. 2593When no arguments are given, 2594.Fl a 2595is implied. 2596.Pp 2597The 2598.Fl l 2599flag may be used to list all available interfaces on the system, with 2600no other additional information. 2601Use of this flag is mutually exclusive 2602with all other flags and commands, except for 2603.Fl d 2604(only list interfaces that are down) 2605and 2606.Fl u 2607(only list interfaces that are up). 2608.Pp 2609The 2610.Fl v 2611flag may be used to get more verbose status for an interface. 2612.Pp 2613The 2614.Fl C 2615flag may be used to list all of the interface cloners available on 2616the system, with no additional information. 2617Use of this flag is mutually exclusive with all other flags and commands. 2618.Pp 2619The 2620.Fl k 2621flag causes keying information for the interface, if available, to be 2622printed. 2623For example, the values of 802.11 WEP keys and 2624.Xr carp 4 2625passphrases will be printed, if accessible to the current user. 2626This information is not printed by default, as it may be considered 2627sensitive. 2628.Pp 2629If the network interface driver is not present in the kernel then 2630.Nm 2631will attempt to load it. 2632The 2633.Fl n 2634flag disables this behavior. 2635.Pp 2636Only the super-user may modify the configuration of a network interface. 2637.Sh NOTES 2638The media selection system is relatively new and only some drivers support 2639it (or have need for it). 2640.Sh EXAMPLES 2641Assign the IPv4 address 2642.Li 192.0.2.10 , 2643with a network mask of 2644.Li 255.255.255.0 , 2645to the interface 2646.Li fxp0 : 2647.Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0 2648.Pp 2649Add the IPv4 address 2650.Li 192.0.2.45 , 2651with the CIDR network prefix 2652.Li /28 , 2653to the interface 2654.Li ed0 , 2655using 2656.Cm add 2657as a synonym for the canonical form of the option 2658.Cm alias : 2659.Dl # ifconfig ed0 inet 192.0.2.45/28 add 2660.Pp 2661Remove the IPv4 address 2662.Li 192.0.2.45 2663from the interface 2664.Li ed0 : 2665.Dl # ifconfig ed0 inet 192.0.2.45 -alias 2666.Pp 2667Enable IPv6 functionality of the interface: 2668.Dl # ifconfig em0 inet6 -ifdisabled 2669.Pp 2670Add the IPv6 address 2671.Li 2001:DB8:DBDB::123/48 2672to the interface 2673.Li em0 : 2674.Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias 2675Note that lower case hexadecimal IPv6 addresses are acceptable. 2676.Pp 2677Remove the IPv6 address added in the above example, 2678using the 2679.Li / 2680character as shorthand for the network prefix, 2681and using 2682.Cm delete 2683as a synonym for the canonical form of the option 2684.Fl alias : 2685.Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete 2686.Pp 2687Configure a single CARP redundant address on igb0, and then switch it 2688to be master: 2689.Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar 2690.Dl # ifconfig igb0 vhid 1 state master 2691.Pp 2692Configure the interface 2693.Li xl0 , 2694to use 100baseTX, full duplex Ethernet media options: 2695.Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex 2696.Pp 2697Label the em0 interface as an uplink: 2698.Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&" 2699.Pp 2700Create the software network interface 2701.Li gif1 : 2702.Dl # ifconfig gif1 create 2703.Pp 2704Destroy the software network interface 2705.Li gif1 : 2706.Dl # ifconfig gif1 destroy 2707.Pp 2708Display available wireless networks using 2709.Li wlan0 : 2710.Dl # ifconfig wlan0 list scan 2711.Sh DIAGNOSTICS 2712Messages indicating the specified interface does not exist, the 2713requested address is unknown, or the user is not privileged and 2714tried to alter an interface's configuration. 2715.Sh SEE ALSO 2716.Xr netstat 1 , 2717.Xr carp 4 , 2718.Xr gif 4 , 2719.Xr netintro 4 , 2720.Xr pfsync 4 , 2721.Xr polling 4 , 2722.Xr vlan 4 , 2723.\" .Xr eon 5 , 2724.Xr rc 8 , 2725.Xr routed 8 , 2726.Xr jail 8 , 2727.Xr sysctl 8 2728.Sh HISTORY 2729The 2730.Nm 2731utility appeared in 2732.Bx 4.2 . 2733.Sh BUGS 2734Basic IPv6 node operation requires a link-local address on each 2735interface configured for IPv6. 2736Normally, such an address is automatically configured by the 2737kernel on each interface added to the system or enabled; this behavior may 2738be disabled by setting per-interface flag 2739.Cm -auto_linklocal . 2740The default value of this flag is 1 and can be disabled by using the sysctl 2741MIB variable 2742.Va net.inet6.ip6.auto_linklocal . 2743.Pp 2744Do not configure IPv6 addresses with no link-local address by using 2745.Nm . 2746It can result in unexpected behaviors of the kernel. 2747