Retrieve Resource Information (QRZRRSI) API

Required Parameter Group:

Receiver variable

Output

Char(*)

Length of receiver variable

Input

Binary(4)

Format name

Input

Char(8)

Request criteria

Input

Char(*)

Error code

I/O

Char(*)

Default Public Authority: *USE

Threadsafe: No

The Retrieve Resource Information (QRZRRSI) API retrieves selected fields of a hardware resource from a known resource name. The user of the API supplies the resource name along with the request criteria by using key values. The first or next information data that matches the request criteria from the resource name supplied is returned.

Key values are used as a singular search criterion rather than as part of a more complex search. The singular search criterion, by its nature, has very concise results.

Authorities and Locks

API Public Authority: *USE

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The content and format of the information returned. The possible format name is as follows:

RTVI0100

Returns the resource information from the hardware resource name supplied and that matches the request criteria. See RTVI0100 Format for details about the format.

Request criteria

INPUT; CHAR(*)

The criteria for which the retrieve will be processed.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Format of the Request Criteria

Offset

Type

Field

Dec

Hex

CHAR(32)

Resource name

CHAR(16)

Handle

BINARY(4)

Search request

BINARY(4)

Offset to first key

BINARY(4)

Number of keys

CHAR(*)

Keys

Field Descriptions

Handle. The unique value that is obtained through the Create Handle (QRZCRTH) API. The handle allows repeated calls to obtain more than one resource name that meets the request criteria. The handle is created through the Create Handle (QRZCRTH) API. The handle is required in conjunction with the first or next search request. The handle must be set to binary zeros in conjunction with the first search request when no next search request is needed. The user is responsible for deleting the handle when it is no longer needed. Use the Delete Handle (QRZDLTH) API to delete the handle.

Keys. Following are the key values to be used in the request criteria. For a description of the key and the values that are valid for the key, see Key Field Descriptions.

Key

Field

Type

rvxCommunication flag

CHAR(1)

Type number

CHAR(4)

Serial number

CHAR(10)

Model number

CHAR(3)

Packaging location data

CHAR(*)

DSA location data

CHAR(*)

UA location data

CHAR(*)

Reported this IPL flag

CHAR(1)

LAN flag

CHAR(1)

Vary-on wait time

BINARY(4)

Bus number

CHAR(*)

Port number

CHAR(*)

Plant of manufacture number

CHAR(2)

Part number¹

CHAR(12)

Emulating type

CHAR(4)

Emulating model

CHAR(3)

Memory size

BINARY(4)

Powered-on flag

CHAR(1)

Resource classification

CHAR(8)

Operational flag

CHAR(1)

IOP has disk flag

CHAR(1)

Normal mode flag

CHAR(1)

Supplied data at IPL flag

CHAR(1)

Disk candidate flag

CHAR(1)

Miscellaneous manufacture information

CHAR(2)

Number of resources

BINARY(2)

Card number

CHAR(*)

Board number

CHAR(*)

RCTT level

CHAR(1)

Card position¹

CHAR(5)

EIA (Electronics Industries Association)¹

CHAR(2)

User location text¹

CHAR(40)

Frame ID¹

CHAR(4)

Device position¹

CHAR(5)

I/O bus address

CHAR(*)

Adapter address

CHAR(*)

Channel address

CHAR(*)

Controller address

CHAR(*)

Frame resource name¹

CHAR(4)

Auxiliary processor

CHAR(*)

Device address

CHAR(*)

Keyboard type

CHAR(1)

Color flag

CHAR(1)

Supported on system flag

CHAR(1)

Controller description needed flag

CHAR(1)

Supports assign command flag

CHAR(1)

Wide screen flag

CHAR(1)

Programmable flag

CHAR(1)

Keyboard type extended

CHAR(1)

Console usage

CHAR(8)

ASCII flag

CHAR(1)

High-speed digital flag

CHAR(1)

LAN speed

CHAR(1)

V.24 interface flag

CHAR(1)

X.21 interface flag

CHAR(1)

V.35 interface flag

CHAR(1)

V.36 interface flag

CHAR(1)

Maximum lines attached

CHAR(1)

Interface adapter card flag

CHAR(1)

DCE adapter card flag

CHAR(1)

