Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP-UX Reference > I

ioscan(1M)

HP-UX 11i Version 3: February 2007
» 

Technical documentation

» Feedback
Content starts here

 » Table of Contents

 » Index

NAME

ioscan — scan the I/O system

SYNOPSIS

/usr/sbin/ioscan [-N] [-k|-u] [-e] [-d driver | -C class] [-I instance] [-H hw_path] [ -f[-n] | -F[-n] ] [devfile]

/usr/sbin/ioscan [-b] -M driver -H hw_path [-I instance]

/usr/sbin/ioscan -t

/usr/sbin/ioscan -P property [-d driver | -C class] [-I instance] [-H hw_path] [devfile]

/usr/sbin/ioscan -m lun [-F] [-d driver | -C class] [-I instance] [-H lun hw_path] [devfile]

/usr/sbin/ioscan [-F] -m dsf [devfile]

/usr/sbin/ioscan -m hwpath [-F] [-H hw_path]

/usr/sbin/ioscan -s

/usr/sbin/ioscan -r -H hw_path

/usr/sbin/ioscan -B

/usr/sbin/ioscan -U

/usr/sbin/ioscan -a [-F]

DESCRIPTION

ioscan 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, ioscan displays by default the hardware path to the hardware module, the class of the hardware module, and a brief description.

By default, ioscan 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 system hardware. Entities that cannot be scanned are not listed. By default, ioscan will display the list using the legacy view (see intro(7)).

The ioscan command scans the system in the agile view or the legacy view, depending on whether or not the -N option is used, and lists all reportable hardware found. If ioscan cannot find any hardware based on the options and arguments specified, it prints no information and exits with a return value of 0 since the scan encountered no errors.

ioscan can also use its options to perform the following:

  • ioscan -N displays output using the agile view instead of the legacy view (see intro(7)).

  • ioscan -M forces the specified software driver into the kernel I/O system and forces software driver to be bound. This can be used to make the system recognize a device that cannot be recognized automatically; for example, because it has not yet been connected to the system, does not support autoconfiguration, or because diagnostics need to be run on a faulty device.

  • ioscan -b, when used with -M option, tries to do an online binding first. If the driver does not support online binding, binding will be deferred to next boot. The hardware path specified for a deferred binding operation must be a LUN hardware path of a node of type DEVICE in UNCLAIMED state.

  • ioscan -t displays the date and time at which system hardware was last scanned.

    Note: The -t option cannot be used with any other options available for this command.

  • ioscan -P property displays the property of a node.

  • ioscan -m lun displays the mapping between LUN hardware path and the lunpath hardware path.

  • ioscan -m dsf displays the mapping between legacy device special files and persistent device special files (see intro(7)).

  • ioscan -m hwpath displays the mapping between (legacy) hardware path, lunpath hardware path, and LUN hardware path.

  • ioscan -s lists the stale entries present in the system.

  • ioscan -r reverts the deferred binding action on a device lunpath.

  • ioscan -B lists all the pending deferred bindings.

  • ioscan -U scans all unclaimed nodes of type INTERFACE.

  • ioscan -a shows information about thread 0 for a processor with Hyper Threading feature.

Security Restriction

Generally, ioscan requires superuser privileges. A non root user may use the following options:

-k

only to display the kernel hardware tree.

-m

use the mapping features.

-P

display the property of a node.

-B

list pending deferred bindings.

Driver binding and actual hardware scanning is restricted to root.

Options

ioscan recognizes the following options:

-a

Show information about thread '0' for a processor with Hyper Threading feature. When used with -F option, command generates a compact listing of fields separated by colons (:), useful for producing custom listings with awk. Fields include: socket, core, thread.

-b

Defer the binding of a driver to a hardware path until the next system boot. Must be used with -M and -H options.

-B

List all the pending deferred bindings.

-C class

Restrict the output listing to those devices belonging to the specified class. Cannot be used with -d.

-d driver

Restrict the output listing to those devices controlled by the specified driver. Cannot be used with -C.

-e

Display the device path as follows:

On Integrity servers, display EFI (Extensible Firmware Interface) device paths when available.

On PA-RISC Hardware, when used with -N option, displays PA device path when available in hexadecimal and also in decimal format separated with a comma ,. This is the form to be used when booting from ISL in the hpux command prompt with the -a option (see hpux(1M)). The same format can be used to enter a lunpath hardware path in the Boot Console Handler (BCH) boot prompt.

-f

Generate a full listing, displaying the module's class, instance number, hardware path, driver, software state, hardware type, and a brief description.

-F

Produce a compact listing of fields (see Fields below), separated by colons (:). This option overrides the -f option.

-H hw_path

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 NO_HW. The state of the device may be restored by retrying ioscan from a bus node above the NO_HW node.

When used with -M, this option specifies the full hardware path at which to bind the software modules.

-I instance

Restrict the scan and output listing to the specified instance, when used with either -d or -C. When used with -M, specifies the desired instance number for binding. Must be used with either -d, -C, or -M option.

