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