HMC Manual Reference Pages  - LSHWRES (1)

NAME

lshwres - list hardware resources

CONTENTS

Synopsis
Description
Options
Examples
Environment
Bugs
Author
See Also

SYNOPSIS

To list physical I/O resources:
lshwres -r io --rsubtype {unit | bus | slot |
iopool | taggedio | slotchildren}
-m managed-system
[--level {pool | sys}] [-R]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list virtual I/O resources:
lshwres -r virtualio
--rsubtype
{eth | fc | hsl | virtualopti | scsi | serial |
slot | vnetwork | vnic | vnicbkdev | vswitch}
-m managed-system
[--level {lpar | slot | sys}]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list memory resources:
lshwres -r mem -m managed-system
--level {lpar | sys} [-R]
[--maxmem quantity [--hptratio ratio]]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list I/O entitled memory statistics for a partition:
lshwres -r mem -m managed-system --level lpar
--filter "
filter-data" --stat
[-F [attribute-names] [--header]] [--help]

To list shared memory pool resources:
lshwres -r mempool -m managed-system [--rsubtype pgdev]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list reserved storage device pool resources (only supported on managed systems that support partition suspend and resume operations):
lshwres -r rspool -m managed-system [--rsubtype rsdev]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list processing resources:
lshwres -r proc -m managed-system
--level {lpar | pool | sys} [-R]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list shared processor pool resources on a managed system that supports multiple shared processor pools:
lshwres -r procpool -m managed-system
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list Host Channel adapter (HCA) resources:
lshwres -r hca -m managed-system
--level {lpar | sys}
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list Host Ethernet adapter (HEA) resources:
lshwres -r hea -m managed-system
--rsubtype {logical | phys}
--level {port | port_group | sys}
[-R] [--stat]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

To list Switch Network Interface (SNI) adapter resources:
lshwres -r sni -m managed-system
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]
To list Single Root I/O Virtualization (SR-IOV) adapter resources:
lshwres -r sriov -m managed-system
--rsubtype {adapter | logport | physport}
[--level {eth | ethc}] [-R]
[--filter "filter-data"]
[-F [attribute-names] [--header]] [--help]

DESCRIPTION

lshwres lists the hardware resources of the managed-system, including physical I/O, virtual I/O, memory, shared memory pool, processing, shared processor pool, Host Channel adapter (HCA), Host Ethernet adapter (HEA), Switch Network Interface (SNI) adapter, and Single Root I/O Virtualization (SR-IOV) resources.

OPTIONS

-r The type of hardware resources to list. Valid values are io for physical I/O, virtualio for virtual I/O, mem for memory, mempool for shared memory pool, rspool for reserved storage device pool, proc for processing, procpool for shared processor pool, hca for HCA, hea for HEA, sni for SNI adapter, and sriov for SR-IOV resources.

The procpool resource type is only supported for managed systems that support multiple shared processor pools.

The rspool resource type is only supported for managed systems that support partition suspend and resume operations.

--rsubtype The subtype of hardware resources to list. Valid physical I/O resource subtypes are unit for I/O units, bus for I/O buses, slot for I/O slots, iopool for I/O pools, taggedio for tagged I/O, and slotchildren for I/O slot children resources. Valid virtual I/O resource subtypes are eth for virtual ethernet, fc for virtual fibre channel, hsl for High Speed Link (HSL) OptiConnect, virtualopti for virtual OptiConnect, scsi for virtual SCSI, serial for virtual serial, slot for virtual slot, vnetwork for virtual network, vnic for virtual NIC, vnicbkdev for virtual NIC backing devices, and vswitch for virtual switch resources. Valid HEA resource subtypes are logical for logical HEA resources, and phys for physical HEA resources. Valid SR-IOV resource subtypes are adapter for SR-IOV adapter resources, logport for SR-IOV logical port resources, and physport for SR-IOV physical port resources.

