Retrieve IOA Cache Battery Information (QSMRTVBTC) API
Required Parameter Group:
| 1 | Receiver Variable | Input | Char(*) |
| 2 | Length of receiver Variable | Input | Binary(4) |
| 3 | Format Name | Input | Char(8) |
| 4 | Time Zone | Input | Char(10) |
| 5 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve IOA Cache Battery Information (QSMRTVBTC) API returns the IOA cache battery information for I/O Adapters(IOAs) that power the cache battery. This API does not return information for IOAs which do not have a cache. This API only retrieves IOA cache battery information for the partition where it is used.
Authorities and Locks
None.
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 of the receiver variable parameter correctly. As a result, the API returns only the complete data for a message that the area can hold. If there was space for all but 5 bytes of the message text then none of the information for that message would be returned.
The entries are returned in the format specified in the Format name parameter. See CBTT0100 Format for a description of this parameter.
- 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.
- Format Name
- INPUT; CHAR(8)
The format of the returned message information. You must use this format:
HSTL0100 Basic message information with identified return fields. This format is described in CBTT0100 Format. - Time zone
- INPUT; CHAR(10)
Specifies the time zone that the time and date data is input and returned in. valid values for this field are:
*SYS Local system value associated with the time zone is specified by the time zone system value *UTC Coordinated Universal Time(UTC) value. *JOB Local job time value and the associated time zone is specified by the job attribute. Time zone name Specifies the name of a time zone description(*TIMZON) object. - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
CBTT0100 Format
CBTT0100 Format
The following table shows the information returned in the receiver variable for the CBTT0100 format. For detailed descriptions of each field, see the Field Descriptions.
The structure defined by this format is repeated for each entry returned.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes Returned |
| 4 | 4 | BINARY(4) | Bytes Available |
| 8 | 8 | BINARY(4) | Number of Entries |
| 12 | C | BINARY(4) | Offset to first entry |
| 16 | 10 | BINARY(8) | UTC |
| 18 | 1A | BINARY(2) | CCSID |
| 26 | 1A | CHAR(7) | Date retrieved |
| 33 | 21 | CHAR(6) | Time Retrieved |
| 39 | 27 | CHAR(8) | System name |
| 47 | 2F | CHAR(4) | System type |
| 51 | 33 | CHAR(3) | System model |
| 54 | 36 | CHAR(15) | System serial number |
| 69 | 45 | CHAR(3) | Reserved |
| 72 | 48 | BINARY(2) | Partition number |
| 74 | 4A | CHAR(48) | Partition name |
| 122 | 7A | CHAR(*) | Reserved |
| These fields repeat for each IOA cache battery Information entry | |||
| BINARY(2) | Length of entry | ||
| BINARY(2) | Entry Number | ||
| CHAR(4) | IOA type | ||
| CHAR(4) | IOA model | ||
| CHAR(15) | IOA serial number | ||
| CHAR(10) | IOA resource name | ||
| CHAR(79) | Physical location | ||
| CHAR(4) | Frame ID | ||
| CHAR(3) | Card Position | ||
| CHAR(1) | Version | ||
| CHAR(1) | Error state | ||
| CHAR(1) | Battery state | ||
| CHAR(1) | Maintainable | ||
| CHAR(1) | Data in cache written to disk | ||
| BINARY(2) | Days to warning | ||
| BINARY(2) | Days to Error | ||
| BINARY(2) | Power on time | ||
| BINARY(2) | Adjusted power on time | ||
| CHAR(24) | Reserved | ||
| CHAR(*) | Reserved | ||
Field Descriptions
Adjusted power on time. The number of days that the IOA cache battery has been powered on, which the IOA has adjusted based on an internal IOA algorithm.
Battery type. The type of battery which charges the IOA cache. The meaning of each type is:
| '00'X | The the IOA does not have a battery. |
| '01'X | the IOA battery is Nickel Cadmium. |
| '02'X | the IOA battery is Nickel Metal Hydride. |
| '03'X | the IOA battery is Lithium Ion. |
| Values larger than '04'X are for 'other' type of IOA batteries. | |
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.
Card position. The card position of the I/O Adapter.
CCSID. The coded character set identifier in which the character information is returned.
Data in cache written to disk. An indicator showing if the data in the IOA cache has been successfully written onto the disk media.
| '00'X | the data in the IOA cache has not yet been written to the disk media. If the battery is replaced, data in the IOA cache will be lost. |
| '01'X | the data in the IOA cache has been written to the disk media. It is safe to replace the battery. |
Date retrieved. The date on which the information was retrieved, in CYYMMDD(century, year, month, and day) format.
Days to error. The number of days until the battery goes into an error status, thus stopping the IOA caching function.
Days to warning. The number of days until the battery sends a warning about its condition.
Entry Number. The identifier for the entry in the array.
Error state. An indicator showing if an error has occurred on the IOA battery which powers the IOA cache. The meaning of each state is:
| '00'X | the IOA has not issued an error or warning. |
| '01'X | the IOA has issued a warning regarding the battery. |
| '02'X | the IOA has issued an error condition regarding the battery. |
| Values larger than '02'X are for 'other' states. | |
Frame ID. The frame identifier of the position of the I/O Adapter.
IOA cache battery information entry. The beginning of an array of entries containing information retrieved for the IOAs. No partial entries will be returned. The location of the first entry should be calculated using the offset to first entry field.
IOA model. The model of the I/O Adapter.
IOA Resource Name. T he resource name of the I/O Adapter.
IOA Serial Number. T he serial number of the I/O Adapter.
IOA Type. The type of the I/O Adapter.
Length of entry. The length in bytes of each entry in the IOA cache battery information entry. This length should be used for indexing the entries, rather than assuming the length as defined in the template.
Maintainable. An indictor showing if the battery can be maintained. The meaning of maintainable is:
| '00'X | the IOA cache battery is not maintainable. |
| '01'X | the IOA cache battery is maintainable. |
| Values larger than '01'X are not used. | |
Number of entries. The number of IOAs which have cache batteries. The data for each of the IOAs is provided in the IOA cache battery information entry.
Offset to first entry. The length in bytes from the start of the format to the first IOA cache battery information entry.
Partition Name. The name of the partition.
Partition Number. The number of the partition.
Physical location. The physical location of the I/O Adapter.
Power on time. The number of days that the IOA cache battery has been powered on.
System model. The model number of the system.
System name. The name of the system.
System type. The type of the system.
System serial number. The serial number of the system.
Time retrieved. The time at which the data was retrieved, in HHMMSS (hour, minute, and second) format. A 24 hour format is used.
UTC. The Coordinated Universal Timestamp when the data was retrieved.
Version. The version field returns the value indicating how the location information is to be presented. The meaning of the version is:
| '00'X | Pre-converged hardware. |
| '01'X | Converged hardware. |
Error messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
API introduced: V7R2
| Top | Miscellaneous APIs | APIs by category |