1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 4. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94 29.\" $FreeBSD$ 30.\" 31.Dd July 8, 2007 32.Dt IFCONFIG 8 33.Os 34.Sh NAME 35.Nm ifconfig 36.Nd configure network interface parameters 37.Sh SYNOPSIS 38.Nm 39.Op Fl L 40.Op Fl k 41.Op Fl m 42.Op Fl n 43.Ar interface 44.Op Cm create 45.Op Ar address_family 46.Oo 47.Ar address 48.Op Ar dest_address 49.Oc 50.Op Ar parameters 51.Nm 52.Ar interface 53.Cm destroy 54.Nm 55.Fl a 56.Op Fl L 57.Op Fl d 58.Op Fl m 59.Op Fl u 60.Op Fl v 61.Op Ar address_family 62.Nm 63.Fl l 64.Op Fl d 65.Op Fl u 66.Op Ar address_family 67.Nm 68.Op Fl L 69.Op Fl d 70.Op Fl k 71.Op Fl m 72.Op Fl u 73.Op Fl v 74.Op Fl C 75.Nm 76.Op Fl g Ar groupname 77.Sh DESCRIPTION 78The 79.Nm 80utility is used to assign an address 81to a network interface and/or configure 82network interface parameters. 83The 84.Nm 85utility must be used at boot time to define the network address 86of each interface present on a machine; it may also be used at 87a later time to redefine an interface's address 88or other operating parameters. 89.Pp 90The following options are available: 91.Bl -tag -width indent 92.It Ar address 93For the 94.Tn DARPA Ns -Internet 95family, 96the address is either a host name present in the host name data 97base, 98.Xr hosts 5 , 99or a 100.Tn DARPA 101Internet address expressed in the Internet standard 102.Dq dot notation . 103.Pp 104It is also possible to use the CIDR notation (also known as the 105slash notation) to include the netmask. 106That is, one can specify an address like 107.Li 192.168.0.1/16 . 108.Pp 109For 110.Dq inet6 111family, it is also possible to specify the prefix length using the slash 112notation, like 113.Li ::1/128 . 114See the 115.Cm prefixlen 116parameter below for more information. 117.\" For the Xerox Network Systems(tm) family, 118.\" addresses are 119.\" .Ar net:a.b.c.d.e.f , 120.\" where 121.\" .Ar net 122.\" is the assigned network number (in decimal), 123.\" and each of the six bytes of the host number, 124.\" .Ar a 125.\" through 126.\" .Ar f , 127.\" are specified in hexadecimal. 128.\" The host number may be omitted on IEEE 802 protocol 129.\" (Ethernet, FDDI, and Token Ring) interfaces, 130.\" which use the hardware physical address, 131.\" and on interfaces other than the first. 132.\" For the 133.\" .Tn ISO 134.\" family, addresses are specified as a long hexadecimal string, 135.\" as in the Xerox family. 136.\" However, two consecutive dots imply a zero 137.\" byte, and the dots are optional, if the user wishes to (carefully) 138.\" count out long strings of digits in network byte order. 139.Pp 140The link-level 141.Pq Dq link 142address 143is specified as a series of colon-separated hex digits. 144This can be used to 145e.g.\& set a new MAC address on an ethernet interface, though the 146mechanism used is not ethernet-specific. 147If the interface is already 148up when this option is used, it will be briefly brought down and 149then brought back up again in order to ensure that the receive 150filter in the underlying ethernet hardware is properly reprogrammed. 151.It Ar address_family 152Specify the 153address family 154which affects interpretation of the remaining parameters. 155Since an interface can receive transmissions in differing protocols 156with different naming schemes, specifying the address family is recommended. 157The address or protocol families currently 158supported are 159.Dq inet , 160.Dq inet6 , 161.Dq atalk , 162.Dq ipx , 163.\" .Dq iso , 164and 165.Dq link . 166.\" and 167.\" .Dq ns . 168The default is 169.Dq inet . 170.Dq ether 171and 172.Dq lladdr 173are synonyms for 174.Dq link . 175.It Ar dest_address 176Specify the address of the correspondent on the other end 177of a point to point link. 178.It Ar interface 179This 180parameter is a string of the form 181.Dq name unit , 182for example, 183.Dq Li ed0 . 184.It Ar groupname 185List the interfaces in the given group. 186.El 187.Pp 188The following parameters may be set with 189.Nm : 190.Bl -tag -width indent 191.It Cm add 192Another name for the 193.Cm alias 194parameter. 195Introduced for compatibility 196with 197.Bsx . 198.It Cm alias 199Establish an additional network address for this interface. 200This is sometimes useful when changing network numbers, and 201one wishes to accept packets addressed to the old interface. 202If the address is on the same subnet as the first network address 203for this interface, a non-conflicting netmask must be given. 204Usually 205.Li 0xffffffff 206is most appropriate. 207.It Fl alias 208Remove the network address specified. 209This would be used if you incorrectly specified an alias, or it 210was no longer needed. 211If you have incorrectly set an NS address having the side effect 212of specifying the host portion, removing all NS addresses will 213allow you to respecify the host portion. 214.It Cm anycast 215(Inet6 only.) 216Specify that the address configured is an anycast address. 217Based on the current specification, 218only routers may configure anycast addresses. 219Anycast address will not be used as source address of any of outgoing 220IPv6 packets. 221.It Cm arp 222Enable the use of the Address Resolution Protocol 223.Pq Xr arp 4 224in mapping 225between network level addresses and link level addresses (default). 226This is currently implemented for mapping between 227.Tn DARPA 228Internet 229addresses and 230.Tn IEEE 231802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses). 232.It Fl arp 233Disable the use of the Address Resolution Protocol 234.Pq Xr arp 4 . 235.It Cm staticarp 236If the Address Resolution Protocol is enabled, 237the host will only reply to requests for its addresses, 238and will never send any requests. 239.It Fl staticarp 240If the Address Resolution Protocol is enabled, 241the host will perform normally, 242sending out requests and listening for replies. 243.It Cm broadcast 244(Inet only.) 245Specify the address to use to represent broadcasts to the 246network. 247The default broadcast address is the address with a host part of all 1's. 248.It Cm debug 249Enable driver dependent debugging code; usually, this turns on 250extra console error logging. 251.It Fl debug 252Disable driver dependent debugging code. 253.It Cm promisc 254Put interface into permanently promiscuous mode. 255.It Fl promisc 256Disable permanently promiscuous mode. 257.It Cm delete 258Another name for the 259.Fl alias 260parameter. 261.It Cm down 262Mark an interface 263.Dq down . 264When an interface is marked 265.Dq down , 266the system will not attempt to 267transmit messages through that interface. 268If possible, the interface will be reset to disable reception as well. 269This action does not automatically disable routes using the interface. 270.It Cm group Ar group-name 271Assign the interface to a 272.Dq group . 273Any interface can be in multiple groups. 274.Pp 275Cloned interfaces are members of their interface family group by default. 276For example, a PPP interface such as 277.Em ppp0 278is a member of the PPP interface family group, 279.Em ppp . 280.\" The interface(s) the default route(s) point to are members of the 281.\" .Em egress 282.\" interface group. 283.It Cm -group Ar group-name 284Remove the interface from the given 285.Dq group . 286.It Cm eui64 287(Inet6 only.) 288Fill interface index 289(lowermost 64bit of an IPv6 address) 290automatically. 291.It Cm ipdst 292This is used to specify an Internet host who is willing to receive 293IP packets encapsulating IPX packets bound for a remote network. 294An apparent point to point link is constructed, and 295the address specified will be taken as the IPX address and network 296of the destination. 297.It Cm maclabel Ar label 298If Mandatory Access Control support is enabled in the kernel, 299set the MAC label to 300.Ar label . 301.\" (see 302.\" .Xr maclabel 7 ) . 303.It Cm media Ar type 304If the driver supports the media selection system, set the media type 305of the interface to 306.Ar type . 307Some interfaces support the mutually exclusive use of one of several 308different physical media connectors. 309For example, a 10Mbit/s Ethernet 310interface might support the use of either 311.Tn AUI 312or twisted pair connectors. 313Setting the media type to 314.Cm 10base5/AUI 315would change the currently active connector to the AUI port. 316Setting it to 317.Cm 10baseT/UTP 318would activate twisted pair. 319Refer to the interfaces' driver 320specific documentation or man page for a complete list of the 321available types. 322.It Cm mediaopt Ar opts 323If the driver supports the media selection system, set the specified 324media options on the interface. 325The 326.Ar opts 327argument 328is a comma delimited list of options to apply to the interface. 329Refer to the interfaces' driver specific man page for a complete 330list of available options. 331.It Fl mediaopt Ar opts 332If the driver supports the media selection system, disable the 333specified media options on the interface. 334.It Cm mode Ar mode 335If the driver supports the media selection system, set the specified 336operating mode on the interface to 337.Ar mode . 338For IEEE 802.11 wireless interfaces that support multiple operating modes 339this directive is used to select between 802.11a 340.Pq Cm 11a , 341802.11b 342.Pq Cm 11b , 343and 802.11g 344.Pq Cm 11g 345operating modes. 346.It Cm inst Ar minst , Cm instance Ar minst 347Set the media instance to 348.Ar minst . 349This is useful for devices which have multiple physical layer interfaces 350.Pq PHYs . 351.It Cm name Ar name 352Set the interface name to 353.Ar name . 354.It Cm rxcsum , txcsum 355If the driver supports user-configurable checksum offloading, 356enable receive (or transmit) checksum offloading on the interface. 357Some drivers may not be able to enable these flags independently 358of each other, so setting one may also set the other. 359The driver will offload as much checksum work as it can reliably 360support, the exact level of offloading varies between drivers. 361.It Fl rxcsum , txcsum 362If the driver supports user-configurable checksum offloading, 363disable receive (or transmit) checksum offloading on the interface. 364These settings may not always be independent of each other. 365.It Cm tso 366If the driver supports 367.Xr tcp 4 368segmentation offloading, enable TSO on the interface. 369Some drivers may not be able to support TSO for 370.Xr ip 4 371and 372.Xr ip6 4 373packets, so they may enable only one of them. 374.It Fl tso 375If the driver supports 376.Xr tcp 4 377segmentation offloading, disable TSO on the interface. 378It will always disable TSO for 379.Xr ip 4 380and 381.Xr ip6 4 . 382.It Cm lro 383If the driver supports 384.Xr tcp 4 385large receive offloading, enable LRO on the interface. 386.It Fl lro 387If the driver supports 388.Xr tcp 4 389large receive offloading, disable LRO on the interface. 390.It Cm vlanmtu , vlanhwtag 391If the driver offers user-configurable VLAN support, enable 392reception of extended frames or tag processing in hardware, 393respectively. 394Note that this must be issued on a physical interface associated with 395.Xr vlan 4 , 396not on a 397.Xr vlan 4 398interface itself. 399.It Fl vlanmtu , vlanhwtag 400If the driver offers user-configurable VLAN support, disable 401reception of extended frames or tag processing in hardware, 402respectively. 403.It Cm polling 404Turn on 405.Xr polling 4 406feature and disable interrupts on the interface, if driver supports 407this mode. 408.It Fl polling 409Turn off 410.Xr polling 4 411feature and enable interrupt mode on the interface. 412.It Cm create 413Create the specified network pseudo-device. 414If the interface is given without a unit number, try to create a new 415device with an arbitrary unit number. 416If creation of an arbitrary device is successful, the new device name is 417printed to standard output unless the interface is renamed or destroyed 418in the same 419.Nm 420invocation. 421.It Cm destroy 422Destroy the specified network pseudo-device. 423.It Cm plumb 424Another name for the 425.Cm create 426parameter. 427Included for 428.Tn Solaris 429compatibility. 430.It Cm unplumb 431Another name for the 432.Cm destroy 433parameter. 434Included for 435.Tn Solaris 436compatibility. 437.It Cm metric Ar n 438Set the routing metric of the interface to 439.Ar n , 440default 0. 441The routing metric is used by the routing protocol 442.Pq Xr routed 8 . 443Higher metrics have the effect of making a route 444less favorable; metrics are counted as additional hops 445to the destination network or host. 446.It Cm mtu Ar n 447Set the maximum transmission unit of the interface to 448.Ar n , 449default is interface specific. 450The MTU is used to limit the size of packets that are transmitted on an 451interface. 452Not all interfaces support setting the MTU, and some interfaces have 453range restrictions. 454.It Cm netmask Ar mask 455.\" (Inet and ISO.) 456(Inet only.) 457Specify how much of the address to reserve for subdividing 458networks into sub-networks. 459The mask includes the network part of the local address 460and the subnet part, which is taken from the host field of the address. 461The mask can be specified as a single hexadecimal number 462with a leading 463.Ql 0x , 464with a dot-notation Internet address, 465or with a pseudo-network name listed in the network table 466.Xr networks 5 . 467The mask contains 1's for the bit positions in the 32-bit address 468which are to be used for the network and subnet parts, 469and 0's for the host part. 470The mask should contain at least the standard network portion, 471and the subnet field should be contiguous with the network 472portion. 473.Pp 474The netmask can also be specified in CIDR notation after the address. 475See the 476.Ar address 477option above for more information. 478.It Cm prefixlen Ar len 479(Inet6 only.) 480Specify that 481.Ar len 482bits are reserved for subdividing networks into sub-networks. 483The 484.Ar len 485must be integer, and for syntactical reason it must be between 0 to 128. 486It is almost always 64 under the current IPv6 assignment rule. 487If the parameter is omitted, 64 is used. 488.Pp 489The prefix can also be specified using the slash notation after the address. 490See the 491.Ar address 492option above for more information. 493.\" see 494.\" Xr eon 5 . 495.\" .It Cm nsellength Ar n 496.\" .Pf ( Tn ISO 497.\" only) 498.\" This specifies a trailing number of bytes for a received 499.\" .Tn NSAP 500.\" used for local identification, the remaining leading part of which is 501.\" taken to be the 502.\" .Tn NET 503.\" (Network Entity Title). 504.\" The default value is 1, which is conformant to US 505.\" .Tn GOSIP . 506.\" When an ISO address is set in an ifconfig command, 507.\" it is really the 508.\" .Tn NSAP 509.\" which is being specified. 510.\" For example, in 511.\" .Tn US GOSIP , 512.\" 20 hex digits should be 513.\" specified in the 514.\" .Tn ISO NSAP 515.\" to be assigned to the interface. 516.\" There is some evidence that a number different from 1 may be useful 517.\" for 518.\" .Tn AFI 519.\" 37 type addresses. 520.It Cm range Ar netrange 521Under appletalk, set the interface to respond to a 522.Ar netrange 523of the form 524.Ar startnet Ns - Ns Ar endnet . 525Appletalk uses this scheme instead of 526netmasks though 527.Fx 528implements it internally as a set of netmasks. 529.It Cm remove 530Another name for the 531.Fl alias 532parameter. 533Introduced for compatibility 534with 535.Bsx . 536.It Cm phase 537The argument following this specifies the version (phase) of the 538Appletalk network attached to the interface. 539Values of 1 or 2 are permitted. 540.Sm off 541.It Cm link Op Cm 0 No - Cm 2 542.Sm on 543Enable special processing of the link level of the interface. 544These three options are interface specific in actual effect, however, 545they are in general used to select special modes of operation. 546An example 547of this is to enable SLIP compression, or to select the connector type 548for some Ethernet cards. 549Refer to the man page for the specific driver 550for more information. 551.Sm off 552.It Fl link Op Cm 0 No - Cm 2 553.Sm on 554Disable special processing at the link level with the specified interface. 555.It Cm monitor 556Put the interface in monitor mode. 557No packets are transmitted, and received packets are discarded after 558.Xr bpf 4 559processing. 560.It Fl monitor 561Take the interface out of monitor mode. 562.It Cm up 563Mark an interface 564.Dq up . 565This may be used to enable an interface after an 566.Dq Nm Cm down . 567It happens automatically when setting the first address on an interface. 568If the interface was reset when previously marked down, 569the hardware will be re-initialized. 570.El 571.Pp 572The following parameters are specific to IEEE 802.11 wireless interfaces: 573.Bl -tag -width indent 574.It Cm apbridge 575When operating as an access point, pass packets between 576wireless clients directly (default). 577To instead let them pass up through the 578system and be forwarded using some other mechanism, use 579.Fl apbridge . 580Disabling the internal bridging 581is useful when traffic is to be processed with 582packet filtering. 583.It Cm authmode Ar mode 584Set the desired authentication mode in infrastructure mode. 585Not all adaptors support all modes. 586The set of 587valid modes is 588.Cm none , open , shared 589(shared key), 590.Cm 8021x 591(IEEE 802.1x), 592and 593.Cm wpa 594(IEEE WPA/WPA2/802.11i). 595The 596.Cm 8021x 597and 598.Cm wpa 599modes are only useful when using an authentication service 600(a supplicant for client operation or an authenticator when 601operating as an access point). 602Modes are case insensitive. 603.It Cm bgscan 604Enable background scanning when operating as a station. 605Background scanning is a technique whereby a station associated to 606an access point will temporarily leave the channel to scan for 607neighboring stations. 608This allows a station to maintain a cache of nearby access points 609so that roaming between access points can be done without doing 610a lengthy scan operation. 611Background scanning is done only when a station is not busy and 612any outbound traffic will cancel a scan operation. 613Background scanning should never cause packets to be lost though 614there may be some small latency if outbound traffic interrupts a 615scan operation. 616By default background scanning is enabled if the device is capable. 617To disable background scanning, use 618.Fl bgscan . 619Background scanning is controlled by the 620.Cm bgscanidle 621and 622.Cm bgscanintvl 623parameters. 624Background scanning must be enabled for roaming; this is an artifact 625of the current implementation and may not be required in the future. 626.It Cm bgscanidle Ar idletime 627Set the minimum time a station must be idle (not transmitting or 628receiving frames) before a background scan is initiated. 629The 630.Ar idletime 631parameter is specified in milliseconds. 632By default a station must be idle at least 250 milliseconds before 633a background scan is initiated. 634The idle time may not be set to less than 100 milliseconds. 635.It Cm bgscanintvl Ar interval 636Set the interval at which background scanning is attempted. 637The 638.Ar interval 639parameter is specified in seconds. 640By default a background scanning is considered every 300 seconds (5 minutes). 641The 642.Ar interval 643may not be set to less than 15 seconds. 644.It Cm bintval Ar interval 645Set the interval at which beacon frames are sent when operating in 646ad-hoc or ap mode. 647The 648.Ar interval 649parameter is specified in TU's (1024 usecs). 650By default beacon frames are transmitted every 100 TU's. 651.It Cm bmissthreshold Ar count 652Set the number of consecutive missed beacons at which the station 653will attempt to roam (i.e., search for a new access point). 654The 655.Ar count 656parameter must be in the range 1 to 255; though the 657upper bound may be reduced according to device capabilities. 658The default threshold is 7 consecutive missed beacons; but 659this may be overridden by the device driver. 660Another name for the 661.Cm bmissthreshold 662parameter is 663.Cm bmiss . 664.It Cm bssid Ar address 665Specify the MAC address of the access point to use when operating 666as a station in a BSS network. 667This overrides any automatic selection done by the system. 668To disable a previously selected access point, supply 669.Cm any , none , 670or 671.Cm - 672for the address. 673This option is useful when more than one access point uses the same SSID. 674Another name for the 675.Cm bssid 676parameter is 677.Cm ap . 678.It Cm burst 679Enable packet bursting. 680Packet bursting is a transmission technique whereby the wireless 681medium is acquired once to send multiple frames and the interframe 682spacing is reduced. 683This technique can significantly increase throughput by reducing 684transmission overhead. 685Packet bursting is supported by the 802.11e QoS specification 686and some devices that do not support QoS may still be capable. 687By default packet bursting is enabled if a device is capable 688of doing it. 689To disable packet bursting, use 690.Fl burst . 691.It Cm chanlist Ar channels 692Set the desired channels to use when scanning for access 693points, neighbors in an IBSS network, or looking for unoccupied 694channels when operating as an access point. 695The set of channels is specified as a comma-separated list with 696each element in the list representing either a single channel number or a range 697of the form 698.Dq Li a-b . 699Channel numbers must be in the range 1 to 255 and be permissible 700according to the operating characteristics of the device. 701.It Cm channel Ar number 702Set a single desired channel. 703Channels range from 1 to 255, but the exact selection available 704depends on the region your adaptor was manufactured for. 705Setting 706the channel to 707.Li 0 , 708.Cm any , 709or 710.Cm - 711will give you the default for your adaptor. 712Some 713adaptors ignore this setting unless you are in ad-hoc mode. 714Alternatively the frequency, in megahertz, may be specified 715instead of the channel number. 716.Pp 717When there are several ways to use a channel the channel 718number/frequency may be appended with attributes to clarify. 719For example, if a device is capable of operating on channel 6 720with 802.11n and 802.11g then one can specify that g-only use 721should be used by specifying ``6:g''. 722Similarly the channel width can be specified by appending it 723with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel, 724These attributes can be combined as in: ``6:ht/40''. 725The full set of flags specified following a `:'' are: 726.Cm a 727(802.11a), 728.Cm b 729(802.11b), 730.Cm d 731(Atheros Dynamic Turbo mode), 732.Cm g 733(802.11g), 734.Cm h 735or 736.Cm n 737(802.11n aka HT), 738.Cm s 739(Atheros Static Turbo mode), 740and 741.Cm t 742(Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt''). 743The full set of channel widths following a '/' are: 744.Cm 5 745(5MHz aka quarter-rate channel), 746.Cm 10 747(10MHz aka half-rate channel), 748.Cm 20 749(20MHz mostly for use in specifying ht20), 750and 751.Cm 40 752(40MHz mostly for use in specifying ht40), 753In addition, 754a 40MHz HT channel specification may include the location 755of the extension channel by appending ``+'' or ``-'' for above and below, 756respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation 757with the center channel at frequency 2437 and the extension channel above. 758.It Cm doth 759Enable inclusion of an 802.11h country information element in beacon 760frames transmitted when operating as an access point. 761By default 802.11h is enabled if the device is capable. 762To disable 802.11h use 763.Fl doth . 764.It Cm deftxkey Ar index 765Set the default key to use for transmission. 766Typically this is only set when using WEP encryption. 767The 768.Cm weptxkey 769is an alias for this request; it is provided for backwards compatibility. 770.It Cm dtimperiod Ar period 771Set the 772DTIM 773period for transmitting buffered multicast data frames when 774operating in ap mode. 775The 776.Ar period 777specifies the number of beacon intervals between DTIM 778and must be in the range 1 to 15. 779By default DTIM is 1 (i.e., DTIM occurs at each beacon). 780.It Cm dturbo 781Enable the use of Atheros Dynamic Turbo mode when communicating with 782another Dynamic Turbo-capable station. 783Dynamic Turbo mode is an Atheros-specific mechanism by which 784stations switch between normal 802.11 operation and a ``boosted'' 785mode in which a 40MHz wide channel is used for communication. 786Stations using Dynamic Turbo mode operate boosted only when the 787channel is free of non-dturbo stations; when a non-dturbo station 788is identified on the channel all stations will automatically drop 789back to normal operation. 790By default, Dynamic Turbo mode is not enabled, even if the device is capable. 791Note that turbo mode (dynamic or static) is only allowed on some 792channels depending on the regulatory constraints; use the 793.Cm list chan 794command to identify the channels where turbo mode may be used. 795To disable Dynamic Turbo mode use 796.Fl dturbo . 797.It Cm fragthreshold Ar length 798Set the threshold for which transmitted frames are broken into fragments. 799The 800.Ar length 801argument is the frame size in bytes and must be in the range 256 to 2346. 802Setting 803.Ar length 804to 805.Li 2346 , 806.Cm any , 807or 808.Cm - 809disables transmit fragmentation. 810Not all adaptors honor the fragmentation threshold. 811.It Cm hidessid 812When operating as an access point, do not broadcast the SSID 813in beacon frames or respond to probe request frames unless 814they are directed to the ap (i.e., they include the ap's SSID). 815By default, the SSID is included in beacon frames and 816undirected probe request frames are answered. 817To re-enable the broadcast of the SSID etc., use 818.Fl hidessid . 819.It Cm ff 820Enable the user of Atheros Fast Frames when communicating with 821another Fast Frames-capable station. 822Fast Frames are an encapsulation technique by which two 802.3 823frames are transmitted in a single 802.11 frame. 824This can noticeably improve throughput but requires that the 825receiving station understand how to decapsulate the frame. 826Fast frame use is negotiated using the Atheros 802.11 vendor-specific 827protocol extension so enabling use is safe when communicating with 828non-Atheros devices. 829By default, use of fast frames is enabled if the device is capable. 830To explicitly disable fast frames, use 831.Fl ff . 832.It Cm list active 833Display the list of channels available for use taking into account 834any restrictions set with the 835.Cm chanlist 836directive. 837See the description of 838.Cm list chan 839for more information. 840.It Cm list caps 841Display the adaptor's capabilities, including the operating 842modes supported. 843.It Cm list chan 844Display the list of channels available for use. 845Channels are shown with their IEEE channel number, equivalent 846frequency, and usage modes. 847Channels identified as 848.Ql 11g 849are also usable in 850.Ql 11b 851mode. 852Channels identified as 853.Ql 11a Turbo 854may be used only for Atheros' Static Turbo mode 855(specified with 856. Cm mediaopt turbo ) . 857Channels marked with a 858.Ql * 859have a regulatory constraint that they be passively scanned. 860This means a station is not permitted to transmit on the channel until 861it identifies the channel is being used for 802.11 communication; 862typically by hearing a beacon frame from an access point operating 863on the channel. 864.Cm list freq 865is another way of requesting this information. 866.It Cm list mac 867Display the current MAC Access Control List state. 868Each address is prefixed with a character that indicates the 869current policy applied to it: 870.Ql + 871indicates the address is allowed access, 872.Ql - 873indicates the address is denied access, 874.Ql * 875indicates the address is present but the current policy open 876(so the ACL is not consulted). 877.It Cm list scan 878Display the access points and/or ad-hoc neighbors 879located in the vicinity. 880The 881.Fl v 882flag may be used to display long SSIDs. 883This information may be updated automatically by the adaptor 884and/or with a 885.Cm scan 886request or through background scanning. 887.Cm list ap 888is another way of requesting this information. 889.It Cm list sta 890When operating as an access point display the stations that are 891currently associated. 892When operating in ad-hoc mode display stations identified as 893neighbors in the IBSS. 894When operating in station mode display the access point. 895Capabilities advertised by the stations are described under 896the 897.Cm scan 898request. 899Depending on the capabilities of the stations the following 900flags can be included in the output: 901.Bl -tag -width 3n 902.It Li A 903Authorized. 904Indicates that the station is permitted to send/receive data frames. 905.It Li E 906Extended Rate Phy (ERP). 907Indicates that the station is operating in an 802.11g network 908using extended transmit rates. 909.It Li H 910High Throughput (HT). 911Indicates that the station is using MCS to send/receive frames. 912.It Li P 913Power Save. 914Indicates that the station is operating in power save mode. 915.It Li Q 916Quality of Service (QoS). 917Indicates that the station is using QoS encapsulation for 918data frame. 919QoS encapsulation is enabled only when WME mode is enabled. 920.El 921.It Cm list wme 922Display the current parameters to use when operating in WME mode. 923When WME mode is enabled for an adaptor this information will be 924displayed with the regular status; this command is mostly useful 925for examining parameters when WME mode is disabled. 926See the description of the 927.Cm wme 928directive for information on the various parameters. 929.It Cm mcastrate Ar rate 930Set the rate for transmitting multicast/broadcast frames. 931Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s. 932This rate should be valid for the current operating conditions; 933if an invalid rate is specified drivers are free to chose an 934appropriate rate. 935.It Cm powersave 936Enable powersave operation. 937When operating as a client, the station will conserve power by 938periodically turning off the radio and listening for 939messages from the access point telling it there are packets waiting. 940The station must then retrieve the packets. 941Not all devices support power save operation as a client. 942The 802.11 specification requires that all access points support 943power save but some drivers do not. 944Use 945.Fl powersave 946to disable powersave operation when operating as a client. 947.It Cm powersavesleep Ar sleep 948Set the desired max powersave sleep time in TU's (1024 usecs). 949By default the max powersave sleep time is 100 TU's. 950.It Cm protmode Ar technique 951For interfaces operating in 802.11g, use the specified 952.Ar technique 953for protecting OFDM frames in a mixed 11b/11g network. 954The set of valid techniques is 955.Cm off , cts 956(CTS to self), 957and 958.Cm rtscts 959(RTS/CTS). 960Technique names are case insensitive. 961Not all devices support 962.Cm cts 963as a protection technique. 964.It Cm pureg 965When operating as an access point in 802.11g mode allow only 96611g-capable stations to associate (11b-only stations are not 967permitted to associate). 968To allow both 11g and 11b-only stations to associate, use 969.Fl pureg . 970.It Cm roaming Ar mode 971When operating as a station, control how the system will 972behave when communication with the current access point 973is broken. 974The 975.Ar mode 976argument may be one of 977.Cm device 978(leave it to the hardware device to decide), 979.Cm auto 980(handle either in the device or the operating system\[em]as appropriate), 981.Cm manual 982(do nothing until explicitly instructed). 983By default, the device is left to handle this if it is 984capable; otherwise, the operating system will automatically 985attempt to reestablish communication. 986Manual mode is used by applications such as 987.Xr wpa_supplicant 8 988that want to control the selection of an access point. 989.It Cm roam:rssi11a Ar rssi 990Set the threshold for controlling roaming when operating in an 991802.11a BSS. 992The 993.Ar rssi 994parameter specifies the receive signal strength in .5 dBm units 995at which roaming should be considered. 996If the current rssi drops below this setting and background scanning 997is enabled, then the system will check if a more desirable access point is 998available and switch over to it. 999The current scan cache contents are used if they are considered 1000valid according to the 1001.Cm scanvalid 1002parameter; otherwise a background scan operation is triggered before 1003any selection occurs. 1004By default 1005.Ar rssi 1006is set to 7 dBm. 1007.It Cm roam:rssi11b Ar rssi 1008Set the threshold for controlling roaming when operating in an 1009802.11b-only BSS. 1010See 1011.Cm roam:rssi11a 1012for a description of this parameter. 1013By default 1014.Ar rssi 1015is set to 7 dBm. 1016.It Cm roam:rssi11g Ar rssi 1017Set the threshold for controlling roaming when operating in a 1018(mixed) 802.11g BSS. 1019See 1020.Cm roam:rssi11a 1021for a description of this parameter. 1022By default 1023.Ar rssi 1024is set to 7 dBm. 1025.It Cm roam:rate11a Ar rate 1026Set the threshold for controlling roaming when operating in an 1027802.11a BSS. 1028The 1029.Ar rate 1030parameter specifies the transmit rate in megabits 1031at which roaming should be considered. 1032If the current transmit rate drops below this setting and background scanning 1033is enabled, then the system will check if a more desirable access point is 1034available and switch over to it. 1035The current scan cache contents are used if they are considered 1036valid according to the 1037.Cm scanvalid 1038parameter; otherwise a background scan operation is triggered before 1039any selection occurs. 1040By default 1041.Ar rate 1042is set to 12 Mb/s. 1043.It Cm roam:rate11b Ar rate 1044Set the threshold for controlling roaming when operating in an 1045802.11b-only BSS. 1046See 1047.Cm roam:rate11a 1048for a description of this parameter. 1049By default 1050.Ar rate 1051is set to 1 Mb/s. 1052.It Cm roam:rate11g Ar rate 1053Set the threshold for controlling roaming when operating in a 1054(mixed) 802.11g BSS. 1055See 1056.Cm roam:rate11a 1057for a description of this parameter. 1058By default 1059.Ar rate 1060is set to 5 Mb/s. 1061.It Cm rtsthreshold Ar length 1062Set the threshold for which 1063transmitted frames are preceded by transmission of an 1064RTS 1065control frame. 1066The 1067.Ar length 1068argument 1069is the frame size in bytes and must be in the range 1 to 2346. 1070Setting 1071.Ar length 1072to 1073.Li 2346 , 1074.Cm any , 1075or 1076.Cm - 1077disables transmission of RTS frames. 1078Not all adaptors support setting the RTS threshold. 1079.It Cm ssid Ar ssid 1080Set the desired Service Set Identifier (aka network name). 1081The SSID is a string up to 32 characters 1082in length and may be specified as either a normal string or in 1083hexadecimal when preceded by 1084.Ql 0x . 1085Additionally, the SSID may be cleared by setting it to 1086.Ql - . 1087.It Cm scan 1088Initiate a scan of neighboring stations, wait for it to complete, and 1089display all stations found. 1090Only the super-user can initiate a scan. 1091Depending on the capabilities of the APs, the following 1092flags can be included in the output: 1093.Bl -tag -width 3n 1094.It Li A 1095Channel Agility. 1096Indicates that the station support channel hopping as described by the 1097IEEE 802.11b specification. 1098.It Li B 1099Packet Binary Convolution Code (PBCC). 1100A modulation alternative to the standard OFDM method. 1101.It Dv C 1102Pollreq 1103.It Dv c 1104Pollable 1105.It Dv D 1106Direct Sequence Spread Spectrum (DSSSOFDM). 1107Indicates the the station supports DSSS modulation. 1108.It Li E 1109Extended Service Set (ESS). 1110Indicates that the station is part of an infrastructure network 1111(in contrast to an IBSS/ad-hoc network). 1112.It Li I 1113IBSS/ad-hoc network. 1114Indicates that the station is part of an ad-hoc network 1115(in contrast to an ESS network). 1116.It Li P 1117Privacy. 1118Data confidentiality is required for all data frames 1119exchanged within the BSS. 1120This means that this BSS requires the station to 1121use cryptographic means such as WEP, TKIP or AES-CCMP to 1122encrypt/decrypt data frames being exchanged with others. 1123.It Dv R 1124Robust Security Network (RSN). 1125Indicates that the station supports the IEEE 802.11i authentication 1126and key management protocol. 1127.It Li S 1128Short Preamble. 1129Indicates that the network is using short preambles (defined 1130in 802.11b High Rate/DSSS PHY, short preamble utilizes a 113156 bit sync field in contrast to a 128 bit field used in long 1132preamble mode). 1133.It Li s 1134Short slot time. 1135Indicates that the network is using a short slot time. 1136.El 1137.Pp 1138Interesting information elements captured from the neighboring 1139stations are displayed at the end of each row. 1140Possible elements are: 1141.Cm WME 1142(station supports WME), 1143.Cm WPA 1144(station supports WPA), 1145.Cm RSN 1146(station supports 802.11i/RSN), 1147.Cm HT 1148(station supports 802.11n/HT communication), 1149.Cm ATH 1150(station supoprts Atheros protocol extensions), 1151.Cm VEN 1152(station supports unknown vendor-specific extensions). 1153If the 1154.Fl v 1155flag is used the information element contents will be shown. 1156.Pp 1157The 1158.Cm list scan 1159request can be used to show recent scan results without 1160initiating a new scan. 1161.Pp 1162The 1163.Fl v 1164flag may be used to prevent the shortening of long SSIDs. 1165.It Cm scanvalid Ar threshold 1166Set the maximum time the scan cache contents are considered valid; 1167i.e. will be used without first triggering a scan operation to 1168refresh the data. 1169The 1170.Ar threshold 1171parameter is specified in seconds and defaults to 60 seconds. 1172The minimum setting for 1173.Ar threshold 1174is 10 seconds. 1175One should take care setting this threshold; if it is set too low 1176then attempts to roam to another access point may trigger unnecessary 1177background scan operations. 1178.It Cm stationname Ar name 1179Set the name of this station. 1180It appears that the station name is not really part of the IEEE 802.11 1181protocol though all interfaces seem to support it. 1182As such it only 1183seems to be meaningful to identical or virtually identical equipment. 1184Setting the station name is identical in syntax to setting the SSID. 1185.It Cm txpower Ar power 1186Set the power used to transmit frames. 1187The 1188.Ar power 1189argument 1190is a unitless value in the range 0 to 100 that is interpreted 1191by drivers to derive a device-specific value. 1192Out of range values are truncated. 1193Typically only a few discreet power settings are available and 1194the driver will use the setting closest to the specified value. 1195Not all adaptors support changing the transmit power. 1196.It Cm wepmode Ar mode 1197Set the desired WEP mode. 1198Not all adaptors support all modes. 1199The set of valid modes is 1200.Cm off , on , 1201and 1202.Cm mixed . 1203The 1204.Cm mixed 1205mode explicitly tells the adaptor to allow association with access 1206points which allow both encrypted and unencrypted traffic. 1207On these adaptors, 1208.Cm on 1209means that the access point must only allow encrypted connections. 1210On other adaptors, 1211.Cm on 1212is generally another name for 1213.Cm mixed . 1214Modes are case insensitive. 1215.It Cm weptxkey Ar index 1216Set the WEP key to be used for transmission. 1217This is the same as setting the default transmission key with 1218.Cm deftxkey . 1219.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key 1220Set the selected WEP key. 1221If an 1222.Ar index 1223is not given, key 1 is set. 1224A WEP key will be either 5 or 13 1225characters (40 or 104 bits) depending of the local network and the 1226capabilities of the adaptor. 1227It may be specified either as a plain 1228string or as a string of hexadecimal digits preceded by 1229.Ql 0x . 1230For maximum portability, hex keys are recommended; 1231the mapping of text keys to WEP encryption is usually driver-specific. 1232In particular, the 1233.Tn Windows 1234drivers do this mapping differently to 1235.Fx . 1236A key may be cleared by setting it to 1237.Ql - . 1238If WEP is supported then there are at least four keys. 1239Some adaptors support more than four keys. 1240If that is the case, then the first four keys 1241(1-4) will be the standard temporary keys and any others will be adaptor 1242specific keys such as permanent keys stored in NVRAM. 1243.It Cm wme 1244Enable Wireless Multimedia Extensions (WME) support, if available, 1245for the specified interface. 1246WME is a subset of the IEEE 802.11e standard to support the 1247efficient communication of realtime and multimedia data. 1248To disable WME support, use 1249.Fl wme . 1250.Pp 1251The following parameters are meaningful only when WME support is in use. 1252Parameters are specified per-AC (Access Category) and 1253split into those that are used by a station when acting 1254as an access point and those for client stations in the BSS. 1255The latter are received from the access point and may not be changed 1256(at the station). 1257The following Access Categories are recognized: 1258.Pp 1259.Bl -tag -width ".Cm AC_BK" -compact 1260.It Cm AC_BE 1261(or 1262.Cm BE ) 1263best effort delivery, 1264.It Cm AC_BK 1265(or 1266.Cm BK ) 1267background traffic, 1268.It Cm AC_VI 1269(or 1270.Cm VI ) 1271video traffic, 1272.It Cm AC_VO 1273(or 1274.Cm VO ) 1275voice traffic. 1276.El 1277.Pp 1278AC parameters are case-insensitive. 1279Traffic classification is done in the operating system using the 1280vlan priority associated with data frames or the 1281ToS (Type of Service) indication in IP-encapsulated frames. 1282If neither information is present, traffic is assigned to the 1283Best Effort (BE) category. 1284.Bl -tag -width indent 1285.It Cm ack Ar ac 1286Set the ACK policy for QoS transmissions by the local station; 1287this controls whether or not data frames transmitted by a station 1288require an ACK response from the receiving station. 1289To disable waiting for an ACK use 1290.Fl ack . 1291This parameter is applied only to the local station. 1292.It Cm acm Ar ac 1293Enable the Admission Control Mandatory (ACM) mechanism 1294for transmissions by the local station. 1295To disable the ACM use 1296.Fl acm . 1297On stations in a BSS this parameter is read-only and indicates 1298the setting received from the access point. 1299NB: ACM is not supported right now. 1300.It Cm aifs Ar ac Ar count 1301Set the Arbitration Inter Frame Spacing (AIFS) 1302channel access parameter to use for transmissions 1303by the local station. 1304On stations in a BSS this parameter is read-only and indicates 1305the setting received from the access point. 1306.It Cm cwmin Ar ac Ar count 1307Set the CWmin channel access parameter to use for transmissions 1308by the local station. 1309On stations in a BSS this parameter is read-only and indicates 1310the setting received from the access point. 1311.It Cm cwmax Ar ac Ar count 1312Set the CWmax channel access parameter to use for transmissions 1313by the local station. 1314On stations in a BSS this parameter is read-only and indicates 1315the setting received from the access point. 1316.It Cm txoplimit Ar ac Ar limit 1317Set the Transmission Opportunity Limit channel access parameter 1318to use for transmissions by the local station. 1319This parameter defines an interval of time when a WME station 1320has the right to initiate transmissions onto the wireless medium. 1321On stations in a BSS this parameter is read-only and indicates 1322the setting received from the access point. 1323.It Cm bss:aifs Ar ac Ar count 1324Set the AIFS channel access parameter to send to stations in a BSS. 1325This parameter is meaningful only when operating in ap mode. 1326.It Cm bss:cwmin Ar ac Ar count 1327Set the CWmin channel access parameter to send to stations in a BSS. 1328This parameter is meaningful only when operating in ap mode. 1329.It Cm bss:cwmax Ar ac Ar count 1330Set the CWmax channel access parameter to send to stations in a BSS. 1331This parameter is meaningful only when operating in ap mode. 1332.It Cm bss:txoplimit Ar ac Ar limit 1333Set the TxOpLimit channel access parameter to send to stations in a BSS. 1334This parameter is meaningful only when operating in ap mode. 1335.El 1336.El 1337.Pp 1338The following parameters support an optional access control list 1339feature available with some adaptors when operating in ap mode; see 1340.Xr wlan_acl 4 . 1341This facility allows an access point to accept/deny association 1342requests based on the MAC address of the station. 1343Note that this feature does not significantly enhance security 1344as MAC address spoofing is easy to do. 1345.Bl -tag -width indent 1346.It Cm mac:add Ar address 1347Add the specified MAC address to the database. 1348Depending on the policy setting association requests from the 1349specified station will be allowed or denied. 1350.It Cm mac:allow 1351Set the ACL policy to permit association only by 1352stations registered in the database. 1353.It Cm mac:del Ar address 1354Delete the specified MAC address from the database. 1355.It Cm mac:deny 1356Set the ACL policy to deny association only by 1357stations registered in the database. 1358.It Cm mac:kick Ar address 1359Force the specified station to be deauthenticated. 1360This typically is done to block a station after updating the 1361address database. 1362.It Cm mac:open 1363Set the ACL policy to allow all stations to associate. 1364.It Cm mac:flush 1365Delete all entries in the database. 1366.El 1367.Pp 1368The following parameters are for compatibility with other systems: 1369.Bl -tag -width indent 1370.It Cm nwid Ar ssid 1371Another name for the 1372.Cm ssid 1373parameter. 1374Included for 1375.Nx 1376compatibility. 1377.It Cm station Ar name 1378Another name for the 1379.Cm stationname 1380parameter. 1381Included for 1382.Bsx 1383compatibility. 1384.It Cm wep 1385Another way of saying 1386.Cm wepmode on . 1387Included for 1388.Bsx 1389compatibility. 1390.It Fl wep 1391Another way of saying 1392.Cm wepmode off . 1393Included for 1394.Bsx 1395compatibility. 1396.It Cm nwkey key 1397Another way of saying: 1398.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" . 1399Included for 1400.Nx 1401compatibility. 1402.It Cm nwkey Xo 1403.Sm off 1404.Ar n : k1 , k2 , k3 , k4 1405.Sm on 1406.Xc 1407Another way of saying 1408.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" . 1409Included for 1410.Nx 1411compatibility. 1412.It Fl nwkey 1413Another way of saying 1414.Cm wepmode off . 1415Included for 1416.Nx 1417compatibility. 1418.El 1419.Pp 1420The following parameters are specific to bridge interfaces: 1421.Bl -tag -width indent 1422.It Cm addm Ar interface 1423Add the interface named by 1424.Ar interface 1425as a member of the bridge. 1426The interface is put into promiscuous mode 1427so that it can receive every packet sent on the network. 1428.It Cm deletem Ar interface 1429Remove the interface named by 1430.Ar interface 1431from the bridge. 1432Promiscuous mode is disabled on the interface when 1433it is removed from the bridge. 1434.It Cm maxaddr Ar size 1435Set the size of the bridge address cache to 1436.Ar size . 1437The default is 100 entries. 1438.It Cm timeout Ar seconds 1439Set the timeout of address cache entries to 1440.Ar seconds 1441seconds. 1442If 1443.Ar seconds 1444is zero, then address cache entries will not be expired. 1445The default is 240 seconds. 1446.It Cm addr 1447Display the addresses that have been learned by the bridge. 1448.It Cm static Ar interface-name Ar address 1449Add a static entry into the address cache pointing to 1450.Ar interface-name . 1451Static entries are never aged out of the cache or re-placed, even if the 1452address is seen on a different interface. 1453.It Cm deladdr Ar address 1454Delete 1455.Ar address 1456from the address cache. 1457.It Cm flush 1458Delete all dynamically-learned addresses from the address cache. 1459.It Cm flushall 1460Delete all addresses, including static addresses, from the address cache. 1461.It Cm discover Ar interface 1462Mark an interface as a 1463.Dq discovering 1464interface. 1465When the bridge has no address cache entry 1466(either dynamic or static) 1467for the destination address of a packet, 1468the bridge will forward the packet to all 1469member interfaces marked as 1470.Dq discovering . 1471This is the default for all interfaces added to a bridge. 1472.It Cm -discover Ar interface 1473Clear the 1474.Dq discovering 1475attribute on a member interface. 1476For packets without the 1477.Dq discovering 1478attribute, the only packets forwarded on the interface are broadcast 1479or multicast packets and packets for which the destination address 1480is known to be on the interface's segment. 1481.It Cm learn Ar interface 1482Mark an interface as a 1483.Dq learning 1484interface. 1485When a packet arrives on such an interface, the source 1486address of the packet is entered into the address cache as being a 1487destination address on the interface's segment. 1488This is the default for all interfaces added to a bridge. 1489.It Cm -learn Ar interface 1490Clear the 1491.Dq learning 1492attribute on a member interface. 1493.It Cm sticky Ar interface 1494Mark an interface as a 1495.Dq sticky 1496interface. 1497Dynamically learned address entries are treated at static once entered into 1498the cache. 1499Sticky entries are never aged out of the cache or replaced, even if the 1500address is seen on a different interface. 1501.It Cm -sticky Ar interface 1502Clear the 1503.Dq sticky 1504attribute on a member interface. 1505.It Cm private Ar interface 1506Mark an interface as a 1507.Dq private 1508interface. 1509A private interface does not forward any traffic to any other port that is also 1510a private interface. 1511.It Cm -private Ar interface 1512Clear the 1513.Dq private 1514attribute on a member interface. 1515.It Cm span Ar interface 1516Add the interface named by 1517.Ar interface 1518as a span port on the bridge. 1519Span ports transmit a copy of every frame received by the bridge. 1520This is most useful for snooping a bridged network passively on 1521another host connected to one of the span ports of the bridge. 1522.It Cm -span Ar interface 1523Delete the interface named by 1524.Ar interface 1525from the list of span ports of the bridge. 1526.It Cm stp Ar interface 1527Enable Spanning Tree protocol on 1528.Ar interface . 1529The 1530.Xr if_bridge 4 1531driver has support for the IEEE 802.1D Spanning Tree protocol (STP). 1532Spanning Tree is used to detect and remove loops in a network topology. 1533.It Cm -stp Ar interface 1534Disable Spanning Tree protocol on 1535.Ar interface . 1536This is the default for all interfaces added to a bridge. 1537.It Cm edge Ar interface 1538Set 1539.Ar interface 1540as an edge port. 1541An edge port connects directly to end stations cannot create bridging 1542loops in the network, this allows it to transition straight to forwarding. 1543.It Cm -edge Ar interface 1544Disable edge status on 1545.Ar interface . 1546.It Cm autoedge Ar interface 1547Allow 1548.Ar interface 1549to automatically detect edge status. 1550This is the default for all interfaces added to a bridge. 1551.It Cm -autoedge Ar interface 1552Disable automatic edge status on 1553.Ar interface . 1554.It Cm ptp Ar interface 1555Set the 1556.Ar interface 1557as a point to point link. 1558This is required for straight transitions to forwarding and 1559should be enabled on a direct link to another RSTP capable switch. 1560.It Cm -ptp Ar interface 1561Disable point to point link status on 1562.Ar interface . 1563This should be disabled for a half duplex link and for an interface 1564connected to a shared network segment, 1565like a hub or a wireless network. 1566.It Cm autoptp Ar interface 1567Automatically detect the point to point status on 1568.Ar interface 1569by checking the full duplex link status. 1570This is the default for interfaces added to the bridge. 1571.It Cm -autoptp Ar interface 1572Disable automatic point to point link detection on 1573.Ar interface . 1574.It Cm maxage Ar seconds 1575Set the time that a Spanning Tree protocol configuration is valid. 1576The default is 20 seconds. 1577The minimum is 6 seconds and the maximum is 40 seconds. 1578.It Cm fwddelay Ar seconds 1579Set the time that must pass before an interface begins forwarding 1580packets when Spanning Tree is enabled. 1581The default is 15 seconds. 1582The minimum is 4 seconds and the maximum is 30 seconds. 1583.It Cm hellotime Ar seconds 1584Set the time between broadcasting of Spanning Tree protocol 1585configuration messages. 1586The hello time may only be changed when operating in legacy stp mode. 1587The default is 2 seconds. 1588The minimum is 1 second and the maximum is 2 seconds. 1589.It Cm priority Ar value 1590Set the bridge priority for Spanning Tree. 1591The default is 32768. 1592The minimum is 0 and the maximum is 61440. 1593.It Cm proto Ar value 1594Set the Spanning Tree protocol. 1595The default is rstp. 1596The available options are stp and rstp. 1597.It Cm holdcnt Ar value 1598Set the transmit hold count for Spanning Tree. 1599This is the number of packets transmitted before being rate limited. 1600The default is 6. 1601The minimum is 1 and the maximum is 10. 1602.It Cm ifpriority Ar interface Ar value 1603Set the Spanning Tree priority of 1604.Ar interface 1605to 1606.Ar value . 1607The default is 128. 1608The minimum is 0 and the maximum is 240. 1609.It Cm ifpathcost Ar interface Ar value 1610Set the Spanning Tree path cost of 1611.Ar interface 1612to 1613.Ar value . 1614The default is calculated from the link speed. 1615To change a previously selected path cost back to automatic, set the 1616cost to 0. 1617The minimum is 1 and the maximum is 200000000. 1618.El 1619.Pp 1620The following parameters are specific to lagg interfaces: 1621.Bl -tag -width indent 1622.It Cm laggport Ar interface 1623Add the interface named by 1624.Ar interface 1625as a port of the aggregation interface. 1626.It Cm -laggport Ar interface 1627Remove the interface named by 1628.Ar interface 1629from the aggregation interface. 1630.It Cm laggproto Ar proto 1631Set the aggregation protocol. 1632The default is failover. 1633The available options are failover, fec, lacp, loadbalance, roundrobin and 1634none. 1635.El 1636.Pp 1637The following parameters are specific to IP tunnel interfaces, 1638.Xr gif 4 : 1639.Bl -tag -width indent 1640.It Cm tunnel Ar src_addr dest_addr 1641Configure the physical source and destination address for IP tunnel 1642interfaces. 1643The arguments 1644.Ar src_addr 1645and 1646.Ar dest_addr 1647are interpreted as the outer source/destination for the encapsulating 1648IPv4/IPv6 header. 1649.It Fl tunnel 1650Unconfigure the physical source and destination address for IP tunnel 1651interfaces previously configured with 1652.Cm tunnel . 1653.It Cm deletetunnel 1654Another name for the 1655.Fl tunnel 1656parameter. 1657.El 1658.Pp 1659The following parameters are specific to 1660.Xr pfsync 4 1661interfaces: 1662.Bl -tag -width indent 1663.It Cm maxupd Ar n 1664Set the maximum number of updates for a single state which 1665can be collapsed into one. 1666This is an 8-bit number; the default value is 128. 1667.El 1668.Pp 1669The following parameters are specific to 1670.Xr vlan 4 1671interfaces: 1672.Bl -tag -width indent 1673.It Cm vlan Ar vlan_tag 1674Set the VLAN tag value to 1675.Ar vlan_tag . 1676This value is a 16-bit number which is used to create an 802.1Q 1677VLAN header for packets sent from the 1678.Xr vlan 4 1679interface. 1680Note that 1681.Cm vlan 1682and 1683.Cm vlandev 1684must both be set at the same time. 1685.It Cm vlandev Ar iface 1686Associate the physical interface 1687.Ar iface 1688with a 1689.Xr vlan 4 1690interface. 1691Packets transmitted through the 1692.Xr vlan 4 1693interface will be 1694diverted to the specified physical interface 1695.Ar iface 1696with 802.1Q VLAN encapsulation. 1697Packets with 802.1Q encapsulation received 1698by the parent interface with the correct VLAN tag will be diverted to 1699the associated 1700.Xr vlan 4 1701pseudo-interface. 1702The 1703.Xr vlan 4 1704interface is assigned a 1705copy of the parent interface's flags and the parent's ethernet address. 1706The 1707.Cm vlandev 1708and 1709.Cm vlan 1710must both be set at the same time. 1711If the 1712.Xr vlan 4 1713interface already has 1714a physical interface associated with it, this command will fail. 1715To 1716change the association to another physical interface, the existing 1717association must be cleared first. 1718.Pp 1719Note: if the hardware tagging capability 1720is set on the parent interface, the 1721.Xr vlan 4 1722pseudo 1723interface's behavior changes: 1724the 1725.Xr vlan 4 1726interface recognizes that the 1727parent interface supports insertion and extraction of VLAN tags on its 1728own (usually in firmware) and that it should pass packets to and from 1729the parent unaltered. 1730.It Fl vlandev Op Ar iface 1731If the driver is a 1732.Xr vlan 4 1733pseudo device, disassociate the parent interface from it. 1734This breaks the link between the 1735.Xr vlan 4 1736interface and its parent, 1737clears its VLAN tag, flags and its link address and shuts the interface down. 1738The 1739.Ar iface 1740argument is useless and hence deprecated. 1741.El 1742.Pp 1743The following parameters are specific to 1744.Xr carp 4 1745interfaces: 1746.Bl -tag -width indent 1747.It Cm advbase Ar seconds 1748Specifies the base of the advertisement interval in seconds. 1749The acceptable values are 1 to 255. 1750The default value is 1. 1751.\" The default value is 1752.\" .Dv CARP_DFLTINTV . 1753.It Cm advskew Ar interval 1754Specifies the skew to add to the base advertisement interval to 1755make one host advertise slower than another host. 1756It is specified in 1/256 of seconds. 1757The acceptable values are 1 to 254. 1758The default value is 0. 1759.It Cm pass Ar phrase 1760Set the authentication key to 1761.Ar phrase . 1762.It Cm vhid Ar n 1763Set the virtual host ID. 1764This is a required setting. 1765Acceptable values are 1 to 255. 1766.El 1767.Pp 1768The 1769.Nm 1770utility displays the current configuration for a network interface 1771when no optional parameters are supplied. 1772If a protocol family is specified, 1773.Nm 1774will report only the details specific to that protocol family. 1775.Pp 1776If the 1777.Fl m 1778flag is passed before an interface name, 1779.Nm 1780will display the capability list and all 1781of the supported media for the specified interface. 1782If 1783.Fl L 1784flag is supplied, address lifetime is displayed for IPv6 addresses, 1785as time offset string. 1786.Pp 1787Optionally, the 1788.Fl a 1789flag may be used instead of an interface name. 1790This flag instructs 1791.Nm 1792to display information about all interfaces in the system. 1793The 1794.Fl d 1795flag limits this to interfaces that are down, and 1796.Fl u 1797limits this to interfaces that are up. 1798When no arguments are given, 1799.Fl a 1800is implied. 1801.Pp 1802The 1803.Fl l 1804flag may be used to list all available interfaces on the system, with 1805no other additional information. 1806Use of this flag is mutually exclusive 1807with all other flags and commands, except for 1808.Fl d 1809(only list interfaces that are down) 1810and 1811.Fl u 1812(only list interfaces that are up). 1813.Pp 1814The 1815.Fl v 1816flag may be used to get more verbose status for an interface. 1817.Pp 1818The 1819.Fl C 1820flag may be used to list all of the interface cloners available on 1821the system, with no additional information. 1822Use of this flag is mutually exclusive with all other flags and commands. 1823.Pp 1824The 1825.Fl k 1826flag causes keying information for the interface, if available, to be 1827printed. 1828For example, the values of 802.11 WEP keys will be printed, if accessible to 1829the current user. 1830This information is not printed by default, as it may be considered 1831sensitive. 1832.Pp 1833If the network interface driver is not present in the kernel then 1834.Nm 1835will attempt to load it. 1836The 1837.Fl n 1838flag disables this behavior. 1839.Pp 1840Only the super-user may modify the configuration of a network interface. 1841.Sh NOTES 1842The media selection system is relatively new and only some drivers support 1843it (or have need for it). 1844.Sh EXAMPLES 1845Assign the IPv4 address 1846.Li 192.0.2.10 , 1847with a network mask of 1848.Li 255.255.255.0 , 1849to the interface 1850.Li fxp0 : 1851.Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0 1852.Pp 1853Add the IPv4 address 1854.Li 192.0.2.45 , 1855with the CIDR network prefix 1856.Li /28 , 1857to the interface 1858.Li ed0 , 1859using 1860.Cm add 1861as a synonym for the canonical form of the option 1862.Cm alias : 1863.Dl # ifconfig ed0 inet 192.0.2.45/28 add 1864.Pp 1865Remove the IPv4 address 1866.Li 192.0.2.45 1867from the interface 1868.Li ed0 : 1869.Dl # ifconfig ed0 inet 192.0.2.45 -alias 1870.Pp 1871Add the IPv6 address 1872.Li 2001:DB8:DBDB::123/48 1873to the interface 1874.Li em0 : 1875.Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias 1876Note that lower case hexadecimal IPv6 addresses are acceptable. 1877.Pp 1878Remove the IPv6 address added in the above example, 1879using the 1880.Li / 1881character as shorthand for the network prefix, 1882and using 1883.Cm delete 1884as a synonym for the canonical form of the option 1885.Fl alias : 1886.Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete 1887.Pp 1888Configure the interface 1889.Li xl0 , 1890to use 100baseTX, full duplex Ethernet media options: 1891.Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex 1892.Pp 1893Create the software network interface 1894.Li gif1 : 1895.Dl # ifconfig gif1 create 1896.Pp 1897Destroy the software network interface 1898.Li gif1 : 1899.Dl # ifconfig gif1 destroy 1900.Sh DIAGNOSTICS 1901Messages indicating the specified interface does not exist, the 1902requested address is unknown, or the user is not privileged and 1903tried to alter an interface's configuration. 1904.Sh SEE ALSO 1905.Xr netstat 1 , 1906.Xr carp 4 , 1907.Xr netintro 4 , 1908.Xr pfsync 4 , 1909.Xr polling 4 , 1910.Xr vlan 4 , 1911.\" .Xr eon 5 , 1912.Xr rc 8 , 1913.Xr routed 8 , 1914.Xr sysctl 8 1915.Sh HISTORY 1916The 1917.Nm 1918utility appeared in 1919.Bx 4.2 . 1920.Sh BUGS 1921Basic IPv6 node operation requires a link-local address on each 1922interface configured for IPv6. 1923Normally, such an address is automatically configured by the 1924kernel on each interface added to the system; this behaviour may 1925be disabled by setting the sysctl MIB variable 1926.Va net.inet6.ip6.auto_linklocal 1927to 0. 1928.Pp 1929If you delete such an address using 1930.Nm , 1931the kernel may act very odd. 1932Do this at your own risk. 1933