Perform Hardware Configuration Operation (QYHCHCOP) API

The Perform Hardware Configuration Operation (QYHCHCOP) API allows for viewing, changing, and checking the status of certain parts of the system's hardware configuration. This API allows the following activities:

• view the logical partition configuration
• change the logical partition configuration
• check the status of a logical partition configuration change
• view the disk unit and ASP configuration
• change the disk unit and ASP configuration
• check the status of disk unit and ASP configuration change

Authorities and Locks

This API is shipped with *EXCLUDE public authority.

To use this API you must:

• be explicitly authorized to the API, or call the API from a program that adopts enough authority to call the API and have *IOSYSCFG and *SERVICE special authority.
  
  
• have set the password level of the Dedicated Service Tools (DST). This is done through the service tools security data option, followed by the password level option. When this option has been activated, service tools user ID passwords are case sensitive.
  
  
• have a service tools user ID and password that has been authorized to perform the task you are requesting. Service tools user IDs are configured using Dedicated Service Tools (DST).
  
  
• have a service tools user ID and password that match the i5/OS user profile and password of the user that is calling this API. Care must be taken to make sure the password cases match between the i5/OS user profile and the service tools user ID.

The port name "as-sts" must be unblocked and enabled for this API to process successfully. If the port name is not unblocked, this this API will return a CPFBA03 message.

The service authority required to perform an operation depends on the operation you are trying to perform. To see what authority a specific operation requires, consult the logical partition configuration markup language document or the disk management configuration markup language document. The following table summarizes the authority required for various operations.

Required Parameter Group

Hardware Configuration Request

INPUT; CHAR(*)

The information for the request. The type of information provided is described in the request type parameter.

Hardware Configuration Request Length

INPUT; BINARY(4) Unsigned

The length of the hardware configuration request buffer.

Request type

INPUT; BINARY(4) Unsigned

The type of request being made. The following constants are defined for the request type.

LPARRequest = 1	Change, view, or check the status of the logical partition configuration using the Logical Partition Markup Language. For the format of the markup language, see LPARConfigurationScript Specification, Version 10.
DiskRequest = 2	Change, view, or check the status of the disk and ASP configuration using the Disk Management Markup Language. For the format of the markup language, see DMConfigurationScript Specification, Version 30.

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that is to receive the response from the hardware configuration request. The format of this variable is determined by the type of hardware configuration request submitted.

Length of receiver variable

INPUT; BINARY(4) Unsigned

The length of the receiver variable, in bytes.

Bytes of return data available

OUTPUT; BINARY(4) Unsigned

The number of bytes that is available for return. If this value is larger than the receiver variable, some of the return data was lost.

Error code

I/O; CHAR(*)

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

Error Messages