The only valid shared memory pool resource subtype is pgdev for paging space devices. The only valid reserved storage device pool subtype is rsdev for reserved storage devices. On a managed system that supports Active Memory Sharing and partition suspend and resume operations, the command lshwres -m managed-system -r mempool --rsubtype pgdev lists the devices in the reserved storage device pool, and is equivalent to the command lshwres -m managed-system -r rspool --rsubtype rsdev.

This option is required when listing physical I/O, virtual I/O, HEA, or SR-IOV resources. This option is not valid when listing memory, processing, shared processor pool, HCA, or SNI adapter resources.

-m The name of the managed system which has the hardware resources to list. The name may either be the user-defined name for the managed system, or be in the form tttt-mmm*sssssss, where tttt is the machine type, mmm is the model, and sssssss is the serial number of the managed system. The tttt-mmm*sssssss form must be used if there are multiple managed systems with the same user-defined name.
--level The level of information to list. Valid values are lpar for partition, pool for pool, port for port, port_group for port group, slot for slot, sys for system, eth for ethernet, and ethc for converged ethernet.

This option is required when listing I/O pool resources, virtual ethernet, fibre channel, serial, or slot resources, memory, processing, HCA, or HEA resources, or SR-IOV physical ports.

Valid levels for I/O pool resources are pool or sys. Valid levels for virtual ethernet resources are lpar or sys. Valid levels for virtual fibre channel resources are lpar or sys. Valid levels for virtual serial resources are lpar. Valid levels for virtual slot resources are lpar, slot, or sys. Valid levels for memory resources are lpar or sys. Valid levels for processing resources are lpar, pool, or sys. Valid levels for HCA resources are lpar or sys. Valid levels for physical HEA resources are port, port_group, or sys. Valid levels for logical HEA resources are port or sys. Valid levels for SR-IOV logical ports are eth. Valid levels for SR-IOV physical ports are eth or ethc.

-R Only list information for partitions with hardware resources that can be restored due to a dynamic logical partitioning (DLPAR) operation failure.

The rsthwres command can be used to restore those hardware resources.

This option is only valid for listing physical I/O slots, partition level memory or processing resources, logical HEA resources, or SR-IOV logical ports.

--maxmem When this option is specified, the required minimum memory amount needed for partitions to support the maximum memory quantity and Hardware Page Table ratio specified is listed. All memory quantities are in megabytes, and are a multiple of the memory region size for the managed-system.

This information is useful for specifying memory amounts in partition profiles.

The required minimum memory amount listed is the minimum memory amount required for a partition by the managed system’s system firmware. An operating system installed on the partition may require more memory than the amount listed.

This option is only valid when listing system level memory resources.

--hptratio The ratio of the Hardware Page Table (HPT) size to the maximum memory for a partition. Valid values for the managed-system are displayed by the lshwres -r mem -m managed-system --level sys -F possible_hpt_ratios command.

If this option is not used to specify an HPT ratio, the default HPT ratio for the managed-system is used.

This option is only valid when used with the --maxmem option.

--stat When this option is specified when listing HEA physical port resources, port counter statistics for HEA physical ports are listed.

When this option is specified when listing partition level memory resources, I/O entitled memory statistics are listed.

This option is only valid when listing HEA physical port resources or partition level memory resources.

--filter The filter(s) to apply to the hardware resources to be listed. Filters are used to select which hardware resources of the specified type are to be listed. If no filters are used, then all of the hardware resources of the specified type will be listed. For example, all of the physical I/O slots on a specific I/O unit and bus can be listed by using a filter to specify the I/O unit and the bus which has the slots to list. Otherwise, if no filter is used, then all of the physical I/O slots in the managed system will be listed.

The filter data consists of filter name/value pairs, which are in comma separated value (CSV) format. The filter data must be enclosed in double quotes.

The format of the filter data is as follows:

"filter-name=value,filter-name=value,..."

Note that certain filters accept a comma separated list of values, as follows:

"" filter-name=value,value,... ",..."

When a list of values is specified, the filter name/value pair must be enclosed in double quotes. Depending on the shell being used, nested double quote characters may need to be preceded by an escape character, which is usually a ’#146; character.

