psm jcs backup

This command initiates an on-demand backup 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 backup -s|--service-name serviceName 
   [-d|--datbase-included true|false]
   [-f|--full true|false]
   [-o|--notes free form note]
   [-of|--output-format json|html|short]
   [-wc|--wait-until-complete true|false]


All parameters are required unless otherwise noted.

Parameters Description
-s|–-service-name serviceName Name of the Oracle Java Cloud Service instance.
[-d|--database-included true|false] (Optional) Indicates whether or not the database be included in backup.


this feature not available for Exadata databases.

Accepted values: true, false

-k|-–keep-forever (Optional) For full backups, omit this parameter to specify no expiration date. By default, backups are retained for the default retention period defined in the backup configuration.
-a|-–backup-type (Optional) Indicate the type of backup to be made.

Accepted values: full, incremental


This parameter replaces the parameter full used in previous versions of the CLI. full was deprecated.
-o|-–notes free form note (Optional) Free-form text to provide additional information about the backup.
-of|-–output—format json|html|short (Optional) Output format of the command’s response:

Accepted values: json, html, short

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

-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


$ psm jcs backup -s Example1Instance -n On-demand-backup-request -of json  
Job ID : 34270

Note that this command returned a job ID. To see the status of your create-service operation, use this ID with the psm jcs operation-status command:

$ psm jcs operation-status -j 34270

When you see the message:


the service instance was successfully backup.