ioscan(1M) ioscan(1M)
NAME
ioscan - scan the I/O system
SYNOPSIS
driver | class] instance] hw_path] | [devfile]
instance]
driver | class] instance] hw_path] [devfile]
driver | class] instance] lun hw_path] [devfile]
[devfile]
hw_path]
DESCRIPTION
scans system hardware, usable I/O system devices, or kernel I/O system data structures as appropriate, and lists the results. For each
hardware module on the system, displays by default the hardware path to the hardware module, the class of the hardware module, and a brief
description.
By default, scans the system and lists all reportable hardware found. The types of hardware reported include processors, memory, interface
cards and I/O devices. Scanning the hardware may cause drivers to be unbound and others bound in their place in order to match actual sys-
tem hardware. Entities that cannot be scanned are not listed. By default, will display the list using the legacy view (see intro(7)).
The command scans the system in the agile view or the legacy view, depending on whether or not the option is used, and lists all reportable
hardware found. If cannot find any hardware based on the options and arguments specified, prints no information and exits with a return
value of since the scan encountered no errors.
can also use its options to perform the following:
o displays output using the agile view instead of the legacy view (see intro(7)).
o forces the specified software driver into the kernel I/O system and forces software driver to be bound. This option can be used to make
the system recognize a device that cannot be recognized automatically; for example, a device has not yet been connected to the system,
the device does not support autoconfiguration, or diagnostics need to be run on a faulty device.
o when used with the option, tries to do an online binding first. If the driver does not support online binding, binding will be deferred
to the next boot. The hardware path specified for a deferred binding operation must be a LUN hardware path of a node.
o displays the date and time at which system hardware was last scanned.
Note: The option cannot be used with any other options available for this command.
o displays the property of a node.
o displays the mapping between LUN hardware path and the lunpath hardware path.
o displays the mapping between legacy device special files and persistent device special files (see intro(7)).
o displays the mapping between (legacy) hardware path, lunpath hardware path, and LUN hardware path.
o lists the stale entries present in the system.
o reverts the deferred binding action on a device lunpath.
o lists all the pending deferred bindings.
o scans all unclaimed nodes of type INTERFACE.
o shows information about thread 0 for a processor with Hyper Threading feature.
o displays the alias path of a node.
Security Restriction
Generally, requires superuser privileges. A non root user may use the following options:
only to display the kernel hardware tree.
use the mapping features.
display the property of a node.
list pending deferred bindings.
display date and time of the last system hardware scan.
list usable I/O system devices.
display information about thread 0 of a processor with Hyper Threading feature.
Driver binding and actual hardware scanning is restricted to root.
Options
recognizes the following options:
Display the alias_path of a node. The alias_path is an alternative user-friendly name assigned to a hardware path. Must be used
with the option.
Show information about thread "0" for a processor with
Hyper Threading feature. When used with the option, the command generates a compact listing of fields separated by
colons which is useful for producing custom listings with Fields include: socket, core, thread.
Defer the binding of a driver to a hardware path until the next
system boot. Must be used with the and options.
List all the pending deferred bindings.
Restrict the output listing to those devices belonging to the specified
class. Cannot be used with
Restrict the output listing to those devices controlled by the specified
driver. Cannot be used with
Display the device path as follows:
On Integrity servers, display the EFI (Extensible Firmware Interface) device paths when available.
On PA-RISC Hardware, when used with the option, display the PA device path when available in hexadecimal and also
display the PA device path in decimal format separated with a comma This form is to be used when booting from ISL in
the command prompt with the option (see hpux(1M)). The same format can be used to enter a lunpath hardware path at
the Boot Console Handler (BCH) boot prompt.
In the agile view, EFI device paths are associated with the nodes which have class as lunpath.
Generate a full listing, displaying the module's class,
instance number, hardware path, driver, software state, hardware type, and a brief description.
Produce a compact listing of fields (see
below), separated by colons This option overrides the option.
Restrict the scan and output listing
to those devices connected at the specified hardware path. The hardware path must be a bus path. Scanning below the
bus level will not probe the hardware and may produce incorrect results.
For example, specifying the path at the target level will always change the state of the device attached to it as The
state of the device may be restored by retrying from a bus node above the node.
When used with this option specifies the full hardware path at which to bind the software modules.
Restrict the output listing to the specified
instance, when used with either or When used with specifies the desired instance number for binding. Must be used
with either the or option.
Scan kernel I/O system data structures instead of the actual hardware
and list the results. No binding or unbinding of drivers is performed. The and options can be used to restrict
listings. Cannot be used with This option does not require superuser privileges.
List locally connected devices.
Display mapping information according to the keyword
specified. retrieves the information from the kernel I/O data structures without scanning the hardware. Keywords
can be any one of the following:
Display the LUN to lunpath mapping.
The and options can be used to restrict listings. Arguments passed must be from the agile view. The
option can be used to generate a compact listing of fields separated by colons Fields include: class,
instance number, LUN hardware path, driver, software state, hardware type, block major number, character
major number, health, a brief description, lunpath(s). Device special files corresponding to LUN will be
shown on separate line(s).
Display the mapping between the legacy and persistent special files.
Either a legacy or persistent special file can be specified as an argument. If none is specified, all
valid mappings for character special files are displayed. The option can be used to generates a compact
listing of fields separated by colons Fields include: persistent special file, legacy special file(s).
Multiple legacy special files mapping to the persistent special file are separated by a white space.
Display the mapping between the legacy hardware path,
lunpath hardware path, and LUN hardware path. The option can be used to restrict listings. The argument
specified with can either be a legacy hardware path, lunpath hardware path, or LUN hardware path. The
hardware path specified will also be displayed along with the corresponding other two representations, if
present.
The option can be used to generate a compact listing of fields separated by colons which is useful for pro-
ducing custom listings with Fields include: LUN hardware path, lunpath hardware path, legacy hardware
path(s). If there are multiple legacy hardware paths mapped to a lunpath hardware path, they will be sepa-
rated by a white space in the last field. For example, if a lunpath hardware path has two mappings to a
legacy hardware path, the two legacy hardware paths are separated by a white space in the last field. If
there are multiple mappings, they are displayed in separate lines. For example, if one lun hardware path
maps to two lunpath hardware paths, then each lunpath hardware path will map to a legacy hardware path.
Specify the software driver to bind at the hardware path
given by the option. Must be used with the option.
List device file names in the output.
Only special files in the directory and its subdirectories are listed. Must be used with either the or the option.
Display the agile view
(see intro(7)) of the system hardware. For mass storage device entries that would normally include the driver class,
the legacy hardware path, and the device description, prints a class of lunpath, the lunpath hardware path, and the
name of the LUN that it maps to, when used with this option. In addition, the output will include entries for the
mass storage devices at their LUN hardware paths, with the expected driver class and description. Thus, each mass
storage device will have at least two entries in the output: one for the LUN hardware path and one for each lunpath
hardware path. If used with the option, only prints persistent special files.
Display the property of nodes in the agile view.
This option can be combined with the and options, but the parameters passed must belong to the agile view. The valid
properties are:
bus_type, cdio, is_block, is_char, is_pseudo, b_major, c_major, minor, class, driver, hw_path, id_bytes, instance,
module_name, sw_state, hw_type, description, health, error_recovery, is_inst_replaceable, wwid, uniq_name,
alias_path, physical_location, and ms_scan_time.
More details about the above properties can be found in the section below, except for error_recovery,
is_inst_replaceable, wwid, uniq_name, alias_path, physical_location, and ms_scan_time which are explained here:
error_recovery
This property indicates support for the PCI error recovery feature. The property is only created for the Local
Bus Adapters (LBA) nodes. The error_recovery property can be set to one of the following values:
The platform and all interface card driver instances under the given
LBA node support the PCI error recovery capability.
Either the platform or one of the interface card driver instances
under the given LBA node do not support the PCI error recovery capability.
The is to be displayed for nodes that are not LBA nodes.
The availability of this feature is dependent on the platform and operating system environment, as described in
the at
is_inst_replaceable
This property indicates the capability of the driver to support online instance number replacement. Online
instance number replacement means that the instance number of a node can be modified without a system reboot.
The is_inst_replaceable property can be set to one of the following values:
The driver corresponding to this node supports online
instance number replacement.
The driver corresponding to this node does not support
online instance number replacement.
The is_inst_replaceable property is not available for the driver corresponding to this node.
wwid This property indicates the
uniq_name
This property indicates the
For more information on the wwid and uniq_name properties, refer to the scsimgr(1M) manpage.
alias_path
This property indicates the alias path of a node. Alias path is an alternative user-friendly name assigned to a
hardware path.
physical_location
This property indicates the This hexadecimal value indicates the actual physical device location. A physical
location consistently refers to a device based on where the device is physically located in the system configu-
ration.
ms_scan_time
This property shows the time taken by the IO subsystem to scan a device. This value is updated every time a
system hardware is actually scanned. The time listed will be in the following format: MM min SS sec UUU ms.
The scan time will be displayed only for the mass storage devices, for non mass storage devices it will be dis-
played as
NOTE: For a bus node, the ms_scan_time is the total time taken to scan the bus node and all the devices con-
nected to it.
Remove a deferred binding at the specified hardware path.
Must be used with the option. The must belong to the agile view.
List stale I/O node entries that are present in the system.
These entries correspond to nodes that have an entry in the system I/O configuration file, but the corresponding
device is not found (see ioconfig(4)).
Display the date and time at which
the system hardware was last scanned. For example, displays the following output:
Scan and list usable I/O
system devices instead of the actual hardware. Usable I/O devices are those having a driver in the kernel and an
assigned instance number. The and options can be used to restrict listings. The option cannot be used with
Initiate a scan on unclaimed nodes of type INTERFACE
in the agile view.
The and options can be used to obtain listings of subsets of the I/O system, although the entire system is still scanned. Specifying
option causes to restrict both the scan and the listing to the hardware subset indicated.
Fields
The option can be used to generate a compact listing of fields separated by colons useful for producing custom listings with
Fields include the module's: bus type, cdio, is_block, is_char, is_pseudo, block major number, character major number, minor number, class,
driver, hardware path, identify bytes, instance number, module path, module name, software state, hardware type, a brief description, card
instance, is_remote, EFI device path or PA device path, health, and alias_path.
The additional field is_remote is displayed only when the option is specified twice The field EFI device path or PA device path is dis-
played on Integrity systems or PA-RISC systems respectively only when the option is specified with the option.
If the option is specified with the option, the health property is added at the end of the listing.
If the option is specified with the option, the alias_path field is displayed at the end of the listing.
If a field does not exist, consecutive colons hold the field's position.
The number of fields in the output can be extended by adding additional colon separated fields at the end of the listing. Fields are
defined as follows:
bus type Bus type associated with the node.
cdio The name associated with the Context-Dependent I/O module.
is_block A boolean value indicating whether a device block major number exists. A or is generated in this field.
is_char A boolean value indicating whether a device character major number exists. A or is generated in this field.
is_pseudo A boolean value indicating a pseudo driver. A or is generated in this field.
block major The device block major number. A indicates that a device block major number does not exist.
character major The device character major number. A indicates that a device character major number does not exist.
minor The device minor number.
class A device category, defined in the files located in the directory and consistent with the listings output by (see
lsdev(1M)). Examples are and
driver The name of the driver that controls the hardware component. If no driver is available to control the hardware component,
a question mark is displayed in the output.
hw path A numerical string of hardware components, notated sequentially from the bus address to the device address. Typically,
the initial number is appended by slash to represent a bus converter (if required by your machine), and subsequent numbers
are separated by periods Each number represents the location of a hardware component on the path to the device.
identify bytes The identify bytes returned from a module or device.
instance The instance number associated with the device or card. The instance number is a unique number assigned to a card or
device within a class. If no driver is available for the hardware component or an error occurs binding the driver, the
kernel will not assign an instance number and a is listed.
module path The software components separated by periods
module name The module name of the software component controlling the node.
software state The result of software binding.
software bound successfully
no associated software found
the hardware at this address is no longer usable due to some irrecoverable
error condition; a system reboot may clear this condition
associated software and hardware are in suspended state
the hardware at this address does not match the previously associated hardware
the hardware at this address is no longer responding
the hardware at this address is responding but is in an error state
a scan operation is in progress for this node
hardware type Entity identifier for the hardware component. The entity identifier is one of the following strings:
there is no hardware associated or the type of hardware is unknown
hardware component is a processor
hardware component is memory
hardware component is bus converter or bus adapter
hardware component is a virtual (software controlled) bus
hardware component is an interface card
hardware component is a device
hardware component is a target path
hardware component is a LUN path
description A description of the device.
card instance The instance number of the hardware interface card.
is_remote Displays if the device is connected remotely or if the device is connected locally. Displaying is_remote is deprecated in
HP-UX 11i v3.
EFI device path or PA device path
On Integrity servers hardware, this field contains the EFI device path. On PA-RISC hardware, this field contains the PA
device path in both hexadecimal and decimal format separated by a comma
health State of the node as defined by the subsystem that manages this node (for example, a driver). The health is one of the
following strings:
node is online and functional
node has gone offline and is inaccessible
node is online but performance is degraded due to some
links, paths, and connections being offline
an error condition occurred which requires manual intervention
(for example, authentication failure, hardware failure, and so on)
node is being diagnosed
node has been disabled or suspended
node is functional but not in use (standby node)
Property Not Available
alias_path An alternative user-friendly name assigned to a hardware path.
RETURN VALUE
returns:
upon normal completion
if an error occurred
if the driver does not support the functionality.
EXAMPLES
Scan the system hardware and list all the devices belonging to the disk device class.
Forcibly bind driver at the hardware path
Display lun to lunpath mapping.
Display the mapping between (legacy) hardware path, lunpath hardware path and lun hardware path.
Display the mapping between legacy device special file and persistent device special file.
Display the property of all the nodes with the class name as in the agile view.
Display the property of all the LBA nodes claimed by the driver in the agile view.
Display the list of all the nodes in the agile view.
Display the EFI device paths of all the devices in the agile view.
Display the time taken to scan the device at the hardware path
WARNINGS
The following options are deprecated in HP-UX 11i v3 and will be removed in a future release:
List locally connected devices.
Display the
is_remote field. This field is also deprecated.
AUTHOR
was developed by HP.
FILES
SEE ALSO
kcmodule(1M), lsdev(1M), ioconfig(4), intro(7).
ioscan(1M)