admipinterface(1M) DG/UX R4.11MU05 admipinterface(1M)
NAME
admipinterface - manage the TCP/IP network interfaces database
SYNOPSIS
admipinterface -o add -d device [ -m netmask ] [ -b 0 | 1 ] [ -p
link-protocol ] [ -t template ] [ -g group ] [ -i
interface ] [ -r baudrate ] hostname
admipinterface -o delete [ -qv ] [ -g group ] all | hostname ...
admipinterface -o modify [ -n new-hostname ] [ -d device ] [ -m
netmask ] [ -b 0 | 1 ] [ -p link-protocol ] [ -t template
] [ -g group ] [ -i interface ] [ -r baudrate ] hostname
admipinterface -o list [ -qv ] [ -g group ] [ all | hostname ... ]
admipinterface -o attach [ -qv ] [ -g group ] all | hostname ...
admipinterface -o detach [ -qv ] [ -g group ] all | hostname ...
admipinterface -o start [ -qv ] [ -g group ] all | hostname ...
admipinterface -o stop [ -qv ] [ -g group ] all | hostname ...
DESCRIPTION
admipinterface manages the TCP/IP network interfaces database. A
TCP/IP network interfaces database entry consists of: an Internet
address or hostname (which must have either a hosts(4),
pppdialinfo(4M), or slipdialinfo(4M) entry), an interface name, a
device name (which must have a /dev entry), a netmask, a broadcast
address for broadcasting interfaces, a link-protocol, a group, and an
IXE template for ixe(7) interfaces. Note that some of these fields
are optional for certain devices.
Operations
add Add a new network interface to the network interfaces
database.
delete Remove one or more network interface entries from the
network interfaces database.
modify Change a network interface entry in the network interfaces
database. The hostname, device, netmask, broadcast
address, link-level protocol, template name, group,
interface name and baud rate may be edited.
list List one or more network interfaces in the network
interfaces database. Information is listed about each
hostname given; if no hostnames are given or if hostname is
all, then information is listed about all network
interfaces within the given group.
attach Attach one or more network interfaces from the network
interfaces database using the netinit command. Attaching
an interface builds the interface into the TCP/IP protocol
stack.
detach Detach one or more network interfaces from the network
interfaces database by killing the currently executing
netinit process associated with each interface. Detaching
an interface removes its link to the TCP/IP protocol stack
and destroys any transient data structures associated with
the interface (i.e. routes, statistics, etc.).
start Start one or more network interfaces from the network
interfaces database using the ifconfig command. This
operation does NOT build the interface into the TCP/IP
protocol stack.
stop Stop one or more network interfaces from the network
interfaces database using the ifconfig command. This
operation leaves the protocol stack and transient data
structures associated with the interface intact.
Options
-d device device is the device name which must have a /dev entry.
The admipinterface command interprets device names ending
in en as ethernet devices, ending in tr as token ring
devices and ending in fn as FDDI devices. The devices
currently supported are: loop(7), inen(7), dgen(7),
hken(7), cien(7), alen(7), dpen(7), nfen(7), tcen(7),
pefn(7), vitr(7), nftr(7), ixe(7), li(7), ci(7), pa(7) and
tty.
-m netmask
netmask is the hexadecimal mask that masks off the host
part from the network part of the Internet address .
Without this option the default netmask will be used. The
default netmask does not allow subnetting.
-b 0 | 1 broadcast-polarity specifies whether the host part of the
broadcast address is composed of 1's or 0's. The default is
1.
-p link-protocol
link-protocol is the link level protocol used to build the
network protocol stack. The link level protocols currently
supported are: slip, ppp, ether, and 802.3. The link level
protocols ppp and slip are only valid for tty devices. The
link level protocols ether and 802.3 are only valid for
inen, hken, dgen, and cien devices. For the latter set of
ethernet devices the link-protocol defaults to ether. Also
for these ethernet devices, if the link-protocol is not
ether, then the interface name will be derived from link-
protocol and prepended onto device, otherwise the interface
name will be the same as the device name. For example, if
device is hken0, and link-protocol is 802.3, then the
interface name will be snaphken0. However, if link-
protocol is ether, then the interface name will be hken0.
-t template
template is the file that contains IXE information for X.25
network interfaces. This option is only valid for ixe
interfaces.
-g group group specifies in what group the interface has membership.
The default value for group is default. Note that for the
list, delete, attach, detach, start, and stop operations,
group only has meaning if hostname is all, and that a group
name of all will designate all interfaces in all groups.
-i interface
interface specifies the interface name for the interface.
The interface name is the identifier used to key on the
interface by commands such as netstat(1M) and ifconfig(1M).
The default value for interface is the value of device plus
a possible prefix determined by the value of link-proto.
-r baudrate
baudrate specifies the baud rate for SLIP or PPP
interfaces.
-n new-hostname
new-hostname is the new hostname that will replace hostname
in the modify command. Without this option the hostname is
not changed.
-q "Quiet." For the list operation this produces an
unformatted listing (i.e. no headers, fields delimited by a
single space). For the delete, attach, detach, start and
stop operations it suppresses confirmation messages.
-v "Verbose." For the list operation this produces a
formatted listing with two aligned columns of field-value
pairs for each interface. For the delete, attach, detach,
start and stop operations it enables confirmation messages.
This option is enabled by default.
EXAMPLES
In the following examples, the system administrator performs the
following actions: add the my-host-ixe0 and my-host-ixe1 ixe
interfaces; add the my-host hken0 interface with an interface name of
backuphken0; add the SLIP interface slip-host on tty00; modify the
my-host hken0 interface by specifying a subnet mask and specifying it
belongs to group failover; detach all interfaces in all groups; and
attach all interfaces in group failover.
admipinterface -o add -d ixe0 -m 0xffff0000 -t ixe0.file my-host-ixe0
admipinterface -o add -d ixe1 -m 0xffff0000 -t ixe1.file my-host-ixe1
admipinterface -o add -d hken0 -b 1 -p ether my-host
admipinterface -o add -d tty00 -r 19200 slip-host
admipinterface -o modify -m 0xffffff00 -g failover my-host
admipinterface -o detach -g all all
admipinterface -o attach -g failover all
FILES
/etc/tcpip.params
File that contains the network interfaces database.
OUTPUT
The list operation writes its output to stdout.
The verbose form of the list operation outputs the entry in two
aligned columns of field-value pairs for each interface.
If -q option is specified with the list operation, headers are
suppressed and each entry is printed on a separate line. The fields
within the entry are delimited by a single space, and are in the
following order:
hostname interface device netmask broadcast link-protocol
template baudrate group status
DIAGNOSTICS
Warnings
- The delete, attach, detach, start, or stop operation is
requested, and hostname does not exist.
- The attach operation is requested, and hostname is already
attached.
- The detach operation is requested, and hostname is already
detached.
Errors
- The add operation is requested, and hostname already exists.
- The modify operation is requested, and hostname does not exist.
- The modify operation is requested, and new-hostname already
exists.
- The modify operation is requested with new-hostname , and
hostname is not detached.
- The delete operation is requested, and hostname is not detached.
- The attach operation is requested, and there is no /dev/ device
entry.
Exit Codes
0 The operation was successful.
1 The operation was unsuccessful.
2 The operation failed due to access restrictions.
3 There was an error in the command line.
NOTES
Only a user with appropriate privilege is granted access to the add,
delete, modify, attach, detach, start, and stop operations. For
systems supporting the DG/UX Capability Option, appropriate privilege
is defined as having one or more specific capabilities enabled in the
effective capability set of the user. See capdefaults(5) for the
default capabilities for this command.
On a generic DG/UX system, appropriate privilege means that your
process has an effective UID of root. (See the
appropriateprivilege(5) man page for more information.) Anyone with
read access to the network interfaces database file is granted access
to the list operation.
In order to use the failover functionality, you must have either the
Failover package or the DG/UX Cluster Software product installed.
SEE ALSO
ifconfig(1M), netinit(1M), netstat(1M), pppd(1C), slipd(1C),
hosts(4), tcpip.params(4M), pppdialinfo(4M), pppusers(4M),
slipdialinfo(4M), slipusers(4M), capdefaults(5), loop(7), inen(7),
dgen(7), hken(7), cien(7), alen(7), dpen(7), pefn(7), vitr(7), li(7),
ci(7), pa(7), ixe(7) in the X.25 product.
Licensed material--property of copyright holder(s)