Create Execution

Use this API to create a CEMLI execution.

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions

Scope and AuthZ

  • You must have mcs:oci:api:PrivilegedUser scope to access this API.
  • You can create CEMLI execution only for your customer instances.
  • You can use CEMLI execution API only if your customer has opted-in for CEMLI functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Dependency

Base Path

/cemli/v1/

Functionality

  • This API allows the user to create a CEMLI patch execution for a customer instance.
  • Request fields that require explanation:
    • selfService is the type of patch execution. The supported value is CEMLI_PATCH.
    • autoSkip value decides whether the execution must continue with the subsequent patches if failures occur while applying any of the selected patches.
    • autoStop value decides whether the execution must stop if failures occur while applying any of the selected patches.
    • nonProdRfc is the corresponding NonProduction ticket for which the patch execution was done with the same patch list.
    • duration is the time needed for applying the patch.
    • bounceOptions specifies the components that need to be bounced. Applicable bounce options can be fetched using Get Bounce Options for an Instance.
    • primaryContact is the contact to be used while creating the ticket. This parameter must be the valid contact for Customer Support Identifier (CSI).
  • Response field that requires an explanation:
    • id is the unique identifier for the execution.

Verb

POST

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, or EBSI) Yes
instanceId Path parameter Instance name or target name Yes

Sample request

{
  "selfService": "CEMLI_PATCH",
  "patchNumbers": [
    10000001992,
    10000001991
  ],
  "summary": "Apply 2 cemli patches",
  "nonProdRfc": "3-B3RSD2H",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "bounceOptions": {
    "options": [
      {
        "name": "bounceAddOnCACHE",
        "value": true
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          }
        ]
      },
      {
        "name": "vserv1283.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          }
        ]
      }
    ]
  },
  "autoSkip": true,
  "autoStop": false,
  "ticketingDetails": {
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan"
  }
}

Sample Response

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ"
}