Maximum ports attached

CHAR(1)

Maximum frame size

BINARY(2)

FAX communications flag

CHAR(1)

File server I/O processor flag

CHAR(1)

User configurable flag

CHAR(1)

Can backspace flag

CHAR(1)

Can overwrite flag

CHAR(1)

Supports tape write error recovery procedure (TWERP) flag

CHAR(1)

Library address

CHAR(*)

Session address

CHAR(*)

Transport type

CHAR(*)

UA type

CHAR(*)

Is daughter card flag¹

CHAR(1)

Contact data¹

CHAR(136)

Remote type

CHAR(4)

Remote model

CHAR(3)

Remote serial

CHAR(10)

Remote name

CHAR(8)

Is an OEM¹

CHAR(1)

Is shared¹

CHAR(1)

Tape capability

BINARY(2)

119

Resource ID

CHAR(4)

120

Write format

CHAR(2)

121

Read format

CHAR(2)

122

Media type

CHAR(1)

123

In library

CHAR(1)

124

Installed memory

BINARY(4)

125

Usable memory

BINARY(4)

126

Host type

CHAR(4)

127

Host model

CHAR(3)

128

Host serial

CHAR(10)

129

Host name

CHAR(8)

130

Host this system

CHAR(1)

137

System feature code

CHAR(*)

145

Extended resource classification

CHAR (40)

146

I/O adapter address

CHAR(*)

150

Processor feature

CHAR(4)

151

Interactive feature¹

CHAR(4)

152

Location Code Format

CHAR(1)

153

Location Code¹

CHAR(79)

154

Logically controlling CEC identity

CHAR(16)

155

Rack VPD

CHAR(16)

159

Expanded serial number

CHAR(15)

160

Hardware status

BINARY (4)

161

Engineering change level

BINARY (4)

163

Rack VPD keyword

CHAR(2)

165

Resource extended attributes

CHAR(4)

167

Switchable mode

CHAR (1)

169

Fibre channel adapter port data

CHAR(90)

170

Fibre channel adapter

CHAR(1)

Restriction Note:

In logical partitions that contain virtual hardware, it is possible that this field would return blanks for character fields and 0 for numeric fields.

Number of keys. The number of keys supplied in the keys variable. One key per call is supported; multiple keys on one call are not supported.

Offset to first key. The offset from the start of the structure to the first key.

Resource name. The name of the resource from which the retrieval is to be made. The resource name either is known or was obtained by using another hardware resource API. Note: This field must specify the CEC resource name when requesting resource information data for either the Processor feature (key value 150), the Interactive feature (key value 151) or the Location code format (key value 152).

Search request. Whether the search request is a first attempt or a next attempt.

The first attempt to obtain resource information from a possible list of resource information. This obtains the first list entry.

The next attempt to obtain resource information from a possible list of resource information. This obtains a subsequent list entry if it exists.

RTVI0100 Format

Offset

Type

Field

Dec

Hex

BINARY(4)

Bytes returned

BINARY(4)

Bytes available

BINARY(4)

Number of entries returned

BINARY(4)

Length of variable record

BINARY(4)

Key

BINARY(4)

Length of data

CHAR(*)

Data

Field Descriptions

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Data. The data that is returned for the key.

Key. The key for the data in this variable length record. For a list of keys that can be returned in this field, see the Keys field description.

Length of data. The length of the data portion of this variable length record.

Length of variable record. The length of the current variable length record.

Number of entries returned. The number of values returned by the API.

Key Field Descriptions

Adapter address. The address of the adapter, the value is a relative part number beginning at '0', it is is returned as BINARY(2) and CHAR(4). Both variables. BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

ASCII flag. Whether the resource is an American National Standard Code for Information Exchange (ASCII) type. Valid values for this field are 0 (No) and 1 (Yes).

Auxiliary processor. The address of the auxiliary processor. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Board number. A numerical representation of a section of the bus that the card is plugged into. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Bus number. A numerical representation of the path connection of the system processor to the card. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(4) and CHAR(2), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Can backspace flag. Whether the resource supports the backspace operation. Valid values for this field are 0 (No) and 1 (Yes).

Can overwrite flag. Whether the resource supports the overwrite operation. Valid values for this field are 0 (No) and 1 (Yes).

