Configuration APIs

The configuration application programming interfaces (APIs) allow you to get information about the configuration status of the system and about individual configuration descriptions. The configuration APIs available to you are:

Change Configuration Description (QDCCCFGD) changes the value of one or more parameters in an existing configuration description.
List Configuration Descriptions (QDCLCFGD) returns a list of configuration descriptions.
Retrieve Configuration Status (QDCRCFGS) retrieves the current status of a controller, device, line, or network interface.
Retrieve Controller Description (QDCRCTLD) retrieves information about a controller description.
Retrieve Device Description (QDCRDEVD) retrieves information about a device description.
Retrieve Line Description (QDCRLIND) retrieves information about a line description.
Retrieve Network Server Description (QDCRNWSD) retrieves information about a network server description.

DASD Management APIs

The direct access storage device (DASD) management APIs provide basic control of disk units in the system. These APIs can be used to perform a variety of actions, such as changing the storage threshold for an auxiliary storage pool (ASP), adding a disk unit to an ASP, resuming protection on a disk unit, and formatting a disk unit. In general, these actions represent the DASD management options available through the Work with Disk Units menu options from the OS/400 command to Start a Service Tool (STRSST). The Start DASD Management Operation (QYASSDMO) API provides a complete list of DASD management configuration actions.

The Retrieve DASD Management Information (QYASRDI) and Open List of ASPs (QYASPOL) return general information. These APIs do not require a DASD management session handle.

The remaining APIs use a configuration session between the system DASD Manager and the configuration application. This session handle must be reserved using the Start DASD Management Session (QYASSDMS) API. The system DASD Manager supports only one active session at a time. The Work with Disk Units options under Dedicated Service Tools (DST) and System Service Tools (SST), the Operations Navigator DASD Management client, and all other applications performing DASD operations require a session to perform their requests. Therefore, it is important that applications use End DASD management Session (QYASEDMS) to release that session when all operations are complete.

Most DASD management operations require a handle to a previously reserved configuration session. The Start DASD Management Operation (QYASSDMO) API initiates an action. Most operations run to completion and return completion status on the start request. Some operations require a longer period of time in which to execute. These long-running operations return immediately, but must be checked for operation completion. The Retrieve DASD Management Status (QYASRDMS) API allows an application to check for status on a long-running operation. The End DASD Management Operation (QYASEDMO) provides a cancel mechanism. It is the responsibility of the application to know which operations return status immediately and which applications require additional status checking.

For information regarding how to work with disk units, auxiliary storage pools, and storage protection, see the Backup and Recovery book.

The DASD Management APIs are:

End DASD Management Operation (QYASEDMO) ends an active operation.
End DASD Management Session (QYASEDMS) releases a client's reservation.
Open List of ASPs (QYASPOL) generates a list of ASPs or information about an ASP.
Retrieve DASD Information (QYASRDI) retrieves disk unit information.
Retrieve DASD Management Status (QYASRDMS) retrieves status information for an active operation.
Start DASD Management Operation (QYASSDMO) requests the DASD manager to perform an operation.
Start DASD Management Session (QYASSDMS) reserves the DASD manager for a specific client.

Top | OS/400 APIs | APIs by category

[Information Center Home Page | Feedback ]

[Legal | AS/400 Glossary]