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