psm jcs create-snapshot

Create a snapshot for an Oracle Java Cloud Service instance.


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

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


All parameters are required unless otherwise specified.

Parameter Description

-s|--service-name instance-name

Name of the Oracle Java Cloud Service instance

-a|--name snapshot-name

Name of the snapshot

-d|--description “string”

Short description of the snapshot

-o|--colocated true|false

Snapshots can be stored as block storage volumes (colocated snapshots) or as objects in the Object Storage service. A colocated snapshot can only be used to create clones within the same region as the source service instance. If set to false, the snapshot can be used to create clones in other regions. The default value is true.

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

(Optional) A boolean value that, when set to true, makes the command behave 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)
Default: 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.


$ psm jcs create-snapshot --service-name myjcs --name myjcs-snap1 -of json