-k

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 -d, -C, -I, and -H options can be used to restrict listings. Cannot be used with -u. This option does not require superuser privileges.

-m keyword

Display mapping information according to the keyword specified. ioscan retrieves the information from the kernel I/O data structures without scanning the hardware. Keywords can be any one of the following:

lun

Display the LUN to lunpath mapping. The -d, -C, -I, and -H options can be used to restrict listings. Arguments passed must be from the agile view. The -F 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).

dsf

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 -F 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.

hwpath

Display the mapping between the legacy hardware path, lunpath hardware path, and LUN hardware path. The -H option can be used to restrict listings. The argument specified with -H 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 -F option can be used to generate a compact listing of fields separated by colons (:), which is useful for producing custom listings with awk. 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 separated 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 which map to a legacy hardware path each.

-M driver

Specify the software driver to bind at the hardware path given by the -H option. Must be used with the -H option.

-n

List device file names in the output. Only special files in the /dev directory and its subdirectories are listed. Must be used with either the -f or the -F option.

-N

Displays 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, ioscan 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 ioscan output: one for the LUN hardware path and one for each lunpath hardware path. If used with the -n option, ioscan only prints persistent special files.

-P property

Displays the property of nodes in the agile view. This option can be combined with the -C, -d, -I and -H 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.

-r

Remove a deferred binding at the specified hardware path. Must be used with the -H option. The hw_path must belong to the agile view.

-s

Lists stale I/O node entries 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)).

-t

Display the date and time at which the system hardware was last scanned. This is an example output ioscan produces with this option:

Fri Nov 22 11:22:21 2005.

-u

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 -d, -C, -I, and -H options can be used to restrict listings. The -u option cannot be used with -k.

-U

Initiates a scan on unclaimed nodes of type INTERFACE in the agile view.

The -d and -C options can be used to obtain listings of subsets of the I/O system, although the entire system is still scanned. Specifying -d or -C along with -I, or specifying -H or a devfile causes ioscan to restrict both the scan and the listing to the hardware subset indicated.

Fields

The -F option can be used to generate a compact listing of fields separated by colons (:), useful for producing custom listings with awk.

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 and EFI device path or PA device path.

If the -N option is specified with the -F option, the health property is added at the end of the listing. If a field does not exist, consecutive colons hold the field's position. 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 T or F is generated in this field.

is_char

A boolean value indicating whether a device character major number exists. A T or F is generated in this field.

is_pseudo

A boolean value indicating a pseudo driver. A T or F is generated in this field.

block major

The device block major number. A -1 indicates that a device block major number does not exist.

character major

The device character major number. A -1 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 /usr/conf/master.d and consistent with the listings output by lsdev (see lsdev(1M)). Examples are disk, printer, and tape.

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. It 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 (-1), 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.

CLAIMED

software bound successfully

UNCLAIMED

no associated software found

UNUSABLE

the hardware at this address is no longer usable due to some irrecoverable error condition; a system reboot may clear this condition

SUSPENDED

associated software and hardware are in suspended state

DIFF_HW

software found does not match the associated software

NO_HW

the hardware at this address is no longer responding

ERROR

the hardware at this address is responding but is in an error state

SCAN

a scan operation is in progress for this node

hardware type

Entity identifier for the hardware component. It is one of the following strings:

UNKNOWN

there is no hardware associated or the type of hardware is unknown

PROCESSOR

hardware component is a processor

MEMORY

hardware component is memory

BUS_NEXUS

hardware component is bus converter or bus adapter

VIRTBUS

hardware component is a virtual (software controlled) bus

INTERFACE

hardware component is an interface card

DEVICE

hardware component is a device

TGT_PATH

hardware component is a target path

LUN_PATH

hardware component is a LUN path

description

A description of the device.

card instance

The instance number of the hardware interface card.

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). It is one of the following strings:

online

node is online and functional

offline

node has gone offline and is inaccessible

limited

node is online but performance is degraded due to some links, paths, and connections being offline

unusable

an error condition occurred which requires manual intervention (for example, authentication failure, hardware failure, and so on)

testing

node is being diagnosed

disabled

node has been disabled or suspended

standby

node is functional but not in use (standby node)

RETURN VALUE

ioscan returns:

0

upon normal completion

1

if an error occurred

2

if the driver does not support the functionality.

EXAMPLES

Scan the system hardware and list all the devices belonging to the disk device class.

ioscan -C disk

Forcibly bind driver tape2 at the hardware path 8.4.1.

ioscan -M tape2 -H 8.4.1

Display lun to lunpath mapping.

ioscan -m lun

Display the health property of all the nodes with the class name as disk in the agile view.

ioscan -P health -C disk

Display the list of all the nodes in the agile view.

ioscan -kN

AUTHOR

ioscan was developed by HP.

FILES

/dev/config /dev/*

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 1983-2007 Hewlett-Packard Development Company, L.P.