nwmgr_igelan(1M)nwmgr_igelan(1M)NAME
nwmgr_igelan: nwmgr - network interface management command for igelan
driver
SYNOPSIS
number]
Remarks
The and commands are deprecated. These commands will be removed in a
future HP-UX release. HP recommends the use of replacement command to
perform all network interface-related tasks.
DESCRIPTION
The program is the unified command to administer all LAN and RDMA-based
interfaces of HP-UX. General information about the command as a whole
can be found in the manual page nwmgr(1M). This manual page describes
as applied to the driver.
The driver is one of the HP-UX drivers that manages Gigabit Ethernet
interfaces, both copper (1000Base-T) and fiber (1000Base-SX). Each
interface has several attributes. Some, such as MTU, are configurable
while others are read-only. In general, each attribute can have a cer‐
tain value in the running system (which is its current value), another
value in the configuration file that stores data across boots (its
saved value) and a HP-supplied value that is applied by the driver
after boot (its default value) before the saved value is applied. The
list of attributes is documented in the section below.
The command can be used on interfaces to display information (with the
option, which is the default), modify settings (the option), reset the
interface or its statistics (the option), and to diagnose link connec‐
tivity (the option).
Operations other than require the authorization. For more information
about authorizations and Role-based Access Control, see rbac(5).
The settings of the interfaces on the system can be saved to the con‐
figuration file so that these settings will take effect across reboots.
The output in each case can be obtained in either human-readable form
(which is the default) or in a script-friendly parseable form (with the
or option). The format for script-friendly output is described in the
manual page nwmgr(1M). It is guaranteed that any change in the script‐
able output across releases will contain only additions, never modifi‐
cations or deletions. The human-readable format can change across
releases, including modifications and deletions, though the changes can
be expected to be incremental.
The usage is explained in greater detail below. The output format that
is described is the human-readable one; references to the scriptable
output are made as necessary.
Operations
The command provides the following operations for the interface.
Operation to perform Critical Resource Analysis on the interface.
Operation to diagnose/test link connectivity.
Operation to get/display interface settings.
Operation to display help information.
Operation to reset interface or statistics.
Operation to set the attributes of the interface.
Options
The command provides the following options for the interface. For more
information about these options, refer to nwmgr(1M).
Operation to assign attributes for the operation.
Attributes that can be used for interfaces are described in the
section below.
Specifies the target interface on which the operation is to be per‐
formed.
For the target interface is of the form:
where PPA is the physical point of attachment.
Specifies the configuration from which the operation will copy data.
The option takes or as argument.
Specifies how many test frame to send during a
operation. The default is 1.
Specifies a generic target qualifier was used to specify a subsystem
specific target qualifier.
The arguments supported for are and
Provides more information on the instance of the
subsystem; such as, the hardware path, feature capabili‐
ties, current feature settings, the assigned NMID,
speed, and MTU of the card.
Provides vital product data (VPD) which is a standardize set of
read-only
properties for an interface, including Manufactured Data
for the NIC and the firmware versions.
Specifies the target subsystem for the operation.
For subsystem, the option argument will always be
Specifies that the operation has to be performed on the saved configu‐
ration
(persistent store).
Display the output in script parseable format.
Specifies that the operation applies to the statistics of the target.
Option to display more details in the output.
Attributes
The valid attributes for interface are:
Ethernet MAC address of the remote interface. Used with the operation.
Diagnostics Threshold:
Inbound packet rate threshold below which CKO diagnostics are
run.
0 A value of zero indicates the diagnostics are disabled.
-1 A value of -1 means that the driver chooses an appropriate
threshold.
Minimum: -1
Maximum: 100000
Default: 0.
Ethernet MAC Address.
The default value is the factory MAC address.
Maximum Ethernet payload size, in bytes.
MTU above 1500 is allowed only when the speed is 1 Gbps.
Minimum: 257
Maximum: 9000
Default: 1500
Specifies the package size in bytes of each test frame.
The default size of the test frame will be three bytes less than
the MTU size currently set. Only valid for the operation.
Max Recv Coalesce Ticks:
Maximum time for the NIC to wait after receiving a frame before
it raises an interrupt. This and other interrupt tunables must
be modified with care.
Minimum: 0
Max: 10000000
Default: 0
Max Recv Buffers:
Maximum number of receive descriptors for the NIC to coalesce
before it raises an interrupt. This and other interrupt tun‐
ables must be modified with care.
Minimum: 1
Maximum: 256
Default: 1
Receive Checksum Offload:
Hardware TCP/UDP (IPv4) receive checksum offload.
Values: Off, On.
Default: Off.
Receive Flow Control:
Ability of the interface to receive Ethernet Flow control
frames.
Values: Off, On.
Default: On. (case insensitive).
Speed, Duplex and Autonegotiation:
Actual values of speed, duplex and autonegotiation if the link
is up; the configured values otherwise.
Note that, for 1000Base-SX, the speed is always fixed at 1 Gbps,
and the duplex is always Full. Only the autonegotiation can be
turned on or off. So, the valid values to set for speed in the
command line for 1000Base-SX are and (case insensitive).
For 1000Base-T, it is essential that the link partner have the
same speed, duplex and autonegotiation settings as the NIC being
configured. The speed can be forced to 10 or 100 Mbps, with
Full or Half Duplex, with autonegotiation off. The speed can
also be forced to 1000 Mbps with autonegotiation on and Full
Duplex only. This is done by setting speed to one of or (case
insensitive).
is the option used for auto-negotiation purpose. Here the speed
of the link depends upon the link partners ability and its speed
setting.
In summary, the valid values to set for speed in the command
line for 1000Base-T are: and
The speed value can take one of three formats. In the human-
readable format, it is of the form:
[speed
Example:
Note that the speed and duplex may not be present in some situa‐
tions.
In the script-friendly output, the speed value is of the form:
[speed
Examples:
Note that the speed and duplex are optional in the scriptable
output also: they may not be present in some situations.
In the configuration file, there is an additional twist, because
there are separate variables for speed-duplex and autonegotia‐
tion. For 1000Base-T, the HP_IGELAN_SPEED variable can contain
one of the values and (same as the command line values). The
HP_IGELAN_AUTONEG variable is of no relevance.
For 1000Base-SX, the HP_IGELAN_SPEED is irrelevant, while the
HP_IGELAN_AUTONEG has values of either Off (same as 0) or On
(same as 1), indicating autonegotiation being off or on, respec‐
tively.
Note that speeds below 1 Gbps are allowed only if MTU is 1500
bytes or less.
Max Send Coalesce Ticks:
Maximum time for the NIC to wait after sending a frame before it
raises an interrupt. This and other interrupt tunables must be
modified with care.
Minimum: 0
Maximum: 10000000
Default: 150.
Max Send Buffers:
Maximum number of send descriptors for the NIC to coalesce
before it raises an interrupt. This and other interrupt tun‐
ables must be modified with care.
Minimum: 1
Maximum: 128
Default: 10
Transmit Checksum Offload:
Hardware TCP/UDP (IPv4) transmit checksum offload.
Values: Off, On.
Default: Off
Virtual MTU for TCP Segmentation Offload (TSO).
Setting it to zero disables TSO. Setting it to a non-zero value
enables TSO.
Values: 0, 32160
Default: 0
USAGE
Display Network Interfaces
This command displays network interface without any arguments.
The command without any arguments displays all the network
interfaces in the system, including physical LAN interfaces
(NICs), virtual LAN interfaces (VLANs and APA aggregates), and
RDMA-based interfaces.
View Basic Properties of One or More Interfaces
The following command displays basic properties of interfaces.
The form without the verbose option displays a table, with one
row for each interface that gets listed. If an interface is
specified as a target with the option, only that interface gets
displayed. If the option is specified, all interfaces are dis‐
played. The properties displayed for each interface are
explained in nwmgr(1M). Note that the operation is the default,
so the option need not be specified explicitly.
The verbose option changes the output to include more details
about each interface that is displayed, and also changes the
format to be line-oriented, with each line describing one prop‐
erty. The additional properties displayed for each interface
include not only those described in nwmgr(1M) but also the
speed, duplex and autonegotiation of the interface. More
details can be found in the section.
View Interface Statistics
The following commands display interface statistics.
The option can take zero or more of the following arguments:
The MIB statistics of the interface are displayed. This is the
default if no argument is provided to
The extended MIB statistics are displayed.
This overrides the argument, if present.
Displays the subsystem-specific statistics, which can vary from
one
driver to another.
Displays both extended MIB statistics and subsystem-specific
statistics,
in other words, it is equivalent to It overrides any
other arguments that may be present.
It is possible to give more than one argument to the option, as
a comma-separated list. For example, displays both the speci‐
fied sets of statistics.
View Interface Attributes
These commands can be used to view interface attributes.
These commands display the current value of either all the
attributes of the interface (when the keyword is specified) or
the specified attributes (when they are listed by name). Each
attribute is listed on a separate line as a name-value pair.
View Interface Details
These commands display interface details.
This form displays interface-specific properties that are infor‐
mational, often not configurable and subject to variation across
drivers.
It first displays the verbose listing for the interface; same as
what is shown by:
It then displays PCI-related properties such as the PCI Device
ID. It also displays the current driver state for the specified
interface.
View Interface's Vital Product Data
These commands display the interface's vital product data.
The Vital Product Data (vpd) is a standardized set of read-only
properties for an interface, including Manufactured Data for the
NIC, and the firmware versions.
Set Current Values of Attributes
These commands can be used to set current values of attributes with
user specified values.
You can set current values of attributes by specifying the val‐
ues with these commands.
Save Attribute Values as Default Values for an Interface
These commands can be used to set current attribute values from default
values.
Save the current values of all attributes of an interface into
the configuration file
This form stores the current value of each attribute of an
interface in the configuration file, so that the interface con‐
figuration is preserved across boots. The user can also run the
start-up script later by hand to apply the configuration file
values to the running kernel, by typing:
This feature allows a user to experiment with the current values
and, when a desired configuration is achieved, preserve it for
posterity.
Set Current Attribute Values from Default
These commands set the current values for attributes from the default
values.
The current values of all attributes of an interface (if is
specified) or the specified attributes (if the names are listed)
are set to be equal to their respective default values. This
can be useful in rolling all the changes made to an interface
since the time the system booted.
Reset an Interface
These commands reset an interface.
The interface is subjected to a PCI reset, which clears all pre‐
vious state, including the interface statistics. The interface
is then re-programmed with the attribute values that were cur‐
rent before the reset. Promiscuous mode and multicast addresses
are preserved across the reset.
While the reset is in progress, the data traffic through the
interface is interrupted. So, the command automatically per‐
forms a Critical Resource Analysis (CRA) to see if the interface
is data-critical; in other words, any other resource depends for
its functionality on the availability of the interface. If so,
the reset is not performed.
The reset can be forced, even if the interface is data-critical,
by using the option. It is possible for an interface to be sys‐
tem-critical; in other words, the health of the system depends
on the availability of the interface. In that case, the reset
will not be performed even if the option is specified.
Reset Statistics for an Interface
The following commands reset the statistics for an interface.
The data traffic statistics for an interface are cleared to
zero. This includes the byte count and packet count for inbound
and outbound traffic. Other aspects of the interface are left
unmodified.
Diagnose Link Connectivity
These commands perform link diagnosis.
number]
number]
Link connectivity at the data link layer is checked by sending
IEEE XID test frames to the specified destination MAC address
and counting the replies. The option specifies how many test
frames to send; the default is 1.
The attribute specifies the size of each test frame; the default
size is three bytes less than the MTU size currently set.
The attribute specifies how many seconds to wait for the
acknowledgement of each test frame; the default is 5 seconds.
RETURN VALUES
0 The command returns 0 on success.
<>0 On failure, the command returns values described in the section
below.
ERRORS
Attempt to set a read-only attribute.
The interface is presently inaccessible.
This is usually because the interface is part of an APA
aggregate, which prevents setting attributes on the
interface.
One or more of the attributes or options is invalid for the task.
Memory allocation failed. This could be a transient condition.
Operation or feature is not supported.
The target interface could not be accessed.
The user lacks the authorization
which is required for this operation.
The specified values of one or more attributes was less than the mini‐
mum or
more than the maximum.
EXAMPLES
List all LAN interfaces in the system:
Display the speed and MTU of the interface
Display all attributes of the interface
Set MTU to 9000 and enable transmit CKO on
Restore MTU and transmit CKO to their defaults on
COMPARISON WITH LANADMIN COMMAND
Commands to Display Generic NIC Attributes
┌──────────────────────┬───────────────────────────────────────┐
│ lanadmin │ nwmgr │
├──────────────────────┼───────────────────────────────────────┤
│lanadmin -m PPA │ nwmgr [-g] -A mtu -c lanPPA │
│ │ │
│lanadmin -a PPA │ nwmgr [-g] -A mac -c lanPPA │
│ │ │
│landamin -s PPA │ nwmgr [-g] -A speed -c lanPPA │
│ │ │
│lanadmin -m -a -s PPA │ nwmgr [-g] -A mtu,mac,speed -c lanPPA │
│ │ nwmgr [-g] -A all -c lanPPA │
└──────────────────────┴───────────────────────────────────────┘
Commands to Get NIC Statistics
┌─────────────────────────────┬────────────────────────────────────┐
│ lanadmin │ nwmgr │
├─────────────────────────────┼────────────────────────────────────┤
│lanadmin -g PPA │ nwmgr -g --st mib -c lanPPA │
│ │ │
│lanadmin -x stats drv PPA │ nwmgr -g --st subsys -c lanPPA │
│ │ nwmgr -g --st mib,subsys -c lanPPA │
│ │ │
│lanadmin -g mibstats_ext PPA │ nwmgr -g --st extmib -c lanPPA │
└─────────────────────────────┴────────────────────────────────────┘
Commands to Set Generic NIC Attributes
┌────────────────────────────┬─────────────────────────────────────────┐
│ lanadmin │ nwmgr │
├────────────────────────────┼─────────────────────────────────────────┤
│lanadmin -M mtu_size PPA │ nwmgr -s -A mtu=mtu_size-c lanPPA │
│ │ │
│lanadmin -A MAC_Address PPA │ nwmgr -s -A mac=MAC_Address -c lanPPA │
│ │ │
│landmin -X speed_value PPA │ nwmgr -s -A speed=speed_value -c lanPPA │
│ │ │
│Fiber NICS: │ │
│lanadmin -X auto_on PPA │ nwmgr -s -A speed=auto_on -c lanPPA │
└────────────────────────────┴─────────────────────────────────────────┘
Command to Display NIC Specific Attributes
┌────────────────────────────────┬──────────────────────────────────┐
│ lanadmin │ nwmgr │
├────────────────────────────────┼──────────────────────────────────┤
│lanadmin -x fctrl PPA │ nwmgr [-g] -A rx_fctrl │
│ │ -c lanPPA │
│ │ │
│lanadmin -x send_max_bufs PPA │ nwmgr [-g] -A send_max_bufs │
│ │ -c lanPPA │
│ │ │
│lanadmin -x recv_max_bufs PPA │ nwmgr [-g] -A recv_max_bufs │
│ │ -c lanPPA │
│ │ │
│lanadmin -x send_coal_ticks PPA │ nwmgr [-g] -A send_coal_ticks │
│ │ -c lanPPA │
│ │ │
│lanadmin -x recv_coal_ticks PPA │ nwmgr [-g] -A recv_coal_ticks │
│ │ -c lanPPA │
│ │ │
│lanadmin -x vmtu PPA │ nwmgr [-g] -A vmtu -c lanPPA │
│ │ │
│ │ Similarly the attributes rx_cko, │
│ │ tx_cko can be obtained. │
└────────────────────────────────┴──────────────────────────────────┘
Command to Set NIC Specific Attributes
┌─────────────────────────────┬───────────────────────────────┐
│ lanadmin │ nwmgr │
├─────────────────────────────┼───────────────────────────────┤
│lanadmin -X fctrl on PPA │ nwmgr -s -A rx_fctrl={on|off} │
│ │ -c lanPPA │
│ │ │
│lanadmin -X send_cko_off PPA │ nwmgr -s -A tx_cko={on|off} │
│ │ -c lanPPA │
│ │ │
│lanadmin -X recv_cko_on PPA │ nwmgr -s -A rx_cko={on|off} │
│ │ -c lanPPA │
└─────────────────────────────┴───────────────────────────────┘
Command to Reset a NIC
┌────────────────┬────────────────────┐
│ lanadmin │ nwmgr │
├────────────────┼────────────────────┤
│lanadmin -r PPA │ nwmgr -r -c lanPPA │
└────────────────┴────────────────────┘
Command to Reset Statistics of a NIC
┌────────────────┬────────────────────────┐
│ lanadmin │ nwmgr │
├────────────────┼────────────────────────┤
│lanadmin -c PPA │ nwmgr -r -st -c lanPPA │
└────────────────┴────────────────────────┘
Command to Reset MTU to the Default Value
┌────────────────┬─────────────────────────┐
│ lanadmin │ nwmgr │
├────────────────┼─────────────────────────┤
│lanadmin -R PPA │ nwmgr -s -A mtu │
│ │ -from default -c lanPPA │
└────────────────┴─────────────────────────┘
Command to Set to Default Configurations
┌────────────────────┬───────────────────────────────────────┐
│ lanadmin │ nwmgr │
├────────────────────┼───────────────────────────────────────┤
│lanadmin -A DEFAULT │ nwmgr -s -A mac -from default │
│PPA │ -c lanPPA │
│ │ │
│ │ NOTE: Similarly default configuration │
│ │ can be set for the other attributes │
│ │ like speed,mtu, mac etc. │
└────────────────────┴───────────────────────────────────────┘
The equivalent for displaying the usage information is not avail‐
able.
The options that support and are covered in the nwmgr_apa(1M) and
nwmgr_vlan(1M) manpages.
LINKLOOP COMMAND
Command to Test the Link Level Connectivity
┌───────────────────────┬──────────────────────────────────┐
│ linkloop │ nwmgr │
├───────────────────────┼──────────────────────────────────┤
│linkloop -i PPA │ nwmgr --diag -A dest=MAC_Address │
│MAC_Address │ -c lanPPA │
│ │ │
│linkloop -i PPA │ nwmgr --diag -A dest=linkaddr, │
│-n count -s size │ pktsize=size, timeout=timeout │
│-t timeout MAC_Address │ --it count -c lanPPA │
│ │ │
│linkloop -r rif │ N/A │
└───────────────────────┴──────────────────────────────────┘
does not allow multiple station addresses to be specified in the
same command line.
LANSCAN COMMAND
Command To List Interfaces and Their Attributes
┌────────┬───────────────────────┐
│lanscan │ nwmgr │
├────────┼───────────────────────┤
│lanscan │ nwmgr -g -v -c lanPPA │
│ │ nwmgr -C lan │
│ │ nwmgr -S igelan │
└────────┴───────────────────────┘
Command To Display Interface Names Only
┌───────────┬─────────────────────────────────────────────────────┐
│ lanscan │ nwmgr │
├───────────┼─────────────────────────────────────────────────────┤
│lanscan -i │ nwmgr -g -v -c lanPPA │
│ │ nwmgr -C lan --sc | awk -F# '/if_state/ {print $1}' │
└───────────┴─────────────────────────────────────────────────────┘
Command To Display MAC Types Only
┌───────────┬────────────────────────────────────────────┐
│ lanscan │ nwmgr │
├───────────┼────────────────────────────────────────────┤
│lanscan -m │ nwmgr -g -v -c lanPPA │
│ │ │
│ │ NOTE: nwmgr reports only on Ethernet links │
└───────────┴────────────────────────────────────────────┘
Command To Display NMIDs Only
┌───────────┬───────────────────────┐
│ lanscan │ nwmgr │
├───────────┼───────────────────────┤
│lanscan -n │ nwmgr -g -v -c lanPPA │
└───────────┴───────────────────────┘
Command To Display the PPAs Only
┌───────────┬───────────────────────────────────────────┐
│ lanscan │ nwmgr │
├───────────┼───────────────────────────────────────────┤
│lanscan -p │ nwmgr -g -v -c lanPPA │
│ │ nwmgr -C lan --sc | │
│ │ awk -F# '/if_state/ {print substr($1,4)}' │
└───────────┴───────────────────────────────────────────┘
Command To Display All MAC Addresses
┌───────────┬───────────────────────┐
│ lanscan │ nwmgr │
├───────────┼───────────────────────┤
│lanscan -a │ nwmgr -g -v -c lanPPA │
└───────────┴───────────────────────┘
Note: displays the NIC attributes such as interface name, MAC
type, the NMID, the PPA and the MAC address for only one
NIC as only one instance of class instance can be speci‐
fied for the option.
Note: The options and that support are covered in the
nwmgr_apa(1M) manpage.
AUTHOR
was developed by HP.
FILES
Contains the saved (persistent) configuration for igelan interfaces.
Startup script for the igelan driver, which applies the configuration
file to the running system. It is executed automatically after
each reboot, and can also be executed by the user by providing
the argument
SEE ALSOnwmgr(1M).
nwmgr_igelan(1M)
