psm dhcs backup

Performs an on-demand backup of an Oracle Data Hub Cloud Service cluster.


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

psm dhcs backup -s|--service-name cluster-name
	[-a|--backup-type FULL]
	[-k|--keep-forever Y|N] 
	[-o|--notes "notes"] 
	[-of|--output-format short|json|html]
	[-wc|--wait-until-complete true|false]


Parameter Description

-s|--service-name cluster-name

Specifies the name of the Oracle Data Hub Cloud Service cluster.

–a|--backup-type FULL

Specifies the type of backup. Only FULL is supported at this time.


Specifies if the backup should be kept past the defined backup expiry date.


Enables the addition of explanatory notes. Notes must be enclosed in quotation marks.

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

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

  • short— output is formatted as a brief summary.

  • json— output is formatted as a JSON array.

  • html— output is formatted as HTML

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


The following example performs a backup of the cluster1 cluster.

$ psm dhcs backup --service-name cluster1 --backup-type FULL --notes "full backup before migration"
Job ID : 7125999


You can track the progress of this command by using the psm dhcs operation-status command.