backup-restore volume-restore create

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Create a restore of IBM® Cloud Pak for Data volumes.

Syntax

cpd-cli backup-restore volume-restore create <${PROJECT_CPD_INST_OPERANDS}-volume-restore-name> \
[--cleanup-completed-resources=true|false] \
[--dry-run=true|false] \
[--from-backup=<backup-file-name>] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--scale-wait-timeout=<h,m,s>] \
[--skip-quiesce=true|false] \
[--wait-timeout=<h,m,s>] \
[--verbose]

Arguments

Argument Description
<${PROJECT_CPD_INST_OPERANDS}-volume-restore-name> The name of the volume to create a restore for.

Table 1: Command arguments

Options

Option Description
--cleanup-completed-resources When set to "true", deletes completed Kubernetes jobs and pods.
Status
Optional.
Syntax
--cleanup-completed-resources=true|false
Default value
false
Valid values
false
Does not delete completed Kubernetes jobs and pods.
true
Deletes completed Kubernetes jobs and pods.
--dry-run Executes a dry-run without running the command.
Status
Optional.
Syntax
--dry-run=true|false
Default value
false
Valid values
false
A dry run is not executed before running the command.
true
A dry run is executed before running the command.
--from-backup The backup name from which to restore.
Status
Optional.
Syntax
--from-backup=<backup-file-name>
Default value
No default.
Valid values
A valid backup file name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--image-prefix Specify the image registry prefix.
Status
Optional.
Syntax
--image-prefix=<image-registry-prefix>
Default value
icr.io/cpopen/cpd
Valid values
  • icr.io/cpopen/cpd
  • registry.redhat.io/ubi8
  • ${PRIVATE_REGISTRY_LOCATION}
--log-level The command log level.
Status
Optional.
Syntax
--log-level=info|debug|warn|error|panic
Default value
info
Valid values
debug
Debug messages are written to the log.
error
Error messages are written to the log.
info
Informative messages are written to the log.
panic
Panic messages are written to the log.
warn
Warning messages are written to the log.

--namespace

-n

 The namespace name in which the utility should operate.
Status
Optional.
Syntax
--namespace=<namespace-name>
Default value
${PROJECT_CPD_INST_OPERANDS}
Valid values
A valid project (namespace) name.
--scale-wait-timeout The scale wait timeout duration ('h' for hours, 'm' for minutes, 's' for seconds).
Status
Optional.
Syntax
--scale-wait-timeout=<h,m,s>
Default value
6m0s
Valid values
Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
--skip-quiesce Skip quiesce and unquiesce steps.
Status
Optional.
Syntax
--skip-quiesce=true|false
Default value
false
Valid values
false
Does not skip quiesce and unquiesce steps.
true
Skips quiesce and unquiesce steps.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--wait-timeout The wait timeout setting ('h' for hours, 'm' for minutes, 's' for seconds).
Status
Optional.
Syntax
--wait-timeout=<h,m,s>
Default value
6m0s
Valid values
Any valid duration string. Examples: 1m, 30m, 1h, 2h45m

Table 2: Command options

Examples

Note: The following examples use the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up install variables.

Restore the <${PROJECT_CPD_INST_OPERANDS}-volume-restore-name> backup for the ${PROJECT_CPD_INST_OPERANDS} namespace.
cpd-cli backup-restore volume-restore create <${PROJECT_CPD_INST_OPERANDS}-volume-restore-name> \
--namespace=${PROJECT_CPD_INST_OPERANDS} \
--from-backup=<${PROJECT_CPD_INST_OPERANDS}-volume-backup-name>