Shutdown Console
Shutdown Console powers off the Hardware Management Console. This operation is supported using the BCPii interface.
HTTP method and URI
POST /api/console/operations/shutdown
Request body contents
The request body is expected to contain a JSON object with the following fields. If none of the optional fields are included, an empty request body must be supplied.
Field name | Type | Rqd/Opt | Description |
---|---|---|---|
force |
Boolean | Optional | Whether the shutdown operation is processed when users are connected (true) or not (false). The default is false. |
Description
The Console is powered off.
By default, the shutdown does not occur if one or more users are currently connected to the Console. This can be overridden by use of the force field in the request body.
The action to shutdown the Console occurs asynchronously. If the request is accepted, HTTP status code 202 (Accepted) is returned to indicate that the request has been initiated. However, because this action results in the targeted Console becoming inactive and powered off at completion, it is not possible to track the completion of this request. Thus no response body containing an asynchronous job URI is provided, nor is a job completion notification generated upon completion.
Authorization
To use Shutdown Console, you must have the following:
- For the web services interface, action/task permission to the Power Off or Restart task
- For the BCPii interface the source partition must have receive BCPii security controls permissions for the CPC object.
- Remote Shutdown must be enabled on the Hardware Management Console or Support Element.
HTTP status and reason codes
On success, HTTP status code 202 (Accepted) is returned but 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. |
267 | The operation is rejected, due to the presence of HMC users. Either wait until all HMC users have logged off or retry the request with the force field set to true. | |
403 (Forbidden) | 1 | The user under which the API request was authenticated does not have the required authority to perform this operation. |
270 | The remote restart operation is not enabled on the HMC. | |
304 | This operation is currently blocked. The error message will contain information on the blocking application. | |
500 (Server Error) | 273 | An unexpected error occurred during the operation. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.