Open List Network Server Storage Spaces (QFPADOLD) API

The Open List Network Server Storage Spaces (QFPADOLD) API retrieves a list of storage spaces (virtual disk drives) that can be linked to a server. The functions provided by this API are similar to the Work with Network Server Storage Spaces (WRKNWSSTG) command.

Authorities and Locks

Network Server Storage Space Authority

*RX for IFS directory /QFPNWSSTG

*RX for IFS directory /QFPNWSSTG/name

*R for the files in IFS directory /QFPNWSSTG/name

Note: In the above file paths, 'name' is the name of the storage space.

Network Server Storage Space Lock

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 parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable provided. The length of the receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of the 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 0 bytes.

List information

OUTPUT; CHAR(80)

Information about the list created by this program. For a description of the layout of this parameter, see Format of List Information.

Number of records to return

INPUT; BINARY(4)

The number of records in the list to put into the receiver variable. The value must be 0 or greater.

Format name

INPUT; CHAR(8)

The format of the information returned. You must use the following format name:

DOLD0100

The output storage space list structure. For more information, see DOLD0100 Format.

Storage space name qualifier

INPUT; CHAR(*)

A restriction on the information to be retrieved. This parameter allows the caller to request a subset of the records that normally would be returned on a given format. If this parameter is *ALL, no information qualification is performed. Allowable values are:

*ALL	Information about all storage spaces.
Storage space name	Information about the specified storage space name record only.
Generic storage space name*	Information about storage spaces matching the generic storage space name string.

Length of storage space name qualifier

INPUT; BINARY(4)

The length of the storage space name qualifier.

Network server description name qualifier

INPUT; CHAR(*)

A restriction on the information to be retrieved. This parameter allows the caller to request a subset of the records that normally would be returned on a given format. If this parameter is *ALL, no information qualification is performed. Allowable values are:

*ALL	Information about storage spaces for all network server descriptions, including storage spaces that are not linked to a network server description.
Network server description name	Information about storage spaces linked to the specified network server description name only.

Length of network server description name qualifier

INPUT; BINARY(4)

The length of the network server description name qualifier.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

DOLD0100 Format

Format DOLD0100 returns storage space information.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Displacement to next storage space record
4	4	BINARY(4)	Length of storage space record
8	8	CHAR(10)	Name
18	12	CHAR(50)	Description
68	44	BINARY(4)	Capacity
72	48	BINARY(4)	Percent used
76	4C	BINARY(4)	Disk pool
80	50	BINARY(4)	Storage space format
84	54	BINARY(4)	Storage space formatting status
88	58	BINARY(4)	Access to storage space
92	5C	BINARY(4)	Displacement to list of server entries
96	60	BINARY(4)	Length of server list entries
100	64	BINARY(4)	Number of server list entries
104	68	BINARY(4)	Clustering quorum resource disk
108	6C	CHAR(10)	Disk pool name
118	76	CHAR(2)	Reserved
120	78	BINARY(4)	Displacement to list of extent entries
124	7C	BINARY(4)	Length of extent list entries
128	80	BINARY(4)	Number of extent list entries
132	84	BINARY(4)	Displacement to cluster quorum disk information
136	88	BINARY(4)	Length of cluster quorum disk information
These fields repeat for each server entry		BINARY(4)	Dynamic link
		BINARY(4)	Link sequence position
		CHAR(8)	Network server description name
		BINARY(4)	Displacement to server name
		BINARY(4)	Length of server name
		BINARY(4)	Link type
		BINARY(4)	Storage path identifier
		CHAR(10)	Network server host adapter name
		CHAR(*)	Server name
These fields repeat for each extent entry		BINARY(4)	Extent capacity
		BINARY(4)	Extent free space
		CHAR(16)	Extent format
		CHAR(64)	Volume name
These fields exist when disk is created as a cluster quorum resource disk		CHAR(10)	Cluster name
		CHAR(15)	Cluster domain name
		CHAR(10)	Cluster connection port
		CHAR(15)	Cluster IP address
		CHAR(15)	Cluster subnet mask

Field Descriptions

Access to storage space. The type of access the server has to the storage space data. The possible values follow:

Capacity. The size of the storage space, in megabytes (MB).

Cluster connection port. The port number that was specified when creating the cluster quorum resource disk.

Cluster domain name. The name of the Windows cluster domain that was specified when creating the cluster quorum resource disk.

Cluster IP address. The internet address of the cluster that was specified when creating the cluster quorum resource disk.

Cluster name. The name of the Windows cluster that was specified when creating the cluster quorum resource disk.

Clustering quorum resource disk. Specifies whether the storage space was created as a cluster quorum resource disk or not.

