Manual Pages for UNIX Darwin command on man ifconfig

IFCONFIG(8) BSD System Manager's Manual IFCONFIG(8)

NAME

iiffccoonnffiigg - configure network interface parameters

SYNOPSIS

iiffccoonnffiigg [-LL] [-mm] interface [ccrreeaattee] [addressfamily]

[address[//prefixlength] [destaddress]] [parameters] iiffccoonnffiigg interface ddeessttrrooyy

iiffccoonnffiigg -aa [-LL] [-dd] [-mm] [-uu] [addressfamily]

iiffccoonnffiigg -ll [-dd] [-uu] [addressfamily]

iiffccoonnffiigg [-LL] [-bb] [-dd] [-mm] [-uu]

iiffccoonnffiigg interface vvllaann vlan-tag vvllaannddeevv iface

iiffccoonnffiigg interface -vvllaannddeevv iface

iiffccoonnffiigg interface bboonnddddeevv iface

iiffccoonnffiigg interface -bboonnddddeevv iface

DESCRIPTION

IIffccoonnffiigg is used to assign an address to a network interface and/or con-

figure network interface parameters. IIffccoonnffiigg 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. The following options are available: address

For the DARPA-Internet family, the address is either a host name

present in the host name data base, hosts(5), or a DARPA Internet address expressed in the Internet standard ``dot notation''. 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 192.168.0.1/16. addressfamily Specify the address family which affects interpretation of the

remaining parameters. Since an interface can receive transmis-

sions in differing protocols with different naming schemes, spec-

ifying the address family is recommended. The address or proto-

col families currently supported are ``inet'', ``inet6'', destaddress Specify the address of the correspondent on the other end of a point to point link. interface

This parameter is a string of the form ``name unit'', for exam-

ple, ``en0''. iface This parameter has the same encoding as the interface parameter. The following parameters may be set with iiffccoonnffiigg:

aadddd Another name for the aalliiaass parameter. Introduced for compatibil-

ity with BSD/OS. aalliiaass 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. If the address is on the same subnet as the first network address for this interface, a netmask of 0xffffffff has to be specified.

-aalliiaass 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. aannyyccaasstt (Inet6 only.) 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. aarrpp Enable the use of the Address Resolution Protocol (arp(4)) in mapping between network level addresses and link level addresses (default). This is currently implemented for mapping between

DARPA Internet addresses and IEEE 802 48-bit MAC addresses (Eth-

ernet, FDDI, and Token Ring addresses).

-aarrpp Disable the use of the Address Resolution Protocol (arp(4)).

bboonnddddeevv iface If the interface is a bond pseudo device, associate physical interface iface with it. The bond pseudo device conforms to the IEEE 802.3ad Link Aggregation specification. If this is the first physical interface to be associated with the bond interface, the bond interface inherits the ethernet address from the physical interface. Physical interfaces that are added

to the bond have their ethernet address re-programmed so that all

members of the bond have the same ethernet address. If the phys-

ical interface is subsequently removed from the bond using

-bboonnddddeevv, a new ethernet address is chosen from the remaining

interfaces, and all interfaces are re-programmed again with the

new ethernet address. If no remaining interfaces exist, the bond interface's ethernet address is cleared.

If the specified physical interface iface is not capable of hav-

ing its ethernet address re-programmed, the bboonnddddeevv command will

fail. Once the physical interface iface is successfully associated with the bond interface, all received packets are diverted to the bond interface. The physical interface is no longer useable on its own, and remains that way until it is removed from the bond using

-bboonnddddeevv.

It is possible that the specified interface iface is not capable

of aggregating, and may remain unused until the operating condi-

tions change. The link status of the bond interface depends on the state of link aggregation. If no active partner is detected, the link status will remain inactive.

To monitor the 802.3ad Link Aggregation state, use the -bb option.

A physical interface that is associated with a vlan pseudo device cannot at the same time be associated with a bond pseudo device. A physical interface cannot be associated with more than one bond pseudo device at the same time. It is not possible to associate a bond with pseudo interfaces

such as vlan. Only physical ethernet interfaces may be associ-

ated with a bond.

-bboonnddddeevv iface

If the interface is a bond pseudo device, disassociate the physi-

cal interface iface from it. Before the interface is removed from the bond, the bond device announces to the link partner that the interface is now individual and no longer aggregatable. If the physical iface is the last interface in the bond, the bond interface clears its link address. bbrrooaaddccaasstt (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. ddeebbuugg Enable driver dependent debugging code; usually, this turns on extra console error logging.

-ddeebbuugg Disable driver dependent debugging code.

ddeelleettee Another name for the -aalliiaass parameter.

ddoowwnn 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. eetthheerr Another name for the llllaaddddrr parameter. llllaaddddrr addr

Set the link-level address on an interface. This can be used to

e.g. set a new MAC address on an ethernet interface, though the

mechanism used is not ethernet-specific. The address addr is

specified as a series of colon-separated hex digits. 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 filter in the underlying ethernet hard-

ware is properly reprogrammed. mmeeddiiaa type If the driver supports the media selection system, set the media

type of the interface to type. Some interfaces support the mutu-

ally exclusive use of one of several different physical media

connectors. For example, a 10Mb/s Ethernet interface might sup-

port the use of either AUI or twisted pair connectors. Setting the media type to ``10base5/AUI'' would change the currently active connector to the AUI port. Setting it to ``10baseT/UTP'' would activate twisted pair. Refer to the interfaces' driver specific documentation or man page for a complete list of the available types. mmeeddiiaaoopptt opts

If the driver supports the media selection system, set the speci-

fied media options on the interface. The opts argument 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.

-mmeeddiiaaoopptt opts

If the driver supports the media selection system, disable the specified media options on the interface. ttuunnnneell srcaddr destaddr

(IP tunnel devices only.) Configure the physical source and des-

tination address for IP tunnel interfaces (gif(4)). The argu-

ments srcaddr and destaddr are interpreted as the outer source/destination for the encapsulating IPv4/IPv6 header. ddeelleetteettuunnnneell Unconfigure the physical source and destination address for IP tunnel interfaces previously configured with ttuunnnneell.

ccrreeaattee 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. If creation of an arbitrary device is successful, the new device name is printed to standard output. ddeessttrrooyy

Destroy the specified network pseudo-device.

pplluummbb Another name for the ccrreeaattee parameter. Included for Solaris com-

patibility. uunnpplluummbb Another name for the ddeessttrrooyy parameter. Included for Solaris compatibility. mmeettrriicc n Set the routing metric of the interface to n, default 0. The routing metric is used by the routing protocol (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. mmttuu n Set the maximum transmission unit of the interface to n, default is interface specific. The MTU is used to limit the size of packets that are transmitted on an interface. Not all interfaces

support setting the MTU, and some interfaces have range restric-

tions. nneettmmaasskk mask

(Inet only.) Specify how much of the address to reserve for sub-

dividing networks into sub-networks. The mask includes the net-

work part of the local address and the subnet part, which is

taken from the host field of the address. The mask can be speci-

fied 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 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. The netmask can also be specified in CIDR notation after the address. See the address option above for more information. pprreeffiixxlleenn len (Inet6 only.) Specify that len bits are reserved for subdividing

networks into sub-networks. The 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. If the parame-

ter is omitted, 64 is used.

rreemmoovvee Another name for the -aalliiaass parameter. Introduced for compati-

bility with BSD/OS.

lliinnkk[00-22]

Enable special processing of the link level of the interface.

These three options are interface specific in actual effect, how-

ever, they are in general used to select special modes of opera-

tion. 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.

-lliinnkk[00-22]

Disable special processing at the link level with the specified interface.

uupp Mark an interface ``up''. This may be used to enable an inter-

face after an ``iiffccoonnffiigg ddoowwnn''. 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-ini-

tialized. vvllaann vlantag vvllaannddeevv iface If the interface is a vlan pseudo interface, set its vlan tag value to vlantag and associate it with the physical interface iface.

The vlantag value is a 16-bit number that is used to create an

802.1Q vlan header for packets sent from the vlan interface. A packet that is transmitted through the vlan interface is sent using the specified physical interface iface with 802.1Q vlan encapsulation with the specified vlantag. A packet with 802.1Q encapsulation received by the physical interface is directed to the associated vlan interface with the matching vlantag. If there is no matching vlan interface, the packet is dropped. The vlan interface is assigned a copy of the parent interface's flags and the parent's ethernet address. If the vlan interface already has a physical interface associated with it, this command

will fail. To change the association to another physical inter-

face, the existing association must be cleared first using

-vvllaannddeevv.

If the physical interface supports 802.1Q VLAN tagging in hard-

ware, the vlan pseudo interface does not itself insert or remove the 802.1Q encapsulation header. Instead, the vlantag is passed out of band from the packet data. A physical interface that is associated with a bond pseudo device cannot at the same time be associated with a vlan interface. However, a physical interface can be associated with multiple vlan interfaces at the same time, as long as each of the vlantag values are unique.

-vvllaannddeevv iface

If the driver is a vlan pseudo device, disassociate the physical interface iface from it. This breaks the link between the vlan interface and its parent, clears its vlan tag, flags and its link address. IIffccoonnffiigg displays the current configuration for a network interface when no optional parameters are supplied. If a protocol family is specified, iiffccoonnffiigg will report only the details specific to that protocol family. If the driver supports the media selection system, the supported media

list will be included in the output, regardless of whether the -mm flag is

passed or not.

The -bb option passed before the interface name will print the link aggre-

gation state for bond pseudo devices.

If -LL flag is supplied, address lifetime is displayed for IPv6 addresses,

as time offset string.

Optionally, the -aa flag may be used instead of an interface name. This

flag instructs iiffccoonnffiigg to display information about all interfaces in

the system. The -dd flag limits this to interfaces that are down, and -uu

limits this to interfaces that are up. When no arguments are given, -aa

is implied.

The -ll 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 -dd (only list

interfaces that are down) and -uu (only list interfaces that are up).

Only the super-user may modify the configuration of a network interface.

NNOOTTEESS

The media selection system is relatively new and only some drivers sup-

port it (or have need for it). DIAGNOSTICS Messages indicating the specified interface does not exist, the requested address is unknown, or the user is not privileged and tried to alter an interface's configuration.

BUGS

IPv6 link-local addresses are required for several basic communication

between IPv6 node. If they are deleted by iiffccoonnffiigg manually, the kernel might show very strange behavior. So, such manual deletions are strongly discouraged.