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