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 October 21, 2013 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 no_prefer_iface 720Set a flag to not prefer address on the interface as candidates of the 721source address for outgoing packets, even when the interface is 722outgoing interface. 723.It Cm -no_prefer_iface 724Clear a flag 725.Cm no_prefer_iface . 726.El 727.Pp 728The following parameters are specific to cloning 729IEEE 802.11 wireless interfaces with the 730.Cm create 731request: 732.Bl -tag -width indent 733.It Cm wlandev Ar device 734Use 735.Ar device 736as the parent for the cloned device. 737.It Cm wlanmode Ar mode 738Specify the operating mode for this cloned device. 739.Ar mode 740is one of 741.Cm sta , 742.Cm ahdemo 743(or 744.Cm adhoc-demo ), 745.Cm ibss , 746(or 747.Cm adhoc ), 748.Cm ap , 749(or 750.Cm hostap ), 751.Cm wds , 752.Cm tdma , 753.Cm mesh , 754and 755.Cm monitor . 756The operating mode of a cloned interface cannot be changed. 757The 758.Cm tdma 759mode is actually implemented as an 760.Cm adhoc-demo 761interface with special properties. 762.It Cm wlanbssid Ar bssid 763The 802.11 mac address to use for the bssid. 764This must be specified at create time for a legacy 765.Cm wds 766device. 767.It Cm wlanaddr Ar address 768The local mac address. 769If this is not specified then a mac address will automatically be assigned 770to the cloned device. 771Typically this address is the same as the address of the parent device 772but if the 773.Cm bssid 774parameter is specified then the driver will craft a unique address for 775the device (if supported). 776.It Cm wdslegacy 777Mark a 778.Cm wds 779device as operating in ``legacy mode''. 780Legacy 781.Cm wds 782devices have a fixed peer relationship and do not, for example, roam 783if their peer stops communicating. 784For completeness a Dynamic WDS (DWDS) interface may marked as 785.Fl wdslegacy . 786.It Cm bssid 787Request a unique local mac address for the cloned device. 788This is only possible if the device supports multiple mac addresses. 789To force use of the parent's mac address use 790.Fl bssid . 791.It Cm beacons 792Mark the cloned interface as depending on hardware support to 793track received beacons. 794To have beacons tracked in software use 795.Fl beacons . 796For 797.Cm hostap 798mode 799.Fl beacons 800can also be used to indicate no beacons should 801be transmitted; this can be useful when creating a WDS configuration but 802.Cm wds 803interfaces can only be created as companions to an access point. 804.El 805.Pp 806The following parameters are specific to IEEE 802.11 wireless interfaces 807cloned with a 808.Cm create 809operation: 810.Bl -tag -width indent 811.It Cm ampdu 812Enable sending and receiving AMPDU frames when using 802.11n (default). 813The 802.11n specification states a compliant station must be capable 814of receiving AMPDU frames but transmission is optional. 815Use 816.Fl ampdu 817to disable all use of AMPDU with 802.11n. 818For testing and/or to work around interoperability problems one can use 819.Cm ampdutx 820and 821.Cm ampdurx 822to control use of AMPDU in one direction. 823.It Cm ampdudensity Ar density 824Set the AMPDU density parameter used when operating with 802.11n. 825This parameter controls the inter-packet gap for AMPDU frames. 826The sending device normally controls this setting but a receiving station 827may request wider gaps. 828Legal values for 829.Ar density 830are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds). 831A value of 832.Cm - 833is treated the same as 0. 834.It Cm ampdulimit Ar limit 835Set the limit on packet size for receiving AMPDU frames when operating 836with 802.11n. 837Legal values for 838.Ar limit 839are 8192, 16384, 32768, and 65536 but one can also specify 840just the unique prefix: 8, 16, 32, 64. 841Note the sender may limit the size of AMPDU frames to be less 842than the maximum specified by the receiving station. 843.It Cm amsdu 844Enable sending and receiving AMSDU frames when using 802.11n. 845By default AMSDU is received but not transmitted. 846Use 847.Fl amsdu 848to disable all use of AMSDU with 802.11n. 849For testing and/or to work around interoperability problems one can use 850.Cm amsdutx 851and 852.Cm amsdurx 853to control use of AMSDU in one direction. 854.It Cm amsdulimit Ar limit 855Set the limit on packet size for sending and receiving AMSDU frames 856when operating with 802.11n. 857Legal values for 858.Ar limit 859are 7935 and 3839 (bytes). 860Note the sender may limit the size of AMSDU frames to be less 861than the maximum specified by the receiving station. 862Note also that devices are not required to support the 7935 limit, 863only 3839 is required by the specification and the larger value 864may require more memory to be dedicated to support functionality 865that is rarely used. 866.It Cm apbridge 867When operating as an access point, pass packets between 868wireless clients directly (default). 869To instead let them pass up through the 870system and be forwarded using some other mechanism, use 871.Fl apbridge . 872Disabling the internal bridging 873is useful when traffic is to be processed with 874packet filtering. 875.It Cm authmode Ar mode 876Set the desired authentication mode in infrastructure mode. 877Not all adapters support all modes. 878The set of 879valid modes is 880.Cm none , open , shared 881(shared key), 882.Cm 8021x 883(IEEE 802.1x), 884and 885.Cm wpa 886(IEEE WPA/WPA2/802.11i). 887The 888.Cm 8021x 889and 890.Cm wpa 891modes are only useful when using an authentication service 892(a supplicant for client operation or an authenticator when 893operating as an access point). 894Modes are case insensitive. 895.It Cm bgscan 896Enable background scanning when operating as a station. 897Background scanning is a technique whereby a station associated to 898an access point will temporarily leave the channel to scan for 899neighboring stations. 900This allows a station to maintain a cache of nearby access points 901so that roaming between access points can be done without 902a lengthy scan operation. 903Background scanning is done only when a station is not busy and 904any outbound traffic will cancel a scan operation. 905Background scanning should never cause packets to be lost though 906there may be some small latency if outbound traffic interrupts a 907scan operation. 908By default background scanning is enabled if the device is capable. 909To disable background scanning, use 910.Fl bgscan . 911Background scanning is controlled by the 912.Cm bgscanidle 913and 914.Cm bgscanintvl 915parameters. 916Background scanning must be enabled for roaming; this is an artifact 917of the current implementation and may not be required in the future. 918.It Cm bgscanidle Ar idletime 919Set the minimum time a station must be idle (not transmitting or 920receiving frames) before a background scan is initiated. 921The 922.Ar idletime 923parameter is specified in milliseconds. 924By default a station must be idle at least 250 milliseconds before 925a background scan is initiated. 926The idle time may not be set to less than 100 milliseconds. 927.It Cm bgscanintvl Ar interval 928Set the interval at which background scanning is attempted. 929The 930.Ar interval 931parameter is specified in seconds. 932By default a background scan is considered every 300 seconds (5 minutes). 933The 934.Ar interval 935may not be set to less than 15 seconds. 936.It Cm bintval Ar interval 937Set the interval at which beacon frames are sent when operating in 938ad-hoc or ap mode. 939The 940.Ar interval 941parameter is specified in TU's (1024 usecs). 942By default beacon frames are transmitted every 100 TU's. 943.It Cm bmissthreshold Ar count 944Set the number of consecutive missed beacons at which the station 945will attempt to roam (i.e., search for a new access point). 946The 947.Ar count 948parameter must be in the range 1 to 255; though the 949upper bound may be reduced according to device capabilities. 950The default threshold is 7 consecutive missed beacons; but 951this may be overridden by the device driver. 952Another name for the 953.Cm bmissthreshold 954parameter is 955.Cm bmiss . 956.It Cm bssid Ar address 957Specify the MAC address of the access point to use when operating 958as a station in a BSS network. 959This overrides any automatic selection done by the system. 960To disable a previously selected access point, supply 961.Cm any , none , 962or 963.Cm - 964for the address. 965This option is useful when more than one access point uses the same SSID. 966Another name for the 967.Cm bssid 968parameter is 969.Cm ap . 970.It Cm burst 971Enable packet bursting. 972Packet bursting is a transmission technique whereby the wireless 973medium is acquired once to send multiple frames and the interframe 974spacing is reduced. 975This technique can significantly increase throughput by reducing 976transmission overhead. 977Packet bursting is supported by the 802.11e QoS specification 978and some devices that do not support QoS may still be capable. 979By default packet bursting is enabled if a device is capable 980of doing it. 981To disable packet bursting, use 982.Fl burst . 983.It Cm chanlist Ar channels 984Set the desired channels to use when scanning for access 985points, neighbors in an IBSS network, or looking for unoccupied 986channels when operating as an access point. 987The set of channels is specified as a comma-separated list with 988each element in the list representing either a single channel number or a range 989of the form 990.Dq Li a-b . 991Channel numbers must be in the range 1 to 255 and be permissible 992according to the operating characteristics of the device. 993.It Cm channel Ar number 994Set a single desired channel. 995Channels range from 1 to 255, but the exact selection available 996depends on the region your adaptor was manufactured for. 997Setting 998the channel to 999.Li any , 1000or 1001.Cm - 1002will clear any desired channel and, if the device is marked up, 1003force a scan for a channel to operate on. 1004Alternatively the frequency, in megahertz, may be specified 1005instead of the channel number. 1006.Pp 1007When there are several ways to use a channel the channel 1008number/frequency may be appended with attributes to clarify. 1009For example, if a device is capable of operating on channel 6 1010with 802.11n and 802.11g then one can specify that g-only use 1011should be used by specifying ``6:g''. 1012Similarly the channel width can be specified by appending it 1013with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel, 1014These attributes can be combined as in: ``6:ht/40''. 1015The full set of flags specified following a ``:'' are: 1016.Cm a 1017(802.11a), 1018.Cm b 1019(802.11b), 1020.Cm d 1021(Atheros Dynamic Turbo mode), 1022.Cm g 1023(802.11g), 1024.Cm h 1025or 1026.Cm n 1027(802.11n aka HT), 1028.Cm s 1029(Atheros Static Turbo mode), 1030and 1031.Cm t 1032(Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt''). 1033The full set of channel widths following a '/' are: 1034.Cm 5 1035(5MHz aka quarter-rate channel), 1036.Cm 10 1037(10MHz aka half-rate channel), 1038.Cm 20 1039(20MHz mostly for use in specifying ht20), 1040and 1041.Cm 40 1042(40MHz mostly for use in specifying ht40). 1043In addition, 1044a 40MHz HT channel specification may include the location 1045of the extension channel by appending ``+'' or ``-'' for above and below, 1046respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation 1047with the center channel at frequency 2437 and the extension channel above. 1048.It Cm country Ar name 1049Set the country code to use in calculating the regulatory constraints 1050for operation. 1051In particular the set of available channels, how the wireless device 1052will operation on the channels, and the maximum transmit power that 1053can be used on a channel are defined by this setting. 1054Country/Region codes are specified as a 2-character abbreviation 1055defined by ISO 3166 or using a longer, but possibly ambiguous, spelling; 1056e.g., "ES" and "Spain". 1057The set of country codes are taken from 1058.Pa /etc/regdomain.xml 1059and can also 1060be viewed with the ``list countries'' request. 1061Note that not all devices support changing the country code from a default 1062setting; typically stored in EEPROM. 1063See also 1064.Cm regdomain , 1065.Cm indoor , 1066.Cm outdoor , 1067and 1068.Cm anywhere . 1069.It Cm dfs 1070Enable Dynamic Frequency Selection (DFS) as specified in 802.11h. 1071DFS embodies several facilities including detection of overlapping 1072radar signals, dynamic transmit power control, and channel selection 1073according to a least-congested criteria. 1074DFS support is mandatory for some 5GHz frequencies in certain 1075locales (e.g., ETSI). 1076By default DFS is enabled according to the regulatory definitions 1077specified in 1078.Pa /etc/regdomain.xml 1079and the current country code, regdomain, 1080and channel. 1081Note the underlying device (and driver) must support radar detection 1082for full DFS support to work. 1083To be fully compliant with the local regulatory agency frequencies that 1084require DFS should not be used unless it is fully supported. 1085Use 1086.Fl dfs 1087to disable this functionality for testing. 1088.It Cm dotd 1089Enable support for the 802.11d specification (default). 1090When this support is enabled in station mode, beacon frames that advertise 1091a country code different than the currently configured country code will 1092cause an event to be dispatched to user applications. 1093This event can be used by the station to adopt that country code and 1094operate according to the associated regulatory constraints. 1095When operating as an access point with 802.11d enabled the beacon and 1096probe response frames transmitted will advertise the current regulatory 1097domain settings. 1098To disable 802.11d use 1099.Fl dotd . 1100.It Cm doth 1101Enable 802.11h support including spectrum management. 1102When 802.11h is enabled beacon and probe response frames will have 1103the SpectrumMgt bit set in the capabilities field and 1104country and power constraint information elements will be present. 1105802.11h support also includes handling Channel Switch Announcements (CSA) 1106which are a mechanism to coordinate channel changes by an access point. 1107By default 802.11h is enabled if the device is capable. 1108To disable 802.11h use 1109.Fl doth . 1110.It Cm deftxkey Ar index 1111Set the default key to use for transmission. 1112Typically this is only set when using WEP encryption. 1113Note that you must set a default transmit key 1114for the system to know which key to use in encrypting outbound traffic. 1115The 1116.Cm weptxkey 1117is an alias for this request; it is provided for backwards compatibility. 1118.It Cm dtimperiod Ar period 1119Set the 1120DTIM 1121period for transmitting buffered multicast data frames when 1122operating in ap mode. 1123The 1124.Ar period 1125specifies the number of beacon intervals between DTIM 1126and must be in the range 1 to 15. 1127By default DTIM is 1 (i.e., DTIM occurs at each beacon). 1128.It Cm quiet 1129Enable the use of quiet IE. Hostap will use this to silence other 1130stations to reduce interference for radar detection when 1131operating on 5GHz frequency and doth support is enabled. 1132Use 1133.Fl quiet 1134to disable this functionality. 1135.It Cm quiet_period Ar period 1136Set the QUIET 1137.Ar period 1138to the number of beacon intervals between the start of regularly 1139scheduled quiet intervals defined by Quiet element. 1140.It Cm quiet_count Ar count 1141Set the QUIET 1142.Ar count 1143to the number of TBTTs until the beacon interval during which the 1144next quiet interval shall start. A value of 1 indicates the quiet 1145interval will start during the beacon interval starting at the next 1146TBTT. A value 0 is reserved. 1147.It Cm quiet_offset Ar offset 1148Set the QUIET 1149.Ar offset 1150to the offset of the start of the quiet interval from the TBTT 1151specified by the Quiet count, expressed in TUs. 1152The value of the 1153.Ar offset 1154shall be less than one beacon interval. 1155.It Cm quiet_duration Ar dur 1156Set the QUIET 1157.Ar dur 1158to the duration of the Quiet interval, expressed in TUs. 1159The value should be less than beacon interval. 1160.It Cm dturbo 1161Enable the use of Atheros Dynamic Turbo mode when communicating with 1162another Dynamic Turbo-capable station. 1163Dynamic Turbo mode is an Atheros-specific mechanism by which 1164stations switch between normal 802.11 operation and a ``boosted'' 1165mode in which a 40MHz wide channel is used for communication. 1166Stations using Dynamic Turbo mode operate boosted only when the 1167channel is free of non-dturbo stations; when a non-dturbo station 1168is identified on the channel all stations will automatically drop 1169back to normal operation. 1170By default, Dynamic Turbo mode is not enabled, even if the device is capable. 1171Note that turbo mode (dynamic or static) is only allowed on some 1172channels depending on the regulatory constraints; use the 1173.Cm list chan 1174command to identify the channels where turbo mode may be used. 1175To disable Dynamic Turbo mode use 1176.Fl dturbo . 1177.It Cm dwds 1178Enable Dynamic WDS (DWDS) support. 1179DWDS is a facility by which 4-address traffic can be carried between 1180stations operating in infrastructure mode. 1181A station first associates to an access point and authenticates using 1182normal procedures (e.g., WPA). 1183Then 4-address frames are passed to carry traffic for stations 1184operating on either side of the wireless link. 1185DWDS extends the normal WDS mechanism by leveraging existing security 1186protocols and eliminating static binding. 1187.Pp 1188When DWDS is enabled on an access point 4-address frames received from 1189an authorized station will generate a ``DWDS discovery'' event to user 1190applications. 1191This event should be used to create a WDS interface that is bound 1192to the remote station (and usually plumbed into a bridge). 1193Once the WDS interface is up and running 4-address traffic then logically 1194flows through that interface. 1195.Pp 1196When DWDS is enabled on a station, traffic with a destination address 1197different from the peer station are encapsulated in a 4-address frame 1198and transmitted to the peer. 1199All 4-address traffic uses the security information of the stations 1200(e.g., cryptographic keys). 1201A station is associated using 802.11n facilities may transport 12024-address traffic using these same mechanisms; this depends on available 1203resources and capabilities of the device. 1204The DWDS implementation guards against layer 2 routing loops of 1205multicast traffic. 1206.It Cm ff 1207Enable the use of Atheros Fast Frames when communicating with 1208another Fast Frames-capable station. 1209Fast Frames are an encapsulation technique by which two 802.3 1210frames are transmitted in a single 802.11 frame. 1211This can noticeably improve throughput but requires that the 1212receiving station understand how to decapsulate the frame. 1213Fast frame use is negotiated using the Atheros 802.11 vendor-specific 1214protocol extension so enabling use is safe when communicating with 1215non-Atheros devices. 1216By default, use of fast frames is enabled if the device is capable. 1217To explicitly disable fast frames, use 1218.Fl ff . 1219.It Cm fragthreshold Ar length 1220Set the threshold for which transmitted frames are broken into fragments. 1221The 1222.Ar length 1223argument is the frame size in bytes and must be in the range 256 to 2346. 1224Setting 1225.Ar length 1226to 1227.Li 2346 , 1228.Cm any , 1229or 1230.Cm - 1231disables transmit fragmentation. 1232Not all adapters honor the fragmentation threshold. 1233.It Cm hidessid 1234When operating as an access point, do not broadcast the SSID 1235in beacon frames or respond to probe request frames unless 1236they are directed to the ap (i.e., they include the ap's SSID). 1237By default, the SSID is included in beacon frames and 1238undirected probe request frames are answered. 1239To re-enable the broadcast of the SSID etc., use 1240.Fl hidessid . 1241.It Cm ht 1242Enable use of High Throughput (HT) when using 802.11n (default). 1243The 802.11n specification includes mechanisms for operation 1244on 20MHz and 40MHz wide channels using different signalling mechanisms 1245than specified in 802.11b, 802.11g, and 802.11a. 1246Stations negotiate use of these facilities, termed HT20 and HT40, 1247when they associate. 1248To disable all use of 802.11n use 1249.Fl ht . 1250To disable use of HT20 (e.g., to force only HT40 use) use 1251.Fl ht20 . 1252To disable use of HT40 use 1253.Fl ht40 . 1254.Pp 1255HT configuration is used to ``auto promote'' operation 1256when several choices are available. 1257For example, if a station associates to an 11n-capable access point 1258it controls whether the station uses legacy operation, HT20, or HT40. 1259When an 11n-capable device is setup as an access point and 1260Auto Channel Selection is used to locate a channel to operate on, 1261HT configuration controls whether legacy, HT20, or HT40 operation is setup 1262on the selected channel. 1263If a fixed channel is specified for a station then HT configuration can 1264be given as part of the channel specification; e.g., 6:ht/20 to setup 1265HT20 operation on channel 6. 1266.It Cm htcompat 1267Enable use of compatibility support for pre-802.11n devices (default). 1268The 802.11n protocol specification went through several incompatible iterations. 1269Some vendors implemented 11n support to older specifications that 1270will not interoperate with a purely 11n-compliant station. 1271In particular the information elements included in management frames 1272for old devices are different. 1273When compatibility support is enabled both standard and compatible data 1274will be provided. 1275Stations that associate using the compatibility mechanisms are flagged 1276in ``list sta''. 1277To disable compatibility support use 1278.Fl htcompat . 1279.It Cm htprotmode Ar technique 1280For interfaces operating in 802.11n, use the specified 1281.Ar technique 1282for protecting HT frames in a mixed legacy/HT network. 1283The set of valid techniques is 1284.Cm off , 1285and 1286.Cm rts 1287(RTS/CTS, default). 1288Technique names are case insensitive. 1289.It Cm inact 1290Enable inactivity processing for stations associated to an 1291access point (default). 1292When operating as an access point the 802.11 layer monitors 1293the activity of each associated station. 1294When a station is inactive for 5 minutes it will send several 1295``probe frames'' to see if the station is still present. 1296If no response is received then the station is deauthenticated. 1297Applications that prefer to handle this work can disable this 1298facility by using 1299.Fl inact . 1300.It Cm indoor 1301Set the location to use in calculating regulatory constraints. 1302The location is also advertised in beacon and probe response frames 1303when 802.11d is enabled with 1304.Cm dotd . 1305See also 1306.Cm outdoor , 1307.Cm anywhere , 1308.Cm country , 1309and 1310.Cm regdomain . 1311.It Cm list active 1312Display the list of channels available for use taking into account 1313any restrictions set with the 1314.Cm chanlist 1315directive. 1316See the description of 1317.Cm list chan 1318for more information. 1319.It Cm list caps 1320Display the adaptor's capabilities, including the operating 1321modes supported. 1322.It Cm list chan 1323Display the list of channels available for use. 1324Channels are shown with their IEEE channel number, equivalent 1325frequency, and usage modes. 1326Channels identified as 1327.Ql 11g 1328are also usable in 1329.Ql 11b 1330mode. 1331Channels identified as 1332.Ql 11a Turbo 1333may be used only for Atheros' Static Turbo mode 1334(specified with 1335. Cm mediaopt turbo ) . 1336Channels marked with a 1337.Ql * 1338have a regulatory constraint that they be passively scanned. 1339This means a station is not permitted to transmit on the channel until 1340it identifies the channel is being used for 802.11 communication; 1341typically by hearing a beacon frame from an access point operating 1342on the channel. 1343.Cm list freq 1344is another way of requesting this information. 1345By default a compacted list of channels is displayed; if the 1346.Fl v 1347option is specified then all channels are shown. 1348.It Cm list countries 1349Display the set of country codes and regulatory domains that can be 1350used in regulatory configuration. 1351.It Cm list mac 1352Display the current MAC Access Control List state. 1353Each address is prefixed with a character that indicates the 1354current policy applied to it: 1355.Ql + 1356indicates the address is allowed access, 1357.Ql - 1358indicates the address is denied access, 1359.Ql * 1360indicates the address is present but the current policy open 1361(so the ACL is not consulted). 1362.It Cm list mesh 1363Displays the mesh routing table, used for forwarding packets on a mesh 1364network. 1365.It Cm list regdomain 1366Display the current regulatory settings including the available channels 1367and transmit power caps. 1368.It Cm list roam 1369Display the parameters that govern roaming operation. 1370.It Cm list txparam 1371Display the parameters that govern transmit operation. 1372.It Cm list txpower 1373Display the transmit power caps for each channel. 1374.It Cm list scan 1375Display the access points and/or ad-hoc neighbors 1376located in the vicinity. 1377This information may be updated automatically by the adapter 1378with a 1379.Cm scan 1380request or through background scanning. 1381Depending on the capabilities of the stations the following 1382flags can be included in the output: 1383.Bl -tag -width 3n 1384.It Li A 1385Authorized. 1386Indicates that the station is permitted to send/receive data frames. 1387.It Li E 1388Extended Rate Phy (ERP). 1389Indicates that the station is operating in an 802.11g network 1390using extended transmit rates. 1391.It Li H 1392High Throughput (HT). 1393Indicates that the station is using HT transmit rates. 1394If a `+' follows immediately after then the station associated 1395using deprecated mechanisms supported only when 1396.Cm htcompat 1397is enabled. 1398.It Li P 1399Power Save. 1400Indicates that the station is operating in power save mode. 1401.It Li Q 1402Quality of Service (QoS). 1403Indicates that the station is using QoS encapsulation for 1404data frame. 1405QoS encapsulation is enabled only when WME mode is enabled. 1406.It Li S 1407Short Preamble. 1408Indicates that the station is doing short preamble to optionally 1409improve throughput performance with 802.11g and 802.11b. 1410.It Li T 1411Transitional Security Network (TSN). 1412Indicates that the station associated using TSN; see also 1413.Cm tsn 1414below. 1415.It Li W 1416Wi-Fi Protected Setup (WPS). 1417Indicates that the station associated using WPS. 1418.El 1419.Pp 1420By default interesting information elements captured from the neighboring 1421stations are displayed at the end of each row. 1422Possible elements include: 1423.Cm WME 1424(station supports WME), 1425.Cm WPA 1426(station supports WPA), 1427.Cm WPS 1428(station supports WPS), 1429.Cm RSN 1430(station supports 802.11i/RSN), 1431.Cm HTCAP 1432(station supports 802.11n/HT communication), 1433.Cm ATH 1434(station supports Atheros protocol extensions), 1435.Cm VEN 1436(station supports unknown vendor-specific extensions). 1437If the 1438.Fl v 1439flag is used all the information elements and their 1440contents will be shown. 1441Specifying the 1442.Fl v 1443flag also enables display of long SSIDs. 1444The 1445.Cm list ap 1446command is another way of requesting this information. 1447.It Cm list sta 1448When operating as an access point display the stations that are 1449currently associated. 1450When operating in ad-hoc mode display stations identified as 1451neighbors in the IBSS. 1452When operating in mesh mode display stations identified as 1453neighbors in the MBSS. 1454When operating in station mode display the access point. 1455Capabilities advertised by the stations are described under 1456the 1457.Cm scan 1458request. 1459Depending on the capabilities of the stations the following 1460flags can be included in the output: 1461.Bl -tag -width 3n 1462.It Li A 1463Authorized. 1464Indicates that the station is permitted to send/receive data frames. 1465.It Li E 1466Extended Rate Phy (ERP). 1467Indicates that the station is operating in an 802.11g network 1468using extended transmit rates. 1469.It Li H 1470High Throughput (HT). 1471Indicates that the station is using HT transmit rates. 1472If a `+' follows immediately after then the station associated 1473using deprecated mechanisms supported only when 1474.Cm htcompat 1475is enabled. 1476.It Li P 1477Power Save. 1478Indicates that the station is operating in power save mode. 1479.It Li Q 1480Quality of Service (QoS). 1481Indicates that the station is using QoS encapsulation for 1482data frame. 1483QoS encapsulation is enabled only when WME mode is enabled. 1484.It Li S 1485Short Preamble. 1486Indicates that the station is doing short preamble to optionally 1487improve throughput performance with 802.11g and 802.11b. 1488.It Li T 1489Transitional Security Network (TSN). 1490Indicates that the station associated using TSN; see also 1491.Cm tsn 1492below. 1493.It Li W 1494Wi-Fi Protected Setup (WPS). 1495Indicates that the station associated using WPS. 1496.El 1497.Pp 1498By default information elements received from associated stations 1499are displayed in a short form; the 1500.Fl v 1501flag causes this information to be displayed symbolically. 1502.It Cm list wme 1503Display the current channel parameters to use when operating in WME mode. 1504If the 1505.Fl v 1506option is specified then both channel and BSS parameters are displayed 1507for each AC (first channel, then BSS). 1508When WME mode is enabled for an adaptor this information will be 1509displayed with the regular status; this command is mostly useful 1510for examining parameters when WME mode is disabled. 1511See the description of the 1512.Cm wme 1513directive for information on the various parameters. 1514.It Cm maxretry Ar count 1515Set the maximum number of tries to use in sending unicast frames. 1516The default setting is 6 but drivers may override this with a value 1517they choose. 1518.It Cm mcastrate Ar rate 1519Set the rate for transmitting multicast/broadcast frames. 1520Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s. 1521This rate should be valid for the current operating conditions; 1522if an invalid rate is specified drivers are free to chose an 1523appropriate rate. 1524.It Cm mgtrate Ar rate 1525Set the rate for transmitting management and/or control frames. 1526Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s. 1527.It Cm outdoor 1528Set the location to use in calculating regulatory constraints. 1529The location is also advertised in beacon and probe response frames 1530when 802.11d is enabled with 1531.Cm dotd . 1532See also 1533.Cm anywhere , 1534.Cm country , 1535.Cm indoor , 1536and 1537.Cm regdomain . 1538.It Cm powersave 1539Enable powersave operation. 1540When operating as a client, the station will conserve power by 1541periodically turning off the radio and listening for 1542messages from the access point telling it there are packets waiting. 1543The station must then retrieve the packets. 1544Not all devices support power save operation as a client. 1545The 802.11 specification requires that all access points support 1546power save but some drivers do not. 1547Use 1548.Fl powersave 1549to disable powersave operation when operating as a client. 1550.It Cm powersavesleep Ar sleep 1551Set the desired max powersave sleep time in TU's (1024 usecs). 1552By default the max powersave sleep time is 100 TU's. 1553.It Cm protmode Ar technique 1554For interfaces operating in 802.11g, use the specified 1555.Ar technique 1556for protecting OFDM frames in a mixed 11b/11g network. 1557The set of valid techniques is 1558.Cm off , cts 1559(CTS to self), 1560and 1561.Cm rtscts 1562(RTS/CTS). 1563Technique names are case insensitive. 1564Not all devices support 1565.Cm cts 1566as a protection technique. 1567.It Cm pureg 1568When operating as an access point in 802.11g mode allow only 156911g-capable stations to associate (11b-only stations are not 1570permitted to associate). 1571To allow both 11g and 11b-only stations to associate, use 1572.Fl pureg . 1573.It Cm puren 1574When operating as an access point in 802.11n mode allow only 1575HT-capable stations to associate (legacy stations are not 1576permitted to associate). 1577To allow both HT and legacy stations to associate, use 1578.Fl puren . 1579.It Cm regdomain Ar sku 1580Set the regulatory domain to use in calculating the regulatory constraints 1581for operation. 1582In particular the set of available channels, how the wireless device 1583will operation on the channels, and the maximum transmit power that 1584can be used on a channel are defined by this setting. 1585Regdomain codes (SKU's) are taken from 1586.Pa /etc/regdomain.xml 1587and can also 1588be viewed with the ``list countries'' request. 1589Note that not all devices support changing the regdomain from a default 1590setting; typically stored in EEPROM. 1591See also 1592.Cm country , 1593.Cm indoor , 1594.Cm outdoor , 1595and 1596.Cm anywhere . 1597.It Cm rifs 1598Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n 1599on an HT channel. 1600Note that RIFS must be supported by both the station and access point 1601for it to be used. 1602To disable RIFS use 1603.Fl rifs . 1604.It Cm roam:rate Ar rate 1605Set the threshold for controlling roaming when operating in a BSS. 1606The 1607.Ar rate 1608parameter specifies the transmit rate in megabits 1609at which roaming should be considered. 1610If the current transmit rate drops below this setting and background scanning 1611is enabled, then the system will check if a more desirable access point is 1612available and switch over to it. 1613The current scan cache contents are used if they are considered 1614valid according to the 1615.Cm scanvalid 1616parameter; otherwise a background scan operation is triggered before 1617any selection occurs. 1618Each channel type has a separate rate threshold; the default values are: 161912 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng). 1620.It Cm roam:rssi Ar rssi 1621Set the threshold for controlling roaming when operating in a BSS. 1622The 1623.Ar rssi 1624parameter specifies the receive signal strength in dBm units 1625at which roaming should be considered. 1626If the current rssi drops below this setting and background scanning 1627is enabled, then the system will check if a more desirable access point is 1628available and switch over to it. 1629The current scan cache contents are used if they are considered 1630valid according to the 1631.Cm scanvalid 1632parameter; otherwise a background scan operation is triggered before 1633any selection occurs. 1634Each channel type has a separate rssi threshold; the default values are 1635all 7 dBm. 1636.It Cm roaming Ar mode 1637When operating as a station, control how the system will 1638behave when communication with the current access point 1639is broken. 1640The 1641.Ar mode 1642argument may be one of 1643.Cm device 1644(leave it to the hardware device to decide), 1645.Cm auto 1646(handle either in the device or the operating system\[em]as appropriate), 1647.Cm manual 1648(do nothing until explicitly instructed). 1649By default, the device is left to handle this if it is 1650capable; otherwise, the operating system will automatically 1651attempt to reestablish communication. 1652Manual mode is used by applications such as 1653.Xr wpa_supplicant 8 1654that want to control the selection of an access point. 1655.It Cm rtsthreshold Ar length 1656Set the threshold for which 1657transmitted frames are preceded by transmission of an 1658RTS 1659control frame. 1660The 1661.Ar length 1662argument 1663is the frame size in bytes and must be in the range 1 to 2346. 1664Setting 1665.Ar length 1666to 1667.Li 2346 , 1668.Cm any , 1669or 1670.Cm - 1671disables transmission of RTS frames. 1672Not all adapters support setting the RTS threshold. 1673.It Cm scan 1674Initiate a scan of neighboring stations, wait for it to complete, and 1675display all stations found. 1676Only the super-user can initiate a scan. 1677See 1678.Cm list scan 1679for information on the display. 1680By default a background scan is done; otherwise a foreground 1681scan is done and the station may roam to a different access point. 1682The 1683.Cm list scan 1684request can be used to show recent scan results without 1685initiating a new scan. 1686.It Cm scanvalid Ar threshold 1687Set the maximum time the scan cache contents are considered valid; 1688i.e., will be used without first triggering a scan operation to 1689refresh the data. 1690The 1691.Ar threshold 1692parameter is specified in seconds and defaults to 60 seconds. 1693The minimum setting for 1694.Ar threshold 1695is 10 seconds. 1696One should take care setting this threshold; if it is set too low 1697then attempts to roam to another access point may trigger unnecessary 1698background scan operations. 1699.It Cm shortgi 1700Enable use of Short Guard Interval when operating in 802.11n 1701on an HT channel. 1702NB: this currently enables Short GI on both HT40 and HT20 channels. 1703To disable Short GI use 1704.Fl shortgi . 1705.It Cm smps 1706Enable use of Static Spatial Multiplexing Power Save (SMPS) 1707when operating in 802.11n. 1708A station operating with Static SMPS maintains only a single 1709receive chain active (this can significantly reduce power consumption). 1710To disable SMPS use 1711.Fl smps . 1712.It Cm smpsdyn 1713Enable use of Dynamic Spatial Multiplexing Power Save (SMPS) 1714when operating in 802.11n. 1715A station operating with Dynamic SMPS maintains only a single 1716receive chain active but switches to multiple receive chains when it 1717receives an RTS frame (this can significantly reduce power consumption). 1718Note that stations cannot distinguish between RTS/CTS intended to 1719enable multiple receive chains and those used for other purposes. 1720To disable SMPS use 1721.Fl smps . 1722.It Cm ssid Ar ssid 1723Set the desired Service Set Identifier (aka network name). 1724The SSID is a string up to 32 characters 1725in length and may be specified as either a normal string or in 1726hexadecimal when preceded by 1727.Ql 0x . 1728Additionally, the SSID may be cleared by setting it to 1729.Ql - . 1730.It Cm tdmaslot Ar slot 1731When operating with TDMA, use the specified 1732.Ar slot 1733configuration. 1734The 1735.Ar slot 1736is a number between 0 and the maximum number of slots in the BSS. 1737Note that a station configured as slot 0 is a master and 1738will broadcast beacon frames advertising the BSS; 1739stations configured to use other slots will always 1740scan to locate a master before they ever transmit. 1741By default 1742.Cm tdmaslot 1743is set to 1. 1744.It Cm tdmaslotcnt Ar cnt 1745When operating with TDMA, setup a BSS with 1746.Ar cnt 1747slots. 1748The slot count may be at most 8. 1749The current implementation is only tested with two stations 1750(i.e., point to point applications). 1751This setting is only meaningful when a station is configured as slot 0; 1752other stations adopt this setting from the BSS they join. 1753By default 1754.Cm tdmaslotcnt 1755is set to 2. 1756.It Cm tdmaslotlen Ar len 1757When operating with TDMA, setup a BSS such that each station has a slot 1758.Ar len 1759microseconds long. 1760The slot length must be at least 150 microseconds (1/8 TU) 1761and no more than 65 milliseconds. 1762Note that setting too small a slot length may result in poor channel 1763bandwidth utilization due to factors such as timer granularity and 1764guard time. 1765This setting is only meaningful when a station is configured as slot 0; 1766other stations adopt this setting from the BSS they join. 1767By default 1768.Cm tdmaslotlen 1769is set to 10 milliseconds. 1770.It Cm tdmabintval Ar intval 1771When operating with TDMA, setup a BSS such that beacons are transmitted every 1772.Ar intval 1773superframes to synchronize the TDMA slot timing. 1774A superframe is defined as the number of slots times the slot length; e.g., 1775a BSS with two slots of 10 milliseconds has a 20 millisecond superframe. 1776The beacon interval may not be zero. 1777A lower setting of 1778.Cm tdmabintval 1779causes the timers to be resynchronized more often; this can be help if 1780significant timer drift is observed. 1781By default 1782.Cm tdmabintval 1783is set to 5. 1784.It Cm tsn 1785When operating as an access point with WPA/802.11i allow legacy 1786stations to associate using static key WEP and open authentication. 1787To disallow legacy station use of WEP, use 1788.Fl tsn . 1789.It Cm txpower Ar power 1790Set the power used to transmit frames. 1791The 1792.Ar power 1793argument is specified in .5 dBm units. 1794Out of range values are truncated. 1795Typically only a few discreet power settings are available and 1796the driver will use the setting closest to the specified value. 1797Not all adapters support changing the transmit power. 1798.It Cm ucastrate Ar rate 1799Set a fixed rate for transmitting unicast frames. 1800Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s. 1801This rate should be valid for the current operating conditions; 1802if an invalid rate is specified drivers are free to chose an 1803appropriate rate. 1804.It Cm wepmode Ar mode 1805Set the desired WEP mode. 1806Not all adapters support all modes. 1807The set of valid modes is 1808.Cm off , on , 1809and 1810.Cm mixed . 1811The 1812.Cm mixed 1813mode explicitly tells the adaptor to allow association with access 1814points which allow both encrypted and unencrypted traffic. 1815On these adapters, 1816.Cm on 1817means that the access point must only allow encrypted connections. 1818On other adapters, 1819.Cm on 1820is generally another name for 1821.Cm mixed . 1822Modes are case insensitive. 1823.It Cm weptxkey Ar index 1824Set the WEP key to be used for transmission. 1825This is the same as setting the default transmission key with 1826.Cm deftxkey . 1827.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key 1828Set the selected WEP key. 1829If an 1830.Ar index 1831is not given, key 1 is set. 1832A WEP key will be either 5 or 13 1833characters (40 or 104 bits) depending on the local network and the 1834capabilities of the adaptor. 1835It may be specified either as a plain 1836string or as a string of hexadecimal digits preceded by 1837.Ql 0x . 1838For maximum portability, hex keys are recommended; 1839the mapping of text keys to WEP encryption is usually driver-specific. 1840In particular, the 1841.Tn Windows 1842drivers do this mapping differently to 1843.Fx . 1844A key may be cleared by setting it to 1845.Ql - . 1846If WEP is supported then there are at least four keys. 1847Some adapters support more than four keys. 1848If that is the case, then the first four keys 1849(1-4) will be the standard temporary keys and any others will be adaptor 1850specific keys such as permanent keys stored in NVRAM. 1851.Pp 1852Note that you must set a default transmit key with 1853.Cm deftxkey 1854for the system to know which key to use in encrypting outbound traffic. 1855.It Cm wme 1856Enable Wireless Multimedia Extensions (WME) support, if available, 1857for the specified interface. 1858WME is a subset of the IEEE 802.11e standard to support the 1859efficient communication of realtime and multimedia data. 1860To disable WME support, use 1861.Fl wme . 1862Another name for this parameter is 1863.Cm wmm . 1864.Pp 1865The following parameters are meaningful only when WME support is in use. 1866Parameters are specified per-AC (Access Category) and 1867split into those that are used by a station when acting 1868as an access point and those for client stations in the BSS. 1869The latter are received from the access point and may not be changed 1870(at the station). 1871The following Access Categories are recognized: 1872.Pp 1873.Bl -tag -width ".Cm AC_BK" -compact 1874.It Cm AC_BE 1875(or 1876.Cm BE ) 1877best effort delivery, 1878.It Cm AC_BK 1879(or 1880.Cm BK ) 1881background traffic, 1882.It Cm AC_VI 1883(or 1884.Cm VI ) 1885video traffic, 1886.It Cm AC_VO 1887(or 1888.Cm VO ) 1889voice traffic. 1890.El 1891.Pp 1892AC parameters are case-insensitive. 1893Traffic classification is done in the operating system using the 1894vlan priority associated with data frames or the 1895ToS (Type of Service) indication in IP-encapsulated frames. 1896If neither information is present, traffic is assigned to the 1897Best Effort (BE) category. 1898.Bl -tag -width indent 1899.It Cm ack Ar ac 1900Set the ACK policy for QoS transmissions by the local station; 1901this controls whether or not data frames transmitted by a station 1902require an ACK response from the receiving station. 1903To disable waiting for an ACK use 1904.Fl ack . 1905This parameter is applied only to the local station. 1906.It Cm acm Ar ac 1907Enable the Admission Control Mandatory (ACM) mechanism 1908for transmissions by the local station. 1909To disable the ACM use 1910.Fl acm . 1911On stations in a BSS this parameter is read-only and indicates 1912the setting received from the access point. 1913NB: ACM is not supported right now. 1914.It Cm aifs Ar ac Ar count 1915Set the Arbitration Inter Frame Spacing (AIFS) 1916channel access parameter to use for transmissions 1917by the local station. 1918On stations in a BSS this parameter is read-only and indicates 1919the setting received from the access point. 1920.It Cm cwmin Ar ac Ar count 1921Set the CWmin channel access parameter to use for transmissions 1922by the local station. 1923On stations in a BSS this parameter is read-only and indicates 1924the setting received from the access point. 1925.It Cm cwmax Ar ac Ar count 1926Set the CWmax channel access parameter to use for transmissions 1927by the local station. 1928On stations in a BSS this parameter is read-only and indicates 1929the setting received from the access point. 1930.It Cm txoplimit Ar ac Ar limit 1931Set the Transmission Opportunity Limit channel access parameter 1932to use for transmissions by the local station. 1933This parameter defines an interval of time when a WME station 1934has the right to initiate transmissions onto the wireless medium. 1935On stations in a BSS this parameter is read-only and indicates 1936the setting received from the access point. 1937.It Cm bss:aifs Ar ac Ar count 1938Set the AIFS channel access parameter to send to stations in a BSS. 1939This parameter is meaningful only when operating in ap mode. 1940.It Cm bss:cwmin Ar ac Ar count 1941Set the CWmin channel access parameter to send to stations in a BSS. 1942This parameter is meaningful only when operating in ap mode. 1943.It Cm bss:cwmax Ar ac Ar count 1944Set the CWmax channel access parameter to send to stations in a BSS. 1945This parameter is meaningful only when operating in ap mode. 1946.It Cm bss:txoplimit Ar ac Ar limit 1947Set the TxOpLimit channel access parameter to send to stations in a BSS. 1948This parameter is meaningful only when operating in ap mode. 1949.El 1950.It Cm wps 1951Enable Wireless Privacy Subscriber support. 1952Note that WPS support requires a WPS-capable supplicant. 1953To disable this function use 1954.Fl wps . 1955.El 1956.Pp 1957The following parameters support an optional access control list 1958feature available with some adapters when operating in ap mode; see 1959.Xr wlan_acl 4 . 1960This facility allows an access point to accept/deny association 1961requests based on the MAC address of the station. 1962Note that this feature does not significantly enhance security 1963as MAC address spoofing is easy to do. 1964.Bl -tag -width indent 1965.It Cm mac:add Ar address 1966Add the specified MAC address to the database. 1967Depending on the policy setting association requests from the 1968specified station will be allowed or denied. 1969.It Cm mac:allow 1970Set the ACL policy to permit association only by 1971stations registered in the database. 1972.It Cm mac:del Ar address 1973Delete the specified MAC address from the database. 1974.It Cm mac:deny 1975Set the ACL policy to deny association only by 1976stations registered in the database. 1977.It Cm mac:kick Ar address 1978Force the specified station to be deauthenticated. 1979This typically is done to block a station after updating the 1980address database. 1981.It Cm mac:open 1982Set the ACL policy to allow all stations to associate. 1983.It Cm mac:flush 1984Delete all entries in the database. 1985.It Cm mac:radius 1986Set the ACL policy to permit association only by 1987stations approved by a RADIUS server. 1988Note that this feature requires the 1989.Xr hostapd 8 1990program be configured to do the right thing 1991as it handles the RADIUS processing 1992(and marks stations as authorized). 1993.El 1994.Pp 1995The following parameters are related to a wireless interface operating in mesh 1996mode: 1997.Bl -tag -width indent 1998.It Cm meshid Ar meshid 1999Set the desired Mesh Identifier. 2000The Mesh ID is a string up to 32 characters in length. 2001A mesh interface must have a Mesh Identifier specified 2002to reach an operational state. 2003.It Cm meshttl Ar ttl 2004Set the desired ``time to live'' for mesh forwarded packets; 2005this is the number of hops a packet may be forwarded before 2006it is discarded. 2007The default setting for 2008.Cm meshttl 2009is 31. 2010.It Cm meshpeering 2011Enable or disable peering with neighbor mesh stations. 2012Stations must peer before any data packets can be exchanged. 2013By default 2014.Cm meshpeering 2015is enabled. 2016.It Cm meshforward 2017Enable or disable forwarding packets by a mesh interface. 2018By default 2019.Cm meshforward 2020is enabled. 2021.It Cm meshgate 2022This attribute specifies whether or not the mesh STA activates mesh gate 2023announcements. 2024By default 2025.Cm meshgate 2026is disabled. 2027.It Cm meshmetric Ar protocol 2028Set the specified 2029.Ar protocol 2030as the link metric protocol used on a mesh network. 2031The default protocol is called 2032.Ar AIRTIME . 2033The mesh interface will restart after changing this setting. 2034.It Cm meshpath Ar protocol 2035Set the specified 2036.Ar protocol 2037as the path selection protocol used on a mesh network. 2038The only available protocol at the moment is called 2039.Ar HWMP 2040(Hybrid Wireless Mesh Protocol). 2041The mesh interface will restart after changing this setting. 2042.It Cm hwmprootmode Ar mode 2043Stations on a mesh network can operate as ``root nodes.'' 2044Root nodes try to find paths to all mesh nodes and advertise themselves 2045regularly. 2046When there is a root mesh node on a network, other mesh nodes can setup 2047paths between themselves faster because they can use the root node 2048to find the destination. 2049This path may not be the best, but on-demand 2050routing will eventually find the best path. 2051The following modes are recognized: 2052.Pp 2053.Bl -tag -width ".Cm PROACTIVE" -compact 2054.It Cm DISABLED 2055Disable root mode. 2056.It Cm NORMAL 2057Send broadcast path requests every two seconds. 2058Nodes on the mesh without a path to this root mesh station with try to 2059discover a path to us. 2060.It Cm PROACTIVE 2061Send broadcast path requests every two seconds and every node must reply 2062with a path reply even if it already has a path to this root mesh station. 2063.It Cm RANN 2064Send broadcast root announcement (RANN) frames. 2065Nodes on the mesh without a path to this root mesh station with try to 2066discover a path to us. 2067.El 2068By default 2069.Cm hwmprootmode 2070is set to 2071.Ar DISABLED . 2072.It Cm hwmpmaxhops Ar cnt 2073Set the maximum number of hops allowed in an HMWP path to 2074.Ar cnt . 2075The default setting for 2076.Cm hwmpmaxhops 2077is 31. 2078.El 2079.Pp 2080The following parameters are for compatibility with other systems: 2081.Bl -tag -width indent 2082.It Cm nwid Ar ssid 2083Another name for the 2084.Cm ssid 2085parameter. 2086Included for 2087.Nx 2088compatibility. 2089.It Cm stationname Ar name 2090Set the name of this station. 2091The station name is not part of the IEEE 802.11 2092protocol though some interfaces support it. 2093As such it only 2094seems to be meaningful to identical or virtually identical equipment. 2095Setting the station name is identical in syntax to setting the SSID. 2096One can also use 2097.Cm station 2098for 2099.Bsx 2100compatibility. 2101.It Cm wep 2102Another way of saying 2103.Cm wepmode on . 2104Included for 2105.Bsx 2106compatibility. 2107.It Fl wep 2108Another way of saying 2109.Cm wepmode off . 2110Included for 2111.Bsx 2112compatibility. 2113.It Cm nwkey key 2114Another way of saying: 2115.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" . 2116Included for 2117.Nx 2118compatibility. 2119.It Cm nwkey Xo 2120.Sm off 2121.Ar n : k1 , k2 , k3 , k4 2122.Sm on 2123.Xc 2124Another way of saying 2125.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" . 2126Included for 2127.Nx 2128compatibility. 2129.It Fl nwkey 2130Another way of saying 2131.Cm wepmode off . 2132Included for 2133.Nx 2134compatibility. 2135.El 2136.Pp 2137The following parameters are specific to bridge interfaces: 2138.Bl -tag -width indent 2139.It Cm addm Ar interface 2140Add the interface named by 2141.Ar interface 2142as a member of the bridge. 2143The interface is put into promiscuous mode 2144so that it can receive every packet sent on the network. 2145.It Cm deletem Ar interface 2146Remove the interface named by 2147.Ar interface 2148from the bridge. 2149Promiscuous mode is disabled on the interface when 2150it is removed from the bridge. 2151.It Cm maxaddr Ar size 2152Set the size of the bridge address cache to 2153.Ar size . 2154The default is 2000 entries. 2155.It Cm timeout Ar seconds 2156Set the timeout of address cache entries to 2157.Ar seconds 2158seconds. 2159If 2160.Ar seconds 2161is zero, then address cache entries will not be expired. 2162The default is 1200 seconds. 2163.It Cm addr 2164Display the addresses that have been learned by the bridge. 2165.It Cm static Ar interface-name Ar address 2166Add a static entry into the address cache pointing to 2167.Ar interface-name . 2168Static entries are never aged out of the cache or re-placed, even if the 2169address is seen on a different interface. 2170.It Cm deladdr Ar address 2171Delete 2172.Ar address 2173from the address cache. 2174.It Cm flush 2175Delete all dynamically-learned addresses from the address cache. 2176.It Cm flushall 2177Delete all addresses, including static addresses, from the address cache. 2178.It Cm discover Ar interface 2179Mark an interface as a 2180.Dq discovering 2181interface. 2182When the bridge has no address cache entry 2183(either dynamic or static) 2184for the destination address of a packet, 2185the bridge will forward the packet to all 2186member interfaces marked as 2187.Dq discovering . 2188This is the default for all interfaces added to a bridge. 2189.It Cm -discover Ar interface 2190Clear the 2191.Dq discovering 2192attribute on a member interface. 2193For packets without the 2194.Dq discovering 2195attribute, the only packets forwarded on the interface are broadcast 2196or multicast packets and packets for which the destination address 2197is known to be on the interface's segment. 2198.It Cm learn Ar interface 2199Mark an interface as a 2200.Dq learning 2201interface. 2202When a packet arrives on such an interface, the source 2203address of the packet is entered into the address cache as being a 2204destination address on the interface's segment. 2205This is the default for all interfaces added to a bridge. 2206.It Cm -learn Ar interface 2207Clear the 2208.Dq learning 2209attribute on a member interface. 2210.It Cm sticky Ar interface 2211Mark an interface as a 2212.Dq sticky 2213interface. 2214Dynamically learned address entries are treated at static once entered into 2215the cache. 2216Sticky entries are never aged out of the cache or replaced, even if the 2217address is seen on a different interface. 2218.It Cm -sticky Ar interface 2219Clear the 2220.Dq sticky 2221attribute on a member interface. 2222.It Cm private Ar interface 2223Mark an interface as a 2224.Dq private 2225interface. 2226A private interface does not forward any traffic to any other port that is also 2227a private interface. 2228.It Cm -private Ar interface 2229Clear the 2230.Dq private 2231attribute on a member interface. 2232.It Cm span Ar interface 2233Add the interface named by 2234.Ar interface 2235as a span port on the bridge. 2236Span ports transmit a copy of every frame received by the bridge. 2237This is most useful for snooping a bridged network passively on 2238another host connected to one of the span ports of the bridge. 2239.It Cm -span Ar interface 2240Delete the interface named by 2241.Ar interface 2242from the list of span ports of the bridge. 2243.It Cm stp Ar interface 2244Enable Spanning Tree protocol on 2245.Ar interface . 2246The 2247.Xr if_bridge 4 2248driver has support for the IEEE 802.1D Spanning Tree protocol (STP). 2249Spanning Tree is used to detect and remove loops in a network topology. 2250.It Cm -stp Ar interface 2251Disable Spanning Tree protocol on 2252.Ar interface . 2253This is the default for all interfaces added to a bridge. 2254.It Cm edge Ar interface 2255Set 2256.Ar interface 2257as an edge port. 2258An edge port connects directly to end stations cannot create bridging 2259loops in the network, this allows it to transition straight to forwarding. 2260.It Cm -edge Ar interface 2261Disable edge status on 2262.Ar interface . 2263.It Cm autoedge Ar interface 2264Allow 2265.Ar interface 2266to automatically detect edge status. 2267This is the default for all interfaces added to a bridge. 2268.It Cm -autoedge Ar interface 2269Disable automatic edge status on 2270.Ar interface . 2271.It Cm ptp Ar interface 2272Set the 2273.Ar interface 2274as a point to point link. 2275This is required for straight transitions to forwarding and 2276should be enabled on a direct link to another RSTP capable switch. 2277.It Cm -ptp Ar interface 2278Disable point to point link status on 2279.Ar interface . 2280This should be disabled for a half duplex link and for an interface 2281connected to a shared network segment, 2282like a hub or a wireless network. 2283.It Cm autoptp Ar interface 2284Automatically detect the point to point status on 2285.Ar interface 2286by checking the full duplex link status. 2287This is the default for interfaces added to the bridge. 2288.It Cm -autoptp Ar interface 2289Disable automatic point to point link detection on 2290.Ar interface . 2291.It Cm maxage Ar seconds 2292Set the time that a Spanning Tree protocol configuration is valid. 2293The default is 20 seconds. 2294The minimum is 6 seconds and the maximum is 40 seconds. 2295.It Cm fwddelay Ar seconds 2296Set the time that must pass before an interface begins forwarding 2297packets when Spanning Tree is enabled. 2298The default is 15 seconds. 2299The minimum is 4 seconds and the maximum is 30 seconds. 2300.It Cm hellotime Ar seconds 2301Set the time between broadcasting of Spanning Tree protocol 2302configuration messages. 2303The hello time may only be changed when operating in legacy stp mode. 2304The default is 2 seconds. 2305The minimum is 1 second and the maximum is 2 seconds. 2306.It Cm priority Ar value 2307Set the bridge priority for Spanning Tree. 2308The default is 32768. 2309The minimum is 0 and the maximum is 61440. 2310.It Cm proto Ar value 2311Set the Spanning Tree protocol. 2312The default is rstp. 2313The available options are stp and rstp. 2314.It Cm holdcnt Ar value 2315Set the transmit hold count for Spanning Tree. 2316This is the number of packets transmitted before being rate limited. 2317The default is 6. 2318The minimum is 1 and the maximum is 10. 2319.It Cm ifpriority Ar interface Ar value 2320Set the Spanning Tree priority of 2321.Ar interface 2322to 2323.Ar value . 2324The default is 128. 2325The minimum is 0 and the maximum is 240. 2326.It Cm ifpathcost Ar interface Ar value 2327Set the Spanning Tree path cost of 2328.Ar interface 2329to 2330.Ar value . 2331The default is calculated from the link speed. 2332To change a previously selected path cost back to automatic, set the 2333cost to 0. 2334The minimum is 1 and the maximum is 200000000. 2335.It Cm ifmaxaddr Ar interface Ar size 2336Set the maximum number of hosts allowed from an interface, packets with unknown 2337source addresses are dropped until an existing host cache entry expires or is 2338removed. 2339Set to 0 to disable. 2340.El 2341.Pp 2342The following parameters are specific to lagg interfaces: 2343.Bl -tag -width indent 2344.It Cm laggport Ar interface 2345Add the interface named by 2346.Ar interface 2347as a port of the aggregation interface. 2348.It Cm -laggport Ar interface 2349Remove the interface named by 2350.Ar interface 2351from the aggregation interface. 2352.It Cm laggproto Ar proto 2353Set the aggregation protocol. 2354The default is failover. 2355The available options are failover, fec, lacp, loadbalance, roundrobin and 2356none. 2357.It Cm lagghash Ar option Ns Oo , Ns Ar option Oc 2358Set the packet layers to hash for aggregation protocols which load balance. 2359The default is 2360.Dq l2,l3,l4 . 2361The options can be combined using commas. 2362.Pp 2363.Bl -tag -width ".Cm l2" -compact 2364.It Cm l2 2365src/dst mac address and optional vlan number. 2366.It Cm l3 2367src/dst address for IPv4 or IPv6. 2368.It Cm l4 2369src/dst port for TCP/UDP/SCTP. 2370.El 2371.Pp 2372.El 2373.Pp 2374The following parameters are specific to IP tunnel interfaces, 2375.Xr gif 4 : 2376.Bl -tag -width indent 2377.It Cm tunnel Ar src_addr dest_addr 2378Configure the physical source and destination address for IP tunnel 2379interfaces. 2380The arguments 2381.Ar src_addr 2382and 2383.Ar dest_addr 2384are interpreted as the outer source/destination for the encapsulating 2385IPv4/IPv6 header. 2386.It Fl tunnel 2387Unconfigure the physical source and destination address for IP tunnel 2388interfaces previously configured with 2389.Cm tunnel . 2390.It Cm deletetunnel 2391Another name for the 2392.Fl tunnel 2393parameter. 2394.It Cm accept_rev_ethip_ver 2395Set a flag to accept both correct EtherIP packets and ones 2396with reversed version field. Enabled by default. 2397This is for backward compatibility with 2398.Fx 6.1 , 23996.2, 6.3, 7.0, and 7.1. 2400.It Cm -accept_rev_ethip_ver 2401Clear a flag 2402.Cm accept_rev_ethip_ver . 2403.It Cm send_rev_ethip_ver 2404Set a flag to send EtherIP packets with reversed version 2405field intentionally. Disabled by default. 2406This is for backward compatibility with 2407.Fx 6.1 , 24086.2, 6.3, 7.0, and 7.1. 2409.It Cm -send_rev_ethip_ver 2410Clear a flag 2411.Cm send_rev_ethip_ver . 2412.El 2413.Pp 2414The following parameters are specific to GRE tunnel interfaces, 2415.Xr gre 4 : 2416.Bl -tag -width indent 2417.It Cm grekey Ar key 2418Configure the GRE key to be used for outgoing packets. 2419Note that 2420.Xr gre 4 will always accept GRE packets with invalid or absent keys. 2421This command will result in a four byte MTU reduction on the interface. 2422.El 2423.Pp 2424The following parameters are specific to 2425.Xr pfsync 4 2426interfaces: 2427.Bl -tag -width indent 2428.It Cm syncdev Ar iface 2429Use the specified interface 2430to send and receive pfsync state synchronisation messages. 2431.It Fl syncdev 2432Stop sending pfsync state synchronisation messages over the network. 2433.It Cm syncpeer Ar peer_address 2434Make the pfsync link point-to-point rather than using 2435multicast to broadcast the state synchronisation messages. 2436The peer_address is the IP address of the other host taking part in 2437the pfsync cluster. 2438.It Fl syncpeer 2439Broadcast the packets using multicast. 2440.It Cm maxupd Ar n 2441Set the maximum number of updates for a single state which 2442can be collapsed into one. 2443This is an 8-bit number; the default value is 128. 2444.It Cm defer 2445Defer transmission of the first packet in a state until a peer has 2446acknowledged that the associated state has been inserted. 2447.It Fl defer 2448Do not defer the first packet in a state. 2449This is the default. 2450.El 2451.Pp 2452The following parameters are specific to 2453.Xr vlan 4 2454interfaces: 2455.Bl -tag -width indent 2456.It Cm vlan Ar vlan_tag 2457Set the VLAN tag value to 2458.Ar vlan_tag . 2459This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q 2460VLAN header for packets sent from the 2461.Xr vlan 4 2462interface. 2463Note that 2464.Cm vlan 2465and 2466.Cm vlandev 2467must both be set at the same time. 2468.It Cm vlandev Ar iface 2469Associate the physical interface 2470.Ar iface 2471with a 2472.Xr vlan 4 2473interface. 2474Packets transmitted through the 2475.Xr vlan 4 2476interface will be 2477diverted to the specified physical interface 2478.Ar iface 2479with 802.1Q VLAN encapsulation. 2480Packets with 802.1Q encapsulation received 2481by the parent interface with the correct VLAN Identifier will be diverted to 2482the associated 2483.Xr vlan 4 2484pseudo-interface. 2485The 2486.Xr vlan 4 2487interface is assigned a 2488copy of the parent interface's flags and the parent's ethernet address. 2489The 2490.Cm vlandev 2491and 2492.Cm vlan 2493must both be set at the same time. 2494If the 2495.Xr vlan 4 2496interface already has 2497a physical interface associated with it, this command will fail. 2498To 2499change the association to another physical interface, the existing 2500association must be cleared first. 2501.Pp 2502Note: if the hardware tagging capability 2503is set on the parent interface, the 2504.Xr vlan 4 2505pseudo 2506interface's behavior changes: 2507the 2508.Xr vlan 4 2509interface recognizes that the 2510parent interface supports insertion and extraction of VLAN tags on its 2511own (usually in firmware) and that it should pass packets to and from 2512the parent unaltered. 2513.It Fl vlandev Op Ar iface 2514If the driver is a 2515.Xr vlan 4 2516pseudo device, disassociate the parent interface from it. 2517This breaks the link between the 2518.Xr vlan 4 2519interface and its parent, 2520clears its VLAN Identifier, flags and its link address and shuts the interface 2521down. 2522The 2523.Ar iface 2524argument is useless and hence deprecated. 2525.El 2526.Pp 2527The following parameters are used to configure 2528.Xr carp 4 2529protocol on an interface: 2530.Bl -tag -width indent 2531.It Cm vhid Ar n 2532Set the virtual host ID. 2533This is a required setting to initiate 2534.Xr carp 4 . 2535If the virtual host ID does not exist yet, it is created and attached to the 2536interface, otherwise configuration of an existing vhid is adjusted. 2537If the 2538.Cm vhid 2539keyword is supplied along with an 2540.Dq inet6 2541or 2542.Dq inet 2543address, then this address is configured to be run under control of the 2544specified vhid. 2545Whenever a last address that refers to a particular vhid is removed from an 2546interface, the vhid is automatically removed from interface and destroyed. 2547Any other configuration parameters for the 2548.Xr carp 4 2549protocol should be supplied along with the 2550.Cm vhid 2551keyword. 2552Acceptable values for vhid are 1 to 255. 2553.It Cm advbase Ar seconds 2554Specifies the base of the advertisement interval in seconds. 2555The acceptable values are 1 to 255. 2556The default value is 1. 2557.It Cm advskew Ar interval 2558Specifies the skew to add to the base advertisement interval to 2559make one host advertise slower than another host. 2560It is specified in 1/256 of seconds. 2561The acceptable values are 1 to 254. 2562The default value is 0. 2563.It Cm pass Ar phrase 2564Set the authentication key to 2565.Ar phrase . 2566.It Cm state Ar MASTER|BACKUP 2567Forcibly change state of a given vhid. 2568.El 2569.Pp 2570The 2571.Nm 2572utility displays the current configuration for a network interface 2573when no optional parameters are supplied. 2574If a protocol family is specified, 2575.Nm 2576will report only the details specific to that protocol family. 2577.Pp 2578If the 2579.Fl m 2580flag is passed before an interface name, 2581.Nm 2582will display the capability list and all 2583of the supported media for the specified interface. 2584If 2585.Fl L 2586flag is supplied, address lifetime is displayed for IPv6 addresses, 2587as time offset string. 2588.Pp 2589Optionally, the 2590.Fl a 2591flag may be used instead of an interface name. 2592This flag instructs 2593.Nm 2594to display information about all interfaces in the system. 2595The 2596.Fl d 2597flag limits this to interfaces that are down, and 2598.Fl u 2599limits this to interfaces that are up. 2600When no arguments are given, 2601.Fl a 2602is implied. 2603.Pp 2604The 2605.Fl l 2606flag may be used to list all available interfaces on the system, with 2607no other additional information. 2608Use of this flag is mutually exclusive 2609with all other flags and commands, except for 2610.Fl d 2611(only list interfaces that are down) 2612and 2613.Fl u 2614(only list interfaces that are up). 2615.Pp 2616The 2617.Fl v 2618flag may be used to get more verbose status for an interface. 2619.Pp 2620The 2621.Fl C 2622flag may be used to list all of the interface cloners available on 2623the system, with no additional information. 2624Use of this flag is mutually exclusive with all other flags and commands. 2625.Pp 2626The 2627.Fl k 2628flag causes keying information for the interface, if available, to be 2629printed. 2630For example, the values of 802.11 WEP keys and 2631.Xr carp 4 2632passphrases will be printed, if accessible to the current user. 2633This information is not printed by default, as it may be considered 2634sensitive. 2635.Pp 2636If the network interface driver is not present in the kernel then 2637.Nm 2638will attempt to load it. 2639The 2640.Fl n 2641flag disables this behavior. 2642.Pp 2643Only the super-user may modify the configuration of a network interface. 2644.Sh EXAMPLES 2645Assign the IPv4 address 2646.Li 192.0.2.10 , 2647with a network mask of 2648.Li 255.255.255.0 , 2649to the interface 2650.Li fxp0 : 2651.Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0 2652.Pp 2653Add the IPv4 address 2654.Li 192.0.2.45 , 2655with the CIDR network prefix 2656.Li /28 , 2657to the interface 2658.Li ed0 , 2659using 2660.Cm add 2661as a synonym for the canonical form of the option 2662.Cm alias : 2663.Dl # ifconfig ed0 inet 192.0.2.45/28 add 2664.Pp 2665Remove the IPv4 address 2666.Li 192.0.2.45 2667from the interface 2668.Li ed0 : 2669.Dl # ifconfig ed0 inet 192.0.2.45 -alias 2670.Pp 2671Enable IPv6 functionality of the interface: 2672.Dl # ifconfig em0 inet6 -ifdisabled 2673.Pp 2674Add the IPv6 address 2675.Li 2001:DB8:DBDB::123/48 2676to the interface 2677.Li em0 : 2678.Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias 2679Note that lower case hexadecimal IPv6 addresses are acceptable. 2680.Pp 2681Remove the IPv6 address added in the above example, 2682using the 2683.Li / 2684character as shorthand for the network prefix, 2685and using 2686.Cm delete 2687as a synonym for the canonical form of the option 2688.Fl alias : 2689.Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete 2690.Pp 2691Configure a single CARP redundant address on igb0, and then switch it 2692to be master: 2693.Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up 2694.Dl # ifconfig igb0 vhid 1 state master 2695.Pp 2696Configure the interface 2697.Li xl0 , 2698to use 100baseTX, full duplex Ethernet media options: 2699.Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex 2700.Pp 2701Label the em0 interface as an uplink: 2702.Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&" 2703.Pp 2704Create the software network interface 2705.Li gif1 : 2706.Dl # ifconfig gif1 create 2707.Pp 2708Destroy the software network interface 2709.Li gif1 : 2710.Dl # ifconfig gif1 destroy 2711.Pp 2712Display available wireless networks using 2713.Li wlan0 : 2714.Dl # ifconfig wlan0 list scan 2715.Sh DIAGNOSTICS 2716Messages indicating the specified interface does not exist, the 2717requested address is unknown, or the user is not privileged and 2718tried to alter an interface's configuration. 2719.Sh SEE ALSO 2720.Xr netstat 1 , 2721.Xr carp 4 , 2722.Xr gif 4 , 2723.Xr netintro 4 , 2724.Xr pfsync 4 , 2725.Xr polling 4 , 2726.Xr vlan 4 , 2727.Xr devd.conf 5 , 2728.\" .Xr eon 5 , 2729.Xr devd 8 , 2730.Xr rc 8 , 2731.Xr routed 8 , 2732.Xr jail 8 , 2733.Xr sysctl 8 2734.Sh HISTORY 2735The 2736.Nm 2737utility appeared in 2738.Bx 4.2 . 2739.Sh BUGS 2740Basic IPv6 node operation requires a link-local address on each 2741interface configured for IPv6. 2742Normally, such an address is automatically configured by the 2743kernel on each interface added to the system or enabled; this behavior may 2744be disabled by setting per-interface flag 2745.Cm -auto_linklocal . 2746The default value of this flag is 1 and can be disabled by using the sysctl 2747MIB variable 2748.Va net.inet6.ip6.auto_linklocal . 2749.Pp 2750Do not configure IPv6 addresses with no link-local address by using 2751.Nm . 2752It can result in unexpected behaviors of the kernel. 2753