psm MySQLCS create-snapshot

Create a snapshot for an MySQL Cloud Service instance.

Syntax

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

psm MySQLCS create-snapshot -s|--service-name instance-name 
    -a|--name snapshot-name
    [-d|--description "string"]
    [-wc|--wait-until-complete true|false]
    [-of|--output-format json|html|short]

Parameters

Parameter Description

-s|--service-name instance-name

Specifies the name of the MySQL Cloud Service instance.

-a|--name snapshot-name

Specifies the name of the snapshot.

-d|--description “string”

Short description of the snapshot.

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

Examples

The following example creates a snapshot, named mysql57–snap1, of the mysql57-aas instance.

$ psm MySQLCS create-snapshot --service-name mysql57-aas --name mysql57-snap1