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