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