Unless otherwise indicated, multiple values can be specified for each filter.

When listing I/O entitled memory statistics for a partition, this parameter is required, and exactly one partition name or ID must be specified with the lpar_names or lpar_ids filter.

Valid filter names for this command:
adapter_ids
Specify HCA, HEA, or SR-IOV adapter ID(s)
buses
Specify I/O bus ID(s)
logical_port_ids
Specify SR-IOV logical port ID(s)
lpar_ids
Specify partition ID(s)
lpar_names
Specify partition user-defined name(s)
phys_port_ids
Specify SR-IOV physical port ID(s)
pool_names
Specify pool name(s)
pools
Specify pool ID(s)
port_groups
Specify HEA port group(s)
slots
Specify physical I/O slot DRC index(ices)
or virtual I/O slot number(s)
sni_device_ids
Specify SNI adapter device ID(s)
units
Specify I/O unit physical location
code(s)
vlans
Specify virtual LAN ID(s)
vswitches
Specify virtual switch name(s)

Valid filters with -r io --rsubtype unit:
units

Valid filters with -r io --rsubtype bus:
buses, units

Valid filters with -r io --rsubtype slot:
buses, lpar_ids | lpar_names, pools, slots,
units

Valid filters with -r io --rsubtype iopool --level pool:
lpar_ids | lpar_names, pools

Valid filters with -r io --rsubtype taggedio:
lpar_ids | lpar_names

Valid filters with -r io --rsubtype slotchildren:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype eth --level lpar:
lpar_ids | lpar_names, slots, vlans, vswitches

Valid filters with -r virtualio --rsubtype fc --level lpar:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype hsl:
lpar_ids | lpar_names, pools

Valid filters with -r virtualio --rsubtype virtualopti:
lpar_ids | lpar_names, pools

Valid filters with -r virtualio --rsubtype scsi:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype serial --level lpar:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype slot --level lpar:
lpar_ids | lpar_names

Valid filters with -r virtualio --rsubtype slot --level slot:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype vnic:
lpar_ids | lpar_names, slots

Valid filters with -r virtualio --rsubtype vnicbkdev:
lpar_ids | lpar_names

Valid filters with -r virtualio --rsubtype vswitch:
vlans, vswitches

Valid filters with -r mem --level lpar:
lpar_ids | lpar_names

Valid filters with -r mempool --rsubtype pgdev:
lpar_ids | lpar_names
Specify none for lpar_ids to list all
devices that are not assigned to a partition

Valid filters with -r rspool --rsubtype rsdev:
lpar_ids | lpar_names
Specify none for lpar_ids to list all
devices that are not assigned to a partition

Valid filters with -r proc --level lpar:
lpar_ids | lpar_names, pools | pool_names

Valid filters with -r procpool:
pools | pool_names

Valid filters with -r hca --level sys:
adapter_ids

Valid filters with -r hca --level lpar:
adapter_ids, lpar_ids | lpar_names

Valid filters with -r hea --rsubtype logical --level sys:
adapter_ids, lpar_ids | lpar_names

Valid filters with -r hea --rsubtype logical --level port:
adapter_ids, lpar_ids | lpar_names,
port_groups

Valid filters with -r hea --rsubtype phys --level sys:
adapter_ids

Valid filters with -r hea --rsubtype phys --level port:
adapter_ids, port_groups

Valid filters with -r hea --rsubtype phys --level port_group:
adapter_ids, port_groups

Valid filters with -r sni:
lpar_ids | lpar_names, sni_device_ids
valid filters with -r sriov --rsubtype adapter:
adapter_ids
valid filters with -r sriov --rsubtype logport:
adapter_ids, logical_port_ids
valid filters with -r sriov --rsubtype logport --level:
adapter_ids, logical_port_ids, phys_port_ids,
lpar_ids | lpar_names
valid filters with -r sriov --rsubtype logport -R:
adapter_ids, logical_port_ids,
lpar_ids | lpar_names