Card number. A numerical representation of the location of the card on the bus. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Card position. The physical location where the device or feature is plugged into the bus.

Channel address. The address of the channel where the resource is plugged into.The value for this field is returned as BINARY(2) and CHAR(4). Both variables. BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Color flag. Whether the resource supports a color attribute. Valid values for this field are 0 (No) and 1 (Yes).

Console usage. A value that indicates whether this resource is the primary console, the secondary console, or not used as a console of the system.

Resource

Returned value

Not used as console

X'4000000000000000'

Used as primary console

X'4FFFFFFFFFFFFFFF'

Used as secondary console

X'0000000000000001'

Contact data. The data that is received by the resource when it is contacted.

Controller address. A unique identifier for each controller, so that the controller is recognized by the system. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Controller description needed flag. Whether the controller description is needed with this resource. Valid values for this field are 0 (No) and 1 (Yes).

Disk candidate flag. Whether a storage device is a disk. Valid values for this field are 0 (No) and 1 (Yes).

DCE adapter card flag. Whether the resource is a data circuit-terminating equipment (DCE) card adapter. Valid values for this field are 0 (No) and 1 (Yes).

Device address. A unique identifier for each device, so that the device is recognized by the system. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Device position. A unique identifier for each device within its containing frame.

DSA location data. The Direct Select Address location data of the resource. The information for this field is returned as a Location array (see format below).

EIA. A value that represents the physical position of the resource in its containing frame.

Emulating model. A model number for which this resource is emulating.

Emulating type. The object type number that this resource is emulating.

Engineering change level. The engineering change level of the resource.

Expanded serial number. The expanded manufacturing sequence number of designation for the resource.

Extended resource classification. The extended type of hardware that the resource is.

FAX communications flag. Whether this communications resource is a FAX-type communication. Valid values for this field are 0 (No) and 1 (Yes).

Fibre channel adapter. Whether the resource is a fibre channel adapter. Valid values for this field are 0 (No) and 1 (Yes).

Frame ID. The identifier of a supplied frame resource.

Frame resource name. The resource name of the frame that a known resource resides in.

File server I/O processor flag. Whether the resource is an Integrated xSeries^® Server (also known as file server I/O processor and FSIOP). Valid values for this field are 0 (No) and 1 (Yes).

Hardware status. The extended hardware status of the resource. Possible values are as follows:

Resource is powered off or no power is being supplied to it.

Resource has failed.

Resource is operational.

Resource is operational but errors have been detected.

Resource is not connected.

Resource is operational but performance is degraded.

Resource status is unknown currently.

Resource is currently disabled.

Resource is not installed.

Resource is not operational.

Resource is failed due to a system software error.

High-speed digital flag. Whether the resource is a high-speed digital communications line. Valid values for this field are 0 (No) and 1 (Yes).

Host model. The model of the host resource.

Host name. The name of the host resource.

Host serial. The serial number of the host resource.

Host this system. Whether the resource is the host of this system. Valid values for this field are 0 (No) and 1 (Yes).

Host type. The type of the host resource.

In library. Whether the resource is in a library. Valid values for this field are 0 (No) and 1 (Yes).

Installed memory. The amount of memory, in megabytes, installed in the resource.

Interactive feature. The interactive feature of the system. This feature defines the portion of the processor that can be used to perform interactive work.

Interface adapter card flag. Whether the resource is an interface adapter card. Valid values for this field are 0 (No) and 1 (Yes).

I/O adapter address. The address of the I/O adapter where the resource is plugged into. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

I/O bus address. Holds the value of the bus I/O base address. Value is a bus number returned as BINARY(2) and CHAR(4). Both variables. BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

IOP has disk flag. Whether the resource (IOP) has a disk attached. Valid values for this field are 0 (No) and 1 (Yes).

Is an OEM. Whether the resource is an original equipment manufacturer (OEM) resource. Valid values for this field are 0 (No) and 1 (Yes).

Is daughter card flag. Whether the resource is a daughter card. Valid values for this field are 0 (No) and 1 (Yes).

Is shared. Whether the resource is shared. Valid values for this field are 0 (No) and 1 (Yes).

