psm dbcs precheck-patch

Perform a precheck on an Oracle Database Cloud Service instance to identify potential issues that might prevent a specified patch from being applied successfully.

Syntax

In the following syntax, line breaks have been added for clarity. Do not include them when entering the command.

psm dbcs precheck-patch
  -s|--service-name instance-name
  -p|--patch-id patch-id
  [-of|--output-format json|html|short]

Description

This command performs a precheck to identify potential issues that might prevent the specified patch from being applied successfully without actually patching the service instance. Specifically, the patching precheck reports on the following conditions:

  • Disk space shortage

  • Database connectivity failure

  • Server access failure

  • Storage access failure

Prechecking does not check whether another administration task (backup, restoration, or scaling) is in progress, which would prevent patching.

Parameters

Parameter Description

-s|--service-name instance-name

Specifies the name of the Database Cloud Service instance on which you want to precheck the patch.

-p|--patch—id patch-id

Specifies the patch ID of the patch to precheck. To retrieve a list of patch IDs available to apply a service instance, see psm dbcs available-patches.

-of|--output-format json|html|short

(Optional) Specifies the output format of the command’s response:

  • json—output is formatted as a JSON array.

  • html—output is formatted as HTML

  • short—output is formatted as a brief summary.

The default output format is the one you specified when using the psm setup command to configure the psm CLI.

Examples

The following example shows a precheck of patch 22291127-EE on the db12c-xp-si Database Cloud Service instance.

$ psm dbcs precheck-patch --service-name db12c-xp-si --patch-id 22291127-EE
{
    "status":"Completed",
    "details":{
        "message":"PATCHING-5227: Pre-Checking service for patch [22291127-EE] is submitted as an asynchronous job.",
        "jobId":"5859919"
    }
}
Job ID : 5859919

Here is the information about job 5859919 upon successful completion of the operation:

$ psm dbcs operation-status --job-id 5859919
{
    "activityLogId":3651100,
    "serviceName":"db12c-xp-si",
    "serviceType":"dbaas",
    "identityDomain":"usexample",
    "serviceId":129996,
    "jobId":5859919,
    "startDate":"2016-07-27T18:28:54.346+0000",
    "endDate":"2016-07-27T18:29:58.990+0000",
    "status":"SUCCEED",
    "operationId":129996,
    "operationType":"PRECHECK",
    "summaryMessage":"PRECHECK",
    "authDomain":"usexample",
    "authUser":"dbaasadmin",
    "initiatedBy":"USER",
    "messages":[
        {
            "activityDate":"2016-07-27T18:28:54.344+0000",
            "message":"Phase initialize completed"
        },
        {
            "activityDate":"2016-07-27T18:28:54.346+0000",
            "message":"Patching job [5859919] initiated by [dbaasadmin] started.."
        },
        {
            "activityDate":"2016-07-27T18:29:58.945+0000",
            "message":"Phase pre-check completed"
        },
        {
            "activityDate":"2016-07-27T18:29:58.988+0000",
            "message":"Completed"
        }
    ]
}