Cluster subnet mask. The subnet mask of the cluster that was specified when creating the cluster quorum resource disk.

Description. The text description of the storage space.

Disk pool. The disk pool that contains the storage space.

Disk pool name. The device description name for the independent user disk pool that contains the storage space.

Displacement to cluster quorum disk information. The displacement in bytes from the beginning of the record to the cluster quorum disk information. If this disk is not a cluster quorum disk, this value is zero.

Displacement to list of extent entries. The displacement in bytes from the beginning of the record to the list of disk drive extents found on the storage space. If there are no disk drive extents found on this storage space, this value is zero.

Displacement to list of server entries. The displacement in bytes from the beginning of the record to the list of network server descriptions that are linked to the storage space. If there are no network server descriptions linked to the storage space, this value is zero.

Displacement to next storage space record. The displacement in bytes from the beginning of the record to the next storage space record. If this is the last record, this value is zero.

Displacement to server name. The displacement in bytes from the beginning of the server list entry to the server name.

Dynamic link. Whether the storage space was linked to the server dynamically. The possible values follow:

Extent capacity. The size of the disk drive extent in megabytes (MB).

Extent format. A blank padded Unicode (CCSID 13488) text string describing the file system type formatted on the volume residing on the disk drive extent. Expected value includes but is not limited to one of the following.

Extent free space. The size in megabytes (MB) on this disk extent that is not occupied by data.

Length of cluster quorum disk information. The length of the cluster quorum disk information.

Length of extent list entries. The length of each disk drive extent entry.

Length of server list entries. The length of each server entry.

Length of server name. The length of the server name.

Length of storage space record. The length of the data for the current storage space.

Link sequence position. The relative order that storage spaces are linked to the network server description. Storage spaces are presented to the hosted operating system in the order specified by the link sequence position value. There are several types of storage space links. The link types and the corresponding link sequence position ranges are as follows:

Link type. The type of linking and access mode used for this disk drive. The possible link types are as follow:

Name. The name of the storage space.

Network server description name. The name of the network server description that is linked to the storage space.

Network server host adapter name. The name of the network server host adapter device description that is being used to access this disk drive. This field will be blank if a network server host adapter is not required to access this disk. The following special value can be returned:

*MULTIPATH

Multiple storage paths are defined in the NWSD for accessing this disk drive.

Number of extent list entries. The number of disk drive extent entries. The maximum number of extent entries per disk drive is 32. If more than 32 extent entries exist on the disk drive, the contents of the 32nd extent entry will be a sum of all remaining extent entries.

Number of server list entries. The number of server entries.

Percent used. The percentage of the storage space capacity that is occupied by data.

Reserved. Reserved area for 4-byte boundary alignment.

Server name. The name of the server that is linked to the storage space.

Storage path identifier. This value represents the storage path identifier of the network server host adapter device being used to access this storage.

1	First storage path in NWSD
2	Second storage path in NWSD
3	Third storage path in NWSD
4	Fourth storage path in NWSD
-1	Default storage path
-2	Multipath as defined in NWSD
-3	Storage path not used for accessing disk

Storage space format. The file system format that is used for the storage space. The possible values follow:

Storage space formatting status. Whether the storage space is properly formatted for the specified file system format and ready to use. The possible values follow:

Volume name. A blank padded Unicode (CCSID 13488) text string describing the volume name residing on the disk drive extent.
If the disk contains more than 32 extents, the volume name on the 32nd extent entry will be *OVERFLOW.

Format of List Information

The following table shows the format of the list information parameter. For detailed descriptions of the field in the table, see Field Descriptions.

Field Descriptions

Date and time created. The date and time the list was created. The 13 characters are:

First record in buffer. The number of the first record in the receiver variable.

Information complete indicator. Whether all information requested has been supplied.

Length of information returned. The size, in bytes, of the information returned in the receiver variable.

List status indicator. The status of the list building. The indicators are:

Record length. The length of each record of information returned. For variable length records, this value is set to 0. For variable length records, you can obtain the length of individual records from the records themselves.

Records returned. The number of records returned in the receiver variable. This is the smallest of the following values:

• The number of records that fit into the receiver variable.
• The number of records in the list.
• The number of records requested.

Request handle. The handle of the request that can be used for subsequent requests of information from the list. The handle is valid until the Close List (QGYCLST) API is called to close the list or until the job ends.

Note: This field should be treated as a hexadecimal field. It should not be converted from one CCSID to another (for example, EBCDIC to ASCII) because doing so could result in an unusable value.

Reserved. Reserved field. Must be set to hexadecimal or binary zero.

Total records. The total number of records available in the list.

Error Messages