Retrieve Disk Information (QYASRDI) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Format name Input Char(8)
4 Disk unit resource name array Input Array of CHAR(10)
5 Number of disk unit resource names Input Binary(4)
6 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Disk Information (QYASRDI) API retrieves disk unit information. Information for specific disk units is requested by putting the disk unit resource names into the input parameter disk unit resource name array, along with putting the number of requested disk unit names into the input parameter number of disk unit resource names. Information about the requested disk units is returned in the receiver variable.


Authorities and Locks

None.


Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The receiver variable to receive the disk unit information.

Length of receiver variable
INPUT; BINARY(4)

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.

Format name
INPUT; CHAR(8)

The format of the information returned from the Retrieve Disk Information (QYASRDI) API. The DMIN0100 format is used by this API for the receiver variable. For a detailed description of the format, see Format Descriptions.

Disk unit resource name array
INPUT; ARRAY OF CHAR(10)

An array of one or more disk unit resource names. A disk unit resource name identifies a disk unit. The system resource manager assigns a resource name to every hardware device that is physically attached to the system. The following special values are allowed:

*ALL All disk units.
*UNCONFIG All unconfigured disk units.

Number of disk unit resource names
INPUT; BINARY(4)

The number of disk unit resource names specified in the disk unit resource names array. In the case where the special values *ALL or *UNCONFIG are specified in the disk unit resource name array, the number of disk unit resource names parameter must be set to 1.

Error code
I/O; CHAR(*)

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


Format Descriptions

DMIN0100 Format

The following shows the information returned for the DMIN0100 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) Offset to disk unit data records
12 C BINARY(4) Number of disk unit data records
16 10 BINARY(4) Length of disk unit data records
20 14 BINARY(4) Reserved
NOTE: The following fields repeat the number of time specified in the number of disk unit parity data records field.
  CHAR(10) Disk unit resource name
  CHAR(1) Disk unit found flag
  CHAR(10) Tower resource name associated with disk unit
  CHAR(4) Tower number associated with disk unit
  CHAR(1) Disk unit allowed in new device parity set flag
  CHAR(1) Disk unit allowed in existing device parity set flag
  CHAR(5) Reserved
  BINARY(4) Device parity set number
  BINARY(4) Capacity available after device parity started


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.

Capacity available after device parity started. The number of bytes, in millions, of the capacity available of the disk unit after device parity has been started, if included in a device parity set.

Device parity set number. Device parity set number of disk unit if included in a device parity set. Valid range is 0 to 255.

Disk unit allowed in existing device parity set flag. A boolean flag used to indicate if the disk unit, in the associated record, can be added to an existing device parity set. Valid values are:

0 The disk unit cannot be added to an existing device parity set.
1 The disk unit can be added to an existing device parity set.

Disk unit allowed in new device parity set flag. A boolean flag used to indicate if the disk unit, in the associated record, can be added to a new device parity set. Valid values are:

0 The disk unit cannot be added to a new device parity set.
1 The disk unit can be added to a new device parity set.

Disk unit found flag. Whether the disk unit corresponding to the disk unit resource name was found on the system. Valid values are:

0 The disk unit was not found.
1 The disk unit was found.

Disk unit resource name. A disk unit. The system resource manager assigns a resource name to every hardware device that is physically attached to the system.

Length of disk unit data records. The number of bytes occupied by each disk unit data record.

Number of disk unit data records. The number of disk unit data records that are returned in the receiver variable. Each record has the same format and is repeated in the receiver variable.

Offset to disk unit data records. The offset in bytes from the start of the receiver variable to the first requested disk unit data record.

Tower number associated with disk unit The tower number to which the disk unit is attached. This field may be used to determine the physical location of the disk unit.

Tower resource name associated with disk unit The tower resource name to which the disk unit is attached. This field may be used to determine the physical location of the disk unit.


Error Messages

Message ID Error Message Text
CPFBA49 E Number of disk unit resource names not valid.
CPFBA50 E Number of disk unit resource names is out of range.
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.


API introduced: V4R5

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