nwmgr_igssn(1M) nwmgr_igssn(1M)
NAME
nwmgr_igssn: nwmgr - network interface management command for igssn driver
SYNOPSIS
all
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
nwmgr(1M) 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 a HP-UX Guest driver that manages Ethernet interfaces. Each interface has several attributes. Some, such as MTU, are con-
figurable 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 (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
Attributes 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 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 configuration 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 manpage 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.
The usage is explained in greater detail below. The output format that is described is the human-readable one; references to the script-
able output are made as necessary.
Operations
The command provides the following operations for the igssn 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 performed.
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
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.
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 configuration (per
sistent 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 the interface are:
Ethernet MAC address of the remote interface. Used with the operation.
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 packet size in bytes of each test frame.
The default packet size is current MTU-3. Only valid for the operation.
This can be used to enable or disable TCP Packet Reassembly.
Values: Off, On
Default: On
USAGE
Display Network Interfaces
This command displays netowrk interface without any arguments.
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 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 speci-
fied as a target with the option, only that interface gets displayed. If the option is specified, all igssn 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 property. 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 sec-
tion.
View Interface Statistics
The following command displays 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 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 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
These commands display 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.
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 values 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 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. 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 pos-
terity.
Set Current Attribute Values from Default
These commands sets 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 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 (CRA) to see if the interface is data-critical; in other words, any other resource depends for its func-
tionality 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; 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 resets 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
This command is run to 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.
RETURN VALUES
0 The command returns 0 on success.
<>0 On failure, the command returns values described in the section below. 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 minimum or
more than the maximum.
EXAMPLES
List all LAN interfaces in the system:
Display the MAC Address and MTU of the interface
Display all attributes of the interface
Set MTU to 9000 and disable TCP Packet Reassembly 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 |
| | |
|lanadmin -m -a PPA | nwmgr [-g] -A mtu,mac -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 |
| | |
+----------------------------+---------------------------------------+
Command to Display NIC Specific Attributes
+-----------------------+----------------------+
| lanadmin | nwmgr |
+-----------------------+----------------------+
|lanadmin -x drv_pr PPA | nwmgr [-g] -A drv_pr |
| | -c lanPPA |
+-----------------------+----------------------+
Command to Set NIC Specific Attributes
+---------------------------+-----------------------------+
| lanadmin | nwmgr |
+---------------------------+-----------------------------+
|lanadmin -X drv_pr off PPA | nwmgr -s -A drv_pr={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 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=MAC_Address, |
|-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 igssn |
+--------+-----------------------+
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 specified 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 igssn interfaces.
Startup script for the igssn 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 "start".
SEE ALSO
nwmgr(1M).
nwmgr_igssn(1M)