psm jcs restore

With this command, you can also choose to reset the Oracle WebLogic Server and the JDK software to the versions that correspond to the official patch set update (PSU) level of the software that Oracle Java Cloud Service is currently running, or leave the versions unchanged. After the restoration operation completes, you may need to perform a set of manual tasks to return the service instance to full operation. If a service instance contains Managed Servers and Coherence Managed Servers that are not included in the backup being restored, you must scale in the service instance before trying to restore the instance. For regular Managed Servers, you can use force-scale-in to automatically scale in the service instance after and only if restoration is successful. For Coherence Managed Servers, you must remove the Managed Servers configured on the Coherence data tier (which are identified by managedserver_x_DG) before you try to restore the service instance.

Syntax

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

psm jcs restore -s|--service-name serviceName
  [-e|--restore-config true|false]
  [-t|--reset-binaries true|false] 
  [-f|--force-scale-in true|false] 
  [-o|--continue-on-error true|false]
  [-y|--restore-type recoveryType]
  [-a|--archive-uri uriToArchive]
  [-d|--dba-user dbaUsername]
  [-w|--dba-password dbaPassword]
  [-i|--origignal-wls-admin-user originalWlsUsername]
  [-g|--original-wls-admin-password originalWlsPassword]
  [-l|--cloud-storage-password storagePassword]
  [-u|--cloud-storage-user storageUsername]
  [-h|--schema-password password]
  [-k|--original-encryption-password password]
  [-b|--backup-id backupId]
  [-m|--restore-id restorationId
  [-q|--notes freeFormNotes
  [of|--output-format json|html|short]
  [wc|--wait-until-complete true|false]

Parameters

All parameters are required unless otherwise noted.

Parameter	Description
`-s\|--service-name serviceName`	Name of the Oracle Java Cloud Service instance.
`-e\|restore-config true\|false`	(Optional) Determines whether or not to include configuration files in the restoration. Setting this boolean flag to `true` will include them. Accepted values: `true\|false` Default: `true`
`-t\|--reset-binaries true\|false`	(Optional) Determines whether or not to reset the binaries to the current PSU level. Setting this boolean flag to `true` will reset them. Accepted values: `true\|false` Default: `false`
`-f\|--force-scale-in true\|false`	(Optional) Boolean flag that specifies whether to automatically scale in the Oracle Java Cloud Service instance if there are Managed Servers configured that are not included in the backup being restored. This value defaults to false, indicating that the service instance should not be scaled in automatically. Accepted values: `true\|false` Default: `false`
`-o\|--continue-on-error true\|false`	(Optional) Boolean flag that specifies whether to continue on error. Accepted values: `true\|false` Default: `false`
`-y\|--restore-type recoveryType`	(Optional) A string value that identifies the type of restoration to perform.
`-a\|--archive-uri uriToArchive`	(Optional) A string value that identifies the full URI to the archive. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-d\|--dba-user dbaUsername`	(Optional) A string value that identifies the database administrator.
`-w\|--dba-password dbaPassword`	(Optional) The password for the database administrator identified by `-d\|--dba-user`.
`-i\|--original-wls-admin-user originalWlsUsername`	(Optional) String value identifying the Weblogic user name for the service from which the backup being restored was originally created. Note: Only use this option to recover a deleted service instance with the `restore-type` option with the value `recover`
`-g\|--original-wls-admin-password originalWlsPassword`	(Optional) The password for the Weblogic user identified by`-i\|--original-wls-admin-user`. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-l\|--cloud-storage-password storagePassword`	(Optional) The password for the storage container user identified by`-u\|--cloud-storage-user`.
`-u\|--cloud-storage-user storageUsername`	(Optional) String value identifying the user of the storage container from which the backup will be restored.
`-h\|--schema-password password`	(Optional) Schema password. This option is only required when the schema password changes after the specified backup was taken.
`-k\|--original-encryption-password password`	(Optional) If the backup was encrypted, this is the password you need to use decrypt and restore the backup. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-b\|--backup-id backupId`	(Optional) A string value identifier for the backup you are restoring.
`—m\|--restore-id restorationId`	(Optional) A string value that identifies the restored backup. This parameter differs from `-b\|--backup-id` in that it identifies the backup after it is restored whereas `-b\|--backup-id` identifies the backup from which you are restoring.
`-q\|--notes freeFormNotes`	(Optional) A freeform note describing the restoration. This note can contain any details you feel are germane to the restored backup and process.
`—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`

Examples

$ psm jcs restore -s ExampleInstance -f true -t true -d john.smith@example.com -p password -of short

The following shows an example of the command to recover an instance that was terminated:

$ psm jcs restore -y recover -u mystorageuser -l mystorageuserpassword -w mydbapassword -d mydbausername -g myadminpassword -i myadminuser -a "https://acme.storage.oraclecloud.com/v1/MyService-acme/MyContainer/MyFinalBackup.zip"

Response:

{
    "operationName":"restore-backup",
    "job_id":"8226",
    "target_uri":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomainID\/services\/jaas\/instances\/ExampleInstance\/restoredbackups\/8226"
}

Parameter	Description
`-s\|--service-name serviceName`	Name of the Oracle Java Cloud Service instance.
`-e\|restore-config true\|false`	(Optional) Determines whether or not to include configuration files in the restoration. Setting this boolean flag to `true` will include them. Accepted values: `true\|false` Default: `true`
`-t\|--reset-binaries true\|false`	(Optional) Determines whether or not to reset the binaries to the current PSU level. Setting this boolean flag to `true` will reset them. Accepted values: `true\|false` Default: `false`
`-f\|--force-scale-in true\|false`	(Optional) Boolean flag that specifies whether to automatically scale in the Oracle Java Cloud Service instance if there are Managed Servers configured that are not included in the backup being restored. This value defaults to false, indicating that the service instance should not be scaled in automatically. Accepted values: `true\|false` Default: `false`
`-o\|--continue-on-error true\|false`	(Optional) Boolean flag that specifies whether to continue on error. Accepted values: `true\|false` Default: `false`
`-y\|--restore-type recoveryType`	(Optional) A string value that identifies the type of restoration to perform.
`-a\|--archive-uri uriToArchive`	(Optional) A string value that identifies the full URI to the archive. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-d\|--dba-user dbaUsername`	(Optional) A string value that identifies the database administrator.
`-w\|--dba-password dbaPassword`	(Optional) The password for the database administrator identified by `-d\|--dba-user`.
`-i\|--original-wls-admin-user originalWlsUsername`	(Optional) String value identifying the Weblogic user name for the service from which the backup being restored was originally created. Note: Only use this option to recover a deleted service instance with the `restore-type` option with the value `recover`
`-g\|--original-wls-admin-password originalWlsPassword`	(Optional) The password for the Weblogic user identified by`-i\|--original-wls-admin-user`. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-l\|--cloud-storage-password storagePassword`	(Optional) The password for the storage container user identified by`-u\|--cloud-storage-user`.
`-u\|--cloud-storage-user storageUsername`	(Optional) String value identifying the user of the storage container from which the backup will be restored.
`-h\|--schema-password password`	(Optional) Schema password. This option is only required when the schema password changes after the specified backup was taken.
`-k\|--original-encryption-password password`	(Optional) If the backup was encrypted, this is the password you need to use decrypt and restore the backup. Note: Only use this option to recover a deleted service instance with the `restore-type` option with value `recover`
`-b\|--backup-id backupId`	(Optional) A string value identifier for the backup you are restoring.
`—m\|--restore-id restorationId`	(Optional) A string value that identifies the restored backup. This parameter differs from `-b\|--backup-id` in that it identifies the backup after it is restored whereas `-b\|--backup-id` identifies the backup from which you are restoring.
`-q\|--notes freeFormNotes`	(Optional) A freeform note describing the restoration. This note can contain any details you feel are germane to the restored backup and process.
`—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`