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 25, 2006 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.Ar interface 43.Op Cm create 44.Op Ar address_family 45.Oo 46.Ar address 47.Op Ar dest_address 48.Oc 49.Op Ar parameters 50.Nm 51.Ar interface 52.Cm destroy 53.Nm 54.Fl a 55.Op Fl L 56.Op Fl d 57.Op Fl m 58.Op Fl u 59.Op Fl v 60.Op Ar address_family 61.Nm 62.Fl l 63.Op Fl d 64.Op Fl u 65.Op Ar address_family 66.Nm 67.Op Fl L 68.Op Fl d 69.Op Fl k 70.Op Fl m 71.Op Fl u 72.Op Fl v 73.Op Fl C 74.Nm 75.Op Fl g Ar groupname 76.Sh DESCRIPTION 77The 78.Nm 79utility is used to assign an address 80to a network interface and/or configure 81network interface parameters. 82The 83.Nm 84utility must be used at boot time to define the network address 85of each interface present on a machine; it may also be used at 86a later time to redefine an interface's address 87or other operating parameters. 88.Pp 89The following options are available: 90.Bl -tag -width indent 91.It Ar address 92For the 93.Tn DARPA Ns -Internet 94family, 95the address is either a host name present in the host name data 96base, 97.Xr hosts 5 , 98or a 99.Tn DARPA 100Internet address expressed in the Internet standard 101.Dq dot notation . 102.Pp 103It is also possible to use the CIDR notation (also known as the 104slash notation) to include the netmask. 105That is, one can specify an address like 106.Li 192.168.0.1/16 . 107.Pp 108For 109.Dq inet6 110family, it is also possible to specify the prefix length using the slash 111notation, like 112.Li ::1/128 . 113See the 114.Cm prefixlen 115parameter below for more information. 116.\" For the Xerox Network Systems(tm) family, 117.\" addresses are 118.\" .Ar net:a.b.c.d.e.f , 119.\" where 120.\" .Ar net 121.\" is the assigned network number (in decimal), 122.\" and each of the six bytes of the host number, 123.\" .Ar a 124.\" through 125.\" .Ar f , 126.\" are specified in hexadecimal. 127.\" The host number may be omitted on IEEE 802 protocol 128.\" (Ethernet, FDDI, and Token Ring) interfaces, 129.\" which use the hardware physical address, 130.\" and on interfaces other than the first. 131.\" For the 132.\" .Tn ISO 133.\" family, addresses are specified as a long hexadecimal string, 134.\" as in the Xerox family. 135.\" However, two consecutive dots imply a zero 136.\" byte, and the dots are optional, if the user wishes to (carefully) 137.\" count out long strings of digits in network byte order. 138.Pp 139The link-level 140.Pq Dq link 141address 142is specified as a series of colon-separated hex digits. 143This can be used to 144e.g.\& set a new MAC address on an ethernet interface, though the 145mechanism used is not ethernet-specific. 146If the interface is already 147up when this option is used, it will be briefly brought down and 148then brought back up again in order to ensure that the receive 149filter in the underlying ethernet hardware is properly reprogrammed. 150.It Ar address_family 151Specify the 152address family 153which affects interpretation of the remaining parameters. 154Since an interface can receive transmissions in differing protocols 155with different naming schemes, specifying the address family is recommended. 156The address or protocol families currently 157supported are 158.Dq inet , 159.Dq inet6 , 160.Dq atalk , 161.Dq ipx , 162.\" .Dq iso , 163and 164.Dq link . 165.\" and 166.\" .Dq ns . 167The default is 168.Dq inet . 169.Dq ether 170and 171.Dq lladdr 172are synonyms for 173.Dq link . 174.It Ar dest_address 175Specify the address of the correspondent on the other end 176of a point to point link. 177.It Ar interface 178This 179parameter is a string of the form 180.Dq name unit , 181for example, 182.Dq Li ed0 . 183.It Ar groupname 184List the interfaces in the given group. 185.El 186.Pp 187The following parameters may be set with 188.Nm : 189.Bl -tag -width indent 190.It Cm add 191Another name for the 192.Cm alias 193parameter. 194Introduced for compatibility 195with 196.Bsx . 197.It Cm alias 198Establish an additional network address for this interface. 199This is sometimes useful when changing network numbers, and 200one wishes to accept packets addressed to the old interface. 201If the address is on the same subnet as the first network address 202for this interface, a non-conflicting netmask must be given. 203Usually 204.Li 0xffffffff 205is most appropriate. 206.It Fl alias 207Remove the network address specified. 208This would be used if you incorrectly specified an alias, or it 209was no longer needed. 210If you have incorrectly set an NS address having the side effect 211of specifying the host portion, removing all NS addresses will 212allow you to respecify the host portion. 213.It Cm anycast 214(Inet6 only.) 215Specify that the address configured is an anycast address. 216Based on the current specification, 217only routers may configure anycast addresses. 218Anycast address will not be used as source address of any of outgoing 219IPv6 packets. 220.It Cm arp 221Enable the use of the Address Resolution Protocol 222.Pq Xr arp 4 223in mapping 224between network level addresses and link level addresses (default). 225This is currently implemented for mapping between 226.Tn DARPA 227Internet 228addresses and 229.Tn IEEE 230802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses). 231.It Fl arp 232Disable the use of the Address Resolution Protocol 233.Pq Xr arp 4 . 234.It Cm staticarp 235If the Address Resolution Protocol is enabled, 236the host will only reply to requests for its addresses, 237and will never send any requests. 238.It Fl staticarp 239If the Address Resolution Protocol is enabled, 240the host will perform normally, 241sending out requests and listening for replies. 242.It Cm broadcast 243(Inet only.) 244Specify the address to use to represent broadcasts to the 245network. 246The default broadcast address is the address with a host part of all 1's. 247.It Cm debug 248Enable driver dependent debugging code; usually, this turns on 249extra console error logging. 250.It Fl debug 251Disable driver dependent debugging code. 252.It Cm promisc 253Put interface into permanently promiscuous mode. 254.It Fl promisc 255Disable permanently promiscuous mode. 256.It Cm delete 257Another name for the 258.Fl alias 259parameter. 260.It Cm down 261Mark an interface 262.Dq down . 263When an interface is marked 264.Dq down , 265the system will not attempt to 266transmit messages through that interface. 267If possible, the interface will be reset to disable reception as well. 268This action does not automatically disable routes using the interface. 269.It Cm group Ar group-name 270Assign the interface to a 271.Dq group . 272Any interface can be in multiple groups. 273.Pp 274Cloned interfaces are members of their interface family group by default. 275For example, a PPP interface such as 276.Em ppp0 277is a member of the PPP interface family group, 278.Em ppp . 279.\" The interface(s) the default route(s) point to are members of the 280.\" .Em egress 281.\" interface group. 282.It Cm -group Ar group-name 283Remove the interface from the given 284.Dq group . 285.It Cm eui64 286(Inet6 only.) 287Fill interface index 288(lowermost 64bit of an IPv6 address) 289automatically. 290.It Cm ipdst 291This is used to specify an Internet host who is willing to receive 292IP packets encapsulating IPX packets bound for a remote network. 293An apparent point to point link is constructed, and 294the address specified will be taken as the IPX address and network 295of the destination. 296.It Cm maclabel Ar label 297If Mandatory Access Control support is enabled in the kernel, 298set the MAC label to 299.Ar label . 300.\" (see 301.\" .Xr maclabel 7 ) . 302.It Cm media Ar type 303If the driver supports the media selection system, set the media type 304of the interface to 305.Ar type . 306Some interfaces support the mutually exclusive use of one of several 307different physical media connectors. 308For example, a 10Mbit/s Ethernet 309interface might support the use of either 310.Tn AUI 311or twisted pair connectors. 312Setting the media type to 313.Cm 10base5/AUI 314would change the currently active connector to the AUI port. 315Setting it to 316.Cm 10baseT/UTP 317would activate twisted pair. 318Refer to the interfaces' driver 319specific documentation or man page for a complete list of the 320available types. 321.It Cm mediaopt Ar opts 322If the driver supports the media selection system, set the specified 323media options on the interface. 324The 325.Ar opts 326argument 327is a comma delimited list of options to apply to the interface. 328Refer to the interfaces' driver specific man page for a complete 329list of available options. 330.It Fl mediaopt Ar opts 331If the driver supports the media selection system, disable the 332specified media options on the interface. 333.It Cm mode Ar mode 334If the driver supports the media selection system, set the specified 335operating mode on the interface to 336.Ar mode . 337For IEEE 802.11 wireless interfaces that support multiple operating modes 338this directive is used to select between 802.11a 339.Pq Cm 11a , 340802.11b 341.Pq Cm 11b , 342and 802.11g 343.Pq Cm 11g 344operating modes. 345.It Cm name Ar name 346Set the interface name to 347.Ar name . 348.It Cm rxcsum , txcsum 349If the driver supports user-configurable checksum offloading, 350enable receive (or transmit) checksum offloading on the interface. 351Some drivers may not be able to enable these flags independently 352of each other, so setting one may also set the other. 353The driver will offload as much checksum work as it can reliably 354support, the exact level of offloading varies between drivers. 355.It Fl rxcsum , txcsum 356If the driver supports user-configurable checksum offloading, 357disable receive (or transmit) checksum offloading on the interface. 358These settings may not always be independent of each other. 359.It Cm vlanmtu , vlanhwtag 360If the driver offers user-configurable VLAN support, enable 361reception of extended frames or tag processing in hardware, 362respectively. 363Note that this must be issued on a physical interface associated with 364.Xr vlan 4 , 365not on a 366.Xr vlan 4 367interface itself. 368.It Fl vlanmtu , vlanhwtag 369If the driver offers user-configurable VLAN support, disable 370reception of extended frames or tag processing in hardware, 371respectively. 372.It Cm polling 373Turn on 374.Xr polling 4 375feature and disable interrupts on the interface, if driver supports 376this mode. 377.It Fl polling 378Turn off 379.Xr polling 4 380feature and enable interrupt mode on the interface. 381.It Cm create 382Create the specified network pseudo-device. 383If the interface is given without a unit number, try to create a new 384device with an arbitrary unit number. 385If creation of an arbitrary device is successful, the new device name is 386printed to standard output unless the interface is renamed or destroyed 387in the same 388.Nm 389invocation. 390.It Cm destroy 391Destroy the specified network pseudo-device. 392.It Cm plumb 393Another name for the 394.Cm create 395parameter. 396Included for 397.Tn Solaris 398compatibility. 399.It Cm unplumb 400Another name for the 401.Cm destroy 402parameter. 403Included for 404.Tn Solaris 405compatibility. 406.It Cm metric Ar n 407Set the routing metric of the interface to 408.Ar n , 409default 0. 410The routing metric is used by the routing protocol 411.Pq Xr routed 8 . 412Higher metrics have the effect of making a route 413less favorable; metrics are counted as addition hops 414to the destination network or host. 415.It Cm mtu Ar n 416Set the maximum transmission unit of the interface to 417.Ar n , 418default is interface specific. 419The MTU is used to limit the size of packets that are transmitted on an 420interface. 421Not all interfaces support setting the MTU, and some interfaces have 422range restrictions. 423.It Cm netmask Ar mask 424.\" (Inet and ISO.) 425(Inet only.) 426Specify how much of the address to reserve for subdividing 427networks into sub-networks. 428The mask includes the network part of the local address 429and the subnet part, which is taken from the host field of the address. 430The mask can be specified as a single hexadecimal number 431with a leading 432.Ql 0x , 433with a dot-notation Internet address, 434or with a pseudo-network name listed in the network table 435.Xr networks 5 . 436The mask contains 1's for the bit positions in the 32-bit address 437which are to be used for the network and subnet parts, 438and 0's for the host part. 439The mask should contain at least the standard network portion, 440and the subnet field should be contiguous with the network 441portion. 442.Pp 443The netmask can also be specified in CIDR notation after the address. 444See the 445.Ar address 446option above for more information. 447.It Cm prefixlen Ar len 448(Inet6 only.) 449Specify that 450.Ar len 451bits are reserved for subdividing networks into sub-networks. 452The 453.Ar len 454must be integer, and for syntactical reason it must be between 0 to 128. 455It is almost always 64 under the current IPv6 assignment rule. 456If the parameter is omitted, 64 is used. 457.Pp 458The prefix can also be specified using the slash notation after the address. 459See the 460.Ar address 461option above for more information. 462.\" see 463.\" Xr eon 5 . 464.\" .It Cm nsellength Ar n 465.\" .Pf ( Tn ISO 466.\" only) 467.\" This specifies a trailing number of bytes for a received 468.\" .Tn NSAP 469.\" used for local identification, the remaining leading part of which is 470.\" taken to be the 471.\" .Tn NET 472.\" (Network Entity Title). 473.\" The default value is 1, which is conformant to US 474.\" .Tn GOSIP . 475.\" When an ISO address is set in an ifconfig command, 476.\" it is really the 477.\" .Tn NSAP 478.\" which is being specified. 479.\" For example, in 480.\" .Tn US GOSIP , 481.\" 20 hex digits should be 482.\" specified in the 483.\" .Tn ISO NSAP 484.\" to be assigned to the interface. 485.\" There is some evidence that a number different from 1 may be useful 486.\" for 487.\" .Tn AFI 488.\" 37 type addresses. 489.It Cm range Ar netrange 490Under appletalk, set the interface to respond to a 491.Ar netrange 492of the form 493.Ar startnet Ns - Ns Ar endnet . 494Appletalk uses this scheme instead of 495netmasks though 496.Fx 497implements it internally as a set of netmasks. 498.It Cm remove 499Another name for the 500.Fl alias 501parameter. 502Introduced for compatibility 503with 504.Bsx . 505.It Cm phase 506The argument following this specifies the version (phase) of the 507Appletalk network attached to the interface. 508Values of 1 or 2 are permitted. 509.Sm off 510.It Cm link Op Cm 0 No - Cm 2 511.Sm on 512Enable special processing of the link level of the interface. 513These three options are interface specific in actual effect, however, 514they are in general used to select special modes of operation. 515An example 516of this is to enable SLIP compression, or to select the connector type 517for some Ethernet cards. 518Refer to the man page for the specific driver 519for more information. 520.Sm off 521.It Fl link Op Cm 0 No - Cm 2 522.Sm on 523Disable special processing at the link level with the specified interface. 524.It Cm monitor 525Put the interface in monitor mode. 526No packets are transmitted, and received packets are discarded after 527.Xr bpf 4 528processing. 529.It Fl monitor 530Take the interface out of monitor mode. 531.It Cm up 532Mark an interface 533.Dq up . 534This may be used to enable an interface after an 535.Dq Nm Cm down . 536It happens automatically when setting the first address on an interface. 537If the interface was reset when previously marked down, 538the hardware will be re-initialized. 539.El 540.Pp 541The following parameters are specific to IEEE 802.11 wireless interfaces: 542.Bl -tag -width indent 543.It Cm apbridge 544When operating as an access point, pass packets between 545wireless clients directly (default). 546To instead let them pass up through the 547system and be forwarded using some other mechanism, use 548.Fl apbridge . 549Disabling the internal bridging 550is useful when traffic is to be processed with 551packet filtering. 552.It Cm authmode Ar mode 553Set the desired authentication mode in infrastructure mode. 554Not all adaptors support all modes. 555The set of 556valid modes is 557.Cm none , open , shared 558(shared key), 559.Cm 8021x 560(IEEE 802.1x), 561and 562.Cm wpa 563(IEEE WPA/WPA2/802.11i). 564The 565.Cm 8021x 566and 567.Cm wpa 568modes are only useful when using an authentication service 569(a supplicant for client operation or an authenticator when 570operating as an access point). 571Modes are case insensitive. 572.It Cm bintval Ar interval 573Set the interval at which beacon frames are sent when operating in 574ad-hoc or ap mode. 575The 576.Ar interval 577parameter is specified in TU's (1/1024 msecs). 578By default beacon frames are transmitted every 100 TU's. 579.It Cm bmissthreshold Ar count 580Set the number of consecutive missed beacons at which the station 581will attempt to roam (i.e. search for a new access point). 582The 583.Ar count 584parameter is must be in the range 1 to 255; though the 585upper bound may be reduced according to device capabilities.. 586The default threshold is 7 consecutive missed beacons; but 587this may be overridden by the device driver. 588Another name for the 589.Cm bmissthreshold 590parameter is 591.Cm bmiss . 592.It Cm bssid Ar address 593Specify the MAC address of the access point to use when operating 594as a station in a BSS network. 595This overrides any automatic selection done by the system. 596To disable a previously selected access point, supply 597.Cm any , none , 598or 599.Cm - 600for the address. 601This option is useful when more than one access points have the same SSID. 602Another name for the 603.Cm bssid 604parameter is 605.Cm ap . 606.It Cm burst 607Enable packet bursting. 608Packet bursting is a transmission technique whereby the wireless 609medium is acquired once to send multiple frames and the interframe 610spacing is reduced. 611This technique can significantly increase throughput by reducing 612transmission overhead. 613Packet bursting is supported by the 802.11e QoS specification 614and some devices that do not support QoS may still be capable. 615By default packet bursting is enabled if a device is capable 616of doing it. 617To disable packet bursting, use 618.Fl burst . 619.It Cm chanlist Ar channels 620Set the desired channels to use when scanning for access 621points, neighbors in an IBSS network, or looking for unoccupied 622channels when operating as an access point. 623The set of channels is specified as a comma-separated list with 624each element in the list representing either a single channel number or a range 625of the form 626.Dq Li a-b . 627Channel numbers must be in the range 1 to 255 and be permissible 628according to the operating characteristics of the device. 629.It Cm channel Ar number 630Set a single desired channel. 631Channels range from 1 to 255, but the exact selection available 632depends on the region your adaptor was manufactured for. 633Setting 634the channel to 635.Li 0 , 636.Cm any , 637or 638.Cm - 639will give you the default for your adaptor. 640Some 641adaptors ignore this setting unless you are in ad-hoc mode. 642Alternatively the frequency, in megahertz, may be specified 643instead of the channel number. 644.It Cm deftxkey Ar index 645Set the default key to use for transmission. 646Typically this is only set when using WEP encryption. 647The 648.Cm weptxkey 649is an alias for this request; it is provided for backwards compatibility. 650.It Cm dtimperiod Ar period 651Set the 652DTIM 653period for transmitting buffered multicast data frames when 654operating in ap mode. 655The 656.Ar period 657specifies the number of beacon intervals between DTIM 658and must be in the range 1 to 15. 659By default DTIM is 1 (i.e., DTIM occurs at each beacon). 660.It Cm fragthreshold Ar length 661Set the threshold for which transmitted frames are broken into fragments. 662The 663.Ar length 664argument is the frame size in bytes and must be in the range 256 to 2346. 665Setting 666.Ar length 667to 668.Li 2346 , 669.Cm any , 670or 671.Cm - 672disables transmit fragmentation. 673Not all adaptors honor the fragmentation threshold. 674.It Cm hidessid 675When operating as an access point, do not broadcast the SSID 676in beacon frames or respond to probe request frames unless 677they are directed to the ap (i.e., they include the ap's SSID). 678By default, the SSID is included in beacon frames and 679undirected probe request frames are answered. 680To re-enable the broadcast of the SSID etc., use 681.Fl hidessid . 682.It Cm list active 683Display the list of channels available for use taking into account 684any restrictions set with the 685.Cm chanlist 686directive. 687See the description of 688.Cm list chan 689for more information. 690.It Cm list caps 691Display the adaptor's capabilities, including the operating 692modes supported. 693.It Cm list chan 694Display the list of channels available for use. 695Channels are shown with their IEEE channel number, equivalent 696frequency, and usage modes. 697Channels identified as 698.Ql 11g 699are also usable in 700.Ql 11b 701mode. 702Channels identified as 703.Ql 11a Turbo 704may be used only for Atheros' Static Turbo mode 705.Pq specified with Cm mediaopt turbo . 706Channels marked with a 707.Ql * 708have a regulatory constraint that they be passively scanned. 709This means a station is not permitted to transmit on the channel until 710it identifies the channel is being used for 802.11 communication; 711typically by hearing a beacon frame from an access point operating 712on the channel. 713.Cm list freq 714is another way of requesting this information. 715.It Cm list mac 716Display the current MAC Access Control List state. 717Each address is prefixed with a character that indicates the 718current policy applied to it: 719.Ql + 720indicates the address is allowed access, 721.Ql - 722indicates the address is denied access, 723.Ql * 724indicates the address is present but the current policy open 725(so the ACL is not consulted). 726.It Cm list scan 727Display the access points and/or ad-hoc neighbors 728located in the vicinity. 729This information may be updated automatically by the adaptor 730and/or with a 731.Cm scan 732request. 733.Cm list ap 734is another way of requesting this information. 735.It Cm list sta 736When operating as an access point display the stations that are 737currently associated. 738When operating in ad-hoc mode display stations identified as 739neighbors in the IBSS. 740Capabilities advertised by the stations are described under 741the 742.Cm scan 743request. 744Depending on the capabilities of the stations the following 745flags can be included in the output: 746.Bl -tag -width 3n 747.It Li A 748Authorized. 749Indicates that the station is permitted to send/receive data frames. 750.It Li E 751Extended Rate Phy (ERP). 752Indicates that the station is operating in an 802.11g network 753using extended transmit rates. 754.It Li P 755Power Save. 756Indicates that the station is operating in power save mode. 757.It Li Q 758Quality of Service (QoS). 759Indicates that the station is using QoS encapsulation for 760data frame. 761QoS encapsulation is enabled only when WME mode is enabled. 762.El 763.It Cm list wme 764Display the current parameters to use when operating in WME mode. 765When WME mode is enabled for an adaptor this information will be 766displayed with the regular status; this command is mostly useful 767for examining parameters when WME mode is disabled. 768See the description of the 769.Cm wme 770directive for information on the various parameters. 771.It Cm mcastrate Ar rate 772Set the rate for transmitting multicast/broadcast frames. 773Rates are specified as megabits/second in decimal; e.g. 5.5 for 5.5 Mb/s. 774This rate should be valid for the current operating conditions; 775if an invalid rate is specified drivers are free to chose an 776appropriate rate. 777.It Cm powersave 778Enable powersave operation. 779When operating as a client, the station will conserve power by 780periodically turning off the radio and listening for 781messages from the access point telling it there are packets waiting. 782The station must then retrieve the packets. 783When operating as an access point, the station must honor power 784save operation of associated clients. 785Not all devices support power save operation, either as a client 786or as an access point. 787Use 788.Fl powersave 789to disable powersave operation. 790.It Cm powersavesleep Ar sleep 791Set the desired max powersave sleep time in milliseconds. 792.It Cm protmode Ar technique 793For interfaces operating in 802.11g, use the specified 794.Ar technique 795for protecting OFDM frames in a mixed 11b/11g network. 796The set of valid techniques is 797.Cm off , cts 798(CTS to self), 799and 800.Cm rtscts 801(RTS/CTS). 802Technique names are case insensitive. 803.It Cm pureg 804When operating as an access point in 802.11g mode allow only 80511g-capable stations to associate (11b-only stations are not 806permitted to associate). 807To allow both 11g and 11b-only stations to associate, use 808.Fl pureg . 809.It Cm roaming Ar mode 810When operating as a station, control how the system will 811behave when communication with the current access point 812is broken. 813The 814.Ar mode 815argument may be one of 816.Cm device 817(leave it to the hardware device to decide), 818.Cm auto 819(handle either in the device or the operating system\[em]as appropriate), 820.Cm manual 821(do nothing until explicitly instructed). 822By default, the device is left to handle this if it is 823capable; otherwise, the operating system will automatically 824attempt to reestablish communication. 825Manual mode is mostly useful when an application wants to 826control the selection of an access point. 827.It Cm rtsthreshold Ar length 828Set the threshold for which 829transmitted frames are preceded by transmission of an 830RTS 831control frame. 832The 833.Ar length 834argument 835is the frame size in bytes and must be in the range 1 to 2346. 836Setting 837.Ar length 838to 839.Li 2346 , 840.Cm any , 841or 842.Cm - 843disables transmission of RTS frames. 844Not all adaptors support setting the RTS threshold. 845.It Cm ssid Ar ssid 846Set the desired Service Set Identifier (aka network name). 847The SSID is a string up to 32 characters 848in length and may be specified as either a normal string or in 849hexadecimal when preceded by 850.Ql 0x . 851Additionally, the SSID may be cleared by setting it to 852.Ql - . 853.It Cm scan 854Initiate a scan of neighboring stations, wait for it to complete, and 855display all stations found. 856Only the super-user can initiate a scan. 857Depending on the capabilities of the APs, the following 858flags can be included in the output: 859.Bl -tag -width 3n 860.It Li A 861Channel Agility. 862Indicates that the station support channel hopping as described by the 863IEEE 802.11b specification. 864.It Li B 865Packet Binary Convolution Code (PBCC). 866A modulation alternative to the standard OFDM method. 867.It Dv C 868Pollreq 869.It Dv c 870Pollable 871.It Dv D 872Direct Sequence Spread Spectrum (DSSSOFDM). 873Indicates the the station supports DSSS modulation. 874.It Li E 875Extended Service Set (ESS). 876Indicates that the station is part of an infrastructure network 877(in contrast to an IBSS/ad-hoc network). 878.It Li I 879IBSS/ad-hoc network. 880Indicates that the station is part of an ad-hoc network 881(in contrast to an ESS network). 882.It Li P 883Privacy. 884Data confidentiality is required for all data frames 885exchanged within the BSS. 886This means that this BSS requires the station to 887use cryptographic means such as WEP, TKIP or AES-CCMP to 888encrypt/decrypt data frames being exchanged with others. 889.It Dv R 890Robust Security Network (RSN). 891Indicates that the station supports the IEEE 802.11i authentication 892and key management protocol. 893.It Li S 894Short Preamble. 895Indicates that the network is using short preambles (defined 896in 802.11b High Rate/DSSS PHY, short preamble utilizes a 89756 bit sync field in contrast to a 128 bit field used in long 898preamble mode). 899.It Li s 900Short slot time. 901Indicates that the network is using a short slot time. 902.El 903.Pp 904The 905.Cm list scan 906request can be used to show recent scan results without 907initiating a new scan. 908.It Cm stationname Ar name 909Set the name of this station. 910It appears that the station name is not really part of the IEEE 802.11 911protocol though all interfaces seem to support it. 912As such it only 913seems to be meaningful to identical or virtually identical equipment. 914Setting the station name is identical in syntax to setting the SSID. 915.It Cm txpower Ar power 916Set the power used to transmit frames. 917The 918.Ar power 919argument 920is a unitless value in the range 0 to 100 that is interpreted 921by drivers to derive a device-specific value. 922Out of range values are truncated. 923Typically only a few discreet power settings are available and 924the driver will use the setting closest to the specified value. 925Not all adaptors support changing the transmit power. 926.It Cm wepmode Ar mode 927Set the desired WEP mode. 928Not all adaptors support all modes. 929The set of valid modes is 930.Cm off , on , 931and 932.Cm mixed . 933The 934.Cm mixed 935mode explicitly tells the adaptor to allow association with access 936points which allow both encrypted and unencrypted traffic. 937On these adaptors, 938.Cm on 939means that the access point must only allow encrypted connections. 940On other adaptors, 941.Cm on 942is generally another name for 943.Cm mixed . 944Modes are case insensitive. 945.It Cm weptxkey Ar index 946Set the WEP key to be used for transmission. 947This is the same as setting the default transmission key with 948.Cm deftxkey . 949.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key 950Set the selected WEP key. 951If an 952.Ar index 953is not given, key 1 is set. 954A WEP key will be either 5 or 13 955characters (40 or 104 bits) depending of the local network and the 956capabilities of the adaptor. 957It may be specified either as a plain 958string or as a string of hexadecimal digits preceded by 959.Ql 0x . 960For maximum portability, hex keys are recommended; 961the mapping of text keys to WEP encryption is usually driver-specific. 962In particular, the 963.Tn Windows 964drivers do this mapping differently to 965.Fx . 966A key may be cleared by setting it to 967.Ql - . 968If WEP is supported then there are at least four keys. 969Some adaptors support more than four keys. 970If that is the case, then the first four keys 971(1-4) will be the standard temporary keys and any others will be adaptor 972specific keys such as permanent keys stored in NVRAM. 973.It Cm wme 974Enable Wireless Multimedia Extensions (WME) support, if available, 975for the specified interface. 976WME is a subset of the IEEE 802.11e standard to support the 977efficient communication of realtime and multimedia data. 978To disable WME support, use 979.Fl wme . 980.Pp 981The following parameters are meaningful only when WME support is in use. 982Parameters are specified per-AC (Access Category) and 983split into those that are used by a station when acting 984as an access point and those for client stations in the BSS. 985The latter are received from the access point and may not be changed 986(at the station). 987The following Access Categories are recognized: 988.Pp 989.Bl -tag -width ".Cm AC_BK" -compact 990.It Cm AC_BE 991(or 992.Cm BE ) 993best effort delivery, 994.It Cm AC_BK 995(or 996.Cm BK ) 997background traffic, 998.It Cm AC_VI 999(or 1000.Cm VI ) 1001video traffic, 1002.It Cm AC_VO 1003(or 1004.Cm VO ) 1005voice traffic. 1006.El 1007.Pp 1008AC parameters are case-insensitive. 1009Traffic classification is done in the operating system using the 1010vlan priority associated with data frames or the 1011ToS (Type of Service) indication in IP-encapsulated frames. 1012If neither information is present, traffic is assigned to the 1013Best Effort (BE) category. 1014.Bl -tag -width indent 1015.It Cm ack Ar ac 1016Set the ACK policy for QoS transmissions by the local station; 1017this controls whether or not data frames transmitted by a station 1018require an ACK response from the receiving station. 1019To disable waiting for an ACK use 1020.Fl ack . 1021This parameter is applied only to the local station. 1022.It Cm acm Ar ac 1023Enable the Admission Control Mandatory (ACM) mechanism 1024for transmissions by the local station. 1025To disable the ACM use 1026.Fl acm . 1027On stations in a BSS this parameter is read-only and indicates 1028the setting received from the access point. 1029NB: ACM is not supported right now. 1030.It Cm aifs Ar ac Ar count 1031Set the Arbitration Inter Frame Spacing (AIFS) 1032channel access parameter to use for transmissions 1033by the local station. 1034On stations in a BSS this parameter is read-only and indicates 1035the setting received from the access point. 1036.It Cm cwmin Ar ac Ar count 1037Set the CWmin channel access parameter to use for transmissions 1038by the local station. 1039On stations in a BSS this parameter is read-only and indicates 1040the setting received from the access point. 1041.It Cm cwmax Ar ac Ar count 1042Set the CWmax channel access parameter to use for transmissions 1043by the local station. 1044On stations in a BSS this parameter is read-only and indicates 1045the setting received from the access point. 1046.It Cm txoplimit Ar ac Ar limit 1047Set the Transmission Opportunity Limit channel access parameter 1048to use for transmissions by the local station. 1049This parameter defines an interval of time when a WME station 1050has the right to initiate transmissions onto the wireless medium. 1051On stations in a BSS this parameter is read-only and indicates 1052the setting received from the access point. 1053.It Cm bss:aifs Ar ac Ar count 1054Set the AIFS channel access parameter to send to stations in a BSS. 1055This parameter is meaningful only when operating in ap mode. 1056.It Cm bss:cwmin Ar ac Ar count 1057Set the CWmin channel access parameter to send to stations in a BSS. 1058This parameter is meaningful only when operating in ap mode. 1059.It Cm bss:cwmax Ar ac Ar count 1060Set the CWmax channel access parameter to send to stations in a BSS. 1061This parameter is meaningful only when operating in ap mode. 1062.It Cm bss:txoplimit Ar ac Ar limit 1063Set the TxOpLimit channel access parameter to send to stations in a BSS. 1064This parameter is meaningful only when operating in ap mode. 1065.El 1066.El 1067.Pp 1068The following parameters support an optional access control list 1069feature available with some adaptors when operating in ap mode; see 1070.Xr wlan_acl 4 . 1071This facility allows an access point to accept/deny association 1072requests based on the MAC address of the station. 1073Note that this feature does not significantly enhance security 1074as MAC address spoofing is easy to do. 1075.Bl -tag -width indent 1076.It Cm mac:add Ar address 1077Add the specified MAC address to the database. 1078Depending on the policy setting association requests from the 1079specified station will be allowed or denied. 1080.It Cm mac:allow 1081Set the ACL policy to permit association only by 1082stations registered in the database. 1083.It Cm mac:del Ar address 1084Delete the specified MAC address from the database. 1085.It Cm mac:deny 1086Set the ACL policy to deny association only by 1087stations registered in the database. 1088.It Cm mac:kick Ar address 1089Force the specified station to be deauthenticated. 1090This typically is done to block a station after updating the 1091address database. 1092.It Cm mac:open 1093Set the ACL policy to allow all stations to associate. 1094.It Cm mac:flush 1095Delete all entries in the database. 1096.El 1097.Pp 1098The following parameters are for compatibility with other systems: 1099.Bl -tag -width indent 1100.It Cm nwid Ar ssid 1101Another name for the 1102.Cm ssid 1103parameter. 1104Included for 1105.Nx 1106compatibility. 1107.It Cm station Ar name 1108Another name for the 1109.Cm stationname 1110parameter. 1111Included for 1112.Bsx 1113compatibility. 1114.It Cm wep 1115Another way of saying 1116.Cm wepmode on . 1117Included for 1118.Bsx 1119compatibility. 1120.It Fl wep 1121Another way of saying 1122.Cm wepmode off . 1123Included for 1124.Bsx 1125compatibility. 1126.It Cm nwkey key 1127Another way of saying: 1128.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" . 1129Included for 1130.Nx 1131compatibility. 1132.It Cm nwkey Xo 1133.Sm off 1134.Ar n : k1 , k2 , k3 , k4 1135.Sm on 1136.Xc 1137Another way of saying 1138.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" . 1139Included for 1140.Nx 1141compatibility. 1142.It Fl nwkey 1143Another way of saying 1144.Cm wepmode off . 1145Included for 1146.Nx 1147compatibility. 1148.El 1149.Pp 1150The following parameters are specific to bridge interfaces: 1151.Bl -tag -width indent 1152.It Cm addm Ar interface 1153Add the interface named by 1154.Ar interface 1155as a member of the bridge. 1156The interface is put into promiscuous mode 1157so that it can receive every packet sent on the network. 1158.It Cm deletem Ar interface 1159Remove the interface named by 1160.Ar interface 1161from the bridge. 1162Promiscuous mode is disabled on the interface when 1163it is removed from the bridge. 1164.It Cm maxaddr Ar size 1165Set the size of the bridge address cache to 1166.Ar size . 1167The default is 100 entries. 1168.It Cm timeout Ar seconds 1169Set the timeout of address cache entries to 1170.Ar seconds 1171seconds. 1172If 1173.Ar seconds 1174is zero, then address cache entries will not be expired. 1175The default is 240 seconds. 1176.It Cm addr 1177Display the addresses that have been learned by the bridge. 1178.It Cm static Ar interface-name Ar address 1179Add a static entry into the address cache pointing to 1180.Ar interface-name . 1181Static entries are never aged out of the cache or re-placed, even if the 1182address is seen on a different interface. 1183.It Cm deladdr Ar address 1184Delete 1185.Ar address 1186from the address cache. 1187.It Cm flush 1188Delete all dynamically-learned addresses from the address cache. 1189.It Cm flushall 1190Delete all addresses, including static addresses, from the address cache. 1191.It Cm discover Ar interface 1192Mark an interface as a 1193.Dq discovering 1194interface. 1195When the bridge has no address cache entry 1196(either dynamic or static) 1197for the destination address of a packet, 1198the bridge will forward the packet to all 1199member interfaces marked as 1200.Dq discovering . 1201This is the default for all interfaces added to a bridge. 1202.It Cm -discover Ar interface 1203Clear the 1204.Dq discovering 1205attribute on a member interface. 1206For packets without the 1207.Dq discovering 1208attribute, the only packets forwarded on the interface are broadcast 1209or multicast packets and packets for which the destination address 1210is known to be on the interface's segment. 1211.It Cm learn Ar interface 1212Mark an interface as a 1213.Dq learning 1214interface. 1215When a packet arrives on such an interface, the source 1216address of the packet is entered into the address cache as being a 1217destination address on the interface's segment. 1218This is the default for all interfaces added to a bridge. 1219.It Cm -learn Ar interface 1220Clear the 1221.Dq learning 1222attribute on a member interface. 1223.It Cm span Ar interface 1224Add the interface named by 1225.Ar interface 1226as a span port on the bridge. 1227Span ports transmit a copy of every frame received by the bridge. 1228This is most useful for snooping a bridged network passively on 1229another host connected to one of the span ports of the bridge. 1230.It Cm -span Ar interface 1231Delete the interface named by 1232.Ar interface 1233from the list of span ports of the bridge. 1234.It Cm stp Ar interface 1235Enable Spanning Tree protocol on 1236.Ar interface . 1237The 1238.Xr if_bridge 4 1239driver has support for the IEEE 802.1D Spanning Tree protocol (STP). 1240Spanning Tree is used to detect and remove loops in a network topology. 1241.It Cm -stp Ar interface 1242Disable Spanning Tree protocol on 1243.Ar interface . 1244This is the default for all interfaces added to a bridge. 1245.It Cm maxage Ar seconds 1246Set the time that a Spanning Tree protocol configuration is valid. 1247The default is 20 seconds. 1248The minimum is 1 second and the maximum is 255 seconds. 1249.It Cm fwddelay Ar seconds 1250Set the time that must pass before an interface begins forwarding 1251packets when Spanning Tree is enabled. 1252The default is 15 seconds. 1253The minimum is 1 second and the maximum is 255 seconds. 1254.It Cm hellotime Ar seconds 1255Set the time between broadcasting of Spanning Tree protocol 1256configuration messages. 1257The default is 2 seconds. 1258The minimum is 1 second and the maximum is 255 seconds. 1259.It Cm priority Ar value 1260Set the bridge priority for Spanning Tree. 1261The default is 32768. 1262The minimum is 0 and the maximum is 65536. 1263.It Cm ifpriority Ar interface Ar value 1264Set the Spanning Tree priority of 1265.Ar interface 1266to 1267.Ar value . 1268The default is 128. 1269The minimum is 0 and the maximum is 255. 1270.It Cm ifpathcost Ar interface Ar value 1271Set the Spanning Tree path cost of 1272.Ar interface 1273to 1274.Ar value . 1275The default is 55. 1276The minimum is 0 and the maximum is 65535. 1277.El 1278.Pp 1279The following parameters are specific to IP tunnel interfaces, 1280.Xr gif 4 : 1281.Bl -tag -width indent 1282.It Cm tunnel Ar src_addr dest_addr 1283Configure the physical source and destination address for IP tunnel 1284interfaces. 1285The arguments 1286.Ar src_addr 1287and 1288.Ar dest_addr 1289are interpreted as the outer source/destination for the encapsulating 1290IPv4/IPv6 header. 1291.It Fl tunnel 1292Unconfigure the physical source and destination address for IP tunnel 1293interfaces previously configured with 1294.Cm tunnel . 1295.It Cm deletetunnel 1296Another name for the 1297.Fl tunnel 1298parameter. 1299.El 1300.Pp 1301The following parameters are specific to 1302.Xr pfsync 4 1303interfaces: 1304.Bl -tag -width indent 1305.It Cm maxupd Ar n 1306Set the maximum number of updates for a single state which 1307can be collapsed into one. 1308This is an 8-bit number; the default value is 128. 1309.El 1310.Pp 1311The following parameters are specific to 1312.Xr vlan 4 1313interfaces: 1314.Bl -tag -width indent 1315.It Cm vlan Ar vlan_tag 1316Set the VLAN tag value to 1317.Ar vlan_tag . 1318This value is a 16-bit number which is used to create an 802.1Q 1319VLAN header for packets sent from the 1320.Xr vlan 4 1321interface. 1322Note that 1323.Cm vlan 1324and 1325.Cm vlandev 1326must both be set at the same time. 1327.It Cm vlandev Ar iface 1328Associate the physical interface 1329.Ar iface 1330with a 1331.Xr vlan 4 1332interface. 1333Packets transmitted through the 1334.Xr vlan 4 1335interface will be 1336diverted to the specified physical interface 1337.Ar iface 1338with 802.1Q VLAN encapsulation. 1339Packets with 802.1Q encapsulation received 1340by the parent interface with the correct VLAN tag will be diverted to 1341the associated 1342.Xr vlan 4 1343pseudo-interface. 1344The 1345.Xr vlan 4 1346interface is assigned a 1347copy of the parent interface's flags and the parent's ethernet address. 1348The 1349.Cm vlandev 1350and 1351.Cm vlan 1352must both be set at the same time. 1353If the 1354.Xr vlan 4 1355interface already has 1356a physical interface associated with it, this command will fail. 1357To 1358change the association to another physical interface, the existing 1359association must be cleared first. 1360.Pp 1361Note: if the hardware tagging capability 1362is set on the parent interface, the 1363.Xr vlan 4 1364pseudo 1365interface's behavior changes: 1366the 1367.Xr vlan 4 1368interface recognizes that the 1369parent interface supports insertion and extraction of VLAN tags on its 1370own (usually in firmware) and that it should pass packets to and from 1371the parent unaltered. 1372.It Fl vlandev Op Ar iface 1373If the driver is a 1374.Xr vlan 4 1375pseudo device, disassociate the parent interface from it. 1376This breaks the link between the 1377.Xr vlan 4 1378interface and its parent, 1379clears its VLAN tag, flags and its link address and shuts the interface down. 1380The 1381.Ar iface 1382argument is useless and hence deprecated. 1383.El 1384.Pp 1385The following parameters are specific to 1386.Xr carp 4 1387interfaces: 1388.Bl -tag -width indent 1389.It Cm advbase Ar seconds 1390Specifies the base of the advertisement interval in seconds. 1391The acceptable values are 1 to 255. 1392The default value is 1. 1393.\" The default value is 1394.\" .Dv CARP_DFLTINTV . 1395.It Cm advskew Ar interval 1396Specifies the skew to add to the base advertisement interval to 1397make one host advertise slower than another host. 1398It is specified in 1/256 of seconds. 1399The acceptable values are 1 to 254. 1400The default value is 0. 1401.It Cm pass Ar phrase 1402Set the authentication key to 1403.Ar phrase . 1404.It Cm vhid Ar n 1405Set the virtual host ID. 1406This is a required setting. 1407Acceptable values are 1 to 255. 1408.El 1409.Pp 1410The 1411.Nm 1412utility displays the current configuration for a network interface 1413when no optional parameters are supplied. 1414If a protocol family is specified, 1415.Nm 1416will report only the details specific to that protocol family. 1417.Pp 1418If the 1419.Fl m 1420flag is passed before an interface name, 1421.Nm 1422will display the capability list and all 1423of the supported media for the specified interface. 1424If 1425.Fl L 1426flag is supplied, address lifetime is displayed for IPv6 addresses, 1427as time offset string. 1428.Pp 1429Optionally, the 1430.Fl a 1431flag may be used instead of an interface name. 1432This flag instructs 1433.Nm 1434to display information about all interfaces in the system. 1435The 1436.Fl d 1437flag limits this to interfaces that are down, and 1438.Fl u 1439limits this to interfaces that are up. 1440When no arguments are given, 1441.Fl a 1442is implied. 1443.Pp 1444The 1445.Fl l 1446flag may be used to list all available interfaces on the system, with 1447no other additional information. 1448Use of this flag is mutually exclusive 1449with all other flags and commands, except for 1450.Fl d 1451(only list interfaces that are down) 1452and 1453.Fl u 1454(only list interfaces that are up). 1455.Pp 1456The 1457.Fl v 1458flag may be used to get more verbose status for an interface. 1459.Pp 1460The 1461.Fl C 1462flag may be used to list all of the interface cloners available on 1463the system, with no additional information. 1464Use of this flag is mutually exclusive with all other flags and commands. 1465.Pp 1466The 1467.Fl k 1468flag causes keying information for the interface, if available, to be 1469printed. 1470For example, the values of 802.11 WEP keys will be printed, if accessible to 1471the current user. 1472This information is not printed by default, as it may be considered 1473sensitive. 1474.Pp 1475Only the super-user may modify the configuration of a network interface. 1476.Sh NOTES 1477The media selection system is relatively new and only some drivers support 1478it (or have need for it). 1479.Sh DIAGNOSTICS 1480Messages indicating the specified interface does not exist, the 1481requested address is unknown, or the user is not privileged and 1482tried to alter an interface's configuration. 1483.Sh SEE ALSO 1484.Xr netstat 1 , 1485.Xr carp 4 , 1486.Xr netintro 4 , 1487.Xr pfsync 4 , 1488.Xr polling 4 , 1489.Xr vlan 4 , 1490.\" .Xr eon 5 , 1491.Xr rc 8 , 1492.Xr routed 8 , 1493.Xr sysctl 8 1494.Sh HISTORY 1495The 1496.Nm 1497utility appeared in 1498.Bx 4.2 . 1499.Sh BUGS 1500Basic IPv6 node operation requires a link-local address on each 1501interface configured for IPv6. 1502Normally, such an address is automatically configured by the 1503kernel on each interface added to the system; this behaviour may 1504be disabled by setting the sysctl MIB variable 1505.Va net.inet6.ip6.auto_linklocal 1506to 0. 1507.Pp 1508If you delete such an address using 1509.Nm , 1510the kernel may act very oddly. 1511Do this at your own risk. 1512