Valid filters with -r sriov --rsubtype physport:
adapter_ids, phys_port_ids

-F A delimiter separated list of attribute names for the desired attribute values to be displayed for each hardware resource. If no attribute names are specified, then values for all of the attributes for each hardware resource will be displayed.

When this option is specified, only attribute values will be displayed. No attribute names will be displayed. The attribute values displayed will be separated by the delimiter which was specified with this option.

This option is useful when only attribute values are desired to be displayed, or when the values of only selected attributes are desired to be displayed.

Descriptions of selected command attributes:
topology
A comma separated list of the end-to-end device
mappings for each virtual device. This is displayed
for virtual SCSI and virtual fibre channel adapters
and for SR-IOV logical ports when specified with the
-F option.

For virtual SCSI, each device mapping has the
following format:

virtual-device/state/virtual-SCSI-client-device/
virtual-SCSI-server-adapter/storage-pool/
backing-device

where virtual-device is the name of the virtual device
on the client operating system (will be an empty
string for virtual SCSI server adapters), state is the
state of the virtual device on the client operating
system (will be an empty string for virtual SCSI
server adapters), virtual-SCSI-client-device is the
name of the virtual SCSI client device on the client
operating system (will be an empty string for virtual
SCSI server adapters), virtual-SCSI-server-adapter is
the name of the virtual SCSI server adapter on the
Virtual I/O Server (VIOS), storage-pool is the name of
the storage pool containing the backing device on the
VIOS (will be an empty string if the backing device is
not in a storage pool), and backing-device is the name
of the backing device on the VIOS.

For virtual fibre channel, each device mapping has the
following format:

virtual-device/state/virtual-FC-client-device/
virtual-FC-server-adapter/physical-port

where virtual-device is the name of the virtual device
on the client operating system (will be an empty
string for virtual fibre channel server adapters),
state is the state of the virtual device on the client
operating system (will be an empty string for virtual
fibre channel server adapters), virtual-FC-client-
device
is the name of the virtual fibre channel client
device on the client operating system (will be an
empty string for virtual fibre channel server
adapters), virtual-FC-server-adapter is the name of
the virtual fibre channel server adapter on the VIOS,
and physical-port is the name of the physical fibre
channel port to which this device is backed.

For SR-IOV logical ports, each device mapping has the
following format:

device-name/adapter-id/physical-port-id/
logical-port-id

where device-name is the name of the OS device,
adapter-id is the SR-IOV adapter ID, physical-port-id
is the SR-IOV physical port ID, and logical-port-id
is the SR-IOV logical port ID.

--header Display a header record, which is a delimiter separated list of attribute names for the attribute values that will be displayed. This header record will be the first record displayed. This option is only valid when used with the -F option.
--help Display the help text for this command and exit.

EXAMPLES

List all I/O units on the managed system:

lshwres -r io --rsubtype unit -m system1

List all buses on I/O unit U787A.001.0395036:

lshwres -r io --rsubtype bus -m 9406-570*12345678
--filter "units=U787A.001.0395036"

List only the DRC index, description, and the owning partition for each physical I/O slot on buses 2 and 3 of I/O unit U787A.001.0395036:

lshwres -r io --rsubtype slot -m system1 --filter
"units=U787A.001.0395036,"buses=2,3"" -F drc_index,
description,lpar_name

List all I/O pools and the partitions and slots assigned to each I/O pool:

lshwres -r io --rsubtype iopool -m system1 --level pool

List the tagged I/O devices for the IBM i partition that has an ID of 1:

lshwres -r io --rsubtype taggedio -m 9406-520*100103A
--filter "lpar_ids=1"

List the I/O slot children for the I/O slot with DRC index 21010207:

lshwres -r io --rsubtype slotchildren -m 9117-MMA*107791F
--filter "slots=21010207"

List all virtual ethernet adapters on the managed system:

lshwres -r virtualio --rsubtype eth --level lpar -m system1

List all virtual SCSI adapters on the managed system, and only display attribute values for each adapter, following a header of attribute names:

