nwmgr_btlan(1M) nwmgr_btlan(1M)
NAME
nwmgr_btlan: nwmgr - network interface management command for btlan driver
SYNOPSIS
lan_instance |
lan_instance
lan_instance
lan_instance
lan_instance
lan_instance
lan_instance
lan_instance
lan_instance
number]
lan_instance |
Remarks
The and commands are deprecated. These commands will be removed in a future HP-UX release. HP recommends the use of the replacement com-
mand nwmgr(1M) to perform all network interface-related tasks.
DESCRIPTION
The program is a unified command to administer all Local Area Network (LAN) and RDMA interfaces of HP-UX. See nwmgr(1M) for general infor-
mation about the command. This manpage describes when working with the driver.
The driver is one of the HP-UX drivers that manages the 100BT Ethernet interfaces, both copper (100Base-T) and fiber (100Base-FX). Each
interface has several attributes. Some attributes (for example, MTU) are configurable while others are read-only. In general, each
attribute can have certain value during run time (which is its current value), another value in the configuration file that stores data
across boots (its saved value), and an HP-supplied value that is applied by the driver after boot (its default value) but before the saved
value is applied. See the section for a list of attributes.
For interfaces, use the command to display information (with the option, which is the default), to modify the settings (the option), to
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 output in each case can be obtained in either human-readable form (the default form) or in a script-friendly parseable form (with the
or option). The format for script-friendly output is described in the nwmgr(1M) manpage.
It is guaranteed that any change in the scriptable output across releases will contain only additions, but not modifications or deletions.
The human-readable form can change across releases, including modifications and deletions, though the changes can be expected to be incre-
mental.
The usage is explained in greater detail in the following section. The output format that is described is the human-readable one; refer-
ences 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.
Limits the scope of the
operation to the classes provided.
Specifies the target interface on which the operation is to be performed.
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 keyword or special identifier used by a subsystem to
add additional context for the operation being performed.
The argument supported for is which 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
(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 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.
Displays the maximum Ethernet payload size (MTU), in bytes.
MTU above 1500 is not allowed.
Minimum value: 257.
Maximum value: 1500.
Default value: 1500.
Specifies the package size of each test frame
(for the operation). The default is CURRENT MTU-3 bytes.
The actual values of Speed, Duplex and Autonegotiation of the
Ethernet link if the link is up; otherwise, the configured values. Note that, for 100Base-FX, the is always fixed at 100 Mbps and
the duplex can be set to either Half or Full Duplex.
The valid values allowed for in the command line for 100Base-FX are: and (case insensitive).
For 100Base-T, it is essential that the link partner has the same speed, duplex and auto-negotiation settings as the NIC being con-
figured. The speed can be forced to 10 or 100 Mbps, with Full or Half Duplex, with auto-negotiation off. This is done by setting
speed to one of or (case insensitive). The valid values allowed for in the command line for 100Base-T are: and
The valid values to set for speed for the 100Base-FX are and Note that 10 Mbps and auto-negotiation are not supported speed configu-
rations for the PCI 100Base-FX card.
The output for the speed attribute can take one of the two formats. In the human-readable format, it is of the form:
speed
Example:
In the script-friendly output, the speed value is of the form:
speed
Examples:
Note that in both formats, the speed and duplex attributes are optional. 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 auto-negotiation.
For 100Base-T, the HP_BTLAN_SPEED variable can contain one of the following values and (same as the command line values). The
HP_BTLAN_AUTONEG variable is of no relevance when HP_BTLAN_SPEED is set. For PCI 100Base-FX, the HP_BTLAN_AUTONEG variable is
irrelevant.
Specifies how many seconds to wait for acknowledgement of each
test frame (for the operation). The default is 5 seconds.
USAGE
Display Network Interfaces
The most basic command to display network interface information.
The command without any argument displays all the network interfaces in the system, including physical LAN interfaces (NICs), vir-
tual LAN interfaces (VLANs and APA aggregates and failover groups), and RDMA interfaces.
View Basic Properties of Interfaces
The following command can be used to view the basic properties of one or more interfaces.
lan_instance |
lan_instance |
Note that the operation is the default, so the option need not be specified explicitly.
If an interface is specified as a target with the option, only that interface gets displayed. If the option is specified, inter-
faces are displayed. The properties displayed for each interface are explained in nwmgr(1M).
The command without the option displays a table, with one row for each interface that gets listed.
The verbose option changes the output to include more details about each interface displayed, and also changes the format to be
line-oriented, with each line describing one property. The following attributes are displayed: and
More details on these attributes can be found in the section.
View Interface Statistics
The following command can be used to display interface statistics.
lan_instance
lan_instance
The arguments and are the only valid arguments for for drivers. is the default if no argument is provided with It displays the same
information as which displays extended MIB statistics. displays a subset of MIB statistics of the interface.
View Interface Attributes
The following command can be used to display the current value of either all the attributes of the interface (when the keyword is speci-
fied), or the specified attributes (when they are listed by name, separated by commas).
lan_instance
attr_list} lan_instance
Each attribute is displayed on a separate line as a name-value pair.
View Interface Details
The following command can be used to display detail information of the interface.
lan_instance
lan_instance
This form displays interface-specific properties that are informational, often not configurable and subject to variation across
drivers. In the case of the output is same as what is shown by:
Set Attribute Values
The following command can be used to set values to the specified attributes.
lan_instance
lan_instance
The attributes that can be set are: and
Save Current Attributes Values
The following command can be used to save the current value of each interface in the configuration file.
lan_instance
lan_instance
This form 'freezes' the current state of an interface; that is, it stores the current value of each attribute of an interface in the
configuration file so that the interface configuration is saved across boots. The user can also manually run the start-up script
later to apply the configuration file values to the currently running kernel, by executing:
This feature allows a user to experiment with the current values, and save the desired configuration.
Set Attribute Values from Default Values
The following command can be used to set default values to all attributes (if is specified), or to selected attributes (if the attribute
names are listed).
lan_instance
lan_instance
This can be useful in rolling all the changes made to an interface since the time the system booted.
Reset an Interface
The following command can be used to reset an interface.
lan_instance
lan_instance
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; that is, 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-crit-
ical, by using the option.
It is possible for an interface to be system-critical; that is, the health of the system depends on the availability of the inter-
face. In that case, the reset will not be performed even if the option is specified.
Reset Statistics of an Interface
The following command can be used to reset statistics of 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
The following command can be used 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 value is 1.
The attribute specifies the size of each test frame. The default value is 100 bytes.
The attribute specifies how many seconds to wait for the acknowledgement of each test frame. The default value is 5 seconds.
RETURN VALUES
0 On success
<>0 On failure, the command returns values described in below.
ERRORS
Below are the errors generated by on failure.
Attempt to set a read-only attribute.
The interface is currently inaccessible.
This is usually because the interface is part of an APA aggregate, which prevents setting attributes on the inter-
face.
One or more of the attributes or options is invalid for the operation.
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 is less than the minimum 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 1400 and speed to on
Restore MTU and the MAC address to their defaults on
COMPARISON WITH LANADMIN COMMAND
Commands To Display Generic NIC Attributes
+----------------------+----------------------------------------+
| lanadmin | nwmgr |
+----------------------+----------------------------------------+
|lanadmin -m PPA | nwmgr [-g] -A mtu -c lan PPA |
| | |
|lanadmin -a PPA | nwmgr [-g] -A mac -c lan PPA |
| | |
|landamin -s PPA | nwmgr [-g] -A speed -c lan PPA |
| | |
|lanadmin -m -a -s PPA | nwmgr [-g] -A mtu,mac,speed -c lan PPA |
| | nwmgr [-g] -A all -c lan PPA |
+----------------------+----------------------------------------+
Commands To Get NIC Statistics
+-----------------------------+------------------------------------+
| lanadmin | nwmgr |
+-----------------------------+------------------------------------+
|lanadmin -g PPA | nwmgr -g --st mib -c lan PPA |
| | |
|lanadmin -x stats drv PPA | nwmgr -g --st subsys -c lan PPA |
| | nwmgr -g -st mib,subsys -c lan PPA |
| | |
|lanadmin -g mibstats_ext PPA | nwmgr -g --st extmib -c lan PPA |
+-----------------------------+------------------------------------+
+-----------------------------+------------------------------------+
Commands To Set Generic NIC Attributes
+---------------------------+-----------------------------------+
| lanadmin | nwmgr |
+---------------------------+-----------------------------------+
|lanadmin -M mtu_size PPA | nwmgr -s -A mtu=mtu_size |
| | -c lanPPA |
| | |
|lanadmin -A MAC_Add PPA | nwmgr -s -A mac=MAC_Address |
| | -c lan PPA |
| | |
|lanadmin -S speed PPA | N/A. NOTE: Speed can be specified |
| | as a combination of speed and |
| | duplexity only. For example: |
| | For example 100FD, 100HD etc |
| | |
|landmin -X speed_value PPA | nwmgr -s -A speed=speed_value |
| | -c lan PPA |
+---------------------------+-----------------------------------+
+---------------------------+-----------------------------------+
Command To Reset Statistics of a NIC
+----------------+-------------------------+
| lanadmin | nwmgr |
+----------------+-------------------------+
|lanadmin -c PPA | nwmgr -r -st -c lan PPA |
+----------------+-------------------------+
+----------------+-------------------------+
Command To Reset MTU To the Default Value
+----------------+--------------------------+
| lanadmin | nwmgr |
+----------------+--------------------------+
|lanadmin -R PPA | nwmgr -s -A mtu |
| | -from default -c lan PPA |
+----------------+--------------------------+
+----------------+--------------------------+
Command To Set To Default Configurations
+------------------------+---------------------------------------+
| lanadmin | nwmgr |
+------------------------+---------------------------------------+
|lanadmin -A DEFAULT PPA | nwmgr -s -A mac |
| | -from default -c lan PPA |
| | |
| | NOTE: Similarly default configuration |
| | can be set for the other attributes |
| | like speed,mtu, mac etc. |
+------------------------+---------------------------------------+
+------------------------+---------------------------------------+
Note: The equivalent for displaying the usage information is not available.
Note: The options that support and are covered in the nwmgr_apa(1M) and nwmgr_vlan(1M) manpages.
COMPARISON WITH 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 |
+-----------------------+---------------------------------+
Note: does not allow multiple station addresses to be specified in the same command line.
COMPARISON WITH LANSCAN COMMAND
Command To List Interfaces and Their Attributes
+--------+------------------------+
|lanscan | nwmgr |
+--------+------------------------+
|lanscan | nwmgr -g -v -c lan PPA |
| | nwmgr -C lan |
| | nwmgr -S gelan |
+--------+------------------------+
+--------+------------------------+
Command To Display Interface Names Only
+-----------+----------------------------------------------------+
| lanscan | nwmgr |
+-----------+----------------------------------------------------+
|lanscan -i | nwmgr -g -v -c lan PPA |
| | nwmgr -C lan -sc | awk -F# '/if_state/ {print $1}' |
+-----------+----------------------------------------------------+
+-----------+----------------------------------------------------+
Command To Display MAC Types Only
+-----------+-----------------------------+
| lanscan | nwmgr |
+-----------+-----------------------------+
|lanscan -m | nwmgr -g -v -c lan PPA |
| | |
| | NOTE: nwmgr reports only on |
| | Ethernet links |
+-----------+-----------------------------+
+-----------+-----------------------------+
Command To Display NMIDs Only
+-----------+------------------------+
| lanscan | nwmgr |
+-----------+------------------------+
|lanscan -n | nwmgr -g -v -c lan PPA |
+-----------+------------------------+
+-----------+------------------------+
Command To Display the PPAs Only
+-----------+---------------------------------------+
| lanscan | nwmgr |
+-----------+---------------------------------------+
|lanscan -p | nwmgr -g -v -c lan PPA |
| | 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 lan PPA |
+-----------+------------------------+
+-----------+------------------------+
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 interfaces.
Startup script for the
driver, which applies the configured values to the kernel during run time. It is executed automatically after each reboot, and the
user can also execute it by providing the argument
SEE ALSO
nwmgr(1M).
nwmgr_btlan(1M)