d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
527d10a53b
freebsd-skq/sbin/ifconfig/ifconfig.8

3128 lines
95 KiB
Groff
Raw Normal View History

BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
Remove support for OSI networking in user-land (#ifdef OSI aor CCITT) in preparation for its removal from the kernel source tree. NB: because a function was deleted, libc is now at version 3.0 (was 2.2 previously).
1996-02-06 20:36:15 +00:00
.\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.\"
ifconfig.8: Remove spurious commas Correct misuse of commas/parentheses in an enumeration that makes the number of actual parameters more important than expected. PR: 250526 Submitted by: Samy Mahmoudi <samy.mahmoudi__gmail_com> MFC after: 1 week
2020-10-25 15:01:01 +00:00
.Dd October 25, 2020
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Dt IFCONFIG 8
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Os
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Sh NAME
.Nm ifconfig
.Nd configure network interface parameters
.Sh SYNOPSIS
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm
ifconfig(8) now supports some output formatting options specified by the -f flag or IFCONFIG_FORMAT environment variable, the user can request that inet4 subnet masks be printed in CIDR or dotted-quad notation, in addition to the traditional hex output. inet6 prefixes can be printed in CIDR as well. For more documentation see the ifconfig(8) man page. PR: 169072 Requested by: seanc, marcel, brd, many others Reviewed by: gnn, jhb (earlier version) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2856
2016-05-31 17:30:08 +00:00
.Op Fl f Ar type:format Ns Op Ar ,type:format
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
.Op Fl L
Add a new flag '-k' to ifconfig(8), indicating that it is alright to print potentially sensitive keying material to stdout. With the new 802.11 support, ifconfig(8) is now capable of printing 802.11 keys, and did by default for the root user, which is undesirable in some environments. Now it will not print keying material unless requested (and available to the user). MFC after: 1 week
2005-07-14 18:33:21 +00:00
.Op Fl k
When using interfaces that support if_media, the supported media list is printed on a single, very long, and generally unreadable line. This isn't very useful. It's also really ugly and most of the time you don't care what media is supported anyway. PR: 27701 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-29 09:13:44 +00:00
.Op Fl m
Add the -n flag for disabling automatic module loading, this will be used by rc.d to stop it reloading the network module on unload.
2007-05-22 17:41:09 +00:00
.Op Fl n
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
.Ar interface
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.Op Cm create
Conditionally compile in the af_inet and af_inet6, af_nd6 modules. If compiled in for dual-stack use, test with feature_present(3) to see if we should register the IPv4/IPv6 address family related options. In case there is no "inet" support we would love to go with the usage() and make the address family mandatory (as it is for anything but inet in theory). Unfortunately people are used to ifconfig IF up/down etc. as well, so use a fallback of "link". Adjust the man page to reflect these minor details. Improve error handling printing a warning in addition to the usage telling that we do not know the given address family in two places. Reviewed by: hrs, rwatson Sponsored by: The FreeBSD Foundation Sponsored by: iXsystems MFC after: 2 weeks
2011-05-31 14:40:21 +00:00
.Ar address_family
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Oo
In the words of the submitter: The first "synopsis" example has a "[/prefixlength]" which shouldn't be there, since that stuff is part of the preceeding "address" as is explained in the description of "address". (The way it is now, 192.168.0.1/16/prefixlength would be a proper operand. Note that "prefixlength" is not mentioned by name anywhere.) PR: 32462 Submitted by: Gary W. Swearingen <swear@blarg.net>
2002-01-07 06:51:19 +00:00
.Ar address
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Op Ar dest_address
.Oc
.Op Ar parameters
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.Ar interface
.Cm destroy
.Nm
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Fl a
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
.Op Fl L
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Op Fl d
ifconfig(8): make it possible to filter output by interface group. Now options -g/-G allow to select/unselect interfaces by groups in the "ifconfig -a" output just like already existing -d/-u. Examples: to exclude loopback from the list: ifconfig -a -G lo to show vlan interfaces only: ifconfig -a -g vlan to show tap interfaces that are up: ifconfig -aug tap Arguments to -g/-G may be shell patterns and both may be specified. Later options -g/-G override previous ones. MFC after: 2 weeks Relnotes: yes Differential Revision: https://reviews.freebsd.org/D25029
2020-06-04 14:44:44 +00:00
.Op Fl [gG] Ar groupname
When using interfaces that support if_media, the supported media list is printed on a single, very long, and generally unreadable line. This isn't very useful. It's also really ugly and most of the time you don't care what media is supported anyway. PR: 27701 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-29 09:13:44 +00:00
.Op Fl m
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Op Fl u
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Op Fl v
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
.Op Ar address_family
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Fl l
.Op Fl d
.Op Fl u
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Op Ar address_family
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
.Op Fl L
.Op Fl d
Add a new flag '-k' to ifconfig(8), indicating that it is alright to print potentially sensitive keying material to stdout. With the new 802.11 support, ifconfig(8) is now capable of printing 802.11 keys, and did by default for the root user, which is undesirable in some environments. Now it will not print keying material unless requested (and available to the user). MFC after: 1 week
2005-07-14 18:33:21 +00:00
.Op Fl k
When using interfaces that support if_media, the supported media list is printed on a single, very long, and generally unreadable line. This isn't very useful. It's also really ugly and most of the time you don't care what media is supported anyway. PR: 27701 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-29 09:13:44 +00:00
.Op Fl m
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
.Op Fl u
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Op Fl v
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.Op Fl C
Import interface groups from OpenBSD. This allows to group interfaces in order to - for example - apply firewall rules to a whole group of interfaces. This is required for importing pf from OpenBSD 3.9 Obtained from: OpenBSD (with changes) Discussed on: -net (back in April)
2006-06-19 22:20:45 +00:00
.Nm
.Op Fl g Ar groupname
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Sh DESCRIPTION
The .Nm utility
2002-07-06 19:34:18 +00:00
The
.Nm
utility is used to assign an address
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
to a network interface and/or configure
network interface parameters.
The .Nm utility
2002-07-06 19:34:18 +00:00
The
.Nm
utility must be used at boot time to define the network address
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
of each interface present on a machine; it may also be used at
a later time to redefine an interface's address
or other operating parameters.
.Pp
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
The following options are available:
.Bl -tag -width indent
.It Ar address
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
For the
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
.Tn DARPA Ns -Internet
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
family,
the address is either a host name present in the host name data
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
base,
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Xr hosts 5 ,
or a
.Tn DARPA
Internet address expressed in the Internet standard
.Dq dot notation .
Let ifconfig(8) catch up with the new functionality where one can specify addresses and netmask in CIDR notation. Submitted by: Dima Dorfman <dima@unixfreak.org>
2001-05-05 19:53:20 +00:00
.Pp
It is also possible to use the CIDR notation (also known as the
slash notation) to include the netmask.
That is, one can specify an address like
Cosmetics: .Dl -> .Li.
2001-05-07 07:42:56 +00:00
.Li 192.168.0.1/16 .
mdoc(7) police: Restore (sorta) a useful piece of information that got lost in the previous delta -- an ability to specify /prefixlength after an IPv6 address.
2002-01-09 15:10:31 +00:00
.Pp
Tiny wording nits. MFC after: 1 week
2008-10-19 09:45:29 +00:00
For the
mdoc(7) police: Restore (sorta) a useful piece of information that got lost in the previous delta -- an ability to specify /prefixlength after an IPv6 address.
2002-01-09 15:10:31 +00:00
.Dq inet6
family, it is also possible to specify the prefix length using the slash
notation, like
.Li ::1/128 .
See the
.Cm prefixlen
parameter below for more information.
XNS sort-of-support is no more.
1996-02-13 17:30:37 +00:00
.\" For the Xerox Network Systems(tm) family,
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.\" addresses are
XNS sort-of-support is no more.
1996-02-13 17:30:37 +00:00
.\" .Ar net:a.b.c.d.e.f ,
.\" where
.\" .Ar net
.\" is the assigned network number (in decimal),
.\" and each of the six bytes of the host number,
.\" .Ar a
.\" through
.\" .Ar f ,
.\" are specified in hexadecimal.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.\" The host number may be omitted on IEEE 802 protocol
ARP works on networks other than Ethernet. PR: 22062 Submitted by: Christian Weisgerber <naddy@mips.inka.de>, Brooks Davis <brooks@one-eyed-alien.net>
2001-06-02 04:09:53 +00:00
.\" (Ethernet, FDDI, and Token Ring) interfaces,
XNS sort-of-support is no more.
1996-02-13 17:30:37 +00:00
.\" which use the hardware physical address,
.\" and on interfaces other than the first.
Remove support for OSI networking in user-land (#ifdef OSI aor CCITT) in preparation for its removal from the kernel source tree. NB: because a function was deleted, libc is now at version 3.0 (was 2.2 previously).
1996-02-06 20:36:15 +00:00
.\" For the
.\" .Tn ISO
.\" family, addresses are specified as a long hexadecimal string,
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.\" as in the Xerox family.
.\" However, two consecutive dots imply a zero
Remove support for OSI networking in user-land (#ifdef OSI aor CCITT) in preparation for its removal from the kernel source tree. NB: because a function was deleted, libc is now at version 3.0 (was 2.2 previously).
1996-02-06 20:36:15 +00:00
.\" byte, and the dots are optional, if the user wishes to (carefully)
.\" count out long strings of digits in network byte order.
Turn "ether" address family into a generic "link" family that could be used to set/get arbitrary length link level addresses. Alias "lladdr" parameter and "ether" family to the new "link" family for backward compatibility. PR: bin/31476 MFC after: 1 week
2002-03-27 14:29:23 +00:00
.Pp
The link-level
.Pq Dq link
address
is specified as a series of colon-separated hex digits.
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
This can be used to, for example,
set a new MAC address on an Ethernet interface, though the
mechanism used is not Ethernet specific.
Add an option called "random" that combined with "ether" can generate a random MAC address for an Ethernet interface. PR: 211984 Submitted by: pi@ Reviewed by: gnn, cem, jhb, lidl, rpokala, wblock Approved by: wblock (manpages)
2016-09-16 04:22:21 +00:00
Use the
.Pq Dq random
keyword to set a randomly generated MAC address.
A randomly-generated MAC address might be the same as one already in use
in the network.
Such duplications are extremely unlikely.
Turn "ether" address family into a generic "link" family that could be used to set/get arbitrary length link level addresses. Alias "lladdr" parameter and "ether" family to the new "link" family for backward compatibility. PR: bin/31476 MFC after: 1 week
2002-03-27 14:29:23 +00:00
If the interface is already
up when this option is used, it will be briefly brought down and
then brought back up again in order to ensure that the receive
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
filter in the underlying Ethernet hardware is properly reprogrammed.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Ar address_family
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
Specify the
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
address family
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
which affects interpretation of the remaining parameters.
Since an interface can receive transmissions in differing protocols
Fix a bunch of spelling errors.
1996-01-29 23:52:43 +00:00
with different naming schemes, specifying the address family is recommended.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
The address or protocol families currently
supported are
Submitted by: Archie@whistle.com Obtained from: Whistle Communications patches to allow ifconfig to work with appletalk addresses etc.
1996-07-09 02:38:13 +00:00
.Dq inet ,
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
.Dq inet6 ,
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
and
Turn "ether" address family into a generic "link" family that could be used to set/get arbitrary length link level addresses. Alias "lladdr" parameter and "ether" family to the new "link" family for backward compatibility. PR: bin/31476 MFC after: 1 week
2002-03-27 14:29:23 +00:00
.Dq link .
Conditionally compile in the af_inet and af_inet6, af_nd6 modules. If compiled in for dual-stack use, test with feature_present(3) to see if we should register the IPv4/IPv6 address family related options. In case there is no "inet" support we would love to go with the usage() and make the address family mandatory (as it is for anything but inet in theory). Unfortunately people are used to ifconfig IF up/down etc. as well, so use a fallback of "link". Adjust the man page to reflect these minor details. Improve error handling printing a warning in addition to the usage telling that we do not know the given address family in two places. Reviewed by: hrs, rwatson Sponsored by: The FreeBSD Foundation Sponsored by: iXsystems MFC after: 2 weeks
2011-05-31 14:40:21 +00:00
The default if available is
.Dq inet
or otherwise
.Dq link .
Turn "ether" address family into a generic "link" family that could be used to set/get arbitrary length link level addresses. Alias "lladdr" parameter and "ether" family to the new "link" family for backward compatibility. PR: bin/31476 MFC after: 1 week
2002-03-27 14:29:23 +00:00
.Dq ether
and
.Dq lladdr
are synonyms for
.Dq link .
improve ifconfig(8) man page by describing special behaviour of -l ether PR: docs/187644 Submitted by: Andrew Merenbach (original patch) Approved by: bcr (mentor)
2014-05-27 20:45:15 +00:00
When using the
.Fl l
flag, the
.Dq ether
address family has special meaning and is no longer synonymous with
.Dq link
or
.Dq lladdr .
Specifying
.Fl l Dq ether
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
will list only Ethernet interfaces, excluding all other interface types,
improve ifconfig(8) man page by describing special behaviour of -l ether PR: docs/187644 Submitted by: Andrew Merenbach (original patch) Approved by: bcr (mentor)
2014-05-27 20:45:15 +00:00
including the loopback interface.
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
.It Ar dest_address
Specify the address of the correspondent on the other end
of a point to point link.
.It Ar interface
This
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
parameter is a string of the form
.Dq name unit ,
for example,
Change ed(4), ep(4), and fxp(4) examples to em(4). ed(4) and ep(4) have been removed. fxp(4) remains popular in older systems, but isn't as future proof as em(4). Reviewed by: bz, jhb MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20311
2019-05-18 21:01:36 +00:00
.Dq Li em0 .
Import interface groups from OpenBSD. This allows to group interfaces in order to - for example - apply firewall rules to a whole group of interfaces. This is required for importing pf from OpenBSD 3.9 Obtained from: OpenBSD (with changes) Discussed on: -net (back in April)
2006-06-19 22:20:45 +00:00
.It Ar groupname
List the interfaces in the given group.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.El
.Pp
ifconfig(8) now supports some output formatting options specified by the -f flag or IFCONFIG_FORMAT environment variable, the user can request that inet4 subnet masks be printed in CIDR or dotted-quad notation, in addition to the traditional hex output. inet6 prefixes can be printed in CIDR as well. For more documentation see the ifconfig(8) man page. PR: 169072 Requested by: seanc, marcel, brd, many others Reviewed by: gnn, jhb (earlier version) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2856
2016-05-31 17:30:08 +00:00
The output format of
.Nm
can be controlled using the
.Fl f
flag or the
.Ev IFCONFIG_FORMAT
environment variable.
The format is specified as a comma separated list of
.Sy type:format
pairs.
See the
.Sx EXAMPLES
section for more information.
The
.Sy types
and their associated
.Sy format
strings are:
Address feedback from hrs@ re: r301059 (ifconfig subnet mask) - Use NI_MAXHOST to size buffers for getnameinfo() - remove non-standard 'full' inet6 address printing - remove 'no scope' option - use strchr(3) to optimize replacing separator character in lladdrs Reviewed by: gnn, jhb Differential Revision: https://reviews.freebsd.org/D2856
2016-06-02 03:16:02 +00:00
.Bl -tag -width ether
ifconfig(8) now supports some output formatting options specified by the -f flag or IFCONFIG_FORMAT environment variable, the user can request that inet4 subnet masks be printed in CIDR or dotted-quad notation, in addition to the traditional hex output. inet6 prefixes can be printed in CIDR as well. For more documentation see the ifconfig(8) man page. PR: 169072 Requested by: seanc, marcel, brd, many others Reviewed by: gnn, jhb (earlier version) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2856
2016-05-31 17:30:08 +00:00
.It Sy addr
Adjust the display of inet and inet6 addresses
.Bl -tag -width default
.It Sy default
Display inet and inet6 addresses in the default format,
.Sy numeric
.It Sy fqdn
Display inet and inet6 addresses as fully qualified domain names
.Pq FQDN
.It Sy host
Display inet and inet6 addresses as unqualified hostnames
.It Sy numeric
Display inet and inet6 addresses in numeric format
.El
.It Sy ether
Adjust the display of link-level ethernet (MAC) addresses
.Bl -tag -width default
.It Sy colon
Separate address segments with a colon
.It Sy dash
Separate address segments with a dash
.It Sy default
Display ethernet addresses in the default format,
.Sy colon
.El
.It Sy inet
Adjust the display of inet address subnet masks:
.Bl -tag -width default
.It Sy cidr
Display subnet masks in CIDR notation, for example:
.br
10.0.0.0/8 or 203.0.113.224/26
.It Sy default
Display subnet masks in the default format,
.Sy hex
.It Sy dotted
Display subnet masks in dotted quad notation, for example:
.br
255.255.0.0 or 255.255.255.192
.It Sy hex
Add an option called "random" that combined with "ether" can generate a random MAC address for an Ethernet interface. PR: 211984 Submitted by: pi@ Reviewed by: gnn, cem, jhb, lidl, rpokala, wblock Approved by: wblock (manpages)
2016-09-16 04:22:21 +00:00
Display subnet masks in hexadecimal, for example:
ifconfig(8) now supports some output formatting options specified by the -f flag or IFCONFIG_FORMAT environment variable, the user can request that inet4 subnet masks be printed in CIDR or dotted-quad notation, in addition to the traditional hex output. inet6 prefixes can be printed in CIDR as well. For more documentation see the ifconfig(8) man page. PR: 169072 Requested by: seanc, marcel, brd, many others Reviewed by: gnn, jhb (earlier version) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2856
2016-05-31 17:30:08 +00:00
.br
0xffff0000 or 0xffffffc0
.El
.It Sy inet6
Adjust the display of inet6 address prefixes (subnet masks):
.Bl -tag -width default
.It Sy cidr
Display subnet prefix in CIDR notation, for example:
.br
::1/128 or fe80::1%lo0/64
.It Sy default
Display subnet prefix in the default format
.Sy numeric
.It Sy numeric
Display subnet prefix in integer format, for example:
.br
prefixlen 64
.El
.El
.Pp
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
The following parameters may be set with
mdoc(7) police: use the new features of the Nm macro.
2000-11-20 16:52:27 +00:00
.Nm :
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
.Bl -tag -width indent
Introduce ``add'' and ``remove'' as alternatives to ``alias'' and ``delete''. Improve compatibility with BSD/OS, and also more accurately reflect that IP aliases aren't really any different than the primary IP address on an interface. Reviewed by: dcs Approved by: jkh
2000-02-26 18:55:39 +00:00
.It Cm add
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
Another name for the
.Cm alias
parameter.
Introduced for compatibility
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
with
.Bsx .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm alias
Establish an additional network address for this interface.
This is sometimes useful when changing network numbers, and
one wishes to accept packets addressed to the old interface.
Spelling: ``adress'' -> ``address''
2000-02-26 18:59:34 +00:00
If the address is on the same subnet as the first network address
Reword the ``alias'' description slightly. We must specify a non-conflicting netmask - not necessarily 0xffffffff. MFC after: 3 days
2002-05-11 11:35:35 +00:00
for this interface, a non-conflicting netmask must be given.
Usually
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Li 0xffffffff
Reword the ``alias'' description slightly. We must specify a non-conflicting netmask - not necessarily 0xffffffff. MFC after: 3 days
2002-05-11 11:35:35 +00:00
is most appropriate.
Document "-alias".
2000-05-20 18:05:24 +00:00
.It Fl alias
Remove the network address specified.
This would be used if you incorrectly specified an alias, or it
was no longer needed.
If you have incorrectly set an NS address having the side effect
of specifying the host portion, removing all NS addresses will
allow you to respecify the host portion.
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
.It Cm anycast
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
(Inet6 only.)
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
Specify that the address configured is an anycast address.
Based on the current specification,
only routers may configure anycast addresses.
Anycast address will not be used as source address of any of outgoing
IPv6 packets.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm arp
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Enable the use of the Address Resolution Protocol
.Pq Xr arp 4
in mapping
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
between network level addresses and link level addresses (default).
This is currently implemented for mapping between
.Tn DARPA
Internet
ARP works on networks other than Ethernet. PR: 22062 Submitted by: Christian Weisgerber <naddy@mips.inka.de>, Brooks Davis <brooks@one-eyed-alien.net>
2001-06-02 04:09:53 +00:00
addresses and
.Tn IEEE
802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Fl arp
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Disable the use of the Address Resolution Protocol
.Pq Xr arp 4 .
By popular demand, added the "static ARP" per-interface option.
2003-10-01 08:32:37 +00:00
.It Cm staticarp
If the Address Resolution Protocol is enabled,
the host will only reply to requests for its addresses,
and will never send any requests.
.It Fl staticarp
If the Address Resolution Protocol is enabled,
the host will perform normally,
sending out requests and listening for replies.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm broadcast
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
(Inet only.)
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
Specify the address to use to represent broadcasts to the
network.
The default broadcast address is the address with a host part of all 1's.
.It Cm debug
Enable driver dependent debugging code; usually, this turns on
extra console error logging.
.It Fl debug
Disable driver dependent debugging code.
Implement user-setable promiscuous mode (a new `promisc' flag for ifconfig(8)). Also, for all interfaces in this mode pass all ethernet frames to upper layer, even those not addressed to our own MAC, which allows packets encapsulated in those frames be processed with packet filters (ipfw(8) et al). Emphatically requested by: Anton Turygin <pa3op@ukr-link.net> Valuable suggestions by: fenner
2002-08-19 15:16:38 +00:00
.It Cm promisc
Put interface into permanently promiscuous mode.
.It Fl promisc
Disable permanently promiscuous mode.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm delete
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
Another name for the
.Fl alias
parameter.
Revised revision 199201 (add interface description capability as inspired by OpenBSD), based on comments from many, including rwatson, jhb, brooks and others. Sponsored by: iXsystems, Inc. MFC after: 1 month
2010-01-27 00:30:07 +00:00
.It Cm description Ar value , Cm descr Ar value
Specify a description of the interface.
This can be used to label interfaces in situations where they may
otherwise be difficult to distinguish.
.It Cm -description , Cm -descr
Clear the interface description.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm down
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
Mark an interface
.Dq down .
When an interface is marked
.Dq down ,
the system will not attempt to
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
transmit messages through that interface.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
If possible, the interface will be reset to disable reception as well.
This action does not automatically disable routes using the interface.
ifconfig(8): spell "groupname" consistently with SYNOPSYS. MFC after: 1 week
2020-05-27 08:16:17 +00:00
.It Cm group Ar groupname
Import interface groups from OpenBSD. This allows to group interfaces in order to - for example - apply firewall rules to a whole group of interfaces. This is required for importing pf from OpenBSD 3.9 Obtained from: OpenBSD (with changes) Discussed on: -net (back in April)
2006-06-19 22:20:45 +00:00
Assign the interface to a
.Dq group .
Any interface can be in multiple groups.
.Pp
Cloned interfaces are members of their interface family group by default.
For example, a PPP interface such as
.Em ppp0
is a member of the PPP interface family group,
.Em ppp .
.\" The interface(s) the default route(s) point to are members of the
.\" .Em egress
.\" interface group.
ifconfig(8): spell "groupname" consistently with SYNOPSYS. MFC after: 1 week
2020-05-27 08:16:17 +00:00
.It Cm -group Ar groupname
Import interface groups from OpenBSD. This allows to group interfaces in order to - for example - apply firewall rules to a whole group of interfaces. This is required for importing pf from OpenBSD 3.9 Obtained from: OpenBSD (with changes) Discussed on: -net (back in April)
2006-06-19 22:20:45 +00:00
Remove the interface from the given
.Dq group .
Add eui64 option which fills interface index (lowermost 64bit of an IPv6 address) automatically. This should obsolete prefix(8). Obtained from: NetBSD MFC after: 2 weeks
2002-06-15 15:35:24 +00:00
.It Cm eui64
(Inet6 only.)
Fill interface index
mdoc(7) police: KAMEism in rev. 1.56, nits in rev. 1.58.
2002-08-13 11:51:03 +00:00
(lowermost 64bit of an IPv6 address)
Add eui64 option which fills interface index (lowermost 64bit of an IPv6 address) automatically. This should obsolete prefix(8). Obtained from: NetBSD MFC after: 2 weeks
2002-06-15 15:35:24 +00:00
automatically.
Add infrastructure to allow all frames/packets received on an interface to be assigned to a non-default FIB instance. You may need to recompile world or ports due to the change of struct ifnet. Submitted by: cjsp Submitted by: Alexander V. Chernikov (melifaro ipfw.ru) (original versions) Reviewed by: julian Reviewed by: Alexander V. Chernikov (melifaro ipfw.ru) MFC after: 2 weeks X-MFC: use spare in struct ifnet
2011-07-03 12:22:02 +00:00
.It Cm fib Ar fib_number
Specify interface FIB.
A FIB
.Ar fib_number
is assigned to all frames or packets received on that interface.
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
The FIB is not inherited, e.g., vlans or other sub-interfaces will use
Add infrastructure to allow all frames/packets received on an interface to be assigned to a non-default FIB instance. You may need to recompile world or ports due to the change of struct ifnet. Submitted by: cjsp Submitted by: Alexander V. Chernikov (melifaro ipfw.ru) (original versions) Reviewed by: julian Reviewed by: Alexander V. Chernikov (melifaro ipfw.ru) MFC after: 2 weeks X-MFC: use spare in struct ifnet
2011-07-03 12:22:02 +00:00
the default FIB (0) irrespective of the parent interface's FIB.
The kernel needs to be tuned to support more than the default FIB
using the
.Va ROUTETABLES
kernel configuration option, or the
.Va net.fibs
tunable.
Add new socket ioctls SIOC[SG]TUNFIB to set FIB number of encapsulated packets on tunnel interfaces. Add support of these ioctls to gre(4), gif(4) and me(4) interfaces. For incoming packets M_SETFIB() should use if_fib value from ifnet structure, use proper value in gre(4) and me(4). Differential Revision: https://reviews.freebsd.org/D2462 No objection from: #network MFC after: 2 weeks Sponsored by: Yandex LLC
2015-05-12 07:37:27 +00:00
.It Cm tunnelfib Ar fib_number
Specify tunnel FIB.
A FIB
.Ar fib_number
is assigned to all packets encapsulated by tunnel interface, e.g.,
.Xr gif 4
and
.Xr gre 4 .
Document the `maclabel' command. Obtained from: TrustedBSD Project Sponsored by: Network Associates Laboratories
2002-10-25 22:40:37 +00:00
.It Cm maclabel Ar label
If Mandatory Access Control support is enabled in the kernel,
set the MAC label to
.Ar label .
.\" (see
.\" .Xr maclabel 7 ) .
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.It Cm media Ar type
Spell out a few things for the media options.
1997-09-27 02:55:39 +00:00
If the driver supports the media selection system, set the media type
of the interface to
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Ar type .
Some interfaces support the mutually exclusive use of one of several
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
different physical media connectors.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
For example, a 10Mbit/s Ethernet
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
interface might support the use of either
.Tn AUI
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
or twisted pair connectors.
Setting the media type to
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm 10base5/AUI
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
would change the currently active connector to the AUI port.
Setting it to
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm 10baseT/UTP
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
would activate twisted pair.
Refer to the interfaces' driver
Spell out a few things for the media options.
1997-09-27 02:55:39 +00:00
specific documentation or man page for a complete list of the
available types.
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.It Cm mediaopt Ar opts
Spell out a few things for the media options.
1997-09-27 02:55:39 +00:00
If the driver supports the media selection system, set the specified
media options on the interface.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
The
.Ar opts
argument
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
is a comma delimited list of options to apply to the interface.
Refer to the interfaces' driver specific man page for a complete
list of available options.
.It Fl mediaopt Ar opts
Spell out a few things for the media options.
1997-09-27 02:55:39 +00:00
If the driver supports the media selection system, disable the
specified media options on the interface.
document mode directive
2003-04-28 16:47:40 +00:00
.It Cm mode Ar mode
If the driver supports the media selection system, set the specified
operating mode on the interface to
.Ar mode .
For IEEE 802.11 wireless interfaces that support multiple operating modes
mdoc(7) police: fix more breakages from rev. 1.69.
2003-05-14 16:22:16 +00:00
this directive is used to select between 802.11a
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Pq Cm 11a ,
mdoc(7) police: fix more breakages from rev. 1.69.
2003-05-14 16:22:16 +00:00
802.11b
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Pq Cm 11b ,
mdoc(7) police: fix more breakages from rev. 1.69.
2003-05-14 16:22:16 +00:00
and 802.11g
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Pq Cm 11g
document mode directive
2003-04-28 16:47:40 +00:00
operating modes.
Implement kernel support for hardware rate limited sockets. - Add RATELIMIT kernel configuration keyword which must be set to enable the new functionality. - Add support for hardware driven, Receive Side Scaling, RSS aware, rate limited sendqueues and expose the functionality through the already established SO_MAX_PACING_RATE setsockopt(). The API support rates in the range from 1 to 4Gbytes/s which are suitable for regular TCP and UDP streams. The setsockopt(2) manual page has been updated. - Add rate limit function callback API to "struct ifnet" which supports the following operations: if_snd_tag_alloc(), if_snd_tag_modify(), if_snd_tag_query() and if_snd_tag_free(). - Add support to ifconfig to view, set and clear the IFCAP_TXRTLMT flag, which tells if a network driver supports rate limiting or not. - This patch also adds support for rate limiting through VLAN and LAGG intermediate network devices. - How rate limiting works: 1) The userspace application calls setsockopt() after accepting or making a new connection to set the rate which is then stored in the socket structure in the kernel. Later on when packets are transmitted a check is made in the transmit path for rate changes. A rate change implies a non-blocking ifp->if_snd_tag_alloc() call will be made to the destination network interface, which then sets up a custom sendqueue with the given rate limitation parameter. A "struct m_snd_tag" pointer is returned which serves as a "snd_tag" hint in the m_pkthdr for the subsequently transmitted mbufs. 2) When the network driver sees the "m->m_pkthdr.snd_tag" different from NULL, it will move the packets into a designated rate limited sendqueue given by the snd_tag pointer. It is up to the individual drivers how the rate limited traffic will be rate limited. 3) Route changes are detected by the NIC drivers in the ifp->if_transmit() routine when the ifnet pointer in the incoming snd_tag mismatches the one of the network interface. The network adapter frees the mbuf and returns EAGAIN which causes the ip_output() to release and clear the send tag. Upon next ip_output() a new "snd_tag" will be tried allocated. 4) When the PCB is detached the custom sendqueue will be released by a non-blocking ifp->if_snd_tag_free() call to the currently bound network interface. Reviewed by: wblock (manpages), adrian, gallatin, scottl (network) Differential Revision: https://reviews.freebsd.org/D3687 Sponsored by: Mellanox Technologies MFC after: 3 months
2017-01-18 13:31:17 +00:00
.It Cm txrtlmt
Set if the driver supports TX rate limiting.
- Display the media instance numbers and allow the user to set the active one. This is based on NetBSD but unlike NetBSD this implementation prints the instance number for all media instances and doesn't skip it for the first one as I don't see a reason to suppress it except for the vague reason to preserve the output for single-instance configurations. - Fix some whitespace nits.
2007-01-20 00:56:49 +00:00
.It Cm inst Ar minst , Cm instance Ar minst
Set the media instance to
.Ar minst .
This is useful for devices which have multiple physical layer interfaces
.Pq PHYs .
Add ifconfig support for network interface renaming. In the process, reorganize the printing of the interface name when using wildcard cloning so it is not printed if it we either immediately rename or destroy the interface. Reviewed by: ru
2004-02-04 02:55:46 +00:00
.It Cm name Ar name
Set the interface name to
.Ar name .
It turns out that too many drivers are not only parsing the L2/3/4 headers for TSO but also for generic checksum offloading. Ideally we would only have one common function shared amongst all drivers, and perhaps when updating them for IPv6 we should introduce that. Eventually we should provide the meta information along with mbufs to avoid (re-)parsing entirely. To not break IPv6 (checksums and offload) and to be able to MFC the changes without risking to hurt 3rd party drivers, duplicate the v4 framework, as other OSes have done as well. Introduce interface capability flags for TX/RX checksum offload with IPv6, to allow independent toggling (where possible). Add CSUM_*_IPV6 flags for UDP/TCP over IPv6, and reserve further for SCTP, and IPv6 fragmentation. Define CSUM_DELAY_DATA_IPV6 as we do for legacy IP and add an alias for CSUM_DATA_VALID_IPV6. This pretty much brings IPv6 handling in line with IPv4. TSO is still handled in a different way and not via if_hwassist. Update ifconfig to allow (un)setting of the new capability flags. Update loopback to announce the new capabilities and if_hwassist flags. Individual driver updates will have to follow, as will SCTP. Reported by: gallatin, dim, .. Reviewed by: gallatin (glanced at?) MFC after: 3 days X-MFC with: r235961,235959,235958
2012-05-28 09:30:13 +00:00
.It Cm rxcsum , txcsum , rxcsum6 , txcsum6
Document the rxcsum and txcsum commands. Submitted by: jlemon
2003-02-27 22:59:13 +00:00
If the driver supports user-configurable checksum offloading,
enable receive (or transmit) checksum offloading on the interface.
It turns out that too many drivers are not only parsing the L2/3/4 headers for TSO but also for generic checksum offloading. Ideally we would only have one common function shared amongst all drivers, and perhaps when updating them for IPv6 we should introduce that. Eventually we should provide the meta information along with mbufs to avoid (re-)parsing entirely. To not break IPv6 (checksums and offload) and to be able to MFC the changes without risking to hurt 3rd party drivers, duplicate the v4 framework, as other OSes have done as well. Introduce interface capability flags for TX/RX checksum offload with IPv6, to allow independent toggling (where possible). Add CSUM_*_IPV6 flags for UDP/TCP over IPv6, and reserve further for SCTP, and IPv6 fragmentation. Define CSUM_DELAY_DATA_IPV6 as we do for legacy IP and add an alias for CSUM_DATA_VALID_IPV6. This pretty much brings IPv6 handling in line with IPv4. TSO is still handled in a different way and not via if_hwassist. Update ifconfig to allow (un)setting of the new capability flags. Update loopback to announce the new capabilities and if_hwassist flags. Individual driver updates will have to follow, as will SCTP. Reported by: gallatin, dim, .. Reviewed by: gallatin (glanced at?) MFC after: 3 days X-MFC with: r235961,235959,235958
2012-05-28 09:30:13 +00:00
The feature can be turned on selectively per protocol family.
Use
.Cm rxcsum6 , txcsum6
for
.Xr ip6 4
or
.Cm rxcsum , txcsum
otherwise.
Document the rxcsum and txcsum commands. Submitted by: jlemon
2003-02-27 22:59:13 +00:00
Some drivers may not be able to enable these flags independently
of each other, so setting one may also set the other.
The driver will offload as much checksum work as it can reliably
support, the exact level of offloading varies between drivers.
It turns out that too many drivers are not only parsing the L2/3/4 headers for TSO but also for generic checksum offloading. Ideally we would only have one common function shared amongst all drivers, and perhaps when updating them for IPv6 we should introduce that. Eventually we should provide the meta information along with mbufs to avoid (re-)parsing entirely. To not break IPv6 (checksums and offload) and to be able to MFC the changes without risking to hurt 3rd party drivers, duplicate the v4 framework, as other OSes have done as well. Introduce interface capability flags for TX/RX checksum offload with IPv6, to allow independent toggling (where possible). Add CSUM_*_IPV6 flags for UDP/TCP over IPv6, and reserve further for SCTP, and IPv6 fragmentation. Define CSUM_DELAY_DATA_IPV6 as we do for legacy IP and add an alias for CSUM_DATA_VALID_IPV6. This pretty much brings IPv6 handling in line with IPv4. TSO is still handled in a different way and not via if_hwassist. Update ifconfig to allow (un)setting of the new capability flags. Update loopback to announce the new capabilities and if_hwassist flags. Individual driver updates will have to follow, as will SCTP. Reported by: gallatin, dim, .. Reviewed by: gallatin (glanced at?) MFC after: 3 days X-MFC with: r235961,235959,235958
2012-05-28 09:30:13 +00:00
.It Fl rxcsum , txcsum , rxcsum6 , txcsum6
Document the rxcsum and txcsum commands. Submitted by: jlemon
2003-02-27 22:59:13 +00:00
If the driver supports user-configurable checksum offloading,
disable receive (or transmit) checksum offloading on the interface.
It turns out that too many drivers are not only parsing the L2/3/4 headers for TSO but also for generic checksum offloading. Ideally we would only have one common function shared amongst all drivers, and perhaps when updating them for IPv6 we should introduce that. Eventually we should provide the meta information along with mbufs to avoid (re-)parsing entirely. To not break IPv6 (checksums and offload) and to be able to MFC the changes without risking to hurt 3rd party drivers, duplicate the v4 framework, as other OSes have done as well. Introduce interface capability flags for TX/RX checksum offload with IPv6, to allow independent toggling (where possible). Add CSUM_*_IPV6 flags for UDP/TCP over IPv6, and reserve further for SCTP, and IPv6 fragmentation. Define CSUM_DELAY_DATA_IPV6 as we do for legacy IP and add an alias for CSUM_DATA_VALID_IPV6. This pretty much brings IPv6 handling in line with IPv4. TSO is still handled in a different way and not via if_hwassist. Update ifconfig to allow (un)setting of the new capability flags. Update loopback to announce the new capabilities and if_hwassist flags. Individual driver updates will have to follow, as will SCTP. Reported by: gallatin, dim, .. Reviewed by: gallatin (glanced at?) MFC after: 3 days X-MFC with: r235961,235959,235958
2012-05-28 09:30:13 +00:00
The feature can be turned off selectively per protocol family.
Use
.Fl rxcsum6 , txcsum6
for
.Xr ip6 4
or
.Fl rxcsum , txcsum
otherwise.
Document the rxcsum and txcsum commands. Submitted by: jlemon
2003-02-27 22:59:13 +00:00
These settings may not always be independent of each other.
Make TSO (TCP segmentation offload) capabilities visible and accessible with 'ifconfig em0 tso' and 'ifconfig em0 -tso'. TSO for IPv4 and IPv6 is always enabled or disabled together. The driver may enable only one if it doesn't support both. Document 'tso' and '-tso' in the ifconfig(8) man pages. Sponsored by: TCP/IP Optimization Fundraise 2005
2006-09-06 22:07:14 +00:00
.It Cm tso
If the driver supports
.Xr tcp 4
segmentation offloading, enable TSO on the interface.
Some drivers may not be able to support TSO for
.Xr ip 4
and
.Xr ip6 4
packets, so they may enable only one of them.
.It Fl tso
If the driver supports
.Xr tcp 4
segmentation offloading, disable TSO on the interface.
It will always disable TSO for
.Xr ip 4
and
.Xr ip6 4 .
MFp4 bz_ipv6_fast: Allow tso4 and tso6 be set individually given we have the bits. This will help with drivers not working as expected during the transition time and later. Sponsored by: The FreeBSD Foundation Sponsored by: iXsystems Reviewed by: gnn MFC After: 1 week
2012-05-19 23:25:57 +00:00
.It Cm tso6 , tso4
If the driver supports
.Xr tcp 4
segmentation offloading for
.Xr ip6 4
or
.Xr ip 4
use one of these to selectively enabled it only for one protocol family.
.It Fl tso6 , tso4
If the driver supports
.Xr tcp 4
segmentation offloading for
.Xr ip6 4
or
.Xr ip 4
use one of these to selectively disable it only for one protocol family.
Add reporting and toggling of TCP LRO (large receive offload) support to ifconfig(8).
2007-06-11 20:15:20 +00:00
.It Cm lro
If the driver supports
.Xr tcp 4
large receive offloading, enable LRO on the interface.
.It Fl lro
If the driver supports
.Xr tcp 4
large receive offloading, disable LRO on the interface.
Add kernel-side support for in-kernel TLS. KTLS adds support for in-kernel framing and encryption of Transport Layer Security (1.0-1.2) data on TCP sockets. KTLS only supports offload of TLS for transmitted data. Key negotation must still be performed in userland. Once completed, transmit session keys for a connection are provided to the kernel via a new TCP_TXTLS_ENABLE socket option. All subsequent data transmitted on the socket is placed into TLS frames and encrypted using the supplied keys. Any data written to a KTLS-enabled socket via write(2), aio_write(2), or sendfile(2) is assumed to be application data and is encoded in TLS frames with an application data type. Individual records can be sent with a custom type (e.g. handshake messages) via sendmsg(2) with a new control message (TLS_SET_RECORD_TYPE) specifying the record type. At present, rekeying is not supported though the in-kernel framework should support rekeying. KTLS makes use of the recently added unmapped mbufs to store TLS frames in the socket buffer. Each TLS frame is described by a single ext_pgs mbuf. The ext_pgs structure contains the header of the TLS record (and trailer for encrypted records) as well as references to the associated TLS session. KTLS supports two primary methods of encrypting TLS frames: software TLS and ifnet TLS. Software TLS marks mbufs holding socket data as not ready via M_NOTREADY similar to sendfile(2) when TLS framing information is added to an unmapped mbuf in ktls_frame(). ktls_enqueue() is then called to schedule TLS frames for encryption. In the case of sendfile_iodone() calls ktls_enqueue() instead of pru_ready() leaving the mbufs marked M_NOTREADY until encryption is completed. For other writes (vn_sendfile when pages are available, write(2), etc.), the PRUS_NOTREADY is set when invoking pru_send() along with invoking ktls_enqueue(). A pool of worker threads (the "KTLS" kernel process) encrypts TLS frames queued via ktls_enqueue(). Each TLS frame is temporarily mapped using the direct map and passed to a software encryption backend to perform the actual encryption. (Note: The use of PHYS_TO_DMAP could be replaced with sf_bufs if someone wished to make this work on architectures without a direct map.) KTLS supports pluggable software encryption backends. Internally, Netflix uses proprietary pure-software backends. This commit includes a simple backend in a new ktls_ocf.ko module that uses the kernel's OpenCrypto framework to provide AES-GCM encryption of TLS frames. As a result, software TLS is now a bit of a misnomer as it can make use of hardware crypto accelerators. Once software encryption has finished, the TLS frame mbufs are marked ready via pru_ready(). At this point, the encrypted data appears as regular payload to the TCP stack stored in unmapped mbufs. ifnet TLS permits a NIC to offload the TLS encryption and TCP segmentation. In this mode, a new send tag type (IF_SND_TAG_TYPE_TLS) is allocated on the interface a socket is routed over and associated with a TLS session. TLS records for a TLS session using ifnet TLS are not marked M_NOTREADY but are passed down the stack unencrypted. The ip_output_send() and ip6_output_send() helper functions that apply send tags to outbound IP packets verify that the send tag of the TLS record matches the outbound interface. If so, the packet is tagged with the TLS send tag and sent to the interface. The NIC device driver must recognize packets with the TLS send tag and schedule them for TLS encryption and TCP segmentation. If the the outbound interface does not match the interface in the TLS send tag, the packet is dropped. In addition, a task is scheduled to refresh the TLS send tag for the TLS session. If a new TLS send tag cannot be allocated, the connection is dropped. If a new TLS send tag is allocated, however, subsequent packets will be tagged with the correct TLS send tag. (This latter case has been tested by configuring both ports of a Chelsio T6 in a lagg and failing over from one port to another. As the connections migrated to the new port, new TLS send tags were allocated for the new port and connections resumed without being dropped.) ifnet TLS can be enabled and disabled on supported network interfaces via new '[-]txtls[46]' options to ifconfig(8). ifnet TLS is supported across both vlan devices and lagg interfaces using failover, lacp with flowid enabled, or lacp with flowid enabled. Applications may request the current KTLS mode of a connection via a new TCP_TXTLS_MODE socket option. They can also use this socket option to toggle between software and ifnet TLS modes. In addition, a testing tool is available in tools/tools/switch_tls. This is modeled on tcpdrop and uses similar syntax. However, instead of dropping connections, -s is used to force KTLS connections to switch to software TLS and -i is used to switch to ifnet TLS. Various sysctls and counters are available under the kern.ipc.tls sysctl node. The kern.ipc.tls.enable node must be set to true to enable KTLS (it is off by default). The use of unmapped mbufs must also be enabled via kern.ipc.mb_use_ext_pgs to enable KTLS. KTLS is enabled via the KERN_TLS kernel option. This patch is the culmination of years of work by several folks including Scott Long and Randall Stewart for the original design and implementation; Drew Gallatin for several optimizations including the use of ext_pgs mbufs, the M_NOTREADY mechanism for TLS records awaiting software encryption, and pluggable software crypto backends; and John Baldwin for modifications to support hardware TLS offload. Reviewed by: gallatin, hselasky, rrs Obtained from: Netflix Sponsored by: Netflix, Chelsio Communications Differential Revision: https://reviews.freebsd.org/D21277
2019-08-27 00:01:56 +00:00
.It Cm txtls
Transmit TLS offload encrypts Transport Layer Security (TLS) records and
segments the encrypted record into one or more
.Xr tcp 4
segments over either
.Xr ip 4
or
.Xr ip6 4 .
If the driver supports transmit TLS offload,
enable transmit TLS offload on the interface.
Some drivers may not be able to support transmit TLS offload for
.Xr ip 4
and
.Xr ip6 4
packets, so they may enable only one of them.
.It Fl txtls
If the driver supports transmit TLS offload,
disable transmit TLS offload on the interface.
It will always disable TLS for
.Xr ip 4
and
.Xr ip6 4 .
Add an external mbuf buffer type that holds multiple unmapped pages. Unmapped mbufs allow sendfile to carry multiple pages of data in a single mbuf, without mapping those pages. It is a requirement for Netflix's in-kernel TLS, and provides a 5-10% CPU savings on heavy web serving workloads when used by sendfile, due to effectively compressing socket buffers by an order of magnitude, and hence reducing cache misses. For this new external mbuf buffer type (EXT_PGS), the ext_buf pointer now points to a struct mbuf_ext_pgs structure instead of a data buffer. This structure contains an array of physical addresses (this reduces cache misses compared to an earlier version that stored an array of vm_page_t pointers). It also stores additional fields needed for in-kernel TLS such as the TLS header and trailer data that are currently unused. To more easily detect these mbufs, the M_NOMAP flag is set in m_flags in addition to M_EXT. Various functions like m_copydata() have been updated to safely access packet contents (using uiomove_fromphys()), to make things like BPF safe. NIC drivers advertise support for unmapped mbufs on transmit via a new IFCAP_NOMAP capability. This capability can be toggled via the new 'nomap' and '-nomap' ifconfig(8) commands. For NIC drivers that only transmit packet contents via DMA and use bus_dma, adding the capability to if_capabilities and if_capenable should be all that is required. If a NIC does not support unmapped mbufs, they are converted to a chain of mapped mbufs (using sf_bufs to provide the mapping) in ip_output or ip6_output. If an unmapped mbuf requires software checksums, it is also converted to a chain of mapped mbufs before computing the checksum. Submitted by: gallatin (earlier version) Reviewed by: gallatin, hselasky, rrs Discussed with: ae, kp (firewalls) Relnotes: yes Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D20616
2019-06-29 00:48:33 +00:00
.It Cm nomap
If the driver supports unmapped network buffers,
enable them on the interface.
.It Fl nomap
If the driver supports unmapped network buffers,
disable them on the interface.
Wake On Lan (WOL) infrastructure Submitted by: Stefan Sperling <stsp@stsp.name> Reviewed by: brooks
2007-12-10 02:31:00 +00:00
.It Cm wol , wol_ucast , wol_mcast , wol_magic
Enable Wake On Lan (WOL) support, if available.
WOL is a facility whereby a machine in a low power state may be woken
in response to a received packet.
There are three types of packets that may wake a system:
ucast (directed solely to the machine's mac address),
mcast (directed to a broadcast or multicast address),
or
magic (unicast or multicast frames with a ``magic contents'').
Not all devices support WOL, those that do indicate the mechanisms
they support in their capabilities.
.Cm wol
is a synonym for enabling all available WOL mechanisms.
To disable WOL use
.Fl wol .
Add support for stacked VLANs (IEEE 802.1ad, AKA Q-in-Q). 802.1ad interfaces are created with ifconfig using the "vlanproto" parameter. Eg., the following creates a 802.1Q VLAN (id #42) over a 802.1ad S-VLAN (id #5) over a physical Ethernet interface (em0). ifconfig vlan5 create vlandev em0 vlan 5 vlanproto 802.1ad up ifconfig vlan42 create vlandev vlan5 vlan 42 inet 10.5.42.1/24 VLAN_MTU, VLAN_HWCSUM and VLAN_TSO capabilities should be properly supported. VLAN_HWTAGGING is only partially supported, as there is currently no IFCAP_VLAN_* denoting the possibility to set the VLAN EtherType to anything else than 0x8100 (802.1ad uses 0x88A8). Submitted by: Olivier Piras Sponsored by: RG Nets Differential Revision: https://reviews.freebsd.org/D26436
2020-10-21 21:28:20 +00:00
.It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
If the driver offers user-configurable VLAN support, enable
Add TSO support on VLAN in fconfig(8). Reviewed by: thompsa
2010-02-20 23:01:09 +00:00
reception of extended frames, tag processing in hardware,
Allow toggling of IFCAP_VLAN_HWCSUM for hardware that supports checksum offloading on vlans and document the new option. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2011-12-17 15:44:34 +00:00
frame filtering in hardware, checksum offloading, or TSO on VLAN,
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
respectively.
Add two new ifnet capabilities for hw checksumming and TSO for VXLAN traffic. These are similar to the existing VLAN capabilities. Reviewed by: kib@ Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D25873
2020-09-18 02:10:28 +00:00
Note that this must be configured on a physical interface associated with
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.Xr vlan 4 ,
not on a
.Xr vlan 4
interface itself.
Add support for stacked VLANs (IEEE 802.1ad, AKA Q-in-Q). 802.1ad interfaces are created with ifconfig using the "vlanproto" parameter. Eg., the following creates a 802.1Q VLAN (id #42) over a 802.1ad S-VLAN (id #5) over a physical Ethernet interface (em0). ifconfig vlan5 create vlandev em0 vlan 5 vlanproto 802.1ad up ifconfig vlan42 create vlandev vlan5 vlan 42 inet 10.5.42.1/24 VLAN_MTU, VLAN_HWCSUM and VLAN_TSO capabilities should be properly supported. VLAN_HWTAGGING is only partially supported, as there is currently no IFCAP_VLAN_* denoting the possibility to set the VLAN EtherType to anything else than 0x8100 (802.1ad uses 0x88A8). Submitted by: Olivier Piras Sponsored by: RG Nets Differential Revision: https://reviews.freebsd.org/D26436
2020-10-21 21:28:20 +00:00
.It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
If the driver offers user-configurable VLAN support, disable
Add TSO support on VLAN in fconfig(8). Reviewed by: thompsa
2010-02-20 23:01:09 +00:00
reception of extended frames, tag processing in hardware,
frame filtering in hardware, or TSO on VLAN,
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
respectively.
Add two new ifnet capabilities for hw checksumming and TSO for VXLAN traffic. These are similar to the existing VLAN capabilities. Reviewed by: kib@ Sponsored by: Chelsio Communications Differential Revision: https://reviews.freebsd.org/D25873
2020-09-18 02:10:28 +00:00
.It Cm vxlanhwcsum , vxlanhwtso
If the driver offers user-configurable VXLAN support, enable inner checksum
offloading (receive and transmit) or TSO on VXLAN, respectively.
Note that this must be configured on a physical interface associated with
.Xr vxlan 4 ,
not on a
.Xr vxlan 4
interface itself.
The physical interface is either the interface specified as the vxlandev
or the interface hosting the vxlanlocal address.
The driver will offload as much checksum work and TSO as it can reliably
support, the exact level of offloading may vary between drivers.
.It Fl vxlanhwcsum , vxlanhwtso
If the driver offers user-configurable VXLAN support, disable checksum
offloading (receive and transmit) or TSO on VXLAN, respectively.
Add the "vnet" and "-vnet" options, to allow moving interfaces between jails with VIMAGE. Approved by: bz (mentor)
2009-06-24 18:21:37 +00:00
.It Cm vnet Ar jail
Move the interface to the
.Xr jail 8 ,
specified by name or JID.
If the jail has a virtual network stack, the interface will disappear
from the current environment and become visible to the jail.
.It Fl vnet Ar jail
Reclaim the interface from the
.Xr jail 8 ,
specified by name or JID.
If the jail has a virtual network stack, the interface will disappear
from the jail, and become visible to the current network environment.
Added the new interface capability option for drivers that implement user-configurable polling(4) support. Make ifconfig(8) aware of it. Suggested by: luigi
2004-04-11 13:36:52 +00:00
.It Cm polling
Now ifconfig is the one right way to turn polling on. Thus, remove the "if" clauses.
2005-10-01 19:14:34 +00:00
Turn on
Added the new interface capability option for drivers that implement user-configurable polling(4) support. Make ifconfig(8) aware of it. Suggested by: luigi
2004-04-11 13:36:52 +00:00
.Xr polling 4
Now ifconfig is the one right way to turn polling on. Thus, remove the "if" clauses.
2005-10-01 19:14:34 +00:00
feature and disable interrupts on the interface, if driver supports
this mode.
Added the new interface capability option for drivers that implement user-configurable polling(4) support. Make ifconfig(8) aware of it. Suggested by: luigi
2004-04-11 13:36:52 +00:00
.It Fl polling
Now ifconfig is the one right way to turn polling on. Thus, remove the "if" clauses.
2005-10-01 19:14:34 +00:00
Turn off
Added the new interface capability option for drivers that implement user-configurable polling(4) support. Make ifconfig(8) aware of it. Suggested by: luigi
2004-04-11 13:36:52 +00:00
.Xr polling 4
Now ifconfig is the one right way to turn polling on. Thus, remove the "if" clauses.
2005-10-01 19:14:34 +00:00
feature and enable interrupt mode on the interface.
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.It Cm create
Create the specified network pseudo-device.
If the interface is given without a unit number, try to create a new
device with an arbitrary unit number.
Spelling police: sucessful -> successful. Submitted by: Anders Andersson <anders@codefactory.se>
2001-11-24 23:38:17 +00:00
If creation of an arbitrary device is successful, the new device name is
Add ifconfig support for network interface renaming. In the process, reorganize the printing of the interface name when using wildcard cloning so it is not printed if it we either immediately rename or destroy the interface. Reviewed by: ru
2004-02-04 02:55:46 +00:00
printed to standard output unless the interface is renamed or destroyed
in the same
.Nm
invocation.
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.It Cm destroy
Destroy the specified network pseudo-device.
.It Cm plumb
Another name for the
``create'' and ``destroy'' are command modifiers (.Cm), not flags (.Fl).
2001-08-22 18:37:47 +00:00
.Cm create
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
parameter.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Included for
.Tn Solaris
compatibility.
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.It Cm unplumb
Another name for the
``create'' and ``destroy'' are command modifiers (.Cm), not flags (.Fl).
2001-08-22 18:37:47 +00:00
.Cm destroy
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
parameter.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Included for
.Tn Solaris
compatibility.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm metric Ar n
Set the routing metric of the interface to
.Ar n ,
default 0.
The routing metric is used by the routing protocol
.Pq Xr routed 8 .
Higher metrics have the effect of making a route
Correct some grammos.
2006-10-02 08:55:54 +00:00
less favorable; metrics are counted as additional hops
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
to the destination network or host.
Added support for setting the per-interface MTU.
1994-08-08 10:45:06 +00:00
.It Cm mtu Ar n
Set the maximum transmission unit of the interface to
.Ar n ,
default is interface specific.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
The MTU is used to limit the size of packets that are transmitted on an
Added support for setting the per-interface MTU.
1994-08-08 10:45:06 +00:00
interface.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Not all interfaces support setting the MTU, and some interfaces have
Added support for setting the per-interface MTU.
1994-08-08 10:45:06 +00:00
range restrictions.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm netmask Ar mask
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.\" (Inet and ISO.)
(Inet only.)
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
Specify how much of the address to reserve for subdividing
networks into sub-networks.
The mask includes the network part of the local address
and the subnet part, which is taken from the host field of the address.
The mask can be specified as a single hexadecimal number
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
with a leading
.Ql 0x ,
with a dot-notation Internet address,
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
or with a pseudo-network name listed in the network table
.Xr networks 5 .
The mask contains 1's for the bit positions in the 32-bit address
which are to be used for the network and subnet parts,
and 0's for the host part.
The mask should contain at least the standard network portion,
and the subnet field should be contiguous with the network
portion.
Let ifconfig(8) catch up with the new functionality where one can specify addresses and netmask in CIDR notation. Submitted by: Dima Dorfman <dima@unixfreak.org>
2001-05-05 19:53:20 +00:00
.Pp
The netmask can also be specified in CIDR notation after the address.
See the
.Ar address
option above for more information.
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
.It Cm prefixlen Ar len
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
(Inet6 only.)
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
Specify that
.Ar len
bits are reserved for subdividing networks into sub-networks.
The
.Ar len
must be integer, and for syntactical reason it must be between 0 to 128.
It is almost always 64 under the current IPv6 assignment rule.
Spelling.
2001-08-07 11:09:17 +00:00
If the parameter is omitted, 64 is used.
mdoc(7) police: Restore (sorta) a useful piece of information that got lost in the previous delta -- an ability to specify /prefixlength after an IPv6 address.
2002-01-09 15:10:31 +00:00
.Pp
The prefix can also be specified using the slash notation after the address.
See the
.Ar address
option above for more information.
Introduce ``add'' and ``remove'' as alternatives to ``alias'' and ``delete''. Improve compatibility with BSD/OS, and also more accurately reflect that IP aliases aren't really any different than the primary IP address on an interface. Reviewed by: dcs Approved by: jkh
2000-02-26 18:55:39 +00:00
.It Cm remove
mdoc(7) police: split punctuation characters + misc fixes.
2001-02-01 16:38:02 +00:00
Another name for the
.Fl alias
parameter.
Introduced for compatibility
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
with
.Bsx .
.Sm off
.It Cm link Op Cm 0 No - Cm 2
.Sm on
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
Enable special processing of the link level of the interface.
These three options are interface specific in actual effect, however,
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc.
2000-03-01 11:27:47 +00:00
they are in general used to select special modes of operation.
An example
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
of this is to enable SLIP compression, or to select the connector type
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
for some Ethernet cards.
Refer to the man page for the specific driver
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
for more information.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Sm off
.It Fl link Op Cm 0 No - Cm 2
.Sm on
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
Disable special processing at the link level with the specified interface.
Add the "Monitor" interface flag. Setting this flag on an ethernet interface blocks transmission of packets and discards incoming packets after BPF processing. This is useful if you want to monitor network trafic but not interact with the network in question. Sponsored by: http://www.babeltech.dk
2002-09-27 18:57:47 +00:00
.It Cm monitor
Put the interface in monitor mode.
mdoc(7) police: markup, spelling. Also fixed a critical bug made in revision 1.62 by phk@.
2002-11-25 16:01:28 +00:00
No packets are transmitted, and received packets are discarded after
Add the "Monitor" interface flag. Setting this flag on an ethernet interface blocks transmission of packets and discards incoming packets after BPF processing. This is useful if you want to monitor network trafic but not interact with the network in question. Sponsored by: http://www.babeltech.dk
2002-09-27 18:57:47 +00:00
.Xr bpf 4
processing.
.It Fl monitor
Take the interface out of monitor mode.
finish the pcp feature, but documenting it in the man page...
2019-08-15 16:58:00 +00:00
.It Cm pcp Ar priority_code_point
Priority code point
.Pq Dv PCP
is an 3-bit field which refers to the IEEE 802.1p
class of service and maps to the frame priority level.
.It Fl pcp
Stop tagging packets on the interface w/ the priority code point.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.It Cm up
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
Mark an interface
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Dq up .
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
This may be used to enable an interface after an
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Dq Nm Cm down .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
It happens automatically when setting the first address on an interface.
If the interface was reset when previously marked down,
the hardware will be re-initialized.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.El
.Pp
Fix typos and spelling mistakes.
2010-08-06 14:33:42 +00:00
The following parameters are for ICMPv6 Neighbor Discovery Protocol.
Fix several logic bugs in the previous IPv6 variable change and re-add $ipv6_enable support for backward compatibility. From UPDATING: 1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF for IPv4. For aliases, $ifconfig_IF_aliasN should be used. Note that both variables need the "inet6" keyword at the head. Do not set $ipv6_network_interfaces manually if you do not understand what you are doing. It is not needed in most cases. $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but they are obsolete. 2. $ipv6_enable is obsolete. Use $ipv6_prefer and/or "inet6 accept_rtadv" keyword in ifconfig(8) instead. If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and all configured interfaces have "inet6 accept_rtadv" in the $ifconfig_IF_ipv6. These are for backward compatibility. 3. A new variable $ipv6_prefer has been added. If NO, IPv6 functionality of interfaces with no corresponding $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag, and the default address selection policy of ip6addrctl(8) is the IPv4-preferred one (see rc.d/ip6addrctl for more details). Note that if you want to configure IPv6 functionality on the disabled interfaces after boot, first you need to clear the flag by using ifconfig(8) like: ifconfig em0 inet6 -ifdisabled If YES, the default address selection policy is set as IPv6-preferred. The default value of $ipv6_prefer is NO. 4. If your system need to receive Router Advertisement messages, define "inet6 accept_rtadv" in $ifconfig_IF_ipv6. The rc(8) scripts automatically invoke rtsol(8) when the interface becomes UP. The Router Advertisement messages are used for SLAAC (State-Less Address AutoConfiguration).
2009-09-26 18:59:00 +00:00
Note that the address family keyword
.Dq Li inet6
is needed for them:
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.Bl -tag -width indent
.It Cm accept_rtadv
Set a flag to enable accepting ICMPv6 Router Advertisement messages.
- Document inet6 no_radr flag. - Add descriptions of sysctl(8) variables which can control the default configuration of the inet6 flags. Approved by: re (kib)
2011-09-19 16:01:53 +00:00
The
.Xr sysctl 8
variable
.Va net.inet6.ip6.accept_rtadv
controls whether this flag is set by default or not.
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.It Cm -accept_rtadv
Clear a flag
.Cm accept_rtadv .
- Document inet6 no_radr flag. - Add descriptions of sysctl(8) variables which can control the default configuration of the inet6 flags. Approved by: re (kib)
2011-09-19 16:01:53 +00:00
.It Cm no_radr
Set a flag to control whether routers from which the system accepts
Router Advertisement messages will be added to the Default Router List
or not.
When the
.Cm accept_rtadv
flag is disabled, this flag has no effect.
The
.Xr sysctl 8
variable
.Va net.inet6.ip6.no_radr
controls whether this flag is set by default or not.
.It Cm -no_radr
Clear a flag
.Cm no_radr .
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.It Cm auto_linklocal
Set a flag to perform automatic link-local address configuration when
Spelling fixes.
2010-07-31 21:09:49 +00:00
the interface becomes available.
- Document inet6 no_radr flag. - Add descriptions of sysctl(8) variables which can control the default configuration of the inet6 flags. Approved by: re (kib)
2011-09-19 16:01:53 +00:00
The
.Xr sysctl 8
variable
.Va net.inet6.ip6.auto_linklocal
controls whether this flag is set by default or not.
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.It Cm -auto_linklocal
Clear a flag
.Cm auto_linklocal .
.It Cm defaultif
Set the specified interface as the default route when there is no
default router.
.It Cm -defaultif
Clear a flag
.Cm defaultif .
.It Cm ifdisabled
Set a flag to disable all of IPv6 network communications on the
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
specified interface.
Note that if there are already configured IPv6
Fix several logic bugs in the previous IPv6 variable change and re-add $ipv6_enable support for backward compatibility. From UPDATING: 1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF for IPv4. For aliases, $ifconfig_IF_aliasN should be used. Note that both variables need the "inet6" keyword at the head. Do not set $ipv6_network_interfaces manually if you do not understand what you are doing. It is not needed in most cases. $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but they are obsolete. 2. $ipv6_enable is obsolete. Use $ipv6_prefer and/or "inet6 accept_rtadv" keyword in ifconfig(8) instead. If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and all configured interfaces have "inet6 accept_rtadv" in the $ifconfig_IF_ipv6. These are for backward compatibility. 3. A new variable $ipv6_prefer has been added. If NO, IPv6 functionality of interfaces with no corresponding $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag, and the default address selection policy of ip6addrctl(8) is the IPv4-preferred one (see rc.d/ip6addrctl for more details). Note that if you want to configure IPv6 functionality on the disabled interfaces after boot, first you need to clear the flag by using ifconfig(8) like: ifconfig em0 inet6 -ifdisabled If YES, the default address selection policy is set as IPv6-preferred. The default value of $ipv6_prefer is NO. 4. If your system need to receive Router Advertisement messages, define "inet6 accept_rtadv" in $ifconfig_IF_ipv6. The rc(8) scripts automatically invoke rtsol(8) when the interface becomes UP. The Router Advertisement messages are used for SLAAC (State-Less Address AutoConfiguration).
2009-09-26 18:59:00 +00:00
addresses on that interface, all of them are marked as
.Dq tentative
and DAD will be performed when this flag is cleared.
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.It Cm -ifdisabled
Clear a flag
.Cm ifdisabled .
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
When this flag is cleared and
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.Cm auto_linklocal
flag is enabled, automatic configuration of a link-local address is
performed.
.It Cm nud
Set a flag to enable Neighbor Unreachability Detection.
.It Cm -nud
Clear a flag
.Cm nud .
Add no_prefer_iface option. It stops treating the address on the interface as special by source address selection rule even when the interface is outgoing interface. This is desired in some situation. Requested by: hrs Reviewed by: IHANet folks including hrs MFC after: 1 week
2013-01-09 18:18:08 +00:00
.It Cm no_prefer_iface
Virtualize lagg(4) cloner. This change fixes a panic when tearing down if_lagg(4) interfaces which were cloned in a vnet jail. Sysctl nodes which are dynamically generated for each cloned interface (net.link.lagg.N.*) have been removed, and use_flowid and flowid_shift ifconfig(8) parameters have been added instead. Flags and per-interface statistics counters are displayed in "ifconfig -v". CR: D842
2014-10-01 21:37:32 +00:00
Set a flag to not honor rule 5 of source address selection in RFC 3484.
Make the description of the "no_prefer_iface" flag easier to understand. Reviewed by: Silence on -net@ and from ume@
2014-07-12 10:18:33 +00:00
In practice this means the address on the outgoing interface will not be
preferred, effectively yielding the decision to the address selection
policy table, configurable with
.Xr ip6addrctl 8 .
Add no_prefer_iface option. It stops treating the address on the interface as special by source address selection rule even when the interface is outgoing interface. This is desired in some situation. Requested by: hrs Reviewed by: IHANet folks including hrs MFC after: 1 week
2013-01-09 18:18:08 +00:00
.It Cm -no_prefer_iface
Clear a flag
.Cm no_prefer_iface .
- Implement loopback probing state in enhanced DAD algorithm. - Add no_dad and ignoreloop per-IF knob. no_dad disables DAD completely, and ignoreloop is to prevent infinite loop in loopback probing state when loopback is permanently expected.
2015-03-05 21:27:49 +00:00
.It Cm no_dad
Set a flag to disable Duplicate Address Detection.
.It Cm -no_dad
Clear a flag
.Cm no_dad .
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
.El
.Pp
Add the ability to set `prefer_source' flag to an IPv6 address. It affects the IPv6 source address selection algorithm (RFC 6724) and allows override the last rule ("longest matching prefix") for choosing among equivalent addresses. The address with `prefer_source' will be preferred source address. Obtained from: Yandex LLC MFC after: 1 month Sponsored by: Yandex LLC
2014-09-09 10:52:50 +00:00
The following parameters are specific for IPv6 addresses.
Note that the address family keyword
.Dq Li inet6
is needed for them:
.Bl -tag -width indent
Fix description for the "autoconf" ifconfig(8) flag; it's an address property, not something you set for an interface. MFC after: 2 weeks
2018-06-27 19:28:37 +00:00
.It Cm autoconf
Set the IPv6 autoconfigured address bit.
.It Fl autoconf
Clear the IPv6 autoconfigured address bit.
Add Documentation for missing ifconfig(8) flags autoconf / -autoconf deprecated / -deprecated pltime vltime PR: 209822 Submitted by: Sevan Janiyan <venture37@geeklan.co.uk> MFC after: 2 weeks
2016-05-29 03:44:37 +00:00
.It Cm deprecated
Set the IPv6 deprecated address bit.
.It Fl deprecated
Clear the IPv6 deprecated address bit.
.It Cm pltime Ar n
Set preferred lifetime for the address.
Add the ability to set `prefer_source' flag to an IPv6 address. It affects the IPv6 source address selection algorithm (RFC 6724) and allows override the last rule ("longest matching prefix") for choosing among equivalent addresses. The address with `prefer_source' will be preferred source address. Obtained from: Yandex LLC MFC after: 1 month Sponsored by: Yandex LLC
2014-09-09 10:52:50 +00:00
.It Cm prefer_source
Set a flag to prefer address as a candidate of the source address for
outgoing packets.
.It Cm -prefer_source
Clear a flag
.Cm prefer_source .
Add Documentation for missing ifconfig(8) flags autoconf / -autoconf deprecated / -deprecated pltime vltime PR: 209822 Submitted by: Sevan Janiyan <venture37@geeklan.co.uk> MFC after: 2 weeks
2016-05-29 03:44:37 +00:00
.It Cm vltime Ar n
Set valid lifetime for the address.
Add the ability to set `prefer_source' flag to an IPv6 address. It affects the IPv6 source address selection algorithm (RFC 6724) and allows override the last rule ("longest matching prefix") for choosing among equivalent addresses. The address with `prefer_source' will be preferred source address. Obtained from: Yandex LLC MFC after: 1 month Sponsored by: Yandex LLC
2014-09-09 10:52:50 +00:00
.El
.Pp
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
The following parameters are specific to cloning
IEEE 802.11 wireless interfaces with the
.Cm create
request:
.Bl -tag -width indent
.It Cm wlandev Ar device
Use
.Ar device
as the parent for the cloned device.
.It Cm wlanmode Ar mode
Specify the operating mode for this cloned device.
.Ar mode
is one of
.Cm sta ,
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm ahdemo
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
(or
The .Cm macro usage fixed. PR: 217977 Submitted by: tobik
2017-03-21 13:01:08 +00:00
.Cm adhoc-demo ) ,
ifconfig.8: Remove spurious commas Correct misuse of commas/parentheses in an enumeration that makes the number of actual parameters more important than expected. PR: 250526 Submitted by: Samy Mahmoudi <samy.mahmoudi__gmail_com> MFC after: 1 week
2020-10-25 15:01:01 +00:00
.Cm ibss
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
(or
The .Cm macro usage fixed. PR: 217977 Submitted by: tobik
2017-03-21 13:01:08 +00:00
.Cm adhoc ) ,
ifconfig.8: Remove spurious commas Correct misuse of commas/parentheses in an enumeration that makes the number of actual parameters more important than expected. PR: 250526 Submitted by: Samy Mahmoudi <samy.mahmoudi__gmail_com> MFC after: 1 week
2020-10-25 15:01:01 +00:00
.Cm ap
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
(or
The .Cm macro usage fixed. PR: 217977 Submitted by: tobik
2017-03-21 13:01:08 +00:00
.Cm hostap ) ,
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Cm wds ,
TDMA support for long distance point-to-point links using ath devices: o add net80211 support for a tdma vap that is built on top of the existing adhoc-demo support o add tdma scheduling of frame transmission to the ath driver; it's conceivable other devices might be capable of this too in which case they can make use of the 802.11 protocol additions etc. o add minor bits to user tools that need to know: ifconfig to setup and configure, new statistics in athstats, and new debug mask bits While the architecture can support >2 slots in a TDMA BSS the current design is intended (and tested) for only 2 slots. Sponsored by: Intel
2009-01-08 17:12:47 +00:00
.Cm tdma ,
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
.Cm mesh ,
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
and
.Cm monitor .
The operating mode of a cloned interface cannot be changed.
TDMA support for long distance point-to-point links using ath devices: o add net80211 support for a tdma vap that is built on top of the existing adhoc-demo support o add tdma scheduling of frame transmission to the ath driver; it's conceivable other devices might be capable of this too in which case they can make use of the 802.11 protocol additions etc. o add minor bits to user tools that need to know: ifconfig to setup and configure, new statistics in athstats, and new debug mask bits While the architecture can support >2 slots in a TDMA BSS the current design is intended (and tested) for only 2 slots. Sponsored by: Intel
2009-01-08 17:12:47 +00:00
The
.Cm tdma
mode is actually implemented as an
.Cm adhoc-demo
interface with special properties.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm wlanbssid Ar bssid
The 802.11 mac address to use for the bssid.
This must be specified at create time for a legacy
.Cm wds
device.
.It Cm wlanaddr Ar address
The local mac address.
If this is not specified then a mac address will automatically be assigned
to the cloned device.
Typically this address is the same as the address of the parent device
but if the
.Cm bssid
parameter is specified then the driver will craft a unique address for
the device (if supported).
.It Cm wdslegacy
Mark a
.Cm wds
device as operating in ``legacy mode''.
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
Legacy
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Cm wds
devices have a fixed peer relationship and do not, for example, roam
if their peer stops communicating.
For completeness a Dynamic WDS (DWDS) interface may marked as
.Fl wdslegacy .
.It Cm bssid
Request a unique local mac address for the cloned device.
This is only possible if the device supports multiple mac addresses.
To force use of the parent's mac address use
.Fl bssid .
.It Cm beacons
Mark the cloned interface as depending on hardware support to
track received beacons.
To have beacons tracked in software use
.Fl beacons .
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
For
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Cm hostap
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
mode
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Fl beacons
can also be used to indicate no beacons should
be transmitted; this can be useful when creating a WDS configuration but
.Cm wds
interfaces can only be created as companions to an access point.
.El
.Pp
The following parameters are specific to IEEE 802.11 wireless interfaces
cloned with a
.Cm create
operation:
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Bl -tag -width indent
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm ampdu
Enable sending and receiving AMPDU frames when using 802.11n (default).
The 802.11n specification states a compliant station must be capable
Spelling fixes.
2010-07-31 21:09:49 +00:00
of receiving AMPDU frames but transmission is optional.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Use
.Fl ampdu
to disable all use of AMPDU with 802.11n.
For testing and/or to work around interoperability problems one can use
.Cm ampdutx
and
.Cm ampdurx
to control use of AMPDU in one direction.
.It Cm ampdudensity Ar density
Set the AMPDU density parameter used when operating with 802.11n.
This parameter controls the inter-packet gap for AMPDU frames.
The sending device normally controls this setting but a receiving station
may request wider gaps.
Legal values for
.Ar density
are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
A value of
.Cm -
is treated the same as 0.
.It Cm ampdulimit Ar limit
Set the limit on packet size for receiving AMPDU frames when operating
with 802.11n.
Legal values for
.Ar limit
are 8192, 16384, 32768, and 65536 but one can also specify
just the unique prefix: 8, 16, 32, 64.
Note the sender may limit the size of AMPDU frames to be less
than the maximum specified by the receiving station.
.It Cm amsdu
Enable sending and receiving AMSDU frames when using 802.11n.
By default AMSDU is received but not transmitted.
Use
.Fl amsdu
to disable all use of AMSDU with 802.11n.
For testing and/or to work around interoperability problems one can use
.Cm amsdutx
and
.Cm amsdurx
to control use of AMSDU in one direction.
.It Cm amsdulimit Ar limit
Set the limit on packet size for sending and receiving AMSDU frames
when operating with 802.11n.
Legal values for
.Ar limit
are 7935 and 3839 (bytes).
Note the sender may limit the size of AMSDU frames to be less
than the maximum specified by the receiving station.
Note also that devices are not required to support the 7935 limit,
only 3839 is required by the specification and the larger value
may require more memory to be dedicated to support functionality
that is rarely used.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm apbridge
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
When operating as an access point, pass packets between
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
wireless clients directly (default).
To instead let them pass up through the
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
system and be forwarded using some other mechanism, use
.Fl apbridge .
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Disabling the internal bridging
is useful when traffic is to be processed with
packet filtering.
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm authmode Ar mode
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the desired authentication mode in infrastructure mode.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Not all adapters support all modes.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
The set of
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
valid modes is
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm none , open , shared
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
(shared key),
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm 8021x
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
(IEEE 802.1x),
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
and
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm wpa
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
(IEEE WPA/WPA2/802.11i).
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
The
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm 8021x
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
and
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm wpa
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
modes are only useful when using an authentication service
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
(a supplicant for client operation or an authenticator when
operating as an access point).
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
Modes are case insensitive.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.It Cm bgscan
Enable background scanning when operating as a station.
Background scanning is a technique whereby a station associated to
an access point will temporarily leave the channel to scan for
neighboring stations.
This allows a station to maintain a cache of nearby access points
minor wireless-related corrections MFC after: 1 week
2007-11-02 05:23:22 +00:00
so that roaming between access points can be done without
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
a lengthy scan operation.
Background scanning is done only when a station is not busy and
any outbound traffic will cancel a scan operation.
Background scanning should never cause packets to be lost though
there may be some small latency if outbound traffic interrupts a
scan operation.
By default background scanning is enabled if the device is capable.
To disable background scanning, use
.Fl bgscan .
Background scanning is controlled by the
.Cm bgscanidle
and
.Cm bgscanintvl
parameters.
Background scanning must be enabled for roaming; this is an artifact
of the current implementation and may not be required in the future.
.It Cm bgscanidle Ar idletime
Set the minimum time a station must be idle (not transmitting or
receiving frames) before a background scan is initiated.
The
.Ar idletime
parameter is specified in milliseconds.
By default a station must be idle at least 250 milliseconds before
a background scan is initiated.
The idle time may not be set to less than 100 milliseconds.
.It Cm bgscanintvl Ar interval
Set the interval at which background scanning is attempted.
The
.Ar interval
parameter is specified in seconds.
minor wireless-related corrections MFC after: 1 week
2007-11-02 05:23:22 +00:00
By default a background scan is considered every 300 seconds (5 minutes).
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
The
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.Ar interval
may not be set to less than 15 seconds.
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm bintval Ar interval
Set the interval at which beacon frames are sent when operating in
ad-hoc or ap mode.
The
.Ar interval
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
parameter is specified in TU's (1024 usecs).
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
By default beacon frames are transmitted every 100 TU's.
add beacon miss threshold control Submitted by: Henrik Brix Andersen <henrik@brixandersen.dk> MFC after: 2 weeks
2006-07-26 03:08:45 +00:00
.It Cm bmissthreshold Ar count
Set the number of consecutive missed beacons at which the station
Markup fixes.
2006-09-18 11:55:10 +00:00
will attempt to roam (i.e., search for a new access point).
add beacon miss threshold control Submitted by: Henrik Brix Andersen <henrik@brixandersen.dk> MFC after: 2 weeks
2006-07-26 03:08:45 +00:00
The
.Ar count
Markup fixes.
2006-09-18 11:55:10 +00:00
parameter must be in the range 1 to 255; though the
upper bound may be reduced according to device capabilities.
add beacon miss threshold control Submitted by: Henrik Brix Andersen <henrik@brixandersen.dk> MFC after: 2 weeks
2006-07-26 03:08:45 +00:00
The default threshold is 7 consecutive missed beacons; but
this may be overridden by the device driver.
Another name for the
.Cm bmissthreshold
parameter is
.Cm bmiss .
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm bssid Ar address
Specify the MAC address of the access point to use when operating
as a station in a BSS network.
This overrides any automatic selection done by the system.
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
To disable a previously selected access point, supply
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm any , none ,
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
or
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm -
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
for the address.
Correct some grammos.
2006-10-02 08:55:54 +00:00
This option is useful when more than one access point uses the same SSID.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Another name for the
.Cm bssid
parameter is
.Cm ap .
add control for packet bursting
2005-12-14 19:44:39 +00:00
.It Cm burst
Enable packet bursting.
Packet bursting is a transmission technique whereby the wireless
medium is acquired once to send multiple frames and the interframe
spacing is reduced.
This technique can significantly increase throughput by reducing
transmission overhead.
Packet bursting is supported by the 802.11e QoS specification
and some devices that do not support QoS may still be capable.
By default packet bursting is enabled if a device is capable
of doing it.
To disable packet bursting, use
.Fl burst .
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm chanlist Ar channels
Set the desired channels to use when scanning for access
points, neighbors in an IBSS network, or looking for unoccupied
channels when operating as an access point.
The set of channels is specified as a comma-separated list with
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
each element in the list representing either a single channel number or a range
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
of the form
.Dq Li a-b .
Channel numbers must be in the range 1 to 255 and be permissible
according to the operating characteristics of the device.
.It Cm channel Ar number
Set a single desired channel.
Channels range from 1 to 255, but the exact selection available
depends on the region your adaptor was manufactured for.
Setting
the channel to
correct description of how to clear a desired channel Pointed out by: Chris Buechler MFC after: 1 week
2008-07-30 16:22:52 +00:00
.Li any ,
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
or
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm -
correct description of how to clear a desired channel Pointed out by: Chris Buechler MFC after: 1 week
2008-07-30 16:22:52 +00:00
will clear any desired channel and, if the device is marked up,
force a scan for a channel to operate on.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Alternatively the frequency, in megahertz, may be specified
instead of the channel number.
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
.Pp
When there are several ways to use a channel the channel
number/frequency may be appended with attributes to clarify.
For example, if a device is capable of operating on channel 6
with 802.11n and 802.11g then one can specify that g-only use
should be used by specifying ``6:g''.
Similarly the channel width can be specified by appending it
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
These attributes can be combined as in: ``6:ht/40''.
Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while translating these manual pages. Minor corrections by me. Submitted by: Nobuyuki Koganemaru <n-kogane@syd.odn.ne.jp>
2010-08-16 15:18:30 +00:00
The full set of flags specified following a ``:'' are:
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
.Cm a
(802.11a),
.Cm b
(802.11b),
.Cm d
(Atheros Dynamic Turbo mode),
.Cm g
(802.11g),
.Cm h
or
.Cm n
(802.11n aka HT),
.Cm s
(Atheros Static Turbo mode),
and
.Cm t
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
(Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
The full set of channel widths following a '/' are:
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm 5
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
(5MHz aka quarter-rate channel),
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm 10
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
(10MHz aka half-rate channel),
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm 20
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
(20MHz mostly for use in specifying ht20),
and
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm 40
Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while translating these manual pages. Minor corrections by me. Submitted by: Nobuyuki Koganemaru <n-kogane@syd.odn.ne.jp>
2010-08-16 15:18:30 +00:00
(40MHz mostly for use in specifying ht40).
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
In addition,
a 40MHz HT channel specification may include the location
of the extension channel by appending ``+'' or ``-'' for above and below,
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
with the center channel at frequency 2437 and the extension channel above.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm country Ar name
Set the country code to use in calculating the regulatory constraints
for operation.
In particular the set of available channels, how the wireless device
will operation on the channels, and the maximum transmit power that
can be used on a channel are defined by this setting.
Country/Region codes are specified as a 2-character abbreviation
defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
e.g., "ES" and "Spain".
mdoc sweep
2013-05-13 18:13:50 +00:00
The set of country codes are taken from
.Pa /etc/regdomain.xml
and can also
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
be viewed with the ``list countries'' request.
Note that not all devices support changing the country code from a default
setting; typically stored in EEPROM.
See also
.Cm regdomain ,
.Cm indoor ,
.Cm outdoor ,
and
.Cm anywhere .
.It Cm dfs
Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
DFS embodies several facilities including detection of overlapping
radar signals, dynamic transmit power control, and channel selection
according to a least-congested criteria.
Correct capitalization of "Hz" in user-visible text (manpages, printf(), etc). MFC after: 3 days
2012-02-28 13:19:34 +00:00
DFS support is mandatory for some 5GHz frequencies in certain
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
locales (e.g., ETSI).
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
By default DFS is enabled according to the regulatory definitions
mdoc sweep
2013-05-13 18:13:50 +00:00
specified in
.Pa /etc/regdomain.xml
and the current country code, regdomain,
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
and channel.
Note the underlying device (and driver) must support radar detection
for full DFS support to work.
To be fully compliant with the local regulatory agency frequencies that
require DFS should not be used unless it is fully supported.
Use
.Fl dfs
to disable this functionality for testing.
.It Cm dotd
Enable support for the 802.11d specification (default).
When this support is enabled in station mode, beacon frames that advertise
a country code different than the currently configured country code will
cause an event to be dispatched to user applications.
This event can be used by the station to adopt that country code and
operate according to the associated regulatory constraints.
When operating as an access point with 802.11d enabled the beacon and
probe response frames transmitted will advertise the current regulatory
domain settings.
To disable 802.11d use
.Fl dotd .
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.It Cm doth
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Enable 802.11h support including spectrum management.
When 802.11h is enabled beacon and probe response frames will have
the SpectrumMgt bit set in the capabilities field and
country and power constraint information elements will be present.
802.11h support also includes handling Channel Switch Announcements (CSA)
which are a mechanism to coordinate channel changes by an access point.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
By default 802.11h is enabled if the device is capable.
To disable 802.11h use
.Fl doth .
document deftxkey
2005-12-26 18:15:09 +00:00
.It Cm deftxkey Ar index
Set the default key to use for transmission.
Typically this is only set when using WEP encryption.
explain that you must set a default transmit key for WEP Submitted by: Jeremie Le Hen <jeremie@le-hen.org> MFC after: 1 week
2008-02-29 20:42:17 +00:00
Note that you must set a default transmit key
for the system to know which key to use in encrypting outbound traffic.
document deftxkey
2005-12-26 18:15:09 +00:00
The
.Cm weptxkey
is an alias for this request; it is provided for backwards compatibility.
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm dtimperiod Ar period
Set the
DTIM
period for transmitting buffered multicast data frames when
operating in ap mode.
The
.Ar period
specifies the number of beacon intervals between DTIM
and must be in the range 1 to 15.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
By default DTIM is 1 (i.e., DTIM occurs at each beacon).
Add documentation for the new quiet time IE options. Submitted by: Himali Patel <himali.patel@sibridgetech.com> Sponsored by: Sibridge Technologies
2011-11-12 23:17:01 +00:00
.It Cm quiet
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
Enable the use of quiet IE.
Hostap will use this to silence other
Add documentation for the new quiet time IE options. Submitted by: Himali Patel <himali.patel@sibridgetech.com> Sponsored by: Sibridge Technologies
2011-11-12 23:17:01 +00:00
stations to reduce interference for radar detection when
Correct capitalization of "Hz" in user-visible text (manpages, printf(), etc). MFC after: 3 days
2012-02-28 13:19:34 +00:00
operating on 5GHz frequency and doth support is enabled.
Add documentation for the new quiet time IE options. Submitted by: Himali Patel <himali.patel@sibridgetech.com> Sponsored by: Sibridge Technologies
2011-11-12 23:17:01 +00:00
Use
.Fl quiet
to disable this functionality.
.It Cm quiet_period Ar period
Set the QUIET
.Ar period
to the number of beacon intervals between the start of regularly
scheduled quiet intervals defined by Quiet element.
.It Cm quiet_count Ar count
Set the QUIET
.Ar count
to the number of TBTTs until the beacon interval during which the
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
next quiet interval shall start.
A value of 1 indicates the quiet
Add documentation for the new quiet time IE options. Submitted by: Himali Patel <himali.patel@sibridgetech.com> Sponsored by: Sibridge Technologies
2011-11-12 23:17:01 +00:00
interval will start during the beacon interval starting at the next
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
TBTT.
A value 0 is reserved.
Add documentation for the new quiet time IE options. Submitted by: Himali Patel <himali.patel@sibridgetech.com> Sponsored by: Sibridge Technologies
2011-11-12 23:17:01 +00:00
.It Cm quiet_offset Ar offset
Set the QUIET
.Ar offset
to the offset of the start of the quiet interval from the TBTT
specified by the Quiet count, expressed in TUs.
The value of the
.Ar offset
shall be less than one beacon interval.
.It Cm quiet_duration Ar dur
Set the QUIET
.Ar dur
to the duration of the Quiet interval, expressed in TUs.
The value should be less than beacon interval.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.It Cm dturbo
Enable the use of Atheros Dynamic Turbo mode when communicating with
another Dynamic Turbo-capable station.
Dynamic Turbo mode is an Atheros-specific mechanism by which
stations switch between normal 802.11 operation and a ``boosted''
mode in which a 40MHz wide channel is used for communication.
Stations using Dynamic Turbo mode operate boosted only when the
channel is free of non-dturbo stations; when a non-dturbo station
is identified on the channel all stations will automatically drop
back to normal operation.
By default, Dynamic Turbo mode is not enabled, even if the device is capable.
Note that turbo mode (dynamic or static) is only allowed on some
channels depending on the regulatory constraints; use the
.Cm list chan
command to identify the channels where turbo mode may be used.
To disable Dynamic Turbo mode use
.Fl dturbo .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm dwds
Enable Dynamic WDS (DWDS) support.
DWDS is a facility by which 4-address traffic can be carried between
stations operating in infrastructure mode.
A station first associates to an access point and authenticates using
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
normal procedures (e.g., WPA).
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Then 4-address frames are passed to carry traffic for stations
operating on either side of the wireless link.
DWDS extends the normal WDS mechanism by leveraging existing security
protocols and eliminating static binding.
.Pp
When DWDS is enabled on an access point 4-address frames received from
an authorized station will generate a ``DWDS discovery'' event to user
applications.
This event should be used to create a WDS interface that is bound
to the remote station (and usually plumbed into a bridge).
Once the WDS interface is up and running 4-address traffic then logically
flows through that interface.
.Pp
When DWDS is enabled on a station, traffic with a destination address
different from the peer station are encapsulated in a 4-address frame
and transmitted to the peer.
All 4-address traffic uses the security information of the stations
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
(e.g., cryptographic keys).
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
A station is associated using 802.11n facilities may transport
4-address traffic using these same mechanisms; this depends on available
resources and capabilities of the device.
The DWDS implementation guards against layer 2 routing loops of
multicast traffic.
.It Cm ff
Enable the use of Atheros Fast Frames when communicating with
another Fast Frames-capable station.
Fast Frames are an encapsulation technique by which two 802.3
frames are transmitted in a single 802.11 frame.
This can noticeably improve throughput but requires that the
receiving station understand how to decapsulate the frame.
Fast frame use is negotiated using the Atheros 802.11 vendor-specific
protocol extension so enabling use is safe when communicating with
non-Atheros devices.
By default, use of fast frames is enabled if the device is capable.
To explicitly disable fast frames, use
.Fl ff .
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm fragthreshold Ar length
Set the threshold for which transmitted frames are broken into fragments.
The
.Ar length
argument is the frame size in bytes and must be in the range 256 to 2346.
Setting
.Ar length
to
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Li 2346 ,
.Cm any ,
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
or
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm -
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
disables transmit fragmentation.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Not all adapters honor the fragmentation threshold.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm hidessid
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
When operating as an access point, do not broadcast the SSID
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
in beacon frames or respond to probe request frames unless
-mdoc sweep.
2005-11-18 10:36:29 +00:00
they are directed to the ap (i.e., they include the ap's SSID).
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
By default, the SSID is included in beacon frames and
undirected probe request frames are answered.
To re-enable the broadcast of the SSID etc., use
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Fl hidessid .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm ht
Enable use of High Throughput (HT) when using 802.11n (default).
The 802.11n specification includes mechanisms for operation
on 20MHz and 40MHz wide channels using different signalling mechanisms
than specified in 802.11b, 802.11g, and 802.11a.
Stations negotiate use of these facilities, termed HT20 and HT40,
when they associate.
To disable all use of 802.11n use
.Fl ht .
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
To disable use of HT20 (e.g., to force only HT40 use) use
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Fl ht20 .
To disable use of HT40 use
.Fl ht40 .
.Pp
HT configuration is used to ``auto promote'' operation
when several choices are available.
For example, if a station associates to an 11n-capable access point
it controls whether the station uses legacy operation, HT20, or HT40.
When an 11n-capable device is setup as an access point and
Auto Channel Selection is used to locate a channel to operate on,
HT configuration controls whether legacy, HT20, or HT40 operation is setup
on the selected channel.
If a fixed channel is specified for a station then HT configuration can
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
be given as part of the channel specification; e.g., 6:ht/20 to setup
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
HT20 operation on channel 6.
.It Cm htcompat
Enable use of compatibility support for pre-802.11n devices (default).
The 802.11n protocol specification went through several incompatible iterations.
Some vendors implemented 11n support to older specifications that
will not interoperate with a purely 11n-compliant station.
In particular the information elements included in management frames
for old devices are different.
When compatibility support is enabled both standard and compatible data
will be provided.
Fix typos. Obtained from: DragonFlyBSD
2010-04-28 10:57:27 +00:00
Stations that associate using the compatibility mechanisms are flagged
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
in ``list sta''.
Fix typos. Obtained from: DragonFlyBSD
2010-04-28 10:57:27 +00:00
To disable compatibility support use
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Fl htcompat .
.It Cm htprotmode Ar technique
For interfaces operating in 802.11n, use the specified
.Ar technique
for protecting HT frames in a mixed legacy/HT network.
The set of valid techniques is
.Cm off ,
and
.Cm rts
(RTS/CTS, default).
Technique names are case insensitive.
.It Cm inact
Enable inactivity processing for stations associated to an
access point (default).
When operating as an access point the 802.11 layer monitors
the activity of each associated station.
When a station is inactive for 5 minutes it will send several
``probe frames'' to see if the station is still present.
If no response is received then the station is deauthenticated.
Applications that prefer to handle this work can disable this
facility by using
.Fl inact .
.It Cm indoor
Set the location to use in calculating regulatory constraints.
The location is also advertised in beacon and probe response frames
when 802.11d is enabled with
.Cm dotd .
See also
.Cm outdoor ,
.Cm anywhere ,
.Cm country ,
and
.Cm regdomain .
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list active
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Display the list of channels available for use taking into account
any restrictions set with the
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm chanlist
explain what list chan displays MFC after: 1 week
2006-02-27 19:57:07 +00:00
directive.
See the description of
.Cm list chan
for more information.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list caps
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Display the adaptor's capabilities, including the operating
modes supported.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list chan
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Display the list of channels available for use.
explain what list chan displays MFC after: 1 week
2006-02-27 19:57:07 +00:00
Channels are shown with their IEEE channel number, equivalent
frequency, and usage modes.
Channels identified as
.Ql 11g
are also usable in
.Ql 11b
mode.
Channels identified as
.Ql 11a Turbo
may be used only for Atheros' Static Turbo mode
Markup fixes.
2006-09-18 11:55:10 +00:00
(specified with
. Cm mediaopt turbo ) .
explain what list chan displays MFC after: 1 week
2006-02-27 19:57:07 +00:00
Channels marked with a
.Ql *
have a regulatory constraint that they be passively scanned.
This means a station is not permitted to transmit on the channel until
it identifies the channel is being used for 802.11 communication;
typically by hearing a beacon frame from an access point operating
on the channel.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm list freq
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
is another way of requesting this information.
minor wireless-related corrections MFC after: 1 week
2007-11-02 05:23:22 +00:00
By default a compacted list of channels is displayed; if the
.Fl v
option is specified then all channels are shown.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm list countries
Display the set of country codes and regulatory domains that can be
used in regulatory configuration.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list mac
add list mac and mac:kick support Submitted by: Michal Mertl (original version) MFC after: 2 weeks
2005-08-13 17:38:09 +00:00
Display the current MAC Access Control List state.
Each address is prefixed with a character that indicates the
current policy applied to it:
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Ql +
add list mac and mac:kick support Submitted by: Michal Mertl (original version) MFC after: 2 weeks
2005-08-13 17:38:09 +00:00
indicates the address is allowed access,
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Ql -
add list mac and mac:kick support Submitted by: Michal Mertl (original version) MFC after: 2 weeks
2005-08-13 17:38:09 +00:00
indicates the address is denied access,
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Ql *
add list mac and mac:kick support Submitted by: Michal Mertl (original version) MFC after: 2 weeks
2005-08-13 17:38:09 +00:00
indicates the address is present but the current policy open
-mdoc sweep.
2005-11-18 10:36:29 +00:00
(so the ACL is not consulted).
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
.It Cm list mesh
Displays the mesh routing table, used for forwarding packets on a mesh
network.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm list regdomain
Display the current regulatory settings including the available channels
and transmit power caps.
.It Cm list roam
Display the parameters that govern roaming operation.
.It Cm list txparam
Display the parameters that govern transmit operation.
.It Cm list txpower
Display the transmit power caps for each channel.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list scan
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Display the access points and/or ad-hoc neighbors
located in the vicinity.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
This information may be updated automatically by the adapter
with a
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm scan
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
request or through background scanning.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Depending on the capabilities of the stations the following
flags can be included in the output:
.Bl -tag -width 3n
.It Li A
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
Channel agility.
.It Li B
PBCC modulation.
.It Li C
Poll request capability.
.It Li D
DSSS/OFDM capability.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Li E
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
Extended Service Set (ESS).
.It Li I
Independent Basic Service Set (IBSS).
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Li P
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
Privacy capability.
The station requires authentication.
.It Li R
Robust Secure Network (RSN).
Document the 'short preamble' capability for 802.11bg. Reviewed by: sam MFC after: 4 days
2010-05-14 15:06:12 +00:00
.It Li S
Short Preamble.
Indicates that the station is doing short preamble to optionally
improve throughput performance with 802.11g and 802.11b.
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
.It Li c
Pollable capability.
.It Li s
Short slot time capability.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.El
.Pp
By default interesting information elements captured from the neighboring
stations are displayed at the end of each row.
Possible elements include:
.Cm WME
(station supports WME),
.Cm WPA
(station supports WPA),
recognize WPS ie's Submitted by: "Chuck Tuffli" <chuck@tuffli.net> MFC after: 1 week
2008-08-09 05:37:22 +00:00
.Cm WPS
(station supports WPS),
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Cm RSN
(station supports 802.11i/RSN),
.Cm HTCAP
(station supports 802.11n/HT communication),
.Cm ATH
o Typo fixes. PR: docs/127866 Submitted by: Marius Korsmo
2008-10-05 05:12:48 +00:00
(station supports Atheros protocol extensions),
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Cm VEN
(station supports unknown vendor-specific extensions).
If the
.Fl v
flag is used all the information elements and their
contents will be shown.
Tiny wording nits. MFC after: 1 week
2008-10-19 09:45:29 +00:00
Specifying the
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.Fl v
flag also enables display of long SSIDs.
Tiny wording nits. MFC after: 1 week
2008-10-19 09:45:29 +00:00
The
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm list ap
Tiny wording nits. MFC after: 1 week
2008-10-19 09:45:29 +00:00
command is another way of requesting this information.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list sta
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
When operating as an access point display the stations that are
currently associated.
When operating in ad-hoc mode display stations identified as
neighbors in the IBSS.
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
When operating in mesh mode display stations identified as
neighbors in the MBSS.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
When operating in station mode display the access point.
remove display of the ERP ie from the list sta output (it's always zero); replace it with station capabilities MFC after: 1 month
2006-06-23 17:22:03 +00:00
Capabilities advertised by the stations are described under
the
.Cm scan
request.
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
The following flags can be included in the output:
remove display of the ERP ie from the list sta output (it's always zero); replace it with station capabilities MFC after: 1 month
2006-06-23 17:22:03 +00:00
.Bl -tag -width 3n
.It Li A
Authorized.
Indicates that the station is permitted to send/receive data frames.
.It Li E
Extended Rate Phy (ERP).
Indicates that the station is operating in an 802.11g network
using extended transmit rates.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.It Li H
High Throughput (HT).
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Indicates that the station is using HT transmit rates.
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
If a
.Sq Li +
follows immediately after then the station associated
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
using deprecated mechanisms supported only when
.Cm htcompat
is enabled.
remove display of the ERP ie from the list sta output (it's always zero); replace it with station capabilities MFC after: 1 month
2006-06-23 17:22:03 +00:00
.It Li P
Power Save.
Indicates that the station is operating in power save mode.
.It Li Q
Quality of Service (QoS).
Indicates that the station is using QoS encapsulation for
data frame.
QoS encapsulation is enabled only when WME mode is enabled.
Document the 'short preamble' capability for 802.11bg. Reviewed by: sam MFC after: 4 days
2010-05-14 15:06:12 +00:00
.It Li S
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
Short GI in HT 40MHz mode enabled.
If a
.Sq Li +
follows immediately after then short GI in HT 20MHz mode is enabled as well.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Li T
Transitional Security Network (TSN).
Indicates that the station associated using TSN; see also
.Cm tsn
below.
.It Li W
Wi-Fi Protected Setup (WPS).
Indicates that the station associated using WPS.
ifconfig.8: fix cpability and flag descriptions for list scan / sta Some capability descriptions under list scan actually described flags. Some capability descriptions were missing. Some flag descriptions under list sta actually described capabilites. Reviewed by: adrian MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25014
2020-06-04 13:06:49 +00:00
.It Li s
Short GI in HT 20MHz mode enabled.
remove display of the ERP ie from the list sta output (it's always zero); replace it with station capabilities MFC after: 1 month
2006-06-23 17:22:03 +00:00
.El
minor wireless-related corrections MFC after: 1 week
2007-11-02 05:23:22 +00:00
.Pp
By default information elements received from associated stations
are displayed in a short form; the
.Fl v
o Typo fixes. PR: docs/127866 Submitted by: Marius Korsmo
2008-10-05 05:12:48 +00:00
flag causes this information to be displayed symbolically.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.It Cm list wme
change list wme to only print the channel parameters; to get channel+bss use -v
2008-08-02 18:10:14 +00:00
Display the current channel parameters to use when operating in WME mode.
If the
.Fl v
option is specified then both channel and BSS parameters are displayed
for each AC (first channel, then BSS).
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
When WME mode is enabled for an adaptor this information will be
displayed with the regular status; this command is mostly useful
for examining parameters when WME mode is disabled.
See the description of the
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm wme
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
directive for information on the various parameters.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm maxretry Ar count
Set the maximum number of tries to use in sending unicast frames.
The default setting is 6 but drivers may override this with a value
they choose.
add mcastrate support MFC after: 1 week
2005-12-12 19:23:55 +00:00
.It Cm mcastrate Ar rate
Set the rate for transmitting multicast/broadcast frames.
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
add mcastrate support MFC after: 1 week
2005-12-12 19:23:55 +00:00
This rate should be valid for the current operating conditions;
if an invalid rate is specified drivers are free to chose an
appropriate rate.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm mgtrate Ar rate
Set the rate for transmitting management and/or control frames.
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm outdoor
Set the location to use in calculating regulatory constraints.
The location is also advertised in beacon and probe response frames
when 802.11d is enabled with
.Cm dotd .
See also
.Cm anywhere ,
.Cm country ,
.Cm indoor ,
and
.Cm regdomain .
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm powersave
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Enable powersave operation.
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
When operating as a client, the station will conserve power by
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
periodically turning off the radio and listening for
messages from the access point telling it there are packets waiting.
The station must then retrieve the packets.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
Not all devices support power save operation as a client.
The 802.11 specification requires that all access points support
power save but some drivers do not.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Use
.Fl powersave
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
to disable powersave operation when operating as a client.
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm powersavesleep Ar sleep
Update for revised 802.11 support: o revised channel handling support; ifconfig now queries the kernel to find the list of available channels and handles channel promotion; channel attributes can be specified as part of the channel; e.g. 36:a for channel 36 in 11a (as opposed to turbo A or HT A) o use channel list to map between freq and IEEE channel #; this eliminates all knowledge of how the mapping is done and fixes handling of cases where channels overlap in the IEEE channel # space but are distinct in the frequency+attributes space (e.g. PSB) o add new knobs: bgscan, ff (Atheors fast frames), dturbo (Atheros Dynamic Turbo mode), bgscanidle, bgscanintvl, scanvalid, roam:rssi11a, roam:rssi11b, roam:rssi11g, roam:rate11a, roam:rate11b, roam:rate11g (roaming parameters), burst, doth (forthcoming 11h support) o print contents of WME, ATH, WPA, RSN, information elements with -v option o print signal strength in dBm o print noise floor in dBm o add list txpow to print tx power caps/channel o change default channel display in status to be more informative
2007-06-11 03:56:33 +00:00
Set the desired max powersave sleep time in TU's (1024 usecs).
By default the max powersave sleep time is 100 TU's.
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
.It Cm protmode Ar technique
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
For interfaces operating in 802.11g, use the specified
Assorted markup, grammar, and spelling fixes.
2004-05-17 08:35:43 +00:00
.Ar technique
for protecting OFDM frames in a mixed 11b/11g network.
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
The set of valid techniques is
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm off , cts
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
(CTS to self),
and
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm rtscts
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
(RTS/CTS).
Technique names are case insensitive.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
Not all devices support
.Cm cts
as a protection technique.
add pureg/-pureg parameter for controlling pureg ap mode support Reviewed by: avatar Approved by: re (scottl)
2005-07-06 15:39:11 +00:00
.It Cm pureg
When operating as an access point in 802.11g mode allow only
11g-capable stations to associate (11b-only stations are not
permitted to associate).
To allow both 11g and 11b-only stations to associate, use
.Fl pureg .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm puren
When operating as an access point in 802.11n mode allow only
HT-capable stations to associate (legacy stations are not
permitted to associate).
To allow both HT and legacy stations to associate, use
.Fl puren .
.It Cm regdomain Ar sku
Set the regulatory domain to use in calculating the regulatory constraints
for operation.
In particular the set of available channels, how the wireless device
will operation on the channels, and the maximum transmit power that
can be used on a channel are defined by this setting.
mdoc sweep
2013-05-13 18:13:50 +00:00
Regdomain codes (SKU's) are taken from
.Pa /etc/regdomain.xml
and can also
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
be viewed with the ``list countries'' request.
Note that not all devices support changing the regdomain from a default
setting; typically stored in EEPROM.
See also
.Cm country ,
.Cm indoor ,
.Cm outdoor ,
and
.Cm anywhere .
MIMO power save and RIFS; while here also update per-node state/flags for ampdu
2008-09-22 00:30:26 +00:00
.It Cm rifs
Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
on an HT channel.
Note that RIFS must be supported by both the station and access point
for it to be used.
To disable RIFS use
.Fl rifs .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm roam:rate Ar rate
Set the threshold for controlling roaming when operating in a BSS.
The
.Ar rate
parameter specifies the transmit rate in megabits
at which roaming should be considered.
If the current transmit rate drops below this setting and background scanning
is enabled, then the system will check if a more desirable access point is
available and switch over to it.
The current scan cache contents are used if they are considered
valid according to the
.Cm scanvalid
parameter; otherwise a background scan operation is triggered before
any selection occurs.
Each channel type has a separate rate threshold; the default values are:
12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
.It Cm roam:rssi Ar rssi
Set the threshold for controlling roaming when operating in a BSS.
The
.Ar rssi
parameter specifies the receive signal strength in dBm units
at which roaming should be considered.
If the current rssi drops below this setting and background scanning
is enabled, then the system will check if a more desirable access point is
available and switch over to it.
The current scan cache contents are used if they are considered
valid according to the
.Cm scanvalid
parameter; otherwise a background scan operation is triggered before
any selection occurs.
Fix typo.
2008-08-27 12:54:29 +00:00
Each channel type has a separate rssi threshold; the default values are
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
all 7 dBm.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm roaming Ar mode
When operating as a station, control how the system will
behave when communication with the current access point
is broken.
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
The
.Ar mode
argument may be one of
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm device
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
(leave it to the hardware device to decide),
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm auto
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
(handle either in the device or the operating system\[em]as appropriate),
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm manual
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
(do nothing until explicitly instructed).
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
By default, the device is left to handle this if it is
capable; otherwise, the operating system will automatically
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
attempt to reestablish communication.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
Manual mode is used by applications such as
.Xr wpa_supplicant 8
that want to control the selection of an access point.
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
.It Cm rtsthreshold Ar length
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the threshold for which
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
transmitted frames are preceded by transmission of an
RTS
control frame.
Assorted markup, grammar, and spelling fixes.
2004-05-17 08:35:43 +00:00
The
.Ar length
argument
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
is the frame size in bytes and must be in the range 1 to 2346.
Setting
.Ar length
to
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Li 2346 ,
.Cm any ,
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
or
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm -
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
disables transmission of RTS frames.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Not all adapters support setting the RTS threshold.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm scan
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Initiate a scan of neighboring stations, wait for it to complete, and
display all stations found.
Only the super-user can initiate a scan.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
See
.Cm list scan
for information on the display.
By default a background scan is done; otherwise a foreground
scan is done and the station may roam to a different access point.
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
The
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm list scan
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
request can be used to show recent scan results without
initiating a new scan.
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
.It Cm scanvalid Ar threshold
Set the maximum time the scan cache contents are considered valid;
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
i.e., will be used without first triggering a scan operation to
updates for 802.11-related parameters Reviewed by: thompsa Approved by: re (hrs)
2007-07-09 15:39:58 +00:00
refresh the data.
The
.Ar threshold
parameter is specified in seconds and defaults to 60 seconds.
The minimum setting for
.Ar threshold
is 10 seconds.
One should take care setting this threshold; if it is set too low
then attempts to roam to another access point may trigger unnecessary
background scan operations.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm shortgi
Enable use of Short Guard Interval when operating in 802.11n
on an HT channel.
NB: this currently enables Short GI on both HT40 and HT20 channels.
To disable Short GI use
.Fl shortgi .
MIMO power save and RIFS; while here also update per-node state/flags for ampdu
2008-09-22 00:30:26 +00:00
.It Cm smps
Enable use of Static Spatial Multiplexing Power Save (SMPS)
when operating in 802.11n.
A station operating with Static SMPS maintains only a single
receive chain active (this can significantly reduce power consumption).
To disable SMPS use
.Fl smps .
.It Cm smpsdyn
Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
when operating in 802.11n.
A station operating with Dynamic SMPS maintains only a single
receive chain active but switches to multiple receive chains when it
receives an RTS frame (this can significantly reduce power consumption).
Note that stations cannot distinguish between RTS/CTS intended to
enable multiple receive chains and those used for other purposes.
To disable SMPS use
.Fl smps .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm ssid Ar ssid
Set the desired Service Set Identifier (aka network name).
The SSID is a string up to 32 characters
in length and may be specified as either a normal string or in
hexadecimal when preceded by
.Ql 0x .
Additionally, the SSID may be cleared by setting it to
.Ql - .
TDMA support for long distance point-to-point links using ath devices: o add net80211 support for a tdma vap that is built on top of the existing adhoc-demo support o add tdma scheduling of frame transmission to the ath driver; it's conceivable other devices might be capable of this too in which case they can make use of the 802.11 protocol additions etc. o add minor bits to user tools that need to know: ifconfig to setup and configure, new statistics in athstats, and new debug mask bits While the architecture can support >2 slots in a TDMA BSS the current design is intended (and tested) for only 2 slots. Sponsored by: Intel
2009-01-08 17:12:47 +00:00
.It Cm tdmaslot Ar slot
When operating with TDMA, use the specified
.Ar slot
configuration.
The
.Ar slot
is a number between 0 and the maximum number of slots in the BSS.
Note that a station configured as slot 0 is a master and
will broadcast beacon frames advertising the BSS;
stations configured to use other slots will always
scan to locate a master before they ever transmit.
By default
.Cm tdmaslot
is set to 1.
.It Cm tdmaslotcnt Ar cnt
When operating with TDMA, setup a BSS with
.Ar cnt
slots.
The slot count may be at most 8.
The current implementation is only tested with two stations
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
(i.e., point to point applications).
TDMA support for long distance point-to-point links using ath devices: o add net80211 support for a tdma vap that is built on top of the existing adhoc-demo support o add tdma scheduling of frame transmission to the ath driver; it's conceivable other devices might be capable of this too in which case they can make use of the 802.11 protocol additions etc. o add minor bits to user tools that need to know: ifconfig to setup and configure, new statistics in athstats, and new debug mask bits While the architecture can support >2 slots in a TDMA BSS the current design is intended (and tested) for only 2 slots. Sponsored by: Intel
2009-01-08 17:12:47 +00:00
This setting is only meaningful when a station is configured as slot 0;
other stations adopt this setting from the BSS they join.
By default
.Cm tdmaslotcnt
is set to 2.
.It Cm tdmaslotlen Ar len
When operating with TDMA, setup a BSS such that each station has a slot
.Ar len
microseconds long.
The slot length must be at least 150 microseconds (1/8 TU)
and no more than 65 milliseconds.
Note that setting too small a slot length may result in poor channel
bandwidth utilization due to factors such as timer granularity and
guard time.
This setting is only meaningful when a station is configured as slot 0;
other stations adopt this setting from the BSS they join.
By default
.Cm tdmaslotlen
is set to 10 milliseconds.
.It Cm tdmabintval Ar intval
When operating with TDMA, setup a BSS such that beacons are transmitted every
.Ar intval
superframes to synchronize the TDMA slot timing.
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
A superframe is defined as the number of slots times the slot length; e.g.,
TDMA support for long distance point-to-point links using ath devices: o add net80211 support for a tdma vap that is built on top of the existing adhoc-demo support o add tdma scheduling of frame transmission to the ath driver; it's conceivable other devices might be capable of this too in which case they can make use of the 802.11 protocol additions etc. o add minor bits to user tools that need to know: ifconfig to setup and configure, new statistics in athstats, and new debug mask bits While the architecture can support >2 slots in a TDMA BSS the current design is intended (and tested) for only 2 slots. Sponsored by: Intel
2009-01-08 17:12:47 +00:00
a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
The beacon interval may not be zero.
A lower setting of
.Cm tdmabintval
causes the timers to be resynchronized more often; this can be help if
significant timer drift is observed.
By default
.Cm tdmabintval
is set to 5.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm tsn
When operating as an access point with WPA/802.11i allow legacy
stations to associate using static key WEP and open authentication.
To disallow legacy station use of WEP, use
.Fl tsn .
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
.It Cm txpower Ar power
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the power used to transmit frames.
Assorted markup, grammar, and spelling fixes.
2004-05-17 08:35:43 +00:00
The
.Ar power
minor wireless-related corrections MFC after: 1 week
2007-11-02 05:23:22 +00:00
argument is specified in .5 dBm units.
add support for setting 802.11 rtsthreshold, transmit power, and 11g protection mode Reviewed by: imp (just code)
2004-03-30 22:59:22 +00:00
Out of range values are truncated.
Typically only a few discreet power settings are available and
the driver will use the setting closest to the specified value.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Not all adapters support changing the transmit power.
.It Cm ucastrate Ar rate
Set a fixed rate for transmitting unicast frames.
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
This rate should be valid for the current operating conditions;
if an invalid rate is specified drivers are free to chose an
appropriate rate.
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm wepmode Ar mode
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the desired WEP mode.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Not all adapters support all modes.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
The set of valid modes is
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm off , on ,
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
and
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm mixed .
Assorted markup, grammar, and spelling fixes.
2004-05-17 08:35:43 +00:00
The
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm mixed
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
mode explicitly tells the adaptor to allow association with access
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
points which allow both encrypted and unencrypted traffic.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
On these adapters,
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm on
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
means that the access point must only allow encrypted connections.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
On other adapters,
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm on
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
is generally another name for
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Cm mixed .
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
Modes are case insensitive.
.It Cm weptxkey Ar index
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the WEP key to be used for transmission.
document deftxkey
2005-12-26 18:15:09 +00:00
This is the same as setting the default transmission key with
.Cm deftxkey .
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
Set the selected WEP key.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
If an
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.Ar index
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
is not given, key 1 is set.
A WEP key will be either 5 or 13
Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while translating these manual pages. Minor corrections by me. Submitted by: Nobuyuki Koganemaru <n-kogane@syd.odn.ne.jp>
2010-08-16 15:18:30 +00:00
characters (40 or 104 bits) depending on the local network and the
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
capabilities of the adaptor.
It may be specified either as a plain
It's spelled 'preceded' of course. Submitted by: David Adam <zanchey@ucc.gu.uwa.edu.au> Pointy hat to: brueffer
2005-06-13 15:49:59 +00:00
string or as a string of hexadecimal digits preceded by
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Ql 0x .
Warn that hex keys are the most portable. Submitted by: Gregory Bond <gnb@itga.com.au> Pr: 40872
2002-08-12 06:59:04 +00:00
For maximum portability, hex keys are recommended;
mdoc(7) police: KAMEism in rev. 1.56, nits in rev. 1.58.
2002-08-13 11:51:03 +00:00
the mapping of text keys to WEP encryption is usually driver-specific.
mdoc(7) police: markup, spelling. Also fixed a critical bug made in revision 1.62 by phk@.
2002-11-25 16:01:28 +00:00
In particular, the
.Tn Windows
drivers do this mapping differently to
mdoc(7) police: KAMEism in rev. 1.56, nits in rev. 1.58.
2002-08-13 11:51:03 +00:00
.Fx .
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
A key may be cleared by setting it to
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Ql - .
If WEP is supported then there are at least four keys.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Some adapters support more than four keys.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
If that is the case, then the first four keys
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
(1-4) will be the standard temporary keys and any others will be adaptor
specific keys such as permanent keys stored in NVRAM.
explain that you must set a default transmit key for WEP Submitted by: Jeremie Le Hen <jeremie@le-hen.org> MFC after: 1 week
2008-02-29 20:42:17 +00:00
.Pp
Note that you must set a default transmit key with
.Cm deftxkey
for the system to know which key to use in encrypting outbound traffic.
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.It Cm wme
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Enable Wireless Multimedia Extensions (WME) support, if available,
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
for the specified interface.
WME is a subset of the IEEE 802.11e standard to support the
efficient communication of realtime and multimedia data.
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
To disable WME support, use
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Fl wme .
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
Another name for this parameter is
.Cm wmm .
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.Pp
The following parameters are meaningful only when WME support is in use.
Parameters are specified per-AC (Access Category) and
split into those that are used by a station when acting
as an access point and those for client stations in the BSS.
The latter are received from the access point and may not be changed
(at the station).
The following Access Categories are recognized:
.Pp
-mdoc sweep.
2005-11-18 10:36:29 +00:00
.Bl -tag -width ".Cm AC_BK" -compact
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm AC_BE
-mdoc sweep.
2005-11-18 10:36:29 +00:00
(or
.Cm BE )
best effort delivery,
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm AC_BK
-mdoc sweep.
2005-11-18 10:36:29 +00:00
(or
.Cm BK )
background traffic,
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm AC_VI
-mdoc sweep.
2005-11-18 10:36:29 +00:00
(or
.Cm VI )
video traffic,
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm AC_VO
-mdoc sweep.
2005-11-18 10:36:29 +00:00
(or
.Cm VO )
voice traffic.
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.El
.Pp
AC parameters are case-insensitive.
Traffic classification is done in the operating system using the
vlan priority associated with data frames or the
ToS (Type of Service) indication in IP-encapsulated frames.
-mdoc sweep.
2005-11-18 10:36:29 +00:00
If neither information is present, traffic is assigned to the
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Best Effort (BE) category.
.Bl -tag -width indent
.It Cm ack Ar ac
Set the ACK policy for QoS transmissions by the local station;
this controls whether or not data frames transmitted by a station
require an ACK response from the receiving station.
To disable waiting for an ACK use
.Fl ack .
This parameter is applied only to the local station.
.It Cm acm Ar ac
Enable the Admission Control Mandatory (ACM) mechanism
for transmissions by the local station.
To disable the ACM use
.Fl acm .
On stations in a BSS this parameter is read-only and indicates
the setting received from the access point.
NB: ACM is not supported right now.
.It Cm aifs Ar ac Ar count
Set the Arbitration Inter Frame Spacing (AIFS)
channel access parameter to use for transmissions
by the local station.
On stations in a BSS this parameter is read-only and indicates
the setting received from the access point.
.It Cm cwmin Ar ac Ar count
Set the CWmin channel access parameter to use for transmissions
by the local station.
On stations in a BSS this parameter is read-only and indicates
the setting received from the access point.
.It Cm cwmax Ar ac Ar count
Set the CWmax channel access parameter to use for transmissions
by the local station.
On stations in a BSS this parameter is read-only and indicates
the setting received from the access point.
.It Cm txoplimit Ar ac Ar limit
Set the Transmission Opportunity Limit channel access parameter
to use for transmissions by the local station.
This parameter defines an interval of time when a WME station
has the right to initiate transmissions onto the wireless medium.
On stations in a BSS this parameter is read-only and indicates
the setting received from the access point.
.It Cm bss:aifs Ar ac Ar count
Set the AIFS channel access parameter to send to stations in a BSS.
This parameter is meaningful only when operating in ap mode.
.It Cm bss:cwmin Ar ac Ar count
Set the CWmin channel access parameter to send to stations in a BSS.
This parameter is meaningful only when operating in ap mode.
.It Cm bss:cwmax Ar ac Ar count
Set the CWmax channel access parameter to send to stations in a BSS.
This parameter is meaningful only when operating in ap mode.
.It Cm bss:txoplimit Ar ac Ar limit
Set the TxOpLimit channel access parameter to send to stations in a BSS.
This parameter is meaningful only when operating in ap mode.
.El
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm wps
Enable Wireless Privacy Subscriber support.
Note that WPS support requires a WPS-capable supplicant.
To disable this function use
.Fl wps .
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.El
.Pp
The following parameters support an optional access control list
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
feature available with some adapters when operating in ap mode; see
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.Xr wlan_acl 4 .
This facility allows an access point to accept/deny association
requests based on the MAC address of the station.
Note that this feature does not significantly enhance security
as MAC address spoofing is easy to do.
.Bl -tag -width indent
.It Cm mac:add Ar address
Add the specified MAC address to the database.
Depending on the policy setting association requests from the
specified station will be allowed or denied.
.It Cm mac:allow
Set the ACL policy to permit association only by
stations registered in the database.
add miss args to mac:del and mac:kick Submitted by: Anders Hanssen MFC after: 3 days
2006-02-15 23:16:03 +00:00
.It Cm mac:del Ar address
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
Delete the specified MAC address from the database.
.It Cm mac:deny
Set the ACL policy to deny association only by
stations registered in the database.
add miss args to mac:del and mac:kick Submitted by: Anders Hanssen MFC after: 3 days
2006-02-15 23:16:03 +00:00
.It Cm mac:kick Ar address
add list mac and mac:kick support Submitted by: Michal Mertl (original version) MFC after: 2 weeks
2005-08-13 17:38:09 +00:00
Force the specified station to be deauthenticated.
This typically is done to block a station after updating the
address database.
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
.It Cm mac:open
Set the ACL policy to allow all stations to associate.
.It Cm mac:flush
Delete all entries in the database.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm mac:radius
Set the ACL policy to permit association only by
stations approved by a RADIUS server.
Note that this feature requires the
.Xr hostapd 8
program be configured to do the right thing
as it handles the RADIUS processing
(and marks stations as authorized).
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.El
.Pp
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
The following parameters are related to a wireless interface operating in mesh
mode:
.Bl -tag -width indent
.It Cm meshid Ar meshid
Set the desired Mesh Identifier.
The Mesh ID is a string up to 32 characters in length.
A mesh interface must have a Mesh Identifier specified
to reach an operational state.
.It Cm meshttl Ar ttl
Set the desired ``time to live'' for mesh forwarded packets;
this is the number of hops a packet may be forwarded before
it is discarded.
The default setting for
.Cm meshttl
is 31.
.It Cm meshpeering
Enable or disable peering with neighbor mesh stations.
Stations must peer before any data packets can be exchanged.
By default
.Cm meshpeering
is enabled.
.It Cm meshforward
Enable or disable forwarding packets by a mesh interface.
By default
.Cm meshforward
is enabled.
* Added new command to ifconfig to activate Mesh Gate Announcement called meshgate with corresponding explanation; Approved by: adrian
2012-05-01 16:15:34 +00:00
.It Cm meshgate
This attribute specifies whether or not the mesh STA activates mesh gate
announcements.
By default
.Cm meshgate
is disabled.
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
.It Cm meshmetric Ar protocol
Set the specified
.Ar protocol
as the link metric protocol used on a mesh network.
The default protocol is called
.Ar AIRTIME .
The mesh interface will restart after changing this setting.
.It Cm meshpath Ar protocol
Set the specified
.Ar protocol
as the path selection protocol used on a mesh network.
The only available protocol at the moment is called
.Ar HWMP
(Hybrid Wireless Mesh Protocol).
The mesh interface will restart after changing this setting.
.It Cm hwmprootmode Ar mode
Stations on a mesh network can operate as ``root nodes.''
Root nodes try to find paths to all mesh nodes and advertise themselves
regularly.
When there is a root mesh node on a network, other mesh nodes can setup
paths between themselves faster because they can use the root node
to find the destination.
This path may not be the best, but on-demand
routing will eventually find the best path.
The following modes are recognized:
.Pp
.Bl -tag -width ".Cm PROACTIVE" -compact
.It Cm DISABLED
Disable root mode.
.It Cm NORMAL
Send broadcast path requests every two seconds.
Nodes on the mesh without a path to this root mesh station with try to
discover a path to us.
.It Cm PROACTIVE
Remove repeated words.
2012-06-05 18:19:52 +00:00
Send broadcast path requests every two seconds and every node must reply
Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while translating these manual pages. Minor corrections by me. Submitted by: Nobuyuki Koganemaru <n-kogane@syd.odn.ne.jp>
2010-08-16 15:18:30 +00:00
with a path reply even if it already has a path to this root mesh station.
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
.It Cm RANN
Spelling fixes.
2010-07-31 21:09:49 +00:00
Send broadcast root announcement (RANN) frames.
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
Nodes on the mesh without a path to this root mesh station with try to
discover a path to us.
.El
By default
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Cm hwmprootmode
Implementation of the upcoming Wireless Mesh standard, 802.11s, on the net80211 wireless stack. This work is based on the March 2009 D3.0 draft standard. This standard is expected to become final next year. This includes two main net80211 modules, ieee80211_mesh.c which deals with peer link management, link metric calculation, routing table control and mesh configuration and ieee80211_hwmp.c which deals with the actually routing process on the mesh network. HWMP is the mandatory routing protocol on by the mesh standard, but others, such as RA-OLSR, can be implemented. Authentication and encryption are not implemented. There are several scripts under tools/tools/net80211/scripts that can be used to test different mesh network topologies and they also teach you how to setup a mesh vap (for the impatient: ifconfig wlan0 create wlandev ... wlanmode mesh). A new build option is available: IEEE80211_SUPPORT_MESH and it's enabled by default on GENERIC kernels for i386, amd64, sparc64 and pc98. Drivers that support mesh networks right now are: ath, ral and mwl. More information at: http://wiki.freebsd.org/WifiMesh Please note that this work is experimental. Also, please note that bridging a mesh vap with another network interface is not yet supported. Many thanks to the FreeBSD Foundation for sponsoring this project and to Sam Leffler for his support. Also, I would like to thank Gateworks Corporation for sending me a Cambria board which was used during the development of this project. Reviewed by: sam Approved by: re (kensmith) Obtained from: projects/mesh11s
2009-07-11 15:02:45 +00:00
is set to
.Ar DISABLED .
.It Cm hwmpmaxhops Ar cnt
Set the maximum number of hops allowed in an HMWP path to
.Ar cnt .
The default setting for
.Cm hwmpmaxhops
is 31.
.El
.Pp
Wireless suport fixups: add a bunch of stuff that's been in the code but not documented (e.g. wme, mac acl) and correct some information, etc. Reviewed by: brueffer
2005-08-02 19:13:13 +00:00
The following parameters are for compatibility with other systems:
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Bl -tag -width indent
.It Cm nwid Ar ssid
Another name for the
.Cm ssid
parameter.
Included for
.Nx
compatibility.
Multi-bss (aka vap) support for 802.11 devices. Note this includes changes to all drivers and moves some device firmware loading to use firmware(9) and a separate module (e.g. ral). Also there no longer are separate wlan_scan* modules; this functionality is now bundled into the wlan module. Supported by: Hobnob and Marvell Reviewed by: many Obtained from: Atheros (some bits)
2008-04-20 20:35:46 +00:00
.It Cm stationname Ar name
Set the name of this station.
The station name is not part of the IEEE 802.11
protocol though some interfaces support it.
As such it only
seems to be meaningful to identical or virtually identical equipment.
Setting the station name is identical in syntax to setting the SSID.
One can also use
.Cm station
for
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Bsx
compatibility.
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm wep
Another way of saying
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Cm wepmode on .
Included for
.Bsx
compatibility.
.It Fl wep
Another way of saying
.Cm wepmode off .
Included for
.Bsx
compatibility.
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
.It Cm nwkey key
Another way of saying:
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
Included for
.Nx
compatibility.
.It Cm nwkey Xo
.Sm off
.Ar n : k1 , k2 , k3 , k4
.Sm on
.Xc
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
Another way of saying
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
Included for
.Nx
compatibility.
.It Fl nwkey
Currently, each wireless networking driver has it's own control program despite the fact that most people want to set exactly the same settings regardless of which card they have. It has been repeatidly suggested that this configuration should be done via ifconfig. This patch implements the required functionality in ifconfig and add support to the wi and an drivers. It also provides partial, untested support for the awi driver. PR: 25577 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-26 09:27:08 +00:00
Another way of saying
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Cm wepmode off .
Included for
.Nx
compatibility.
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.El
.Pp
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
The following parameters are specific to bridge interfaces:
.Bl -tag -width indent
.It Cm addm Ar interface
Add the interface named by
.Ar interface
as a member of the bridge.
The interface is put into promiscuous mode
so that it can receive every packet sent on the network.
.It Cm deletem Ar interface
Remove the interface named by
.Ar interface
from the bridge.
Promiscuous mode is disabled on the interface when
it is removed from the bridge.
.It Cm maxaddr Ar size
Set the size of the bridge address cache to
.Ar size .
Update bridge(4) default values. PR: 164564 Submitted by: "Rudy (bulk)" <crapsh@monkeybrains.net> MFC after: 2 weeks
2012-02-29 21:11:02 +00:00
The default is 2000 entries.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm timeout Ar seconds
Set the timeout of address cache entries to
.Ar seconds
seconds.
If
.Ar seconds
is zero, then address cache entries will not be expired.
Update bridge(4) default values. PR: 164564 Submitted by: "Rudy (bulk)" <crapsh@monkeybrains.net> MFC after: 2 weeks
2012-02-29 21:11:02 +00:00
The default is 1200 seconds.
Document two missed if_bridge commands 'addr' and 'static'. Noticed by: Michal Mertl Approved by: mlaier (mentor) MFC after: 3 days
2005-08-14 03:28:08 +00:00
.It Cm addr
Display the addresses that have been learned by the bridge.
.It Cm static Ar interface-name Ar address
Add a static entry into the address cache pointing to
.Ar interface-name .
Static entries are never aged out of the cache or re-placed, even if the
address is seen on a different interface.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm deladdr Ar address
Delete
.Ar address
from the address cache.
.It Cm flush
Delete all dynamically-learned addresses from the address cache.
.It Cm flushall
Delete all addresses, including static addresses, from the address cache.
.It Cm discover Ar interface
Mark an interface as a
.Dq discovering
interface.
When the bridge has no address cache entry
(either dynamic or static)
for the destination address of a packet,
the bridge will forward the packet to all
member interfaces marked as
.Dq discovering .
This is the default for all interfaces added to a bridge.
.It Cm -discover Ar interface
Clear the
.Dq discovering
attribute on a member interface.
For packets without the
.Dq discovering
attribute, the only packets forwarded on the interface are broadcast
or multicast packets and packets for which the destination address
is known to be on the interface's segment.
.It Cm learn Ar interface
Mark an interface as a
.Dq learning
interface.
When a packet arrives on such an interface, the source
address of the packet is entered into the address cache as being a
destination address on the interface's segment.
This is the default for all interfaces added to a bridge.
.It Cm -learn Ar interface
Clear the
.Dq learning
attribute on a member interface.
Add a new address cache type called sticky. On an interface marked sticky any address learned by the bridge is made permanent, the address will not age out and most importantly will not migrate to another interface. This can be used to stop mac address poisoning or clients roaming in much the same way as static entries without the hassle of preloading the table.
2006-11-09 06:32:38 +00:00
.It Cm sticky Ar interface
Mark an interface as a
.Dq sticky
interface.
Dynamically learned address entries are treated at static once entered into
the cache.
Sticky entries are never aged out of the cache or replaced, even if the
address is seen on a different interface.
.It Cm -sticky Ar interface
Clear the
.Dq sticky
attribute on a member interface.
Add a bridge interface flag called PRIVATE where any private port can not communicate with another private port. All unicast/broadcast/multicast layer2 traffic is blocked so it works much the same way as using firewall rules but scales better and is generally easier as firewall packages usually do not allow ARP blocking. An example usage would be having a number of customers on separate vlans bridged with a server network. All the vlans are marked private, they can all communicate with the server network unhindered, but can not exchange any traffic whatsoever with each other. Approved by: re (rwatson)
2007-08-01 00:33:52 +00:00
.It Cm private Ar interface
Mark an interface as a
.Dq private
interface.
A private interface does not forward any traffic to any other port that is also
a private interface.
.It Cm -private Ar interface
Clear the
.Dq private
attribute on a member interface.
Add support for creating span ports so that one can snoop bridged traffic from another interface/machine/network. Obtained from: OpenBSD MFC after: 2 weeks
2005-12-14 02:52:13 +00:00
.It Cm span Ar interface
Add the interface named by
.Ar interface
as a span port on the bridge.
Span ports transmit a copy of every frame received by the bridge.
This is most useful for snooping a bridged network passively on
another host connected to one of the span ports of the bridge.
.It Cm -span Ar interface
Delete the interface named by
.Ar interface
from the list of span ports of the bridge.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm stp Ar interface
Enable Spanning Tree protocol on
.Ar interface .
The
.Xr if_bridge 4
driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
Spanning Tree is used to detect and remove loops in a network topology.
.It Cm -stp Ar interface
Disable Spanning Tree protocol on
.Ar interface .
This is the default for all interfaces added to a bridge.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
.It Cm edge Ar interface
Set
.Ar interface
as an edge port.
An edge port connects directly to end stations cannot create bridging
loops in the network, this allows it to transition straight to forwarding.
.It Cm -edge Ar interface
Disable edge status on
.Ar interface .
.It Cm autoedge Ar interface
Allow
.Ar interface
to automatically detect edge status.
This is the default for all interfaces added to a bridge.
.It Cm -autoedge Ar interface
- Display the media instance numbers and allow the user to set the active one. This is based on NetBSD but unlike NetBSD this implementation prints the instance number for all media instances and doesn't skip it for the first one as I don't see a reason to suppress it except for the vague reason to preserve the output for single-instance configurations. - Fix some whitespace nits.
2007-01-20 00:56:49 +00:00
Disable automatic edge status on
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
.Ar interface .
These days P2P means peer-2-peer (also well known from serveral filesharing protocols) while PointToPoint has been PtP links. Change the variables accordingly while the code is still fresh and undocumented. Requested by: bz
2006-12-11 23:46:40 +00:00
.It Cm ptp Ar interface
Add descriptions for p2p and autop2p.
2006-11-27 21:59:04 +00:00
Set the
.Ar interface
as a point to point link.
This is required for straight transitions to forwarding and
should be enabled on a direct link to another RSTP capable switch.
These days P2P means peer-2-peer (also well known from serveral filesharing protocols) while PointToPoint has been PtP links. Change the variables accordingly while the code is still fresh and undocumented. Requested by: bz
2006-12-11 23:46:40 +00:00
.It Cm -ptp Ar interface
Add descriptions for p2p and autop2p.
2006-11-27 21:59:04 +00:00
Disable point to point link status on
.Ar interface .
This should be disabled for a half duplex link and for an interface
connected to a shared network segment,
like a hub or a wireless network.
These days P2P means peer-2-peer (also well known from serveral filesharing protocols) while PointToPoint has been PtP links. Change the variables accordingly while the code is still fresh and undocumented. Requested by: bz
2006-12-11 23:46:40 +00:00
.It Cm autoptp Ar interface
Add descriptions for p2p and autop2p.
2006-11-27 21:59:04 +00:00
Automatically detect the point to point status on
.Ar interface
by checking the full duplex link status.
This is the default for interfaces added to the bridge.
These days P2P means peer-2-peer (also well known from serveral filesharing protocols) while PointToPoint has been PtP links. Change the variables accordingly while the code is still fresh and undocumented. Requested by: bz
2006-12-11 23:46:40 +00:00
.It Cm -autoptp Ar interface
Add descriptions for p2p and autop2p.
2006-11-27 21:59:04 +00:00
Disable automatic point to point link detection on
.Ar interface .
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm maxage Ar seconds
Set the time that a Spanning Tree protocol configuration is valid.
The default is 20 seconds.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The minimum is 6 seconds and the maximum is 40 seconds.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm fwddelay Ar seconds
Set the time that must pass before an interface begins forwarding
packets when Spanning Tree is enabled.
The default is 15 seconds.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The minimum is 4 seconds and the maximum is 30 seconds.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm hellotime Ar seconds
Set the time between broadcasting of Spanning Tree protocol
configuration messages.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The hello time may only be changed when operating in legacy stp mode.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
The default is 2 seconds.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The minimum is 1 second and the maximum is 2 seconds.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm priority Ar value
Set the bridge priority for Spanning Tree.
The default is 32768.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The minimum is 0 and the maximum is 61440.
Correct the name of the 'proto' command. MFC after: 3 days
2007-03-29 21:30:26 +00:00
.It Cm proto Ar value
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
Set the Spanning Tree protocol.
The default is rstp.
The available options are stp and rstp.
Keep the command name the same as the values display name in ifconfig.
2006-11-27 20:18:43 +00:00
.It Cm holdcnt Ar value
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
Set the transmit hold count for Spanning Tree.
This is the number of packets transmitted before being rate limited.
The default is 6.
The minimum is 1 and the maximum is 10.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm ifpriority Ar interface Ar value
Set the Spanning Tree priority of
.Ar interface
to
.Ar value .
The default is 128.
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The minimum is 0 and the maximum is 240.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.It Cm ifpathcost Ar interface Ar value
Set the Spanning Tree path cost of
.Ar interface
to
.Ar value .
Bring in support for the Rapid Spanning Tree Protocol (802.1w). RSTP provides faster spanning tree convergence, the protocol will exchange information with neighboring switches to quickly transition to forwarding without creating loops. The code will default to RSTP mode but will downgrade any port connected to a legacy STP network so is fully backward compatible. Reviewed by: syrinx Tested by: syrinx
2006-11-01 09:07:47 +00:00
The default is calculated from the link speed.
To change a previously selected path cost back to automatic, set the
cost to 0.
The minimum is 1 and the maximum is 200000000.
Add an option to limit the number of source MACs that can be behind a bridge interface. Once the limit is reached packets with unknown source addresses are dropped until an existing host cache entry expires or is removed. Useful to use with the STICKY cache option. Sponsored by: miniSuperHappyDevHouse NZ
2007-11-04 08:32:27 +00:00
.It Cm ifmaxaddr Ar interface Ar size
Set the maximum number of hosts allowed from an interface, packets with unknown
source addresses are dropped until an existing host cache entry expires or is
removed.
Set to 0 to disable.
Connect if_bridge to the build. Approved by: mlaier (mentor)
2005-06-05 03:32:53 +00:00
.El
.Pp
Rename the trunk(4) driver to lagg(4) as it is too similar to vlan trunking. The name trunk is misused as the networking term trunk means carrying multiple VLANs over a single connection. The IEEE standard for link aggregation (802.3 section 3) does not talk about 'trunk' at all while it is used throughout IEEE 802.1Q in describing vlans. The lagg(4) driver provides link aggregation, failover and fault tolerance. Discussed on: current@
2007-04-17 00:35:11 +00:00
The following parameters are specific to lagg interfaces:
Hook trunk(4) up to the build.
2007-04-10 00:35:31 +00:00
.Bl -tag -width indent
Add support for IP over infiniband, IPoIB, to lagg(4). Currently only the failover protocol is supported due to limitations in the IPoIB architecture. Refer to the lagg(4) manual page for how to configure and use this new feature. A new network interface type, IFT_INFINIBANDLAG, has been added, similar to the existing IFT_IEEE8023ADLAG . ifconfig(8) has been updated to accept a new laggtype argument when creating lagg(4) network interfaces. This new argument is used to distinguish between ethernet and infiniband type of lagg(4) network interface. The laggtype argument is optional and defaults to ethernet. The lagg(4) command line syntax is backwards compatible. Differential Revision: https://reviews.freebsd.org/D26254 Reviewed by: melifaro@ MFC after: 1 week Sponsored by: Mellanox Technologies // NVIDIA Networking
2020-10-22 09:47:12 +00:00
.It Cm laggtype Ar type
When creating a lagg interface the type can be specified as either
.Cm ethernet
or
.Cm infiniband .
If not specified ethernet is the default lagg type.
Rename the trunk(4) driver to lagg(4) as it is too similar to vlan trunking. The name trunk is misused as the networking term trunk means carrying multiple VLANs over a single connection. The IEEE standard for link aggregation (802.3 section 3) does not talk about 'trunk' at all while it is used throughout IEEE 802.1Q in describing vlans. The lagg(4) driver provides link aggregation, failover and fault tolerance. Discussed on: current@
2007-04-17 00:35:11 +00:00
.It Cm laggport Ar interface
Hook trunk(4) up to the build.
2007-04-10 00:35:31 +00:00
Add the interface named by
.Ar interface
Rename the trunk(4) driver to lagg(4) as it is too similar to vlan trunking. The name trunk is misused as the networking term trunk means carrying multiple VLANs over a single connection. The IEEE standard for link aggregation (802.3 section 3) does not talk about 'trunk' at all while it is used throughout IEEE 802.1Q in describing vlans. The lagg(4) driver provides link aggregation, failover and fault tolerance. Discussed on: current@
2007-04-17 00:35:11 +00:00
as a port of the aggregation interface.
.It Cm -laggport Ar interface
Hook trunk(4) up to the build.
2007-04-10 00:35:31 +00:00
Remove the interface named by
.Ar interface
Rename the trunk(4) driver to lagg(4) as it is too similar to vlan trunking. The name trunk is misused as the networking term trunk means carrying multiple VLANs over a single connection. The IEEE standard for link aggregation (802.3 section 3) does not talk about 'trunk' at all while it is used throughout IEEE 802.1Q in describing vlans. The lagg(4) driver provides link aggregation, failover and fault tolerance. Discussed on: current@
2007-04-17 00:35:11 +00:00
from the aggregation interface.
.It Cm laggproto Ar proto
Set the aggregation protocol.
Virtualize lagg(4) cloner. This change fixes a panic when tearing down if_lagg(4) interfaces which were cloned in a vnet jail. Sysctl nodes which are dynamically generated for each cloned interface (net.link.lagg.N.*) have been removed, and use_flowid and flowid_shift ifconfig(8) parameters have been added instead. Flags and per-interface statistics counters are displayed in "ifconfig -v". CR: D842
2014-10-01 21:37:32 +00:00
The default is
.Li failover .
The available options are
.Li failover ,
.Li lacp ,
.Li loadbalance ,
.Li roundrobin ,
.Li broadcast
and
.Li none .
Add the ability to set which packet layers are used for the load balance hash calculation.
2012-03-06 22:58:13 +00:00
.It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
Set the packet layers to hash for aggregation protocols which load balance.
The default is
.Dq l2,l3,l4 .
The options can be combined using commas.
.Pp
.Bl -tag -width ".Cm l2" -compact
.It Cm l2
src/dst mac address and optional vlan number.
.It Cm l3
src/dst address for IPv4 or IPv6.
.It Cm l4
Fix typo and bump the document date which I also forgot. Spotted by: Andrey Zonov
2012-03-07 06:25:17 +00:00
src/dst port for TCP/UDP/SCTP.
Add the ability to set which packet layers are used for the load balance hash calculation.
2012-03-06 22:58:13 +00:00
.El
ifconfig.4, lagg.4: fix documentation bug: -use_flowid needs to be used to force local hash computation and disable usage of RSS hash provided by driver. PR: 234242 MFC after: 1 week
2018-12-22 11:38:54 +00:00
.It Cm -use_flowid
Virtualize lagg(4) cloner. This change fixes a panic when tearing down if_lagg(4) interfaces which were cloned in a vnet jail. Sysctl nodes which are dynamically generated for each cloned interface (net.link.lagg.N.*) have been removed, and use_flowid and flowid_shift ifconfig(8) parameters have been added instead. Flags and per-interface statistics counters are displayed in "ifconfig -v". CR: D842
2014-10-01 21:37:32 +00:00
Enable local hash computation for RSS hash on the interface.
The
.Li loadbalance
and
.Li lacp
modes will use the RSS hash from the network card if available
to avoid computing one, this may give poor traffic distribution
if the hash is invalid or uses less of the protocol header information.
ifconfig.4, lagg.4: fix documentation bug: -use_flowid needs to be used to force local hash computation and disable usage of RSS hash provided by driver. PR: 234242 MFC after: 1 week
2018-12-22 11:38:54 +00:00
.Cm -use_flowid
Virtualize lagg(4) cloner. This change fixes a panic when tearing down if_lagg(4) interfaces which were cloned in a vnet jail. Sysctl nodes which are dynamically generated for each cloned interface (net.link.lagg.N.*) have been removed, and use_flowid and flowid_shift ifconfig(8) parameters have been added instead. Flags and per-interface statistics counters are displayed in "ifconfig -v". CR: D842
2014-10-01 21:37:32 +00:00
disables use of RSS hash from the network card.
The default value can be set via the
.Va net.link.lagg.default_use_flowid
.Xr sysctl 8
variable.
.Li 0
means
.Dq disabled
and
.Li 1
means
.Dq enabled .
ifconfig.4, lagg.4: fix documentation bug: -use_flowid needs to be used to force local hash computation and disable usage of RSS hash provided by driver. PR: 234242 MFC after: 1 week
2018-12-22 11:38:54 +00:00
.It Cm use_flowid
Use the RSS hash from the network card if available.
Virtualize lagg(4) cloner. This change fixes a panic when tearing down if_lagg(4) interfaces which were cloned in a vnet jail. Sysctl nodes which are dynamically generated for each cloned interface (net.link.lagg.N.*) have been removed, and use_flowid and flowid_shift ifconfig(8) parameters have been added instead. Flags and per-interface statistics counters are displayed in "ifconfig -v". CR: D842
2014-10-01 21:37:32 +00:00
.It Cm flowid_shift Ar number
Set a shift parameter for RSS local hash computation.
Hash is calculated by using flowid bits in a packet header mbuf
which are shifted by the number of this parameter.
Select lacp egress ports based on NUMA domain This change creates an array of port maps indexed by numa domain for lacp port selection. If we have lacp interfaces in more than one domain, then we select the egress port by indexing into the numa port maps and picking a port on the appropriate numa domain. This is behavior is controlled by the new ifconfig use_numa flag and net.link.lagg.use_numa sysctl/tunable (both modeled after the existing use_flowid), which default to enabled. Reviewed by: bz, hselasky, markj (and scottl, earlier version) Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D20060
2019-05-03 14:43:21 +00:00
.It Cm use_numa
Enable selection of egress ports based on the native
.Xr NUMA 4
domain for the packets being transmitted.
This is currently only implemented for lacp mode.
This works only on
.Xr NUMA 4
hardware, running a kernel compiled with the
.Xr NUMA 4
option, and when interfaces from multiple
.Xr NUMA 4
domains are ports of the aggregation interface.
.It Cm -use_numa
Disable selection of egress ports based on the native
.Xr NUMA 4
domain for the packets being transmitted.
Make LAG LACP fast timeout tunable through IOCTL. Differential Revision: D3300 Submitted by: LN Sundararajan <lakshmi.n at msystechnologies> Reviewed by: wblock, smh, gnn, hiren, rpokala at panasas MFC after: 2 weeks Sponsored by: Panasas
2015-08-12 20:21:04 +00:00
.It Cm lacp_fast_timeout
Enable lacp fast-timeout on the interface.
.It Cm -lacp_fast_timeout
Disable lacp fast-timeout on the interface.
Add sysctl to control LACP strict compliance default Add net.link.lagg.lacp.default_strict_mode which defines the default value for LACP strict compliance for created lagg devices. Also: * Add lacp_strict option to ifconfig(8). * Fix lagg(4) creation examples. * Minor style(9) fix. MFC after: 1 week
2015-11-06 15:33:27 +00:00
.It Cm lacp_strict
Enable lacp strict compliance on the interface.
The default value can be set via the
.Va net.link.lagg.lacp.default_strict_mode
.Xr sysctl 8
variable.
.Li 0
means
.Dq disabled
and
.Li 1
means
.Dq enabled .
.It Cm -lacp_strict
Disable lacp strict compliance on the interface.
lagg: Clean up handling of the rr_limit option. - Don't allow an unprivileged user to set the stride. [1] - Only set the stride under the softc lock. - Rename the internal fields to accurately reflect their use. Keep ro_bkt to avoid changing the user API. - Simplify the implementation. The port index is just sc_seq / stride. - Document rr_limit in ifconfig.8. Reported by: Ilja Van Sprundel <ivansprundel@ioactive.com> [1] MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D22857
2019-12-22 21:56:47 +00:00
.It Cm rr_limit Ar number
Configure a stride for an interface in round-robin mode.
The default stride is 1.
Hook trunk(4) up to the build.
2007-04-10 00:35:31 +00:00
.El
.Pp
Document in ifconfig(8) that gre(4) accepts tunnel commands - Also ensure wording is consistent for gif and gre Reviewed by: wblock Differential Revision: https://reviews.freebsd.org/D5667
2017-04-29 15:35:30 +00:00
The following parameters apply to IP tunnel interfaces,
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.Xr gif 4 :
.Bl -tag -width indent
.It Cm tunnel Ar src_addr dest_addr
Configure the physical source and destination address for IP tunnel
interfaces.
The arguments
.Ar src_addr
and
.Ar dest_addr
are interpreted as the outer source/destination for the encapsulating
IPv4/IPv6 header.
For the sake of consistency and easier typing, introduce "-tunnel" as an alias for "deletetunnel". The latter is overly long and prone to typos, but keep it for POLA since it costs nothing. MFC after: 5 days
2005-09-29 23:53:29 +00:00
.It Fl tunnel
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
Unconfigure the physical source and destination address for IP tunnel
interfaces previously configured with
.Cm tunnel .
For the sake of consistency and easier typing, introduce "-tunnel" as an alias for "deletetunnel". The latter is overly long and prone to typos, but keep it for POLA since it costs nothing. MFC after: 5 days
2005-09-29 23:53:29 +00:00
.It Cm deletetunnel
Another name for the
.Fl tunnel
parameter.
Document accept_rev_ethip_ver and send_rev_ethip_ver flags of EtherIP (gif(4) + if_bridge(8)). MFC after: 3 days
2009-09-12 22:17:13 +00:00
.It Cm accept_rev_ethip_ver
Spelling fixes.
2010-07-31 21:09:49 +00:00
Set a flag to accept both correct EtherIP packets and ones
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
with reversed version field.
Enabled by default.
Document accept_rev_ethip_ver and send_rev_ethip_ver flags of EtherIP (gif(4) + if_bridge(8)). MFC after: 3 days
2009-09-12 22:17:13 +00:00
This is for backward compatibility with
.Fx 6.1 ,
6.2, 6.3, 7.0, and 7.1.
.It Cm -accept_rev_ethip_ver
Clear a flag
.Cm accept_rev_ethip_ver .
Add an ability accept encapsulated packets from different sources by one gif(4) interface. Add new option "ignore_source" for gif(4) interface. When it is enabled, gif's encapcheck function requires match only for packet's destination address. Differential Revision: https://reviews.freebsd.org/D2004 Obtained from: Yandex LLC MFC after: 2 weeks Sponsored by: Yandex LLC
2015-05-15 12:19:45 +00:00
.It Cm ignore_source
Set a flag to accept encapsulated packets destined to this host
independently from source address.
This may be useful for hosts, that receive encapsulated packets
from the load balancers.
.It Cm -ignore_source
Clear a flag
.Cm ignore_source .
Document accept_rev_ethip_ver and send_rev_ethip_ver flags of EtherIP (gif(4) + if_bridge(8)). MFC after: 3 days
2009-09-12 22:17:13 +00:00
.It Cm send_rev_ethip_ver
Set a flag to send EtherIP packets with reversed version
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
field intentionally.
Disabled by default.
Document accept_rev_ethip_ver and send_rev_ethip_ver flags of EtherIP (gif(4) + if_bridge(8)). MFC after: 3 days
2009-09-12 22:17:13 +00:00
This is for backward compatibility with
.Fx 6.1 ,
6.2, 6.3, 7.0, and 7.1.
.It Cm -send_rev_ethip_ver
Clear a flag
.Cm send_rev_ethip_ver .
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.El
.Pp
Document in ifconfig(8) that gre(4) accepts tunnel commands - Also ensure wording is consistent for gif and gre Reviewed by: wblock Differential Revision: https://reviews.freebsd.org/D5667
2017-04-29 15:35:30 +00:00
The following parameters apply to GRE tunnel interfaces,
Add support for the optional key in the GRE header. PR: kern/114714 Submitted by: Cristian KLEIN
2008-06-20 17:26:34 +00:00
.Xr gre 4 :
.Bl -tag -width indent
Document in ifconfig(8) that gre(4) accepts tunnel commands - Also ensure wording is consistent for gif and gre Reviewed by: wblock Differential Revision: https://reviews.freebsd.org/D5667
2017-04-29 15:35:30 +00:00
.It Cm tunnel Ar src_addr dest_addr
Configure the physical source and destination address for GRE tunnel
interfaces.
The arguments
.Ar src_addr
and
.Ar dest_addr
are interpreted as the outer source/destination for the encapsulating
IPv4/IPv6 header.
.It Fl tunnel
Unconfigure the physical source and destination address for GRE tunnel
interfaces previously configured with
.Cm tunnel .
.It Cm deletetunnel
Another name for the
.Fl tunnel
parameter.
Add support for the optional key in the GRE header. PR: kern/114714 Submitted by: Cristian KLEIN
2008-06-20 17:26:34 +00:00
.It Cm grekey Ar key
Configure the GRE key to be used for outgoing packets.
Note that
.Xr gre 4 will always accept GRE packets with invalid or absent keys.
This command will result in a four byte MTU reduction on the interface.
.El
.Pp
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
The following parameters are specific to
Document the pfsync(4) specific maxupd parameter, with text mostly taken from OpenBSD's manpage. PR: docs/89256 Submitted by: Pim van Pelt <pim at ipng dot nl> MFC after: 3 days
2005-12-16 11:38:18 +00:00
.Xr pfsync 4
interfaces:
.Bl -tag -width indent
Document syncdev, syncpeer and defer keywords for pfsync(4) interfaces.
2012-04-03 18:11:30 +00:00
.It Cm syncdev Ar iface
Use the specified interface
to send and receive pfsync state synchronisation messages.
.It Fl syncdev
Stop sending pfsync state synchronisation messages over the network.
.It Cm syncpeer Ar peer_address
Make the pfsync link point-to-point rather than using
multicast to broadcast the state synchronisation messages.
The peer_address is the IP address of the other host taking part in
the pfsync cluster.
.It Fl syncpeer
Broadcast the packets using multicast.
Document the pfsync(4) specific maxupd parameter, with text mostly taken from OpenBSD's manpage. PR: docs/89256 Submitted by: Pim van Pelt <pim at ipng dot nl> MFC after: 3 days
2005-12-16 11:38:18 +00:00
.It Cm maxupd Ar n
Set the maximum number of updates for a single state which
can be collapsed into one.
Markup fixes.
2006-09-18 11:55:10 +00:00
This is an 8-bit number; the default value is 128.
Document syncdev, syncpeer and defer keywords for pfsync(4) interfaces.
2012-04-03 18:11:30 +00:00
.It Cm defer
Remove end of line whitespace introduced in previous commit.
2012-04-07 09:11:07 +00:00
Defer transmission of the first packet in a state until a peer has
Document syncdev, syncpeer and defer keywords for pfsync(4) interfaces.
2012-04-03 18:11:30 +00:00
acknowledged that the associated state has been inserted.
.It Fl defer
Do not defer the first packet in a state.
This is the default.
Document the pfsync(4) specific maxupd parameter, with text mostly taken from OpenBSD's manpage. PR: docs/89256 Submitted by: Pim van Pelt <pim at ipng dot nl> MFC after: 3 days
2005-12-16 11:38:18 +00:00
.El
.Pp
The following parameters are specific to
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.Xr vlan 4
interfaces:
.Bl -tag -width indent
.It Cm vlan Ar vlan_tag
Set the VLAN tag value to
.Ar vlan_tag .
Adjust the VLAN section of the ifconfig(8) man page to better reflect reality: 1. Only 12-bit VLAN Identifiers, not full 16-bit VLAN tags can be set using ifconfig vlan. 2. When we mean VLAN Identifiers, spell it that way, rather than as VLAN tag. MFC after: 3 days Sponsored by: Adara Networks, Inc.
2012-01-04 21:04:57 +00:00
This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
Add support for stacked VLANs (IEEE 802.1ad, AKA Q-in-Q). 802.1ad interfaces are created with ifconfig using the "vlanproto" parameter. Eg., the following creates a 802.1Q VLAN (id #42) over a 802.1ad S-VLAN (id #5) over a physical Ethernet interface (em0). ifconfig vlan5 create vlandev em0 vlan 5 vlanproto 802.1ad up ifconfig vlan42 create vlandev vlan5 vlan 42 inet 10.5.42.1/24 VLAN_MTU, VLAN_HWCSUM and VLAN_TSO capabilities should be properly supported. VLAN_HWTAGGING is only partially supported, as there is currently no IFCAP_VLAN_* denoting the possibility to set the VLAN EtherType to anything else than 0x8100 (802.1ad uses 0x88A8). Submitted by: Olivier Piras Sponsored by: RG Nets Differential Revision: https://reviews.freebsd.org/D26436
2020-10-21 21:28:20 +00:00
or 802.1ad VLAN header for packets sent from the
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.Xr vlan 4
interface.
Note that
.Cm vlan
and
.Cm vlandev
must both be set at the same time.
Add support for stacked VLANs (IEEE 802.1ad, AKA Q-in-Q). 802.1ad interfaces are created with ifconfig using the "vlanproto" parameter. Eg., the following creates a 802.1Q VLAN (id #42) over a 802.1ad S-VLAN (id #5) over a physical Ethernet interface (em0). ifconfig vlan5 create vlandev em0 vlan 5 vlanproto 802.1ad up ifconfig vlan42 create vlandev vlan5 vlan 42 inet 10.5.42.1/24 VLAN_MTU, VLAN_HWCSUM and VLAN_TSO capabilities should be properly supported. VLAN_HWTAGGING is only partially supported, as there is currently no IFCAP_VLAN_* denoting the possibility to set the VLAN EtherType to anything else than 0x8100 (802.1ad uses 0x88A8). Submitted by: Olivier Piras Sponsored by: RG Nets Differential Revision: https://reviews.freebsd.org/D26436
2020-10-21 21:28:20 +00:00
.It Cm vlanproto Ar vlan_proto
Set the VLAN encapsulation protocol to
.Ar vlan_proto .
Supported encapsulation protocols are currently
.Dq 802.1Q
and
.Dq 802.1ad .
The default encapsulation protocol is
.Dq 802.1Q .
Add support to priority code point (PCP) that is an 3-bit field which refers to IEEE 802.1p class of service and maps to the frame priority level. Values in order of priority are: 1 (Background (lowest)), 0 (Best effort (default)), 2 (Excellent effort), 3 (Critical applications), 4 (Video, < 100ms latency), 5 (Video, < 10ms latency), 6 (Internetwork control) and 7 (Network control (highest)). Example of usage: root# ifconfig em0.1 create root# ifconfig em0.1 vlanpcp 3 Note: The review D801 includes the pf(4) part, but as discussed with kristof, we won't commit the pf(4) bits for now. The credits of the original code is from rwatson. Differential Revision: https://reviews.freebsd.org/D801 Reviewed by: gnn, adrian, loos Discussed with: rwatson, glebius, kristof Tested by: many including Matthew Grooms <mgrooms__shrew.net> Obtained from: pfSense Relnotes: Yes
2016-06-06 09:51:58 +00:00
.It Cm vlanpcp Ar priority_code_point
Add an option called "random" that combined with "ether" can generate a random MAC address for an Ethernet interface. PR: 211984 Submitted by: pi@ Reviewed by: gnn, cem, jhb, lidl, rpokala, wblock Approved by: wblock (manpages)
2016-09-16 04:22:21 +00:00
Priority code point
Add support to priority code point (PCP) that is an 3-bit field which refers to IEEE 802.1p class of service and maps to the frame priority level. Values in order of priority are: 1 (Background (lowest)), 0 (Best effort (default)), 2 (Excellent effort), 3 (Critical applications), 4 (Video, < 100ms latency), 5 (Video, < 10ms latency), 6 (Internetwork control) and 7 (Network control (highest)). Example of usage: root# ifconfig em0.1 create root# ifconfig em0.1 vlanpcp 3 Note: The review D801 includes the pf(4) part, but as discussed with kristof, we won't commit the pf(4) bits for now. The credits of the original code is from rwatson. Differential Revision: https://reviews.freebsd.org/D801 Reviewed by: gnn, adrian, loos Discussed with: rwatson, glebius, kristof Tested by: many including Matthew Grooms <mgrooms__shrew.net> Obtained from: pfSense Relnotes: Yes
2016-06-06 09:51:58 +00:00
.Pq Dv PCP
is an 3-bit field which refers to the IEEE 802.1p
class of service and maps to the frame priority level.
.Pp
Values in order of priority are:
Add an option called "random" that combined with "ether" can generate a random MAC address for an Ethernet interface. PR: 211984 Submitted by: pi@ Reviewed by: gnn, cem, jhb, lidl, rpokala, wblock Approved by: wblock (manpages)
2016-09-16 04:22:21 +00:00
.Cm 1
Add support to priority code point (PCP) that is an 3-bit field which refers to IEEE 802.1p class of service and maps to the frame priority level. Values in order of priority are: 1 (Background (lowest)), 0 (Best effort (default)), 2 (Excellent effort), 3 (Critical applications), 4 (Video, < 100ms latency), 5 (Video, < 10ms latency), 6 (Internetwork control) and 7 (Network control (highest)). Example of usage: root# ifconfig em0.1 create root# ifconfig em0.1 vlanpcp 3 Note: The review D801 includes the pf(4) part, but as discussed with kristof, we won't commit the pf(4) bits for now. The credits of the original code is from rwatson. Differential Revision: https://reviews.freebsd.org/D801 Reviewed by: gnn, adrian, loos Discussed with: rwatson, glebius, kristof Tested by: many including Matthew Grooms <mgrooms__shrew.net> Obtained from: pfSense Relnotes: Yes
2016-06-06 09:51:58 +00:00
.Pq Dv Background (lowest) ,
.Cm 0
.Pq Dv Best effort (default) ,
.Cm 2
.Pq Dv Excellent effort ,
.Cm 3
.Pq Dv Critical applications ,
.Cm 4
.Pq Dv Video, < 100ms latency ,
.Cm 5
.Pq Dv Video, < 10ms latency ,
.Cm 6
.Pq Dv Internetwork control ,
.Cm 7
.Pq Dv Network control (highest) .
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.It Cm vlandev Ar iface
Associate the physical interface
.Ar iface
with a
.Xr vlan 4
interface.
Packets transmitted through the
.Xr vlan 4
interface will be
diverted to the specified physical interface
.Ar iface
with 802.1Q VLAN encapsulation.
Packets with 802.1Q encapsulation received
Adjust the VLAN section of the ifconfig(8) man page to better reflect reality: 1. Only 12-bit VLAN Identifiers, not full 16-bit VLAN tags can be set using ifconfig vlan. 2. When we mean VLAN Identifiers, spell it that way, rather than as VLAN tag. MFC after: 3 days Sponsored by: Adara Networks, Inc.
2012-01-04 21:04:57 +00:00
by the parent interface with the correct VLAN Identifier will be diverted to
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
the associated
.Xr vlan 4
pseudo-interface.
The
.Xr vlan 4
interface is assigned a
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
copy of the parent interface's flags and the parent's Ethernet address.
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
The
.Cm vlandev
and
.Cm vlan
must both be set at the same time.
If the
.Xr vlan 4
interface already has
a physical interface associated with it, this command will fail.
To
change the association to another physical interface, the existing
association must be cleared first.
.Pp
Note: if the hardware tagging capability
is set on the parent interface, the
.Xr vlan 4
pseudo
interface's behavior changes:
the
.Xr vlan 4
interface recognizes that the
parent interface supports insertion and extraction of VLAN tags on its
own (usually in firmware) and that it should pass packets to and from
the parent unaltered.
Deprecate the useless argument to -vlandev. Submitted by: Fredrik Lindberg <fli+freebsd-current at shapeshifter.se> (implementation) Reviewed by: brooks MFC after: 5 days
2005-09-29 23:38:24 +00:00
.It Fl vlandev Op Ar iface
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
If the driver is a
.Xr vlan 4
Deprecate the useless argument to -vlandev. Submitted by: Fredrik Lindberg <fli+freebsd-current at shapeshifter.se> (implementation) Reviewed by: brooks MFC after: 5 days
2005-09-29 23:38:24 +00:00
pseudo device, disassociate the parent interface from it.
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
This breaks the link between the
.Xr vlan 4
interface and its parent,
Adjust the VLAN section of the ifconfig(8) man page to better reflect reality: 1. Only 12-bit VLAN Identifiers, not full 16-bit VLAN tags can be set using ifconfig vlan. 2. When we mean VLAN Identifiers, spell it that way, rather than as VLAN tag. MFC after: 3 days Sponsored by: Adara Networks, Inc.
2012-01-04 21:04:57 +00:00
clears its VLAN Identifier, flags and its link address and shuts the interface
down.
Deprecate the useless argument to -vlandev. Submitted by: Fredrik Lindberg <fli+freebsd-current at shapeshifter.se> (implementation) Reviewed by: brooks MFC after: 5 days
2005-09-29 23:38:24 +00:00
The
.Ar iface
argument is useless and hence deprecated.
Since special interface types get their own subsections (not in mdoc(7) sense yet) in ifconfig(8) manpage, create such subsections for gif(4) and vlan(4) so that their specific options are not mixed up with general options.
2005-09-22 11:49:52 +00:00
.El
.Pp
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
The following parameters are used to configure
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
.Xr vxlan 4
interfaces.
.Bl -tag -width indent
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanid Ar identifier
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
virtual network segment membership of the interface.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanlocal Ar address
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The source address used in the encapsulating IPv4/IPv6 header.
The address should already be assigned to an existing interface.
When the interface is configured in unicast mode, the listening socket
is bound to this address.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanremote Ar address
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The interface can be configured in a unicast, or point-to-point, mode
to create a tunnel between two hosts.
This is the IP address of the remote end of the tunnel.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlangroup Ar address
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The interface can be configured in a multicast mode
to create a virtual network of hosts.
This is the IP multicast group address the interface will join.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanlocalport Ar port
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The port number the interface will listen on.
The default port number is 4789.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanremoteport Ar port
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The destination port number used in the encapsulating IPv4/IPv6 header.
The remote host should be listening on this port.
The default port number is 4789.
Note some other implementations, such as Linux,
do not default to the IANA assigned port,
but instead listen on port 8472.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanportrange Ar low high
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The range of source ports used in the encapsulating IPv4/IPv6 header.
The port selected within the range is based on a hash of the inner frame.
A range is useful to provide entropy within the outer IP header
for more effective load balancing.
The default range is between the
.Xr sysctl 8
variables
.Va net.inet.ip.portrange.first
and
.Va net.inet.ip.portrange.last
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlantimeout Ar timeout
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The maximum time, in seconds, before an entry in the forwarding table
is pruned.
The default is 1200 seconds (20 minutes).
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanmaxaddr Ar max
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The maximum number of entries in the forwarding table.
The default is 2000.
.It Cm vxlandev Ar dev
When the interface is configured in multicast mode, the
.Cm dev
interface is used to transmit IP multicast packets.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanttl Ar ttl
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The TTL used in the encapsulating IPv4/IPv6 header.
The default is 64.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanlearn
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
The source IP address and inner source Ethernet MAC address of
received packets are used to dynamically populate the forwarding table.
When in multicast mode, an entry in the forwarding table allows the
interface to send the frame directly to the remote host instead of
broadcasting the frame to the multicast group.
This is the default.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Fl vxlanlearn
Add an option called "random" that combined with "ether" can generate a random MAC address for an Ethernet interface. PR: 211984 Submitted by: pi@ Reviewed by: gnn, cem, jhb, lidl, rpokala, wblock Approved by: wblock (manpages)
2016-09-16 04:22:21 +00:00
The forwarding table is not populated by received packets.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanflush
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
Delete all dynamically-learned addresses from the forwarding table.
Prefix all the vxlan ifconfig commands so they are unique And rehook ifvxlan back into the build.
2014-12-17 05:36:34 +00:00
.It Cm vxlanflushall
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
Delete all addresses, including static addresses, from the forwarding table.
.El
.Pp
The following parameters are used to configure
Document carp(4) arguments. PR: docs/92653 Submitted by: Jeremy C. Reed <reed@reedmedia.net> Reviewed by: ru Approved by: trhodes (mentor) MFC after: 5 days
2006-02-03 14:41:41 +00:00
.Xr carp 4
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
protocol on an interface:
Document carp(4) arguments. PR: docs/92653 Submitted by: Jeremy C. Reed <reed@reedmedia.net> Reviewed by: ru Approved by: trhodes (mentor) MFC after: 5 days
2006-02-03 14:41:41 +00:00
.Bl -tag -width indent
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
.It Cm vhid Ar n
Set the virtual host ID.
This is a required setting to initiate
.Xr carp 4 .
Remove fifteen-year-old notes on media selection (suggested by simon@). Add commas after "e.g." and "i.e.". Change "silent" to "silence" in wireless create section (reviewed by adri@). MFC after: 1 week
2012-11-07 19:26:32 +00:00
If the virtual host ID does not exist yet, it is created and attached to the
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
interface, otherwise configuration of an existing vhid is adjusted.
If the
.Cm vhid
keyword is supplied along with an
.Dq inet6
or
.Dq inet
address, then this address is configured to be run under control of the
specified vhid.
Whenever a last address that refers to a particular vhid is removed from an
interface, the vhid is automatically removed from interface and destroyed.
Any other configuration parameters for the
.Xr carp 4
protocol should be supplied along with the
.Cm vhid
keyword.
Acceptable values for vhid are 1 to 255.
Document carp(4) arguments. PR: docs/92653 Submitted by: Jeremy C. Reed <reed@reedmedia.net> Reviewed by: ru Approved by: trhodes (mentor) MFC after: 5 days
2006-02-03 14:41:41 +00:00
.It Cm advbase Ar seconds
Specifies the base of the advertisement interval in seconds.
The acceptable values are 1 to 255.
The default value is 1.
.It Cm advskew Ar interval
Specifies the skew to add to the base advertisement interval to
make one host advertise slower than another host.
It is specified in 1/256 of seconds.
The acceptable values are 1 to 254.
The default value is 0.
.It Cm pass Ar phrase
Set the authentication key to
.Ar phrase .
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
.It Cm state Ar MASTER|BACKUP
Forcibly change state of a given vhid.
Document carp(4) arguments. PR: docs/92653 Submitted by: Jeremy C. Reed <reed@reedmedia.net> Reviewed by: ru Approved by: trhodes (mentor) MFC after: 5 days
2006-02-03 14:41:41 +00:00
.El
.Pp
The .Nm utility
2002-07-06 19:34:18 +00:00
The
.Nm
utility displays the current configuration for a network interface
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
when no optional parameters are supplied.
If a protocol family is specified,
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
.Nm
will report only the details specific to that protocol family.
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Pp
When using interfaces that support if_media, the supported media list is printed on a single, very long, and generally unreadable line. This isn't very useful. It's also really ugly and most of the time you don't care what media is supported anyway. PR: 27701 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-29 09:13:44 +00:00
If the
.Fl m
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
flag is passed before an interface name,
.Nm
Document that -m also causes the capability list to be displayed.
2004-04-11 13:44:57 +00:00
will display the capability list and all
When using interfaces that support if_media, the supported media list is printed on a single, very long, and generally unreadable line. This isn't very useful. It's also really ugly and most of the time you don't care what media is supported anyway. PR: 27701 Submitted by: Brooks Davis <brooks@one-eyed-alien.net>
2001-05-29 09:13:44 +00:00
of the supported media for the specified interface.
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
If
.Fl L
Add 'netrange' parameter to 'range' command and fix a couple of typos. PR: 23984 Submitted by: Jimmy Olgeni <olgeni@uli.it>
2001-01-20 21:37:37 +00:00
flag is supplied, address lifetime is displayed for IPv6 addresses,
udp IPv6 support, IPv6/IPv4 tunneling support in kernel, packet divert at kernel for IPv6/IPv4 translater daemon This includes queue related patch submitted by jburkhol@home.com. Submitted by: queue related patch from jburkhol@home.com Reviewed by: freebsd-arch, cvs-committers Obtained from: KAME project
1999-12-07 17:39:16 +00:00
as time offset string.
.Pp
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
Optionally, the
.Fl a
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
flag may be used instead of an interface name.
This flag instructs
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Nm
to display information about all interfaces in the system.
Update man page to allow adding address_family when -l is used (this is a no op for now). Correct use of .Nm. Short usage string (see man page for full list). Spelling. Use err(3).
1998-07-06 06:53:43 +00:00
The
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Fl d
ifconfig(8): make it possible to filter output by interface group. Now options -g/-G allow to select/unselect interfaces by groups in the "ifconfig -a" output just like already existing -d/-u. Examples: to exclude loopback from the list: ifconfig -a -G lo to show vlan interfaces only: ifconfig -a -g vlan to show tap interfaces that are up: ifconfig -aug tap Arguments to -g/-G may be shell patterns and both may be specified. Later options -g/-G override previous ones. MFC after: 2 weeks Relnotes: yes Differential Revision: https://reviews.freebsd.org/D25029
2020-06-04 14:44:44 +00:00
flag limits this to interfaces that are down,
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Fl u
ifconfig(8): make it possible to filter output by interface group. Now options -g/-G allow to select/unselect interfaces by groups in the "ifconfig -a" output just like already existing -d/-u. Examples: to exclude loopback from the list: ifconfig -a -G lo to show vlan interfaces only: ifconfig -a -g vlan to show tap interfaces that are up: ifconfig -aug tap Arguments to -g/-G may be shell patterns and both may be specified. Later options -g/-G override previous ones. MFC after: 2 weeks Relnotes: yes Differential Revision: https://reviews.freebsd.org/D25029
2020-06-04 14:44:44 +00:00
limits this to interfaces that are up,
.Fl g
limits this to members of the specified group of interfaces, and
.Fl G
excludes members of the specified group from the list.
Both
.Fl g
and
.Fl G
flags may be specified to apply both conditions.
Only one option
.Fl g
should be specified as later override previous ones
(same for
.Fl G ) .
.Sy groupname
may contain shell patterns in which case it should be quoted.
Show the actual command line usage in the man page and usage error string.
2000-07-19 17:24:53 +00:00
When no arguments are given,
.Fl a
is implied.
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
.Pp
The
.Fl l
flag may be used to list all available interfaces on the system, with
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
no other additional information.
improve ifconfig(8) man page by describing special behaviour of -l ether PR: docs/187644 Submitted by: Andrew Merenbach (original patch) Approved by: bcr (mentor)
2014-05-27 20:45:15 +00:00
If an
.Ar address_family
is specified, only interfaces of that type will be listed.
.Fl l Dq ether
Style cleanups on ifconfig.8 fix igor warnings uppercase all instances of Ethernet replace bad e.g. CR: D91 Approved by: wblock (mentor)
2014-06-06 00:22:19 +00:00
will list only Ethernet adapters, excluding the loopback interface.
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
Use of this flag is mutually exclusive
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
with all other flags and commands, except for
.Fl d
(only list interfaces that are down)
and
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.Fl u
Grab some of the NetBSD text for describing the new options and the media commands.
1997-05-03 23:03:56 +00:00
(only list interfaces that are up).
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Pp
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
The
Overhaul to cleanup some of the tangled logic that's grown over the years. o break per-address family support out into separate files o modularize per-address family and functional operations using a registration mechanism; this permits configuration according to which files you include (but beware that order of the files is important to insure backwards compatibility) o many cleanups to eliminate incestuous behaviour, global variables, and poor coding practices (still much more to fix) The original motivation of this work was to support dynamic addition of functionality based on the interface so we can eliminate the various little control programs and so that vendors can distribute ifconfig plugins that support their in-kernel code. That work is still to be completed. o Update 802.11 support for all the new net80211 functionality; some of these operations (e.g. list *) may be better suited in a different program
2004-12-08 19:18:07 +00:00
.Fl v
flag may be used to get more verbose status for an interface.
.Pp
The
Support network device cloning via create and destroy options. Reviewed by: ru, ume Obtained from: NetBSD MFC after: 1 week
2001-07-02 20:52:34 +00:00
.Fl C
flag may be used to list all of the interface cloners available on
the system, with no additional information.
Use of this flag is mutually exclusive with all other flags and commands.
.Pp
Add a new flag '-k' to ifconfig(8), indicating that it is alright to print potentially sensitive keying material to stdout. With the new 802.11 support, ifconfig(8) is now capable of printing 802.11 keys, and did by default for the root user, which is undesirable in some environments. Now it will not print keying material unless requested (and available to the user). MFC after: 1 week
2005-07-14 18:33:21 +00:00
The
.Fl k
flag causes keying information for the interface, if available, to be
printed.
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
For example, the values of 802.11 WEP keys and
.Xr carp 4
passphrases will be printed, if accessible to the current user.
Add a new flag '-k' to ifconfig(8), indicating that it is alright to print potentially sensitive keying material to stdout. With the new 802.11 support, ifconfig(8) is now capable of printing 802.11 keys, and did by default for the root user, which is undesirable in some environments. Now it will not print keying material unless requested (and available to the user). MFC after: 1 week
2005-07-14 18:33:21 +00:00
This information is not printed by default, as it may be considered
sensitive.
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days
2012-03-29 05:02:12 +00:00
.Pp
Add the -n flag for disabling automatic module loading, this will be used by rc.d to stop it reloading the network module on unload.
2007-05-22 17:41:09 +00:00
If the network interface driver is not present in the kernel then
.Nm
will attempt to load it.
The
.Fl n
flag disables this behavior.
Add a new flag '-k' to ifconfig(8), indicating that it is alright to print potentially sensitive keying material to stdout. With the new 802.11 support, ifconfig(8) is now capable of printing 802.11 keys, and did by default for the root user, which is undesirable in some environments. Now it will not print keying material unless requested (and available to the user). MFC after: 1 week
2005-07-14 18:33:21 +00:00
.Pp
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
Only the super-user may modify the configuration of a network interface.
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
.Sh EXAMPLES
Assign the IPv4 address
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
.Li 192.0.2.10 ,
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
with a network mask of
.Li 255.255.255.0 ,
to the interface
Change ed(4), ep(4), and fxp(4) examples to em(4). ed(4) and ep(4) have been removed. fxp(4) remains popular in older systems, but isn't as future proof as em(4). Reviewed by: bz, jhb MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20311
2019-05-18 21:01:36 +00:00
.Li em0 :
.Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
.Pp
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
Add the IPv4 address
.Li 192.0.2.45 ,
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
with the CIDR network prefix
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
.Li /28 ,
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
to the interface
Change ed(4), ep(4), and fxp(4) examples to em(4). ed(4) and ep(4) have been removed. fxp(4) remains popular in older systems, but isn't as future proof as em(4). Reviewed by: bz, jhb MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20311
2019-05-18 21:01:36 +00:00
.Li em0 ,
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
using
.Cm add
as a synonym for the canonical form of the option
.Cm alias :
Change ed(4), ep(4), and fxp(4) examples to em(4). ed(4) and ep(4) have been removed. fxp(4) remains popular in older systems, but isn't as future proof as em(4). Reviewed by: bz, jhb MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20311
2019-05-18 21:01:36 +00:00
.Dl # ifconfig em0 inet 192.0.2.45/28 add
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
.Pp
Remove the IPv4 address
.Li 192.0.2.45
from the interface
Change ed(4), ep(4), and fxp(4) examples to em(4). ed(4) and ep(4) have been removed. fxp(4) remains popular in older systems, but isn't as future proof as em(4). Reviewed by: bz, jhb MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D20311
2019-05-18 21:01:36 +00:00
.Li em0 :
.Dl # ifconfig em0 inet 192.0.2.45 -alias
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
.Pp
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
Enable IPv6 functionality of the interface:
.Dl # ifconfig em0 inet6 -ifdisabled
.Pp
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
Add the IPv6 address
.Li 2001:DB8:DBDB::123/48
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
to the interface
.Li em0 :
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
.Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
Note that lower case hexadecimal IPv6 addresses are acceptable.
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
.Pp
Remove the IPv6 address added in the above example,
using the
.Li /
Be explicit in examples about the correct grammar for 'alias' and '-alias', and that 'add' and 'delete are in fact synonyms for these in the ifconfig(8) grammar. Use network prefixes explicitly specified in IETF RFCs for documentation purposes. (bz) PR: 102701 MFC after: 1 day See also: RFC 3330, RFC 3849 Submitted by: bz
2007-02-04 16:48:56 +00:00
character as shorthand for the network prefix,
and using
.Cm delete
as a synonym for the canonical form of the option
.Fl alias :
.Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
.Pp
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
Configure a single CARP redundant address on igb0, and then switch it
to be master:
Provide a working example line for an interface with 1 address running with CARP. Currently, we've got a problem that interface isn't IFF_UP at the time we assign it a redundant address, and the latter gets stuck in INIT state. Additional SIOCSIFFLAGS from ifconfig(8) kicks it to a working state. A proper fix is kernel side and appeared to be non-trivial, not to be checked in before 10.0-RELEASE. Submitted by: Ole Myhre <ole.myhre dataoppdrag.no>
2013-10-21 05:14:00 +00:00
.Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
A major overhaul of the CARP implementation. The ip_carp.c was started from scratch, copying needed functionality from the old implemenation on demand, with a thorough review of all code. The main change is that interface layer has been removed from the CARP. Now redundant addresses are configured exactly on the interfaces, they run on. The CARP configuration itself is, as before, configured and read via SIOCSVH/SIOCGVH ioctls. A new prefix created with SIOCAIFADDR or SIOCAIFADDR_IN6 may now be configured to a particular virtual host id, which makes the prefix redundant. ifconfig(8) semantics has been changed too: now one doesn't need to clone carpXX interface, he/she should directly configure a vhid on a Ethernet interface. To supply vhid data from the kernel to an application the getifaddrs(8) function had been changed to pass ifam_data with each address. [1] The new implementation definitely closes all PRs related to carp(4) being an interface, and may close several others. It also allows to run a single redundant IP per interface. Big thanks to Bjoern Zeeb for his help with inet6 part of patch, for idea on using ifam_data and for several rounds of reviewing! PR: kern/117000, kern/126945, kern/126714, kern/120130, kern/117448 Reviewed by: bz Submitted by: bz [1]
2011-12-16 12:16:56 +00:00
.Dl # ifconfig igb0 vhid 1 state master
.Pp
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
Configure the interface
.Li xl0 ,
to use 100baseTX, full duplex Ethernet media options:
.Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
.Pp
Revised revision 199201 (add interface description capability as inspired by OpenBSD), based on comments from many, including rwatson, jhb, brooks and others. Sponsored by: iXsystems, Inc. MFC after: 1 month
2010-01-27 00:30:07 +00:00
Label the em0 interface as an uplink:
.Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
.Pp
Add an EXAMPLES section to ifconfig(8), clearly showing how to configure IPv6 addresses in FreeBSD. See also: http://www.telscom.ch/index.php/downloads/configure_ipv6_features MFC after: 1 week PR: 102701 Obtained from: OpenBSD (partly, with edits)
2007-02-03 03:37:37 +00:00
Create the software network interface
.Li gif1 :
.Dl # ifconfig gif1 create
.Pp
Destroy the software network interface
.Li gif1 :
.Dl # ifconfig gif1 destroy
Add example of using 'scan' for wireless networks, similarly to OpenBSD's ifconfig(8). PR: 151952 Submitted by: Jared (rhyous of yahoo com) MFC after: 1 week
2011-03-12 19:05:39 +00:00
.Pp
Correct 'list scan' description in the examples. The previous description was incorrect - 'list scan' does not actually do a scan, but instead lists the results of the background 'scan' cache. Submitted by: Fabian Keil (freebsd-listen of fabiankeil de) (via email) Discussed with: bschmidt MFC after: 3 days
2011-04-06 11:20:54 +00:00
Display available wireless networks using
Add example of using 'scan' for wireless networks, similarly to OpenBSD's ifconfig(8). PR: 151952 Submitted by: Jared (rhyous of yahoo com) MFC after: 1 week
2011-03-12 19:05:39 +00:00
.Li wlan0 :
Use 'list scan' in favor of 'scan', as 'scan' has a different purpose. Pointed out by: bschmidt MFC after: 1 day
2011-03-20 22:47:41 +00:00
.Dl # ifconfig wlan0 list scan
ifconfig(8) now supports some output formatting options specified by the -f flag or IFCONFIG_FORMAT environment variable, the user can request that inet4 subnet masks be printed in CIDR or dotted-quad notation, in addition to the traditional hex output. inet6 prefixes can be printed in CIDR as well. For more documentation see the ifconfig(8) man page. PR: 169072 Requested by: seanc, marcel, brd, many others Reviewed by: gnn, jhb (earlier version) Relnotes: yes Sponsored by: ScaleEngine Inc. Differential Revision: https://reviews.freebsd.org/D2856
2016-05-31 17:30:08 +00:00
.Pp
Display inet and inet6 address subnet masks in CIDR notation
.Dl # ifconfig -f inet:cidr,inet6:cidr
ifconfig(8): make it possible to filter output by interface group. Now options -g/-G allow to select/unselect interfaces by groups in the "ifconfig -a" output just like already existing -d/-u. Examples: to exclude loopback from the list: ifconfig -a -G lo to show vlan interfaces only: ifconfig -a -g vlan to show tap interfaces that are up: ifconfig -aug tap Arguments to -g/-G may be shell patterns and both may be specified. Later options -g/-G override previous ones. MFC after: 2 weeks Relnotes: yes Differential Revision: https://reviews.freebsd.org/D25029
2020-06-04 14:44:44 +00:00
.Pp
Display interfaces that are up with the exception of loopback
.Dl # ifconfig -a -u -G lo
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Sh DIAGNOSTICS
Fix typo: exit -> exist
1998-06-08 02:00:45 +00:00
Messages indicating the specified interface does not exist, the
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
requested address is unknown, or the user is not privileged and
tried to alter an interface's configuration.
.Sh SEE ALSO
.Xr netstat 1 ,
Xref carp(4) and polling(4). MFC after: 3 days
2005-03-19 16:14:31 +00:00
.Xr carp 4 ,
Document accept_rev_ethip_ver and send_rev_ethip_ver flags of EtherIP (gif(4) + if_bridge(8)). MFC after: 3 days
2009-09-12 22:17:13 +00:00
.Xr gif 4 ,
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Xr netintro 4 ,
Document the pfsync(4) specific maxupd parameter, with text mostly taken from OpenBSD's manpage. PR: docs/89256 Submitted by: Pim van Pelt <pim at ipng dot nl> MFC after: 3 days
2005-12-16 11:38:18 +00:00
.Xr pfsync 4 ,
Xref carp(4) and polling(4). MFC after: 3 days
2005-03-19 16:14:31 +00:00
.Xr polling 4 ,
We can cross-reference to vlan(4) as long as the corresponding manpage has been committed. The rest of "vlan" words, which are refering to the technology itself, should be capitalized. MFC after: 1 week
2004-02-21 14:21:18 +00:00
.Xr vlan 4 ,
Add vxlan interface vxlan creates a virtual LAN by encapsulating the inner Ethernet frame in a UDP packet. This implementation is based on RFC7348. Currently, the IPv6 support is not fully compliant with the specification: we should be able to receive UPDv6 packets with a zero checksum, but we need to support RFC6935 first. Patches for this should come soon. Encapsulation protocols such as vxlan emphasize the need for the FreeBSD network stack to support batching, GRO, and GSO. Each frame has to make two trips through the network stack, and each frame will be at most MTU sized. Performance suffers accordingly. Some latest generation NICs have begun to support vxlan HW offloads that we should also take advantage of. VIMAGE support should also be added soon. Differential Revision: https://reviews.freebsd.org/D384 Reviewed by: gnn Relnotes: yes
2014-10-20 14:42:42 +00:00
.Xr vxlan 4 ,
Add devd.conf(5) and devd(8) to SEE ALSO xrefs. Give users a pointer to seemingly mysterious actions that are not done by ifconfig itself, but by devd triggering on events caused by ifconfig. PR: docs/173405 Submitted by: Mateusz Kwiatkowski <mateusz.kwiatkowski@atlashost.eu> MFC after: 1 week
2012-11-07 15:59:24 +00:00
.Xr devd.conf 5 ,
mdoc(7) police: fix markup.
2001-07-05 12:37:08 +00:00
.\" .Xr eon 5 ,
Add devd.conf(5) and devd(8) to SEE ALSO xrefs. Give users a pointer to seemingly mysterious actions that are not done by ifconfig itself, but by devd triggering on events caused by ifconfig. PR: docs/173405 Submitted by: Mateusz Kwiatkowski <mateusz.kwiatkowski@atlashost.eu> MFC after: 1 week
2012-11-07 15:59:24 +00:00
.Xr devd 8 ,
mdoc: improvements to SEE ALSO.
2014-12-27 08:22:58 +00:00
.Xr jail 8 ,
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Xr rc 8 ,
mdoc(7) police Submitted by: ru
2004-06-14 19:31:10 +00:00
.Xr routed 8 ,
.Xr sysctl 8
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Sh HISTORY
The
.Nm
The .Nm utility
2002-07-06 19:34:18 +00:00
utility appeared in
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin.
1994-05-26 06:35:07 +00:00
.Bx 4.2 .
Sort sections.
2005-01-18 10:09:38 +00:00
.Sh BUGS
Basic IPv6 node operation requires a link-local address on each
interface configured for IPv6.
Normally, such an address is automatically configured by the
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
kernel on each interface added to the system or enabled; this behavior may
be disabled by setting per-interface flag
.Cm -auto_linklocal .
The default value of this flag is 1 and can be disabled by using the sysctl
MIB variable
.Va net.inet6.ip6.auto_linklocal .
Sort sections.
2005-01-18 10:09:38 +00:00
.Pp
Improve flexibility of receiving Router Advertisement and automatic link-local address configuration: - Convert a sysctl net.inet6.ip6.accept_rtadv to one for the default value of a per-IF flag ND6_IFF_ACCEPT_RTADV, not a global knob. The default value of the sysctl is 0. - Add a new per-IF flag ND6_IFF_AUTO_LINKLOCAL and convert a sysctl net.inet6.ip6.auto_linklocal to one for its default value. The default value of the sysctl is 1. - Make ND6_IFF_IFDISABLED more robust. It can be used to disable IPv6 functionality of an interface now. - Receiving RA is allowed if ip6_forwarding==0 *and* ND6_IFF_ACCEPT_RTADV is set on that interface. The former condition will be revisited later to support a "host + router" box like IPv6 CPE router. The current behavior is compatible with the older releases of FreeBSD. - The ifconfig(8) now supports these ND6 flags as well as "nud", "prefer_source", and "disabled" in ndp(8). The ndp(8) now supports "auto_linklocal". Discussed with: bz and jinmei Reviewed by: bz MFC after: 3 days
2009-09-12 22:08:20 +00:00
Do not configure IPv6 addresses with no link-local address by using
.Nm .
It can result in unexpected behaviors of the kernel.
Reference in New Issue Copy Permalink