Keyboard type. The physical key arrangement and assignments for the keyboard shipped from the factory.

Keyboard type extended. Additional information about the keyboard type.

LAN flag. Whether the resource is a local area network (LAN). Valid values for this field are 0 (No) and 1 (Yes).

LAN speed. A value that returns the line speed of a LAN.

Library address. The address of the library where the resource is plugged into. The value for this field is returned as BINARY(2) and CHAR(2). Both variables, BINARY(2) and CHAR(2), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(2) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Location Code Format. Whether the location code is supported on the system. Valid values for this field are 0 (No) and 1 (Yes).

Location Code. The physical location of the hardware resource in the system. This field is be available only if the system supports the location code format. The location code field is a sequence of 0 or more location labels that when followed in order, lead to the resource location. This is the place someone could go to view, remove, or replace the piece of hardware. Location labels are etched, silk screened, or marked in other ways on hardware. The following location labels might be shown in the location code field (n represents a numerical or alphabetical identifier):

Utttt.mmm.sssssss: Unit location
Pnn: Planar location
Cnn: Card location
Tnn: Port location
Dnn: Device location
Vnnn: Virtual planar
Wnnnnnnnnnnnnnnnn: Worldwide port name
Lnn: Logical path location

Following are the descriptions of the location labels:

Unit location. Value of the unit enclosure identifier composed of uppercase alphabetic characters and digits. Commonly this value will be composed of the machine type (tttt), model (mmm) and serial number (sssssss).
Planar location. Decimal value of the planar identfier within the unit.
Card location. The decimal value of the position of the card within the hardware package. This can be followed by additional card location labels that would identify the decimal value of additional card positions of the resource on the card.
Port location. The decimal value of the port location within the resource.
Device location. The decimal value of the position of the device within the hardware package.
Virtual planar. The decimal value of the position of the virtual planar resource within the hardware package.
Worldwide port name. The hexadecimal value of the worldwide port name of the resource within the hardware package. This value is usually present for fibre channel devices. It will be blank for fibre channel adapters. See key value 169 for fibre channel adapters.
Logical path location. The decimal value of the logical path of the resource within the hardware package. This can be followed by additional logical path location labels that would identify the decimal value of additional logical path data of the resource on the hardware package.

Logically controlling CEC identity. The identity of the Central Electronic Complex (CEC) that logically controls the unit, if owned by this system. The value for this field is returned as CHAR(16).

Maximum frame size. The maximum path information unit (PIU) size that the controller can send or receive.

Maximum lines attached. A value that indicates the maximum number of lines that can be attached to a resource.

Maximum ports attached. A value that indicates the maximum number of ports associated with a resource.

Media type. The media type identifier of the resource.

Memory size. The amount of memory associated with this resource.

Miscellaneous manufacture information. The Miscellaneous manufacture information of the resource. The value for this field is returned as CHAR(2).

Model number. The model number of the resource.

Normal mode flag. Whether the resource is in normal mode. Valid values for this field are 0 (No) and 1 (Yes).

Number of resources. The number of resources connected to a known resource.

Operational flag. Whether the resource is designated as operational. Valid values for this field are 0 (No) and 1 (Yes).

Packaging location data. The packaging location data of the resource. The information for this field is returned as a Location array (see format below).

Part number. A manufacturing identifier that represents similar types of hardware.

Port number. A numerical representation of the location of this port in the card. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Powered-on flag. Whether the resource is powered on. Valid values for this field are 0 (No) and 1 (Yes).

Processor feature. The processor feature, corresponding to the processor capacity of the system.

Programmable flag. Whether the resource supports the programmable attribute. Valid values for this field are 0 (No) and 1 (Yes).

Rack VPD. This is present for packaging resources only. It shows the 16 character rack Vital Product Data (VPD), if present. For all other resources, this is an invalid key. The value for this field is returned as CHAR(16).

Rack VPD keyword. The Vital Product Data (VPD) keyword from which the Rack VPD is retrieved if present. This is present for packaging resources only. For all other resources, this is an invalid key.The value for this field is returned as CHAR(2).

RCTT level. The Reference Code Translation Table (RCTT) identifier.

Read format. The type of read format used by the resource.

Remote model. The model of the remote resource.

