| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Session handle | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
The Retrieve Disk Management Status (QYASRDMS) API retrieves status information for the currently active disk management session that was started by using the Start Disk Management Session (QYASSDMS) API.
None.
The receiver variable that is to receive the disk management status information from the Retrieve Disk Management Status (QYASRDMS) API.
The length of the receiver variable, in bytes. The minimum length is 8 bytes. If the length of the receiver variable is not large enough to hold all repeating fields of the format name specified in the Format name parameter, then no repeating fields are returned. If the length of the receiver variable is not large enough to hold all non-repeating fields of the beginning portion of the format (format header), then only the first 8 bytes are returned.
The format of the information that is returned from the Retrieve Disk Management Status (QYASRDMS) API. The DMST0100 format is used by this API for the receiver variable. For a detailed description of the format, see Format Descriptions.
The unique ID that was returned to the caller on a preceding Start Disk Management Session (QYASSDMS) API. The session handle contains arbitrary binary data and should not be interpreted as character data.
Use binary zeroes to retrieve status information for the current or most recent disk management session when the caller has not started a disk management session using the Start Disk Management Session (QYASSDMS) API.
Use the session handle when the caller has successfully started a disk management session using the Start Disk Management (QYASSDMS) API.
If the session handle is not used to perform an operation using the QYASSDMO API or is not used to check the status of an operation using this API within 5 minutes after a session has been started or an operation has completed, the session of the associated handle will end and the associated handle will be invalidated if a call is made to start another disk management session.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following shows the information returned for the DMST0100 format. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Session status |
| 12 | C | BINARY(4) | Operation identifier of the current or most recent operation performed |
| 16 | 10 | BINARY(4) | Percentage of operation complete |
| 20 | 14 | BINARY(4) | Offset to error data records |
| 24 | 18 | BINARY(4) | Number of error data records |
| 28 | 1C | BINARY(4) | Length of an error data record |
| 32 | 20 | BINARY(4) | Reserved |
| NOTE: The following fields repeat the number of time specified in the number of error data records field in order of occurrence. | |||
| CHAR(7) | Error ID | ||
| CHAR(30) | Error data | ||
Bytes returned. The number of bytes of data returned.
Error data. The data related to the error ID associated with the action identifier.
Error ID. The 7-character error code ID of the most recently completed action associated to the session handle. Possible error code IDs returned are:
| CPFBA23 | Operation failed. |
| CPFBA25 | A general DASD management error has occurred. |
| CPFBA27 | Could not restore mirrored data. |
| CPFBA31 | Disk unit &1 has errors. |
| CPFBA3A | Create new ASP failed. |
| CPFBA3F | Cannot rebuild parity information. |
| CPFBA41 | Device parity set not operational. |
| CPIBA20 | Operation was ended. |
| CPIBA21 | Parity set needs intervention. |
Length of an error data record The total number of bytes of an individual error data record.
Number of error data records The number of error data records specified in the array of error data records.
Offset to error data records. The offset in bytes from the start of the receiver variable to the first error data record.
Operation identifier of current or most recent operation performed. If the session status is 'session is active and currently performing an operation,' then this field indicates the current operation being performed associated to the session handle. Otherwise, this field indicates the operation most recently completed associated to the session handle.
Valid operation key values are:
| 1 | Change the storage threshold percentage of an ASP |
| 2 | Add disk units to an ASP |
| 3 | Suspend mirrored protection on a disk unit |
| 4 | Resume mirrored protection on a disk unit |
| 5 | Include disk unit in device parity protection |
| 6 | Rebuild data on a disk unit after a parity fault |
| 7 | Replace mirrored disk unit |
| 8 | Start device parity protection on a controller with no configured disk units |
| 9 | Enable remote load source mirroring |
| 10 | Disable remote load source mirroring |
| 11 | Power off a disk unit |
| 12 | Power on a disk unit |
| 13 | Format a disk unit |
| 14 | Clear a disk unit |
| 15 | Scan surface of a disk unit |
| 5000 | Active DST/Service Tools operations |
| 5001 | No operations have been performed |
| 5002 | Specified handle not performing an operation |
Percentage operation complete. If the session status is 'session is active and currently performing an operation' of the session indicated by the session handle parameter, then this field indicates, on a scale of 0 to 100, the percentage of completion of the current operation being performed.
Session status. The status of the session indicated by the session handle parameter. Session status values are:
| 0 | Session is active and not currently performing an operation |
| 1 | Session was ended |
| 2 | Session is active and currently performing an operation |
| 3 | Session is in error |
| Message ID | Error Message Text |
|---|---|
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |