Increase Crypto Configuration

The Increase Crypto Configuration operation can be used to add more elements to an existing (empty or non-empty) crypto configuration.

HTTP method and URI

POST /api/partitions/{partition-id}/operations/increase-crypto-configuration

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

Request body contents

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

Field name Type Rqd/Opt Description
crypto-adapter-uris Array of String/ URI Optional Array of URIs listing crypto adapters that should be added to the crypto configuration of this partition.
crypto-domain-configurations Array of crypto-domain-configuration objects Optional Array of crypto-domain-configuration objects (see Table 2) that should be added to the crypto configuration of this partition.

Description

This operation adds the specified adapters and/or domain configurations to the crypto configuration of the corresponding partition.

If this operation changes the value of any property for which property-change notifications are due, those notifications are issued asynchronously to this operation.

A 404 (Not Found) status code is returned if the object-id in the URI {partition-id} does not designate an existing Partition object, or the API user does not have object-access permission to it. If the API user doesn't have action/task permission to the Partition Details task, 403 (Forbidden) status code is returned. If the partition is in one of the transitional states ("starting" or "stopping"), or if the CPC is not in a valid state, a 409 (Conflict) status code is returned. A 400 (Bad Request) status code is returned when no lists are provided or both the lists are empty.

Authorization requirements

This operation has the following authorization requirements:
  • Object-access permission to the partition object designated by {partition-id}.
  • Object-access permission to all crypto adapter objects specified in crypto-adapter-uris.
  • Action/task permission to the Partition Details 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.

Table 1. Increase Crypto Configuration: HTTP status and reason codes
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.
101 No lists provided, or both provided lists are empty.
403 (Forbidden) 1 The API user does not have the required permission for this operation.
404 (Not Found) 1 The partition with object-id {partition-id} does not exist, or the API user does not have object-access permission to it.
2 A URI in the request body does not designated an existing resource of the expected type, or designates a resource for which the API user does not have object-access permission.
409 (Conflict) 1 The operation cannot be performed because the object designated by the request URI is not in the correct state
2 The operation cannot be performed because the object designated by the request URI is currently busy performing some other operation.
6 The state of the CPC hosting the partition is not valid to perform the operation (must be in one of the following states: "active", "service-required", "degraded", or "exceptions".)
10 The operation cannot be performed because the affected SE is in the process of being shut down.
111 The resulting crypto configuration is invalid because it does not contain at least one domain configuration with "control-usage".
112 The resulting crypto configuration contains at least one domain index with "control-usage" which is already configured for "control-usage" by another partition.
113 The list crypto-adapter-uris contains an adapter that is already part of the existing crypto configuration.
114 The list crypto-domain-configurations contains a domain index which is already part of the existing crypto configuration.
119 The resulting crypto configuration is invalid because it does not contain at least one adapter URI.
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. Increase Crypto Configuration: Request
POST /api/partitions/7eedd6e4-e0fb-11e5-9731-42f2e9cfe851/operations/increase-crypto-
   configuration HTTP/1.1
x-api-session: 4zzbvb5b1f5i2huscdbya9c3jp5iwoqv1jp5p5qal2vvmpwmil
content-type: application/json
content-length: 166
{
   "crypto-adapter-uris":[
      "/api/adapters/cd8d52b2-d614-11e5-93bf-42f2e9cfe851"
   ],
   "crypto-domain-configurations":[
      {
         "access-mode":"control-usage",
         "domain-index":1
      }
   ]
}
Figure 2. Increase Crypto Configurations: Response
204 No Content
server: zSeries management console API web server / 2.0
cache-control: no-cache
date: Thu, 03 Mar 2016 05:28:51 GMT

<No response body>