nwmgr_ixgbe(1M) nwmgr_ixgbe(1M)
NAME
nwmgr - network interface management command for ixgbe driver
SYNOPSIS
PPA |
number]
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 the HP-UX driver that manages 10 Gigabit Ethernet fiber interfaces (10GBASE-SR). Each interface has several attributes.
Some such as MTU are configurable while others are read-only. In general, each attribute can have a certain value in the running system
(which is its current value), another value in the configuration file that stores data across boots and DLKM loads (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 named 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 connectivity (the option). Operations other than require the authoriza-
tion. For more information about authorizations and Role-based Access Control, see rbac(5).
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
scriptable output across releases will contain only additions, never modifications or deletions. The human-readable format can change
across releases, including modifications and deletions, though the changes can be expected to be incremental.
Operations
The command provides the following operations for the interface.
Get/display interface settings. This is the default operation when none is specified.
Diagnose/test link connectivity.
Display help information.
Reset interface or the statistics on the interface.
Set the attributes of the interface.
Options
Beside operations, these options are valid for the interface:
Specifies attributes for an operation. For this can be used with the and operations.
See section below for valid attributes of interfaces.
Specifies the target interface on which the operation is to be performed.
For the target interface is of the form:
where PPA is the physical point of attachment.
Specifies the target subsystem for the operation.
For the subsystem, the option argument is always
Specifies the configuration from which the operation will copy
data. For the subsystem, and are the only allowed arguments for this option.
Specifies the number of frames to be sent for diagnostics,
used with the diagnose operation.
Specifies an
specific target qualifier. The arguments supported for are: and
Provides more information on the instance of the
subsystem; such as, the hardware path, feature capabilities, current feature settings, the assigned NMID, speed, and MTU
of the card.
Provides vital product data (VPD) which is a standardized set of read-only
properties for an interface, including Manufacturing Data for the NIC and the firmware versions.
Provides destination port based steering settings information.
Provides interrupt coalescing settings information.
Specifies that the operation must be performed on the saved configuration
(persistent store).
Specifies that the operation must be performed on the current values
of the attributes of the interface. See section below for valid attributes of interfaces.
Displays the output in script parseable format.
Specifies that the operation applies to the statistics of the target.
Specifies verbose output to display more detail.
Attributes
The valid attributes for interface are:
Ethernet MAC address of the remote interface. Used with the operation.
DPS PQM Round Robin.
Enable/Disable round robin mode of queue assignment for destination port based steering.
Values: Off, On
Default: Off
DPS PQM Periodic Invalidation.
Enable/Disable periodic invalidation of Port-to-queue mapping table entries for Destination Port based steering.
Values: Off, On
Default: Off
DPS PQM Invalidation Timer.
Timer value after which the port-to-queue mapping table entries will be invalidated. Valid only when PQM Periodic Invalidation is
on.
Min: 0
Max: 32
Default: 5
Destination Port Based Steering.
A feature that allows packets to be steered to different queues based on the destination port number of the packet. This feature
can improve performance with some workloads.
Values: Off, On
Default: On
Number of Queues.
Number of Queues for Multi-Queue. This feature allows the driver to steer the transmit/receive packets to multiple Tx/Rx queues
respectively. The attribute sets the number of queues for both Transmit and Receive.
Min: 1
Max: 8
Default: 1 (on a single Processor System)
TCP Packet Reassembly in Driver.
This feature allows the driver to combine TCP segments and pass the large combined packet to the upper layers of the network stack
in the receive path. This feature can lower CPU utilization.
must be on before turning on
Values: Off, On
Default: Off
Receive Flow Control Threshold:
Percentage of receive buffers in use before a pause frame is sent.
Min: 1
Max: 100
Default: 75
MAC Address:
Ethernet MAC Address. The default value is the factory MAC address.
MTU: Maximum Ethernet payload size, in bytes. Valid values are 257 - 1500 and 9000.
Default: 1500
9000 bytes is the value to use for Jumbo Frames.
Specifies the package size in bytes of each test frame.
The default is 100. Only valid for the operation.
Receive Checksum Offload.
Hardware TCP/UDP (IPv4) receive checksum offload.
Values: Off, On
Default: On
Receive Flow Control.
Ability of the interface to receive Ethernet Flow control frames.
Values: Off, On
Default: On (case insensitive)
RX Frame Count A.
Frame Count for receive interrupt coalescing for Range 0 - R1%.
Min: 0
Max: 65535
Default: 1
RX Frame Count B.
Frame Count for receive interrupt coalescing for Range R1 - R2%.
Min: 0
Max: 65535
Default: 64
RX Frame Count C.
Frame Count for receive interrupt coalescing for Range R2 - R3%.
Min: 0
Max: 65535
Default: 128
RX Frame Count D.
Frame Count for receive interrupt coalescing for Range R3 - 100%
Min: 0
Max: 65535
Default: 512
RX Range Limit 1.
Link-utilization range limit 1 (R1) for receive interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
must be less than
Min: 0
Max: 100
Default: 5
RX Range Limit 2.
Link-utilization range limit 2 (R2) for receive interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
must be less than
Min: 0
Max: 100
Default: 25
RX Range Limit 3.
Link-utilization range limit 3 (R3) for receive interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
Min: 0 Max: 100
Default: 70
RX Timer Interrupt.
The time interval between receive interrupts. Units in microseconds. Setting to 0 disables the timer.
Min: 0
Max: 32000000
Default: 100
Speed, Duplex and Autonegotiation.
Actual values of speed and duplex if the link is up; the configured values otherwise. Note that, for 10GBase-SR, the speed is
always fixed at 10 Gbps, and the duplex is always Full. This value is read-only.
Transmit Checksum Offload.
Hardware TCP/UDP (IPv4) transmit checksum offload.
Values: Off, On
Default: On
Transmit Flow Control.
Ability of the interface to transmit Ethernet Flow control frames.
Values: Off, On
Default: On (case insensitive)
When configured, the adapter automatically generates a pause frame when the amount of data in the receive queue exceeds the thresh-
old
TX Frame Count A.
Frame Count for transmit interrupt coalescing for Range 0 - R1%.
Min: 0
Max: 65535
Default: 32
TX Frame Count B.
Frame Count for transmit interrupt coalescing for Range R1 - R2%.
Min: 0
Max: 65535
Default: 256
TX Frame Count C.
Frame Count for transmit interrupt coalescing for Range R2 - R3%.
Min: 0
Max: 65535
Default: 512
TX Frame Count D.
Frame Count for transmit interrupt coalescing for Range R3 - 100%
Min: 0
Max: 65535
Default: 512
TX Range Limit 1.
Link-utilization range limit 1 (R1) for transmit interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
must be less than
Min: 0
Max: 100
Default: 5
TX Range Limit 2.
Link-utilization range limit 2 (R2) for transmit interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
must be less than
Min: 0
Max: 100
Default: 25
TX Range Limit 3.
Link-utilization range limit 3 (R3) for transmit interrupt coalescing: 0 - R1 - R2 - R3 - 100%.
Min: 0
Max: 100
Default: 70
TX Timer Interrupt.
The time interval between transmit interrupts. Units in microseconds. Setting to 0 disables the timer.
Min: 0
Max: 32000000
Default: 225000
UDP Multifragment Checksum Offload.
Set IPv4 UDP multi-fragment checksum offload. and must be on before turning on
Values: Off, On
Default: On
Virtual MTU.
Virtual MTU for TCP Segmentation Offload (TSO). Setting it to zero disables TSO. Setting it to a non-zero value enables TSO, but
only if Transmit Checksum Offload is enabled.
Values: 0, 32160
Default: 32160
USAGE
The common usages of for the driver are described in greater detail below. The output format that is described is the human-readable one;
references to the scriptable output are made as necessary.
The command without any arguments displays all the network interfaces in the system, including physical LAN interfaces (NICs), vir-
tual LAN interfaces (VLANs and APA aggregates), and RDMA-based interfaces.
View Basic Properties of One or More Interfaces
The form without the verbose option displays a table, with one row for each interface that gets listed. If an interface is speci-
fied as a target with the option, only that interface gets displayed. If the option is specified, all interfaces are displayed.
The properties displayed for each interface are explained in nwmgr(1M). Note that the get 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 property. The additional properties displayed for each interface include not only
those described in nwmgr(1M) but also the speed and duplex of the interface. More details can be found in the section.
View 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 specified
sets of statistics.
View Interface Attributes
These commands display the current value of either all the attributes of the interface (when the keyword is specified) or the speci-
fied attributes (when they are listed by name). Each attribute is listed on a separate line as a name-value pair.
View Interface Details
This form displays interface-specific properties that are informational, 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 is a standardized set of read-only properties for an interface, including Manufacturing Data for the NIC, and
the firmware versions.
View Destination Port Based Steering Settings
View Interrupt Coalescing Settings
Set Current Values of Specified Attributes to Their Stated Values
Save Attributes Values as Default Values for An Interface
Save the current values of all attributes of an interface in the configuration file
This form stores the current value of each attribute of an interface in the configuration file, so that the interface configuration
is preserved across boots (and DLKM loads). 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 con-
figuration is achieved, preserve it for posterity.
Set Current Attributes Values From Default
These commands set the current values for attributes from the default values for an interface.
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
The interface is subjected to a PCI reset, which clears all previous state, including the interface statistics. The interface is
then re-programmed with the attribute values that were current before the reset. Promiscuous mode and multicast addresses are pre-
served across the reset.
While the reset is in progress, the data traffic through the interface is interrupted. So, the command automatically performs a
Critical Resource Analysis to see if the interface is data-critical, i.e., 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 system-critical, i.e., the health of the system depends on the avail-
ability of the interface. In that case, the reset will not be performed even if the option is specified.
Reset 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
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 is 100 bytes.
The attribute specifies how many seconds to wait for the acknowledgement of each test frame; the default is 5 seconds.
TRANSMIT AND RECEIVE INTERRUPT COALESCING
The 10 GigE card provides four link-utilization ranges, corresponding frame counts, and also a timer. Based on the utilization range, an
interrupt will be generated after a specified number of frames have been processed by the card. The link utilization ranges and the frame
counts are programmable. You can specify three range limits for transmit and and receive and that provide four utilization ranges as indi-
cated below. Please note that the link utilization is expressed as a percentage. Corresponding to each range, we have frame counts:
For transmit: and
For receive:
Here are the ranges (only transmit shown, receive would be the same):
Range-A 0 - tx_r1% tx_frc_a
Range-B tx_r1 - tx_r2% tx_frc_b
Range-C tx_r2 - tx_r3% tx_frc_c
Range-D tx_r3 - 100% tx_frc_d
For the frame counts, the range of values is {0 - 65535}.
The timer value is expressed in microseconds and can be in the range {0 - 32000000}. When the value is zero, interrupts are disabled. The
default values are:
For transmit Interrupt Coalescing:
Link util: 0 - 5 5 - 25 25 - 70 70 - 100
Frame Count: 32 256 512 512
Timer: 225000
For Receive Interrupt Coalescing:
Link util: 0 - 5 5 - 25 25 - 70 70 - 100
Frame Count: 1 64 128 512
Timer: 0
The above values can be set with the following commands:
RETURN VALUES
0 The command returns 0 on success.
<>0 On failure, the command returns values described in the section below.
ERRORS
Operation or feature is not supported.
One or more of the attributes or options is invalid for the task.
The specified values of one or more attributes was less than the minimum or
more than the maximum.
The user lacks the authorization
which is required for this operation.
Attempt to set a read-only attribute.
The target interface could not be accessed.
Memory allocation failed. This could be a transient condition.
The interface is presently inaccessible. This is usually because the interface
is part of an APA aggregate, which prevents setting attributes on the interface.
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 drv_fctrl PPA | nwmgr [-g] -A rx_fctrl,tx_fctrl, |
| | fctrl_thresh -c lanPPA |
| | |
|lanadmin -x drv_mq PPA | nwmgr [-g] -A drv_mq |
| | -c lanPPA |
| | |
|lanadmin -x drv_dp PPA | nwmgr [-g] -A drv_dps |
| | -c lanPPA |
| | |
|lanadmin -x cko PPA | nwmgr [-g] -A tx_cko,rx_cko, |
| | udpmf_cko -c lanPPA |
| | |
|lanadmin -x drv_pr PPA | nwmgr [-g] -A drv_pr |
| | -c lanPPA |
| | |
|lanadmin -x vmtu PPA | nwmgr [-g] -A vmtu -c lanPPA |
| | Similarly the attributes |
| | dps_ttm_time and dps_rr |
| | can be obtained. |
+--------------------------+----------------------------------+
Command to Set NIC Specific Attributes
+-----------------------------------+-------------------------------------+
| lanadmin | nwmgr |
+-----------------------------------+-------------------------------------+
|lanadmin -X tx_coal rng R1 R2 R3 | nwmgr -s -A tx_r1=value1, |
|frc A B C D timer T1 PPA | tx_r2=value2, tx_r3=value3, |
| | tx_frc_a=value4, tx_frc_b=value5, |
| | tx_frc_c=value6, tx_frc_d=value7, |
| | tx_timer=value8 -c lanPPA |
| | |
|lanadmin -X rx_fctrl {on|off} PPA | nwmgr -s -A |
| | rx_fctrl={on|off} -c lanPPA |
| | |
|lanadmin -X fctrl_thresh value PPA | nwmgr -s -A fctrl_thresh=value |
| | -c lanPPA |
| | |
|lanadmin -X recv_cko_on PPA | nwmgr -s -A rx_cko={on|off} |
| | -c lanPPA |
| | |
|lanadmin -X dps_rr_on PPA | nwmgr -s -A dps_rr={on|off} |
| | -c lanPPA |
| | |
|lanadmin -X dps_ttm_time value PPA | nwmgr -s -A dps_ttm_time=value |
| | -c lanPPA |
| | |
|lanadmin -X default PPA | nwmgr -s -A all --from default |
| | -c lanPPA |
| | Similarly the attributes tx_cko, |
| | udpmf_cko, drv_dps, dps_ttm,drv_pr, |
| | rx_coal can be set. |
+-----------------------------------+-------------------------------------+
Command to Display Interface-Specific Properties
+--------------------------+------------------------+
| lanadmin | nwmgr |
+--------------------------+------------------------+
|lanadmin -x card_info PPA | nwmgr [-g] -q info |
| | -c lanPPA |
| | |
|lanadmin -x vpd PPA | nwmgr [-g] -q vpd |
| | -c lanPPA |
| | |
|lanadmin -x dps_map PPA | nwmgr [-g] -q dps_map |
| | -c lanPPA |
| | |
|lanadmin -x drv_coal PPA | nwmgr [-g] -q drv_coal |
| | -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 available.
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 ixgbe |
+--------+-----------------------+
Command To Display Interface Names Only
+-----------+-----------------------------------------------------+
| lanscan | nwmgr |
+-----------+-----------------------------------------------------+
|lanscan -i | nwmgr -C lan --sc | awk -F# '/if_state/ {print $1}' |
+-----------+-----------------------------------------------------+
Command To Display the PPAs Only
+-----------+-------------------------------------------+
| lanscan | nwmgr |
+-----------+-------------------------------------------+
|lanscan -p | nwmgr -C lan --sc | |
| | awk -F# '/if_state/ {print substr($1,4)}' |
+-----------+-------------------------------------------+
Command To Display All MAC Addresses
+-----------+--------------------------------------------+
| lanscan | nwmgr |
+-----------+--------------------------------------------+
|lanscan -a | nwmgr -g --sc| awk -F# '/mac/ {print $4}' |
+-----------+--------------------------------------------+
Note: displays the NIC attributes such as interface name, MAC type, the NMID, the PPA and the MAC address for all LAN interfaces
on the system.
Note: The options and that support are covered in the nwmgr_apa(1M) manpage.
Obsolescence
and commands are deprecated. These commands will be removed in a future HP-UX release. HP recommends the use of replacement command
nwmgr(1M) to perform all network interface related tasks.
AUTHOR
was developed by HP.
FILES
Contains the saved (persistent) configuration for
interfaces.
Startup script for the
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 ALSO
nwmgr(1M).
nwmgr_ixgbe(1M)