ipconfig.8   [plain text]

.\"     @(#)ipconfig.8
.Dd July 14, 2004
.Os "Mac OS X"
.Nm ipconfig
.Nd view and control IP configuration state
.Cm waitall
.Cm getifaddr
.Ar interface-name
.Cm ifcount
.Cm getoption
.Ar interface-name
.Ar (option-name | option-code )
.Cm getpacket
.Ar interface-name
.Cm set
.Ar interface-name 
.Cm set
.Ar interface-name
.Cm ( DHCP | BOOTP )
.Cm set
.Ar interface-name
.Ar ip-address
.Ar subnet-mask
.Cm setverbose
.Ar level
is a utility that communicates with the IPConfiguration agent
to retrieve and set IP configuration parameters.  It should only be used 
in a test and debug context.  Using it for any other purpose is strongly 
Public API's in the SystemConfiguration framework are currently 
the only supported way to access and control the state of IPConfiguration.
The IPConfiguration agent is responsible for configuring and managing the
IP addresses on direct, connectionless interfaces such as IEEE 802.3 Ethernet
and IEEE 1394 FireWire.  The IPConfiguration agent is a program bundle 
that is loaded and executed by the
.Xr configd 8
The IPConfiguration agent implements the client side of the DHCP and BOOTP
protocols described in RFC951, RFC1542, RFC2131, and RFC2132.  It also
assigns and maintains static IP addresses.  It may also allocate and 
assign a link-local IP address if DHCP fails to acquire an IP address.
In all cases, the IPConfiguration agent performs IP address conflict detection
before assigning an IP address to an interface.
utility provides several commands:
.Bl -tag -compact
.It Cm waitall
Blocks until all network services have completed configuring, or have timed 
out in
the process of configuring.  This is only useful for initial system start-up
time synchronization for legacy network services that are incapable of dealing
with dynamic network configuration changes.
.It Cm getifaddr Ar interface-name
Prints to standard output the IP address for the first network service 
associated with the given interface.  The output will be empty if no
service is currently configured or active on the interface.
.It Cm ifcount
Prints the number of interfaces that IPConfiguration is capable of configuring.
The value that's printed will not change unless relevant
network interfaces are either added to or removed from the system.
.It Cm getoption Ar interface-name Ar ( option-name | option-code )
Prints the BOOTP/DHCP option with the given name or option code integer value.
.Xr bootpd 8
for option code names.
If an option has multiple values e.g. \fBdomain_name_server\fR, only the first
value is printed.
.It Cm getpacket Ar interface-name
Prints to standard output the DHCP/BOOTP packet that the client accepted from
the DHCP/BOOTP server.  This command is useful to check what the server
provided, and whether the values are sensible.  This command outputs nothing
if DHCP/BOOTP is not active on the interface, or the attempt to acquire an 
IP address was unsuccessful.
.It Cm set Ar interface-name Cm NONE
.It Cm set Ar interface-name Cm ( DHCP | BOOTP )
.It Cm set Ar interface-name Cm ( MANUAL | INFORM ) Ar ip-address Ar subnet-mask
Sets the interface to have a new temporary network service of the
given type.  All existing services on the interface are first de-configured
before the new service is instantiated.  If NONE is supplied, no new service
is instantiated.
DHCP and BOOTP require no additional arguments. The IP address, subnet mask,
router, and DNS information are retrieved automatically.
MANUAL and INFORM require the specification of an IP address
.Ar ip-address
and a subnet mask
.Ar subnet-mask .
The INFORM service configures the IP address statically like MANUAL, but then
broadcasts DHCP INFORM packets to retrieve DHCP option
information. If the DHCP server responds and supplies a subnet mask, that
subnet mask is used instead of the specified
.Ar subnet-mask .
The \fBset\fR command requires root privileges.
\fBNote:\fR The \fBset\fR command is very useful for debugging, but it can't
be used to configure a persistent service.  The temporary services that are
created only remain until the next network configuration change occurs. See
.Xr scselect 8 .
.It Cm setverbose Ar level
Sets verbose mode logging in the IPConfiguration agent. Specify a
.Ar level
value of
.Cm 0
to disable verbose logging, the default.  Specify a value of
.Cm 1
to enable verbose logging.
When enabled, useful debugging information is logged using
.Xr syslog 3
with level LOG_NOTICE.
In addition, the packet trace file
is opened and BOOTP/DHCP packets that are sent and received are printed to the
The \fBsetverbose\fR command requires root privileges.
# ipconfig getpacket en0
htype = 1
dp_flags = 0
hlen = 6
hops = 0
xid = 1956115059
secs = 0
ciaddr =
yiaddr =
siaddr =
giaddr =
chaddr = 0:3:93:7a:d7:5c
sname = dhcp.mycompany.net
file = 
Options count is 10
dhcp_message_type (uint8): ACK 0x5
server_identifier (ip):
lease_time (uint32): 0x164a
subnet_mask (ip):
router (ip_mult): {}
domain_name_server (ip_mult): {}
domain_name (string): mycompany.net
end (none): 
# ipconfig getoption en0 router
.Xr configd 8 ,
.Xr bootpd 8 ,
.Xr scselect 8
command first appeared in Mac OS X Version 10.0 Public Beta.