Delete Logical Partition OS Message

The Delete Logical Partition OS Message operation deletes a single logical partition OS message. This operation is supported using the BCPii interface.

HTTP method and URI

POST /api/logical-partitions/{logical-partition-id}/operations/delete-os-message

In this request, the URI variable {logical-partition-id} is the object ID of the target logical partition.

Request body contents

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

Name Type Rqd/Opt Description
sequence-number Long Required

The sequence-number property of the OS message on the logical partition to delete.

Description

This operation deletes a specific logical partition OS message. The OS message to be deleted is uniquely identified by the combination of the {logical-partition-id} variable in the URI and the sequence-number in the request body.

The URI path must designate an existing logical partition and the API user must have access permission to it; otherwise status code 404 (Not Found) is returned.

The request body must designate an existing OS message; otherwise, status code 404 (Not Found) is returned. In addition, for the web services interface the API user must have Action/Task permission to the Operating System Messages task; otherwise, status code 403 (Forbidden) is returned.

Authorization requirements

This operation has the following authorization requirements:
  • For the web services interface:
    • Object-access permission to the Logical Partition object designated by {logical-partition-id}
    • Action/task permission for the Operating System Messages task.
  • For the BCPii interface the source partition must have receive BCPii security controls permissions for the Logical Partition object designated by {logical-partition-id}.

HTTP status and reason codes

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

The following HTTP status codes are returned for the indicated errors. 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 Logical Partition object.
1 The API user does not have action/task permission for the Operating System Messages task.
404 (Not Found) 1 The object ID in the URI {logical-partition-id} does not designate an existing Logical Partition object, or the API user does not have object-access permission to the object.
336 The sequence-number in the request body does not designate an existing OS message on the logical partition.
409 (Conflict) 332 The messages interface is not available.

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

Example HTTP interaction

Figure 1. Delete Logical Partition OS Message: Request
POST /api/logical-partitions/4767c72e-b00d-3a1c-ac89-87f821404a0b/operations/delete-os-message 
   HTTP/1.1
x-api-session: 6d1q521ruuym4dhqubv3m77678qbjx7c68wpdpv5v75ut8n1iq
content-type: application/json
content-length: 22
{
   "sequence-number":0
}
Figure 2. Delete Logical Partition OS Message: Response
204 No Content
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Thu, 15 Nov 2018 17:21:00 GMT

<No response body>