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