ifconfig assigns an address to a network interface and
configures network interface parameters. ifconfig must be
used at boot time to define the network address of each
network interface present on a machine; it may also be
used at a later time to redefine a network interface's
address or other operating parameters. When used without
optional parameters, ifconfig displays the current configuration
for a network interface.
The interface parameter is the name of the network interface.
The name is of the form en for Ethernet interfaces,
possibly followed by a letter, where n is 0 for on-board
network interfaces and the expansion slot number for network
interfaces plugged into expansion slots. If a card
in an expansion slot has more than one network interface,
the network interface name will be followed by a letter,
indicating which of the network interfaces on that card it
is. ifconfig-a is special and it does not take any
optional parameters. It displays the current configuration
for all the network interfaces present.
The address is either a host name present in the host name
data base /etc/hosts including names of the form `hostname`-<interface
name>, or an Internet address expressed
in the Internet standard dot notation for IPv4 addresses
and Standard/Compressed/Mixed notation for IPv6 addresses.
address_family Specifies the 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. If
the address-family is not explicitly
mentioned, it would be deduced
from the IP address provided along
with the command if any. If the
address family is not specified and
a hostname is specified, it will
try to resolve to the IPv4 address
of the hostname and if it fails, it
will try to resolve to the IPv6
address of the hostname. The
address or protocol families currently
supported are "inet" and
"inet6".
broadcastaddress
Specifies 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.
May not be applied to a network
interface which is part of a vif.
down
Marks a network interface "down".
When a network interface is marked
"down" the system will not attempt
to transmit messages through that
network interface. This action
does not automatically disable
routes using the network interface.
See the discussion under CLUSTER
CONSIDERATIONS below for the semantics
of this action in a cluster.
May not be applied to a network
interface which is part of a vif.
mediatypetype Specifies the Ethernet media type
used.
10/100,100/1000,and10/100/1000MbpsCopperInterfaces: Depending
on the physical specifications of
the Ethernet card the acceptable
types are "tp" (Half-duplex 10BaseT
RJ-45 twisted-pair), "tp-fd"
(Full duplex 10Base-T RJ-45
twisted-pair), "100tx" (Half-duplex
100Base-T RJ-45 twisted-pair),
"100tx-fd" (Full duplex 100Base-T
RJ-45 twisted-pair), and "auto"
(Auto RJ-45 twisted-pair).
The default media type is set to
"tp" or to "auto" where applicable.
On an auto-negotiable interface,
the system will auto-negotiate the
speed and duplex of the link and
set the network interface accordingly
when it is configured up. If
the other end does not support
auto-negotiation and full duplex
operation is desired, it must be
explicitly set using the mediatype
command.
All 1000Base-T devices support
autonegotiation and the speed cannot
be explicitly set to 1000 Mbps.
At 1000 Mbps, the interface only
operates in full-duplex mode.
1000MbpsFiberInterfaces: The
Gigabit Ethernet Controllers only
support the mediatype "auto". If
the interface detects that the link
partner auto-negotiates, then the
operational flow control setting is
negotiated. If the interface
detects that the link partner does
not auto-negotiate, then it uses
the flow control setting configured
through the flowcontrol option or
the default value for the interface.
The Gigabit Ethernet Controllers
only support full-duplex.
10GbpsFiberInterfaces: The 10G
TOE/Ethernet Controllers support
the mediatype "10g-sr" and "auto".
The interface does not do autonegotiation,
it has fixed capabilities
and only supports 10GB speed,
full duplex. flowcontrol by
default is set to full, but it can
be set to none or send or receive.
flowcontrol
Specifies the flow control type.
The acceptable types are "none" (no
flow control), "receive" (only
receive flow control frames),
"send" (only send flow control
frames), and "full" (send and
receive flow control frames). If
the flowcontrol option is not specified,
the default value is interface-dependent.
If the link partner
is configured for auto-negotiation,
the interface negotiates flow
control by advertising its flow
control setting. The actual operational
value may be different,
depending on the capabilities that
each partner advertises. If the
link partner is not configured for
auto-negotiation, then the interface
sends or accepts flow control
frames as dictated by the flowcontrol
option or the default value.
Gigabit Ethernet interfaces support
flow control as described above,
and their default flowcontrol setting
is "full".
On 100/1000 and 10/100/1000 Mbps
interfaces operating at 10 or 100
Mbps, the system may override the
configured setting with "receive"
or "none" because most 10 and 100
Mbps devices don't support flow
control. In half-duplex mode, the
system always disables flow control.
Use the ifstat command to
see the operational setting.
Not supported on Virtual interfaces
(vif) interfaces.However the
underlying interfaces can be modified
with this option.
dad_attemptscount
(Inet6 only)Specifies the dadattempts(Duplicate
Address Detection-attempts)
to
use
for the multicast interface. It is
used to specify number of consecutive
Neighbor Solicitation messages
sent while performing Duplicate
Address Detection on a tentative
address per multicast interface.
The default value of dad_attempts
is 2 and maximum is 15.
It takes longer for a vif/vlan link
to come up because any underlying
physical links and the logical
interface have to both come
up.Hence actual NS DAD retransmits
for vif/vlan interfaces will be
increased by factor of 2 than what
was given in input.
mtusizesize
Specifies the MTU (maximum transmission
unit) to use for the network
interface. It is used to
specify the jumbo frame size on
Gigabit Ethernet interfaces. Jumbo
frames are packets larger than the
standard Ethernet packet size and
must also be supported by the environment's
networking equipment and
clients. The default MTU for jumbo
frames is 9000 and the maximum is
driver-dependent.
The MTU size does not include the
media header or FCS (checksum).
However, other vendors may include
the 14-byte Ethernet media header,
the 4-byte FCS, or a 4-byte VLAN
tag when specifying their jumbo
frame size.
May not be applied to a network
interface which is part of a vif.
netmaskmask
(Inet only) 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 /etc/networks. The mask contains
1's for the bit positions in
the 32-bit address that 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. A
default netmask is chosen according
to the class of the IP address.
May not be applied to a network
interface which is part of a vif.
Option is only allowed on interfaces
with assigned internet
address or if the internet address
is provided along with the netmask
option.
prefixlenlen (Inet and Inet6) Specify that len
bits are reserved for subdividing
networks into sub-networks. The
len must be integer. When used in
IPv6 context, for syntactical reason
it must be between 0 and 128.
It is almost always 64 under the
current IPv6 assignment rule. If
the parameter is omitted, 64 is
used. When used in IPv4 context, it
must be between 0 and 32.
up
Marks a network interface "up".
This may be used to enable a network
interface after an "ifconfig
down." It happens automatically
when setting the first address on a
network interface. If the network
interface was reset when previously
marked down, the hardware will be
re-initialized.
May not be applied to a network
interface which is part of a vif.
If IPv6 is enabled, an interface
that is brought up will automatically
configure a link local
address and RA prefix IPv6
addresses in response to router
advertisements.
up is ignored if the interface has
no addresses configured, and IPv6
is not enabled.
alias
Configures an additional network
address on this network interface.
May not be applied to a network
interface which is part of a vif.
-alias
Remove a network address for this
network interface.
May not be applied to a network
interface which is part of a vif.
no_ddns
Specifies that DDNS update is not
to be sent for this IP address.
May not be applied to a network
interface which is part of a vif.
trusted
Specifies that the network to which
the network interface is attached
is trusted relative to firewallstyle
security (default).
May not be applied to a network
interface which is part of a vif.
untrusted
Specifies that the network to which
the network interface is attached
is not trusted relative to firewall-style
security.
May not be applied to a network
interface which is part of a vif.
wins
Specifies that the network interface
is to be registered with Windows
Internet Name Services
(default). Such registration is
only performed when CIFS is running
and at least one WINS server has
been configured.
May not be applied to a network
interface which is part of a vif.
-wins
Specifies that the network interface
is not to be registered with
Windows Internet Name Services.
May not be applied to a network
interface which is part of a vif.
nfo
Specifies that negotiated failover
is to be enabled for the network
interface. This option applies
only to filers in a cluster. See
the description of options
Bcf.takeover.on.network_interface_failureR
and
Bcf.takeover.on_network_interface_failure.policyR
in
na_options(1) for more information.
May not be applied to a network
interface which is part of a vif.
-nfo
Specifies that negotiated failover
is to be disabled for the network
interface. This option applies
only to filers in a cluster.
May not be applied to a network
interface which is part of a vif.
partneraddress Applies only to filers in a cluster.
It maps a network interface to
address, which is an IPv4 address
on the partner and is referred to
as the partner IP address. If the
network interface being configured
is a virtual interface then the
partner interface must be denoted
by an interface name and not an IP
address. In takeover mode, this
network interface assumes the identity
of the network interface on
the partner, whose IP address is
address. For example, toaster1 and
toaster2 are filers in a cluster.
If the IP address of e8 on toaster2
is 198.9.200.38, use the following
command on toaster1 if you want e1
of toaster1 to assume the identity
of e8 of toaster2 for the duration
of a takeover:
ifconfige1partner198.9.200.38
Be sure that both the local network
interface and the partner's network
interface are attached to the same
network segment or network switch.
Otherwise, after takeover, clients
of the failed filer might need to
wait an indeterminate amount of
time for routing tables to flush
before being able to access the
data on the failed filer.
May not be applied to a network
interface which is part of a vif.
Address to address mapping is not
supported for IPv6 addresses. If
IPv6 addresses are to be taken
over, partner interface must be
denoted by an interface name and
not an IP address.
partnerinterface
Applies only to filers in a cluster.
It maps a network interface to
interface, which is an interface on
the partner. If IPv6 addresses configured
on the partner interface
also needs to be taken care, interface
to interface mapping needs to
be employed. If the network interface
being configured is a virtual
interface then interface must refer
to a virtual interface on the partner
filer.
May not be applied to a network
interface which is part of a vif.
-partner
Applies only to filers in a cluster.
It removes the mapping between
a network interface and an IP
address or interface on the partner.
May not be applied to a network
interface which is part of a vif.
CLUSTERCONSIDERATIONS
On a filer in a cluster, a network interface
performs one of these roles:
A dedicated network interface for the local
filer whether or not the filer is in
takeover mode. A network interface performs
this role if it has a local IP address but
not a partner IP address, which you can
assign by the partner option of the ifconfig
command.
A shared network interface for both the
local filer and the partner. That is, if the
partner fails, the network interface assumes
the identity of a network interface on the
partner but works on behalf of both the live
filer and the partner. A network interface
performs this role if it has a local IP
address and a partner IP address, which you
assign by the partner option of the ifconfig
command.
A standby network interface for the partner.
That is, if the partner fails, the network
interface works on behalf of the partner.
When the filer is not in takeover mode, the
network interface is idle. A network interface
performs this role if it does not have
a local IP address but a partner IP address,
which you assign by the partner option of
the ifconfig command.
The filer maps a partner IP address to a shared or
standby interface when the filer initiates a
takeover operation. In takeover mode, all requests
destined for the partner IP address are serviced by
the shared or standby interface. Also, in partner
mode, if a command takes a network interface name
as an argument, enter the network interface name of
the failed filer. The command is executed on the
shared or standby interface on the live filer.
Similarly, in partner mode, a command for displaying
network interface information displays the network
interface name of the failed filer, even
though the command is serviced by the shared or
standby interface on the live filer.
To facilitate seamless transition, the partner
interfaces broadcast gratuitous ARPS so that all
clients may update their arp caches.
In takeover mode, attempting to "ifconfig down" an
interface that has taken over an interface of the
failed filer only marks the interface down for the
live filer. To take the interface down completely,
the "ifconfig down" command must also be executed
in partner mode. These state distinctions are indicated
by the UP and PARTNER_UP flags (shown by
ifconfig) associated with each interface.
These ifconfig options are not available in partner
mode: partner, -partner, and mtusize.
The autoconf keyword indicates that an IPv6 address
is obtained via stateless autoconfiguration.
The e0 interface on toaster1 is a dedicated interface.
It services requests only for address
192.9.200.37. After toaster1 takes over toaster2,
this network interface is not available in partner
mode.
The e1 interface on toaster1 is a shared interface.
It services requests for address 192.9.200.38 when
toaster1 is not in takeover mode. When toaster1 is
in takeover mode, the network interface services
requests for both addresses 192.9.200.38 and
192.9.200.41. When toaster1 is in partner mode,
this network interface shows up as the e8 interface
in commands that involve network interface names.
The e2 interface on toaster1 is a standby interface.
It does not service any request when
toaster1 is not in takeover mode. However, after
toaster1 takes over toaster2, this network interface
services requests for address 192.9.200.42.
When toaster1 is in partner mode, this network
interface shows up as the e7 interface in commands
that involve network interface names.
