Report a CPC Problem

Edit online

The Report a CPC Problem operation reports and requests service for a problem on a CPC object designated by {cpc-id}. This operation is supported on the Support Element using the BCPii interface. [Added by feature report-a-problem]

HTTP method and URI

POST /api/cpcs/{cpc-id}/operations/report-problem

In this request, the URI variable {cpc-id} is the Object ID of the CPC object.

Request body contents

The request body is expected to contain a JSON object with the following fields:

Name Type Req/Opt Description
customer-name String (0-50) Optional Name of the customer.

May not contain any double-byte characters or ";".

Default: "Unknown"
customer-phone-number String (0-20) Optional Phone number of customer.

May not contain any double-byte characters or ";".

Default: "Unknown"
problem-description String (1-510) Required Description of the problem.

May not contain any double-byte characters or ";".
problem-type String Enum Required Identifies the type of problem. One of:
  • "power" - Report a problem with the power subsystem.
  • "cpc" - Report a problem with hardware in the processor subsystem.
  • "lan" - Report a problem with the local area network (LAN).
  • "software" - Report a problem with an operating system or other software.
  • "io" -Report a problem with hardware in the input/output (I/O) configuration.
  • "health" - Report the state of the system before applying a maintenance action.
  • "other" - Report a problem that is not adequately described by any other problem type.
  • "test" - Test whether problems can be reported for the selected system.

Description

The Report a CPC Problem operation reports a problem for a CPC object and requests service to repair it.

Problems are reported to the support system for the provided system. Reporting a problem sends the information provided in the request and the machine information that identifies the system to the service provider.

Automatic service call reporting must be enabled on the SE associated with the CPC object via the Remote Service task to use this operation. If the SE associated with the CPC object does not have automatic service call reporting enabled, a 409 (Conflict) status code is returned.

Upon successful problem creation, a 204 (No Content) status code is returned. If the API user does not have action/task permission to the Report a Problem task, a 403 (Forbidden) status code is returned. If the SE associated with the CPC object is unreachable, a 503 (Service Unavailable) status code is returned. The URI path must designate an existing CPC and the API user must have object-access permission to it; otherwise, status code 404 (Not Found) is returned.

Authorization requirements

This operation has the following authorization requirements:

For the web services interface:
  • Object-access permission to the CPC object designated by {cpc-id}.
  • Action/task permission for the Report A Problem task.
For the BCPii interface using the OS side resource checking:
  • The source partition must have receive BCPii security controls permissions for the CPC object designated by {cpc-id}.

HTTP status and reason codes

On success, HTTP status code 204 (No Content) is returned and no response body is provided.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
403 (Forbidden) 0 The request used the BCPii interface and the source partition does not have receive BCPii security controls permission for the CPC object
1 The API user does not have the required action/task permissions.
404 (Not Found) 1

The object ID in the URI ({cpc-id}) does not designate an existing CPC object, or the API user does not have object-access permission to the object.
409 (Conflict) 600

The operation cannot be performed because the SE does not have automatic service call reporting enabled.
503 (Service Unavailable) 1

The request could not be processed because the HMC is not currently communicating with an SE needed to perform the requested operation.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Report a CPC Problem: Request
POST /api/cpcs/0b9e5710-4edc-3402-adf8-809f4d445242/operations/report-problem HTTP/1.1
x-api-session: 2rbq3ademcduira0f4jfawsncvynec6lxlmdgxakzwqui9u6up
Content-Type: application/json
Content-Length: 142
{
  "customer-name":"Tester",
  "customer-phone-number":"888-888-8888",
  "problem-description":"This is a test IO problem",
  "problem-type":"io"
}
Figure 2. Report a CPC Problem: Response
204
Server: Hardware management console API web server / 2.0
Cache-control: no-cache
Date: Mon, 06 Feb 2023 23:25:25 GMT
<No response body>