nwmgr_vlan(1M) nwmgr_vlan(1M)
NAME
nwmgr_vlan: nwmgr - network interface management command for VLAN interface
SYNOPSIS
number]
Remark
The and commands are deprecated and 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 nwmgr(1M) manpage.
This nwmgr_vlan(1M) manpage describes as applied to the VLAN subsystem.
VLANs are logical or "virtual" network segments that can span multiple physical network segments. A primary benefit of VLANs is that they
can isolate broadcast and multicast traffic by determining which destinations should receive that traffic, thereby making better use of
switch and end-station resources.
The commands described here are for interactive administration of HP-UX Virtual LAN (VLAN) interfaces.
The command can be used on VLAN interfaces to display information (with the option, which is the default), add VLAN interfaces (with the
option), delete VLAN interfaces (with the option), modify settings (with the option), reset the interface or its statistics (with the
option), obtain the usage information (with the option) and to diagnose link connectivity (with the option).
Operations other than require authorization. For more information about authorizations and Role-based Access Control, see rbac(5).
The settings of the VLAN interface 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 format (which is the default) or in a script-friendly parseable format
(with the or option).
The format for script-friendly output is described in the nwmgr(1M) manpage. HP guarantees that any change in the scriptable output across
releases will contain only additions. The existing content will not be modified or deleted. The content of human-readable format can
change across releases though the changes can be expected to be incremental.
Operations
The command provides the following operations for the VLAN interface.
Add/create VLAN interface.
Perform Critical Resource Analysis on the VLAN interface.
Delete the VLAN interface.
Diagnose/test link connectivity.
Get/display VLAN interface settings.
This is the default operation when none is specified.
Display help information.
Reset VLAN interface or the statistics on the VLAN interface.
Set the attributes of the VLAN interface.
Options
Beside operations, these options are valid for the VLAN interface:
Specifies attributes for an operation. For VLAN, this can be used with the and operations.
See section below for valid attributes of VLAN interfaces.
Specifies the target interface on which the operation is to be performed.
For VLAN, the target interface is of the form:
where VPPA is the VLAN physical point of attachment.
Specifies the target subsystem for the operation.
For the VLAN subsystem, the option argument is always
Specifies the configuration from which the operation will save
data. For the VLAN subsystem, is the only allowed argument for this option.
Specifies the number of frames to be sent for diagnostics,
used with the diagnose operation.
Specifies that the operation must be performed on the saved configuration
(persistent store).
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 following attributes can be used with the option for VLAN interfaces. Refer to the section below to see which attributes are valid for
specific operations.
Ethernet MAC address of the remote interface. Used with the operation.
Ethernet MAC Address.
Only valid for the operation.
Displays the maximum Ethernet payload size (MTU), in bytes.
Only valid for the operation.
An optional name for the interface.
The default value of name is the null string (""). However, displays this as UNNAMED.
Specifies the packet size in bytes of each test frame.
The default is MTU-3. Only valid for the operation.
Specifies
the physical point of attachment (PPA) of the interface where the VLAN interface will be added. Only valid for the operation.
Specifies
the 802.1p priority in the VLAN tag of the frame header. Switches use the 802.1p priority.
The valid range is 0-7.
The default is 0.
Priority override provides a mechanism to convert IP level
precedence (IPV4 ToS octet) to link level 802.1p user priority.
Priority override applies to outbound frames only. Priority override level strings are:
Your specified priority value will be used. This is the default value.
IP header ToS will be converted to 802.1p priority.
Your specified ToS value will be converted to 802.1 priority.
Speed and duplex of the related interface.
For 10 Mbps, 100 Mbps, and multiple of 10 and 100 Mbps, the speed is displayed in Mbps. For 1 Gbps and above, the speed is dis-
played in Gbps. The duplexity can be either "half" or "full".
Only valid for the operation.
Specifies how many seconds to wait for acknowledgement of each
test frame for the operation.
The default is 5 seconds.
Specifies
the IP precedence in the IP header. Switches ignore ToS. Routers may use it.
The valid range is 0-255.
The default is 0.
ToS override provides a mechanism to override the IP level
precedence in the header of an inbound IP packet. ToS override level strings are:
ToS value in the IP header will be used. This is the default value.
Ether header 802.1p priority will be converted to a ToS value.
Your specified ToS value will be used.
Your specified 802.1 priority value will be converted to a ToS value.
Uniquely identifies the VLAN to which
a frame belongs.
USAGE
The common usages of for VLAN interfaces are described in this section.
Add a VLAN Interface
This command adds a VLAN interface over a VLAN capable interface. If a VPPA (virtual PPA) is specified as a target with the option,
the VLAN interface added will be allocated that VPPA. If the option is not specified, the VPPA is allocated by the system.
The valid attributes (specified with the option) for the operation are:
Delete a VLAN Interface
This command deletes the VLAN interface if it is not in use.
Caution: HP strongly advises you first run the Critical Resource Analysis (with the option) to check usage information before delet-
ing a VLAN interface.
Delete a VLAN Interface from the Configuration File
This command deletes the entries for the specified VLAN interface from the configuration file so that the VLAN interface will not be
created during reboot.
Delete All the VLAN Interfaces from the Configuration File
This command deletes the entries of all VLAN interfaces from the configuration file so that no VLAN interfaces will be created dur-
ing reboot.
Set the Attributes of the VLAN Interface on the System
Attributes that can be set are:
Save VLAN Interface Attributes to the Configuration File
This command saves the current attribute values of the specified VLAN interface to the configuration file, so that the interface
configuration is preserved across boots.
You cannot save individual attributes to the configuration file. All attributes must be saved together. New entries will be cre-
ated if they do not already exist in the configuration file for the specified interface. If there are entries with the same VLAN ID
or VLAN name for the related interface, the existing entries will be deleted and a new entry will be created. If there are entries
with the same VPPA, the existing entries will be deleted and a new entry will be created.
Save the Attributes of all VLAN interfaces to the Configuration File
This command saves the attribute values of all the VLAN interfaces on the system to the configuration file, so that the interface
configuration is preserved across boots.
You cannot save individual attributes to the configuration file. All attributes must be saved together. All the existing entries in
the configuration file will be deleted and new entries will be added for the VLAN interfaces on the system.
View All Attributes of VLAN Interfaces
This command gets the attributes of one or all VLAN interfaces on the system. When the target is a VLAN interface, the attributes
of the specified VLAN interface are displayed. When the target is the VLAN subsystem, attributes of all the VLAN interfaces on the
system are displayed.
When the option is not provided, the following attributes are displayed in a tabular format:
When the option is provided, more details about the interface are displayed in a line-oriented format. The following additional
attributes are displayed with the option:
Operational status of the interface.
The valid values are UP and DOWN.
The cause for the link to be in UP or DOWN state.
Ethernet MAC Address.
The default value is the factory assigned MAC address.
The name of the subsystem.
For VLAN, it is displayed as
The interface on which the VLAN interface is added.
The hardware path of the VLAN interface.
The network management ID of the VLAN interface.
The features supported by the VLAN interface.
The possible outputs are:
o IPV4 Recv CKO - Driver supports inbound IPv4 CKO (Checksum offload).
o IPV4 Send CKO - Driver supports outbound IPv4 CKO.
o IPV4 Recv CKO - Driver supports inbound IPv6 CKO.
o IPV4 Send CKO - Driver supports outbound IPv6 CKO.
o VLAN Tag Offload - Underlying hardware capable of VLAN tagging.
o 64Bit MIB Support - 64 MIB statistics supported by driver.
o IPV4 TCP Segmentation Offload - IPV4 TCP Segmentation supported by driver.
o IPV4 TCP Segmentation Offload - IPV6 TCP Segmentation supported by driver.
o UDP Multifrag CKO - CKO for UDP multifragmented packets supported by driver.
The features set on the VLAN interface.
Maximum Ethernet payload size, in bytes.
MTU above 1500 is allowed only when the speed is 1 Gbps or above.
The valid range is 1024-9000.
The default is 1500.
Speed and duplex of the related interface.
For 10 Mbps, 100 Mbps, and multiple of 10 and 100 Mbps, the speed is displayed in Mbps. For 1 Gbps and above, the speed is
displayed in Gbps.
View All or Selected Attributes of a VLAN Interface
This command gets the value of individual attributes. When is provided as the argument to the option, more details about the inter-
face are displayed in addition to the VLAN attributes. The additional attributes displayed are discussed under the section,
The following attributes are valid for this command:
View VLAN Interface Statistics
This command displays the MIB statistics of the interface. For the VLAN subsystem, 64 bit mib statistics are always displayed
regardless of the related interface.
Reset a VLAN Interface
This command clears all previous state, including the interface statistics. Promiscuous mode and multicast addresses are preserved
across the reset. While the reset is in progress, data traffic through the interface is interrupted.
Reset Statistics on a VLAN Interface
This command resets the statistics for an VLAN interface. With this command, 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 unchanged.
Perform Critical Resource Analysis on the VLAN Interface
This command performs Critical Resource Analysis (CRA) on the VLAN interface and displays the impact of performing a destructive
action on the target. HP recommends performing CRA to check usage before performing destructive actions such as deleting a VLAN
interface.
Diagnose Link Connectivity
number]
number]
This command diagnoses link connectivity at the data link layer by sending IEEE XID test frames to the specified destination MAC
address and counting the replies.
The option specifies the number of test frames to be sent; the default is 1.
The attribute specifies the size in bytes of each test frame; the default is MTU-3.
The attribute specifies how many seconds to wait for the acknowledgement of each test frame; the default is 5 seconds.
RETURN VALUES
0 Success.
<>0 Failure. The command returns values described in below.
ERRORS
Attempt to set a read-only attribute.
Interface is presently inaccessible.
One or more of the attributes or options is invalid for the task.
IO error.
File does not exist.
Memory allocation failed.
This could be a transient condition.
Operation or feature is not supported.
Interface could not be accessed.
User lacks the authorization required for this operation.
Specified values of one or more attributes were lower than the minimum or
greater than the maximum allowed.
Device or interface not found.
Device or interface already exists.
EXAMPLES
Help for all VLAN operations in terse mode:
Help for all VLAN operations in verbose mode:
Help for the operation:
Add vlan with 10 to
View attributes of all VLAN interfaces in tabular format:
View attributes of all VLAN interfaces in format:
View attributes of all VLAN interfaces in scriptable format:
View attributes of in tabular format:
View attributes of in format:
View attributes of in scriptable format:
View of in scriptable format:
View statistics of in scriptable format:
Set to 20 in
Set to 25 in with output in scriptable format:
Save all the attributes of to configuration file:
Save all the attributes of all VLAN interfaces on the system to configuration file:
Delete
Delete from persistent store:
Delete all VLAN interfaces from the persistent store:
Delete with output in scriptable format:
Reset
Reset with output in scriptable format:
Reset/Clear statistics of
Reset/Clear statistics of with output in scriptable format:
Perform Critical Resource Analysis (CRA) of
Perform Critical Resource Analysis (CRA) of with output in scriptable format:
Check connectivity between and MAC address
COMPARISON WITH LANADMIN
/LINKLOOP
The following table lists commands and their equivalent commands.
|
nwmgr | equivalent lanadadmin/linkloop
------------------------------------+-----------------------------------
nwmgr -S vlan | lanadmin -V scan
------------------------------------+-----------------------------------
nwmgr -c lan5000 | lanadmin -V info 5000
------------------------------------+-----------------------------------
nwmgr -a -S vlan -A vlanid=10,ppa=1 | lanadmin -V create vlanid 10 1
------------------------------------+-----------------------------------
nwmgr -d -c lan5000 | lanadmin -V delete 5000
------------------------------------+-----------------------------------
nwmgr -s -c lan5000 -A vlanid=20 | lanadmin -V modify vlanid 20 5000
------------------------------------+-----------------------------------
nwmgr --cra -c lan5000 | lanadmin -p 5000
------------------------------------+-----------------------------------
nwmgr --diag -c lan5000 | linkloop -i 5000 0xaabbccddeeff
-A dest=0xaabbccddeeff |
------------------------------------+-----------------------------------
AUTHOR
was developed by HP.
FILES
Contains the saved (persistent) configuration for vlan interfaces.
Startup script for the vlan 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), dlpi(7), vlan(7).
nwmgr_vlan(1M)