lshwres -r virtualio --rsubtype scsi -m system1 -F --header

List all virtual slots for partition lpar1:

lshwres -r virtualio --rsubtype slot -m system1 --level
slot --filter "lpar_names=lpar1"

List all virtual networks in the managed system:

lshwres -r virtualio --rsubtype vnetwork -m mySys

List all virtual NICs assigned to partition lp1:

lshwres -r virtualio --rsubtype vnic -m mySys
--filter "lpar_names=lp1"

List all virtual NIC backing devices in the managed system:

lshwres -r virtualio --rsubtype vnicbkdev -m mySys

List all virtual switches in the managed system:

lshwres -r virtualio --rsubtype vswitch -m system1

List system level memory information:

lshwres -r mem -m 9406-570*98765432 --level sys

List recoverable memory information:

lshwres -r mem -m 9406-570*98765432 --level lpar -R

List memory information for partitions lpar1 and lpar2:

lshwres -r mem -m system1 --level lpar --filter
""lpar_names=lpar_1,lpar_2""

List only the installed and configurable processors on the system, and separate the output values with a colon:

lshwres -r proc -m 9406-570*98765432 --level sys -F
installed_sys_proc_units:configurable_sys_proc_units

List I/O entitled memory statistics for partition lpar1:

lshwres -r mem -m system1 --level lpar --filter "lpar_names=lpar_1"
--stat

List the shared memory pool:

lshwres -r mempool -m system1

List all of the devices in the shared memory pool (on managed systems that support partition suspend and resume operations, this lists all of the devices in the reserved storage device pool):

lshwres -r mempool -m system1 --rsubtype pgdev

List the reserved storage device pool:

lshwres -r rspool -m 8233-E8B*1234321

List all of the devices in the reserved storage device pool:

lshwres -r rspool -m system1 --rsubtype rsdev

List processing resources for all partitions:

lshwres -r proc -m system1 --level lpar

List the physical processor pool:

lshwres -r proc -m system1 --level pool

List all configured shared processor pools in the managed system:

lshwres -r procpool -m system1

List all HCAs on the managed system:

lshwres -r hca -m 9117-570*12345678 --level sys

List all HCAs assigned to partition AIX1:

lshwres -r hca -m 9117-570*12345678 --level lpar
--filter "lpar_names=AIX1"

List all physical HEAs on the managed system:

lshwres -r hea -m mySys --rsubtype phys --level sys

List all port groups for all HEAs on the managed system:

lshwres -r hea -m mySys --rsubtype phys --level port_group

List all physical ports belonging to port group 2 for the HEA with adapter ID 23000010:

lshwres -r hea -m 9117-MMA*1234ABC --rsubtype phys
--level port --filter "adapter_ids=23000010,
port_groups=2"

List all Logical Host Ethernet adapters (LHEA) on the managed system:

lshwres -r hea -m mySys --rsubtype logical --level sys

List all HEA logical ports assigned to partition p1:

lshwres -r hea -m mySys --rsubtype logical --level port
--filter "lpar_names=p1"

List all SNI adapters on the managed system:

lshwres -r sni -m system1

List all SR-IOV adapters on the managed system:

lshwres -r sriov -m system1 --rsubtype adapter

List all unconfigured SR-IOV logical ports:

lshwres -r sriov -m system1 --rsubtype logport

List all recoverable SR-IOV logical ports:

lshwres -r sriov -m system1 --rsubtype logport -R

List all SR-IOV ethernet logical ports:

lshwres -r sriov -m system1 --rsubtype logport --level eth

List all SR-IOV ethernet physical ports:

lshwres -r sriov -m system1 --rsubtype physport --level eth

List all SR-IOV converged ethernet physical ports:

lshwres -r sriov -m system1 --rsubtype physport --level ethc

ENVIRONMENT

None

BUGS

None

AUTHOR

IBM Austin

SEE ALSO

chhwres, rsthwres, lssyscfg


Linux LSHWRES (1) "November 2015"
Generated by manServer 1.07 from lshwres.1 using man macros.