1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgment:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
33 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.27.2.22 2003/01/26 03:33:56 keramida Exp $
40 .Nd configure network interface parameters
77 utility is used to assign an address
78 to a network interface and/or configure
79 network interface parameters.
82 utility must be used at boot time to define the network address
83 of each interface present on a machine; it may also be used at
84 a later time to redefine an interface's address
85 or other operating parameters.
87 The following options are available:
88 .Bl -tag -width indent
91 .Tn DARPA Ns -Internet
93 the address is either a host name present in the host name data
98 Internet address expressed in the Internet standard
101 It is also possible to use the CIDR notation (also known as the
102 slash notation) to include the netmask.
103 That is, one can specify an address like
108 family, it is also possible to specify the prefix length using the slash
113 parameter below for more information.
114 .\" For the Xerox Network Systems(tm) family,
116 .\" .Ar net:a.b.c.d.e.f ,
119 .\" is the assigned network number (in decimal),
120 .\" and each of the six bytes of the host number,
124 .\" are specified in hexadecimal.
125 .\" The host number may be omitted on IEEE 802 protocol
126 .\" (Ethernet, FDDI, and Token Ring) interfaces,
127 .\" which use the hardware physical address,
128 .\" and on interfaces other than the first.
131 .\" family, addresses are specified as a long hexadecimal string,
132 .\" as in the Xerox family.
133 .\" However, two consecutive dots imply a zero
134 .\" byte, and the dots are optional, if the user wishes to (carefully)
135 .\" count out long strings of digits in network byte order.
140 is specified as a series of colon-separated hex digits.
142 e.g. set a new MAC address on an ethernet interface, though the
143 mechanism used is not ethernet-specific.
144 If the interface is already
145 up when this option is used, it will be briefly brought down and
146 then brought back up again in order to ensure that the receive
147 filter in the underlying ethernet hardware is properly reprogrammed.
148 .It Ar address_family
151 which affects interpretation of the remaining parameters.
152 Since an interface can receive transmissions in differing protocols
153 with different naming schemes, specifying the address family is recommended.
154 The address or protocol families currently
173 Specify the address of the correspondent on the other end
174 of a point to point link.
177 parameter is a string of the form
183 The following parameters may be set with
185 .Bl -tag -width indent
190 Introduced for compatibility
194 Establish an additional network address for this interface.
195 This is sometimes useful when changing network numbers, and
196 one wishes to accept packets addressed to the old interface.
197 If the address is on the same subnet as the first network address
198 for this interface, a non-conflicting netmask must be given.
203 Remove the network address specified.
204 This would be used if you incorrectly specified an alias, or it
205 was no longer needed.
206 If you have incorrectly set an NS address having the side effect
207 of specifying the host portion, removing all NS addresses will
208 allow you to respecify the host portion.
211 Specify that the address configured is an anycast address.
212 Based on the current specification,
213 only routers may configure anycast addresses.
214 Anycast address will not be used as source address of any of outgoing
217 Enable the use of the Address Resolution Protocol
220 between network level addresses and link level addresses (default).
221 This is currently implemented for mapping between
226 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
228 Disable the use of the Address Resolution Protocol
232 Specify the address to use to represent broadcasts to the
234 The default broadcast address is the address with a host part of all 1's.
236 Enable driver dependent debugging code; usually, this turns on
237 extra console error logging.
239 Disable driver dependent debugging code.
241 Put interface into permanently promiscuous mode.
243 Disable permanently promiscuous mode.
251 When an interface is marked
253 the system will not attempt to
254 transmit messages through that interface.
255 If possible, the interface will be reset to disable reception as well.
256 This action does not automatically disable routes using the interface.
260 (lowermost 64bit of an IPv6 address)
263 .\" This is used to specify an Internet host who is willing to receive
264 .\" ip packets encapsulating NS packets bound for a remote network.
265 .\" An apparent point to point link is constructed, and
266 .\" the address specified will be taken as the NS address and network
267 .\" of the destination.
268 .\" IP encapsulation of
270 .\" packets is done differently.
272 If the driver supports the media selection system, set the media type
275 Some interfaces support the mutually exclusive use of one of several
276 different physical media connectors.
277 For example, a 10Mb/s Ethernet
278 interface might support the use of either
280 or twisted pair connectors.
281 Setting the media type to
283 would change the currently active connector to the AUI port.
286 would activate twisted pair.
287 Refer to the interfaces' driver
288 specific documentation or man page for a complete list of the
290 .It Cm mediaopt Ar opts
291 If the driver supports the media selection system, set the specified
292 media options on the interface.
296 is a comma delimited list of options to apply to the interface.
297 Refer to the interfaces' driver specific man page for a complete
298 list of available options.
299 .It Fl mediaopt Ar opts
300 If the driver supports the media selection system, disable the
301 specified media options on the interface.
302 .It Cm tunnel Ar src_addr dest_addr
303 (IP tunnel devices only.)
304 Configure the physical source and destination address for IP tunnel
311 are interpreted as the outer source/destination for the encapsulating
314 Unconfigure the physical source and destination address for IP tunnel
315 interfaces previously configured with
318 Create the specified network pseudo-device.
319 If the interface is given without a unit number, try to create a new
320 device with an arbitrary unit number.
321 If creation of an arbitrary device is successful, the new device name is
322 printed to standard output.
324 Destroy the specified network pseudo-device.
339 .It Cm vlan Ar vlan_tag
340 If the interface is a vlan pseudo interface, set the vlan tag value
343 This value is a 16-bit number which is used to create an 802.1Q
344 vlan header for packets sent from the vlan interface.
349 must both be set at the same time.
350 .It Cm vlandev Ar iface
351 If the interface is a vlan pseudo device, associate physical interface
354 Packets transmitted through the vlan interface will be
355 diverted to the specified physical interface
357 with 802.1Q vlan encapsulation.
358 Packets with 802.1Q encapsulation received
359 by the parent interface with the correct vlan tag will be diverted to
360 the associated vlan pseudo-interface.
361 The vlan interface is assigned a
362 copy of the parent interface's flags and the parent's ethernet address.
367 must both be set at the same time.
368 If the vlan interface already has
369 a physical interface associated with it, this command will fail.
371 change the association to another physical interface, the existing
372 association must be cleared first.
376 flag is set on the vlan interface, the vlan pseudo
377 interface's behavior changes: the
379 tells the vlan interface that the
380 parent interface supports insertion and extraction of vlan tags on its
381 own (usually in firmware) and that it should pass packets to and from
382 the parent unaltered.
383 .It Fl vlandev Ar iface
384 If the driver is a vlan pseudo device, disassociate the physical interface
387 This breaks the link between the vlan interface and its parent,
388 clears its vlan tag, flags and its link address and shuts the interface down.
390 Set the routing metric of the interface to
393 The routing metric is used by the routing protocol
395 Higher metrics have the effect of making a route
396 less favorable; metrics are counted as addition hops
397 to the destination network or host.
399 Set the maximum transmission unit of the interface to
401 default is interface specific.
402 The MTU is used to limit the size of packets that are transmitted on an
404 Not all interfaces support setting the MTU, and some interfaces have
406 .It Cm netmask Ar mask
409 Specify how much of the address to reserve for subdividing
410 networks into sub-networks.
411 The mask includes the network part of the local address
412 and the subnet part, which is taken from the host field of the address.
413 The mask can be specified as a single hexadecimal number
416 with a dot-notation Internet address,
417 or with a pseudo-network name listed in the network table
419 The mask contains 1's for the bit positions in the 32-bit address
420 which are to be used for the network and subnet parts,
421 and 0's for the host part.
422 The mask should contain at least the standard network portion,
423 and the subnet field should be contiguous with the network
426 The netmask can also be specified in CIDR notation after the address.
429 option above for more information.
430 .It Cm prefixlen Ar len
434 bits are reserved for subdividing networks into sub-networks.
437 must be integer, and for syntactical reason it must be between 0 to 128.
438 It is almost always 64 under the current IPv6 assignment rule.
439 If the parameter is omitted, 64 is used.
441 The prefix can also be specified using the slash notation after the address.
444 option above for more information.
447 .\" .It Cm nsellength Ar n
450 .\" This specifies a trailing number of bytes for a received
452 .\" used for local identification, the remaining leading part of which is
455 .\" (Network Entity Title).
456 .\" The default value is 1, which is conformant to US
458 .\" When an ISO address is set in an ifconfig command,
461 .\" which is being specified.
464 .\" 20 hex digits should be
467 .\" to be assigned to the interface.
468 .\" There is some evidence that a number different from 1 may be useful
471 .\" 37 type addresses.
472 .It Cm range Ar netrange
473 Under appletalk, set the interface to respond to a
476 .Ar startnet Ns - Ns Ar endnet .
477 Appletalk uses this scheme instead of
480 implements it internally as a set of netmasks.
485 Introduced for compatibility
489 The argument following this specifies the version (phase) of the
490 Appletalk network attached to the interface.
491 Values of 1 or 2 are permitted.
493 .It Cm link Op Cm 0 No - Cm 2
495 Enable special processing of the link level of the interface.
496 These three options are interface specific in actual effect, however,
497 they are in general used to select special modes of operation.
499 of this is to enable SLIP compression, or to select the connector type
500 for some Ethernet cards.
501 Refer to the man page for the specific driver
502 for more information.
504 .It Fl link Op Cm 0 No - Cm 2
506 Disable special processing at the link level with the specified interface.
510 This may be used to enable an interface after an
512 It happens automatically when setting the first address on an interface.
513 If the interface was reset when previously marked down,
514 the hardware will be re-initialized.
516 For IEEE 802.11 wireless interfaces, set the desired Service Set
517 Identifier (aka network name).
518 The SSID is a string up to 32 characters
519 in length and may be specified as either a normal string or in
520 hexadecimal when proceeded by
522 Additionally, the SSID may be cleared by setting it to
531 .It Cm stationname Ar name
532 For IEEE 802.11 wireless interfaces, set the name of this station.
533 It appears that the station name is not really part of the IEEE 802.11
534 protocol though all interfaces seem to support it.
536 seems to be meaningful to identical or virtually identical equipment.
537 Setting the station name is identical in syntax to setting the SSID.
538 .It Cm station Ar name
545 .It Cm channel Ar number
546 For IEEE 802.11 wireless interfaces, set the desired channel.
547 Channels range from 1 to 14, but the exact selection available
548 depends on the region your adaptor was manufactured for.
550 the channel to 0 will give you the default for your adaptor.
552 adaptors ignore this setting unless you are in ad-hoc mode.
553 .It Cm authmode Ar mode
554 For IEEE 802.11 wireless interfaces, set the desired authentication mode
555 in infrastructure mode.
556 Not all adaptors support all modes.
563 Modes are case insensitive.
565 For IEEE 802.11 wireless interfaces, enable powersave mode.
567 For IEEE 802.11 wireless interfaces, disable powersave mode.
568 .It Cm powersavesleep Ar sleep
569 For IEEE 802.11 wireless interfaces, set the desired max powersave sleep
570 time in milliseconds.
571 .It Cm wepmode Ar mode
572 For IEEE 802.11 wireless interfaces, set the desired WEP mode.
573 Not all adaptors support all modes.
574 The set of valid modes is
580 mode explicitly tells the adaptor to allow association with access
581 points which allow both encrypted and unencrypted traffic.
584 means that the access point must only allow encrypted connections.
587 is generally another name for
589 Modes are case insensitive.
590 .It Cm weptxkey Ar index
591 For IEEE 802.11 wireless interfaces, set the WEP key to be used for
593 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
594 For IEEE 802.11 wireless interfaces, set the selected WEP key.
597 is not given, key 1 is set.
598 A WEP key will be either 5 or 13
599 characters (40 or 104 bits) depending of the local network and the
600 capabilities of the adaptor.
601 It may be specified either as a plain
602 string or as a string of hexadecimal digits proceeded by
604 For maximum portability, hex keys are recommended;
605 the mapping of text keys to WEP encryption is usually driver-specific.
608 drivers do this mapping differently to
610 A key may be cleared by setting it to
612 If WEP is supported then there are at least four keys.
613 Some adaptors support more than four keys.
614 If that is the case, then the first four keys
615 (1-4) will be the standard temporary keys and any others will be adaptor
616 specific keys such as permanent keys stored in NVRAM.
618 Another way of saying
624 Another way of saying
630 Another way of saying:
632 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
639 .Ar n : k1 , k2 , k3 , k4
642 Another way of saying
644 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
650 Another way of saying
660 utility displays the current configuration for a network interface
661 when no optional parameters are supplied.
662 If a protocol family is specified,
664 will report only the details specific to that protocol family.
666 If the driver does supports the media selection system, the supported
667 media list will be included in the output.
671 flag is passed before an interface name,
674 of the supported media for the specified interface.
677 flag is supplied, address lifetime is displayed for IPv6 addresses,
678 as time offset string.
682 flag may be used instead of an interface name.
685 to display information about all interfaces in the system.
688 flag limits this to interfaces that are down, and
690 limits this to interfaces that are up.
691 When no arguments are given,
697 flag may be used to list all available interfaces on the system, with
698 no other additional information.
699 Use of this flag is mutually exclusive
700 with all other flags and commands, except for
702 (only list interfaces that are down)
705 (only list interfaces that are up).
709 flag may be used to list all of the interface cloners available on
710 the system, with no additional information.
711 Use of this flag is mutually exclusive with all other flags and commands.
713 Only the super-user may modify the configuration of a network interface.
715 The media selection system is relatively new and only some drivers support
716 it (or have need for it).
718 Messages indicating the specified interface does not exist, the
719 requested address is unknown, or the user is not privileged and
720 tried to alter an interface's configuration.
722 IPv6 link-local addresses are required for several basic communication
724 If they are deleted by
726 manually, the kernel might show very strange behavior.
727 So, such manual deletions are strongly discouraged.
projects / dragonfly.git / blob