Remote name. The name of the remote resource.

Remote serial. The serial number of the remote resource.

Remote type. The type of the remote resource.

Reported this IPL flag. Whether the resource reported this initial program load (IPL). Valid values for this field are 0 (No) and 1 (Yes).

Resource classification 1. The type of hardware that the resource is.

Resource classification 2. The type of controller that the resource is.

Resource classification 3. The type of device that the resource is.

Resource extended attributes. The resource's extended atrributes. The value for this field is returned as CHAR(4). This value indicates the following according to the information returned in the 4th character.

Type

Field

CHAR(3)

Reserved

CHAR(1)

Attribute value

Bit

Description

Bits 0-1

Reserved (binary 0)

Bit 2

Non-reporting resource

0: Unit is a reporting resource
1: Unit is not a reporting resource

Bit 3

Work station console IOP

0: Unit is not a work station console IOP
1: Unit is a work station console IOP

Bit 4

Unit is not an IBM product (OEM)

0: Unit is an IBM product
1: Unit is not an IBM product

Bit 5

Most recently used alternate IPL unit

0: Unit is not the most recently used alternate IPL unit
1: Unit is the most recently used alternate IPL unit

Bit 6

Potential alternate IPL unit

0: Unit is not a potential alternate IPL unit
1: Unit is a potential alternate IPL unit

Bit 7

Load source disk unit

0: Unit is not a load source disk unit
1: Unit is a load source disk unit

Resource ID. The identification (ID) of the resource.

rvxCommunication. Whether the resource is an RS232 connecting device. Valid values for this field are 0 (No) and 1 (Yes).

Serial number. The manufacturing sequence number of designation of the resource.

Session address. A unique identifier for each session, so that the session is recognized by the system. The value for this field is returned as BINARY(2) and CHAR(2). Both variables, BINARY(2) and CHAR(2), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(2) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Supplied data at IPL flag. Whether the resource supplied data at IPL. Valid values for this field are 0 (No) and 1 (Yes).

Supported on system flag. Whether the resource is supported on the system. Valid values for this field are 0 (No) and 1 (Yes).

Supports assign command flag. Whether the resource supports the assign command. Valid values for this field are 0 (No) and 1 (Yes).

Supports TWERP flag. Whether the resource supports TWERP. Valid values for this field are 0 (No) and 1 (Yes).

Switchable mode. Whether the resource is set to be private or allowed to be switched between systems. Possible values are as follows:

Unknown.

Switchable.

Private.

System feature Code. This value specifies the processor feature code level of the system. This number identifies the processor. The processor feature system value is the same for each partition on a system.

Tape capability: The tape capabilities that this resource has.The BINARY(2) variable is a concatenation of bits or flags each with its meaning depending on its position. The following is the description of each flag:

Description

Bit turned on

Compression in IOP

B'1000000000000000'

Compaction in device

B'0100000000000000'

Autoloader

B'0010000000000000'

Media change detection

B'0001000000000000'

Streaming mode

B'0000100000000000'

Single record mode

B'0000010000000000'

In switched environment

B'0000001000000000'

Reserved

B'0000000100000000'

Random positioning supported

B'0000000010000000'

Reserved

B'0000000001110000'

Supports Storage IO Arch. space to end

B'0000000000001000'

Supports Device Pipe command

B'0000000000000100'

Supports Load Display command

B'0000000000000010'

Reserved

B'0000000000000001'

Transport type. The transport type identification that is returned. The value for this field is returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(4) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character. Valid values are:

SPD bus

PCI bus

Type number. An identifier that represents the object type of this resource.

UA location data. This field shows the location data of the unit address of a resource. The information for this field is returned as a Location Array (see format in the API documentation).

UA type. The type of unit address that is returned. The value for this field is returned as BINARY(2) and CHAR(2). Both variables, BINARY(2) and CHAR(2), are the same. BINARY(2) is the binary representation of the requested value, and CHAR(2) is the character representation of the requested value. The order that the variables are put into storage is binary first and then character.

Usable memory. The amount of memory, in megabytes, that is available for the resource to use.

User configurable flag. Whether the resource can be configured by the user. Valid values for this field are 0 (No) and 1 (Yes).

User location text. A text string that identifies where this resource is physically located.

