Report a Console Problem

The Report a Console Problem operation reports and requests service for a problem on an HMC. [Added by feature report-a-problem]

HTTP method and URI

POST /api/console/operations/report-problem

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:
  • "health" - Report the state of the HMC before applying a maintenance action.
  • "hmc" - Report a problem that occurred on the HMC.
  • "test" - Test whether problems can be reported for the HMC.

Description

The Report a Console Problem operation reports a problem for the HMC and requests service to repair it.

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

Automatic service call reporting must be enabled on the HMC via the Remote Service task to use this operation. If the HMC 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 Console Problem task, a 403 (Forbidden) status code is returned.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission for the Report A Console Problem task.

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) 1 The API user does not have the required action/task permissions.
409 (Conflict) 600

The operation cannot be performed because the HMC does not have automatic service call reporting enabled.

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

Example HTTP interaction

Figure 1. Report a Console Problem: Request
POST /api/console/operations/report-problem HTTP/1.1
x-api-session: 5v1r4vy0gq4tes9uxzel9tvmn59wbhujmt45ko89debv7ubbya
Content-Type: application/json
Content-Length: 134
{
  "customer-name":"Tester",
  "customer-phone-number":"888-888-8888",
  "problem-description":"This is a console problem",
  "problem-type":"hmc"
}
Figure 2. Report a Console Problem: Response
204
Server: Hardware management console API web server / 2.0
Cache-control: no-cache
Date: Mon, 06 Feb 2023 23:00:39 GMT
<No response body>