.\" $NetBSD: ifconfig.8,v 1.31 2000/01/31 18:02:01 itojun Exp $ .\" .\" 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. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" 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. .\" .\" @(#)ifconfig.8 8.4 (Berkeley) 6/1/94 .\" .Dd April 16, 1997 .Dt IFCONFIG 8 .Os BSD 4.2 .Sh NAME .Nm ifconfig .Nd configure network interface parameters .Sh SYNOPSIS .Nm .Ar interface address_family .Oo .Ar address .Op Ar dest_address .Oc .Op Ar parameters .Nm "" .Op Fl A .Op Fl mL .Ar interface .Op Ar protocol_family .Nm "" .Fl a .Op Fl A .Op Fl mL .Op Fl b .Op Fl d .Op Fl u .Op Fl s .Op Ar protocol_family .Nm "" .Fl l .Op Fl b .Op Fl d .Op Fl u .Op Fl s .Nm "" .Fl s .Ar interface .Sh DESCRIPTION .Nm is used to assign an address to a network interface and/or configure network interface parameters. .Nm must be used at boot time to define the network address 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 Available operands for .Nm "" : .Bl -tag -width Ds .It Ar Address For the .Tn DARPA-Internet family, the address is either a host name present in the host name data base, .Xr hosts 5 , or a .Tn DARPA Internet address expressed in the Internet standard .Dq dot notation . For the Xerox Network Systems(tm) family, addresses are .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. The host number may be omitted on 10Mb/s Ethernet interfaces, which use the hardware physical address, and on interfaces other than the first. For the .Tn ISO family, addresses are specified as a long hexadecimal string, as in the Xerox family. However, two consecutive dots imply a zero byte, and the dots are optional, if the user wishes to (carefully) count out long strings of digits in network byte order. .It Ar address_family Specifies the .Ar address family which affects interpretation of the remaining parameters. Since an interface can receive transmissions in differing protocols with different naming schemes, specifying the address family is recommended. The address or protocol families currently supported are .Dq inet , .Dq inet6 , .Dq atalk , .Dq iso , and .Dq ns . .It Ar Interface The .Ar interface parameter is a string of the form .Dq name unit , for example, .Dq en0 .El .Pp The following parameters may be set with .Nm "" : .Bl -tag -width dest_addressxx .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. .It Fl alias Remove the specified network address alias. .It Cm arp Enable the use of the Address Resolution Protocol in mapping between network level addresses and link level addresses (default). This is currently implemented for mapping between .Tn DARPA Internet addresses and 10Mb/s Ethernet addresses. .It Fl arp Disable the use of the Address Resolution Protocol. .It Cm anycast (inet6 only) Set the IPv6 anycast address bit. .It Fl anycast (inet6 only) Clear the IPv6 anycast address bit. .It Cm broadcast Ar mask (Inet only) 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. .ne 1i .It Cm delete 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. .Cm delete does not work for IPv6 addresses. Use .Fl alias with explicit IPv6 address instead. .It Cm dest_address Specify the address of the correspondent on the other end of a point to point link. .It Cm down Mark an interface ``down''. When an interface is marked ``down'', the system will not attempt to transmit messages through that interface. If possible, the interface will be reset to disable reception as well. This action does not automatically disable routes using the interface. .It Cm ipdst This is used to specify an Internet host who is willing to receive ip packets encapsulating NS packets bound for a remote network. An apparent point to point link is constructed, and the address specified will be taken as the NS address and network of the destination. IP encapsulation of .Tn CLNP packets is done differently. .It Cm media Ar type Set the media type of the interface to .Ar type . Some interfaces support the mutually exclusive use of one of several different physical media connectors. For example, a 10Mb/s Ethernet interface might support the use of either .Tn AUI or twisted pair connectors. Setting the media type to .Dq 10base5 or .Dq AUI would change the currently active connector to the AUI port. Setting it to .Dq 10baseT or .Dq UTP would activate twisted pair. Refer to the interfaces' driver specific man page for a complete list of the available types. .It Cm mediaopt Ar opts Set the specified media options on the interface. .Ar opts 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 Disable the specified media options on the interface. .It Cm instance Ar minst Set the media instance to .Ar minst . This is useful for devices which have multiple physical layer interfaces (PHYs). Setting the instance on such devices may not be strictly required by the network interface driver as the driver may take care of this automatically; see the driver's manual page for more information. .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 less favorable; metrics are counted as addition hops to the destination network or host. .It Cm mtu Ar n Set the maximum transmission unit of the interface to .Ar n . Most interfaces don't support this option. .It Cm netmask Ar mask (Inet, inet6 and ISO) 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 with a leading 0x, with a dot-notation Internet address, 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. .Pp For INET and INET6 addresses, the netmask can also be given with slash-notation after the address (e.g 192.168.17.3/24). .\" see .\" Xr eon 5 . .It Cm nsellength Ar n .Pf ( Tn ISO only) This specifies a trailing number of bytes for a received .Tn NSAP used for local identification, the remaining leading part of which is taken to be the .Tn NET (Network Entity Title). The default value is 1, which is conformant to US .Tn GOSIP . When an ISO address is set in an ifconfig command, it is really the .Tn NSAP which is being specified. For example, in .Tn US GOSIP , 20 hex digits should be specified in the .Tn ISO NSAP to be assigned to the interface. There is some evidence that a number different from 1 may be useful for .Tn AFI 37 type addresses. .It Cm nwid Ar id (IEEE 802.11 devices only) Configure network ID for IEEE 802.11-based wireless network interfaces. .It Cm pltime Ar n (inet6 only) Set preferred lifetime for the address. .It Cm prefixlen Ar n (inet6 only) Effect is similar to .Cm netmask . but you can specify by prefix length by digits. .It Cm tentative (inet6 only) Set the IPv6 tentative address bit. .It Fl tentative (inet6 only) Clear the IPv6 tentative address bit. .It Cm trailers Request the use of a ``trailer'' link level encapsulation when sending (default). If a network interface supports .Cm trailers , the system will, when possible, encapsulate outgoing messages in a manner which minimizes the number of memory to memory copy operations performed by the receiver. On networks that support the Address Resolution Protocol (see .Xr arp 4 ; currently, only 10 Mb/s Ethernet), this flag indicates that the system should request that other systems use trailers when sending to this host. Similarly, trailer encapsulations will be sent to other hosts that have made such requests. Currently used by Internet protocols only. .It Fl trailers Disable the use of a ``trailer'' link level encapsulation. .It Cm link[0-2] Enable special processing of the link level of the interface. These three options are interface specific in actual effect, however, they are in general used to select special modes of operation. An example of this is to enable SLIP compression, or to select the connector type for some ethernet cards. Refer to the man page for the specific driver for more information. .ne 1i .It Fl link[0-2] Disable special processing at the link level with the specified interface. .It Cm up Mark an interface ``up''. This may be used to enable an interface after an ``ifconfig down.'' 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. .It Cm vltime Ar n (inet6 only) Set valid lifetime for the address. .El .Pp .Nm displays the current configuration for a network interface when no optional parameters are supplied. If a protocol family is specified, Ifconfig will report only the details specific to that protocol family. .Pp If the .Fl s flag is passed before an interface name, .Nm will attempt to query the interface for its media status. If the interface supports reporting media status, and it reports that it does not appear to be connected to a network, .Nm will exit with status of 1 (false); otherwise, it will exit with a zero (true) exit status. Not all interface drivers support media status reporting. .Pp If the .Fl m flag is passed before an interface name, .Nm will display all of the supported media for the specified interface. If the .Fl L flag is supplied, address lifetime is dislayed for IPv6 addresses, as time offset string. .Pp Optionally, the .Fl a flag may be used instead of an interface name. This flag instructs .Nm to display information about all interfaces in the system. .Fl d limits this to interfaces that are down, .Fl u limits this to interfaces that are up, .Fl b limits this to broadcast interfaces, and .Fl s omits interfaces which appear not to be connected to a network. .Pp If the .Fl A flag is also specified, any relevant interface alias information is also displayed. .Pp The .Fl l flag may be used to list all available interfaces on the system, with no other additional information. Use of this flag is mutually exclusive with all other flags and commands, except for .Fl d (only list interfaces that are down), .Fl u (only list interfaces that are up), .Fl s (only list interfaces that may be connected), .Fl b (only list broadcast interfaces). .Pp Only the super-user may modify the configuration of a network interface. .Sh DIAGNOSTICS Messages indicating the specified interface does not exit, the requested address is unknown, or the user is not privileged and tried to alter an interface's configuration. .Sh SEE ALSO .Xr ifmedia 4 , .Xr netstat 1 , .Xr netintro 4 , .Xr rc 8 , .Xr routed 8 , .\" .Xr eon 5 .Sh HISTORY The .Nm command appeared in .Bx 4.2 .