Wide screen flag. Whether the resource supports the wide-screen attribute. Valid values for this field are 0 (No) and 1 (Yes).

Write format. The type of write format used by the resource.

X.21 interface. Whether the communications resource is of type X.21. Valid values for this field are 0 (No) and 1 (Yes).

Vary-on wait time. The number of seconds needed for this resource to typically vary on.

V.24 interface. Whether the communications resource is of type V.24. Valid values for this field are 0 (No) and 1 (Yes).

V.35 interface. Whether the communications resource is of type V.35. Valid values for this field are 0 (No) and 1 (Yes).

V.36 interface. Whether the communications resource is of type V.36. Valid values for this field are 0 (No) and 1 (Yes).

Location Array Format

Offset

Type

Field

Dec

Hex

CHAR(1)

Array header has data

CHAR(7)

Message ID

BINARY(2)

Array ID

BINARY(14)

Reserved

These fields repeat up to 15 element entries.

CHAR(*)

Data entries

CHAR(1)

Entry has data

CHAR(7)

Message ID

CHAR(*)

Data

Field Descriptions

Array header has data. If the array contains data the value will be 1 (Yes).

Array ID. Identifies what type of data is being supplied. Possible values as follows:

X'0001'

DSA (Direct Select Address) location data

X'0002'

Storage data

X'0003'

Communication data

X'0004'

Work station data

X'0005'

Auxiliary processor data

X'0006'

Spare

X'0007'

Library location data

X'0008'

Cryptography location data

Data. Displayable text with a one for one correlation with the element entry Message ID. The value for this field is returned as CHAR(40) if Packaging location data (key 6) was requested or CHAR(16) if DSA location data (key 7) was requested.

Entry has data. Whether there is information available for this entry. Valid values for this field are 2 (No) and 1 (Yes).

Message ID. The corresponding message identifier containing the description for this resource, otherwise this field has no meaning.

Fibre Channel Adapter Port Data Format

Offset

Type

Field

Dec

Hex

CHAR(1)

Fibre channel adapter

CHAR(1)

Number of ports

CHAR(*)

Port information

These fields repeat up to 4 element entries.

CHAR(1)

Fibre channel port number

CHAR(1)

Port status

CHAR(1)

Protocol

CHAR(1)

Port speed

BINARY(2)

Number of targets detected

CHAR(16)

Worldwide port name

Field Descriptions

Fibre channel adapter. Whether this storage resource is a fibre channel adapter. Valid values for this field are 0 (No) and 1 (Yes).

Fibre channel adapter port data. Data returned for each port in a fibre channel adapter.

Fibre channel port number. A sequential number assigned to the port starting from 0.

Number of ports. The number of ports on the adapter and the number of entries in the port information array.

Number of targets detected. Storage devices detected in the fibre channel link.

Port speed. Port speed in gigabits per second.

Port status. The status of the port. Valid values are 0 (Not active), 1 (Active), 3 (Unknown).

Protocol. The port protocol. Valid values are 0 (arbitrated loop), 1 (point to point), 2 (switched fabric), and 3 (unknown).

Worldwide port name. A unique identifier to distinguish worldwide the physical port in the fibre channel adapter.

Error Messages

Message ID

Error Message Text

CPF0B3B E

Resource name not found.

CPF0B3F E

The reserved area is not set to binary zeros.

CPF0B33 E

The handle is not valid.

CPF0B34 E

The handle is in wrong state for operation.

CPF0B38 E

Resource information not valid.

CPF0B39 E

Data requested by key &1 is not applicable.

CPF0B45 E

Materialize request is not applicable to resource &1.

CPF0B46 E

Materialize failed.

CPF0B48 E

Number of keys &1 is more than number of keys allowed.

CPF0B3A E

Resource name & is not valid.

CPF24B4 E

Severe error while addressing parameter list.

CPF3C19 E

Error occurred with receiver variable specified.

CPF3C21 E

Format name &1 is not valid.

CPF3C24 E

Length of the receiver variable is not valid.

CPF3C90 E

Literal value cannot be changed.

CPF3CF1 E

Error code parameter not valid.

CPF9872 E

Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R6

[ Back to top | Configuration APIs | APIs by category ]