psm MySQLCS precheck-patch

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


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

psm MySQLCS precheck-patch
    -s|--service-name instance-name
    -p|--patch-id patch-id
    [-wc|--wait-until-complete true|false]
    [-of|--output-format json|html|short]


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.


Parameter Description

-s|--service-name instance-name

Specifies the name of the MySQL Cloud Service instance..

-p|--patch—id patch-id

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

–wc|--wait-until-complete true|false

(Optional) If set to true, the command behaves synchronously. That is, it does not return until the submitted job is complete. The following message is displayed until the job is complete:

Waiting for the job to complete... (it cannot be cancelled)

The default value is false.

-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.


The following example shows a precheck of patch–EE on the MySQL57–aas instance.

$ psm MySQLCS precheck-patch --service-name MySQL57–aas --patch-id–EE