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