oadp backup download

Important: IBM Cloud Pak® for Data Version 4.6 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.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Download Kubernetes manifests for a backup. Persistent volume content is not included in the download.

Syntax

cpd-cli oadp backup download <cpd-snapshot-name> \
[--cacert=<certificate-bundle-path>] \
[--force=true|false] \
[--insecure-skip-tls-verify=true|false] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--outfile=<output-file-name>-data.tar.gz] \
[--timeout=<h,m,s>] \
[--verbose]

Arguments

Table 1: Command arguments
Argument Description
<cpd-snapshot-name> The name of the snapshot to download the Kubernetes manifests for.

Options

Option Description
--cacert The certificate bundle path to use when verifying TLS connections.
Status
Optional.
Syntax
--cacert=<certificate-bundle-path>
Default value
No default.
Valid values
A valid certificate bundle path.
--force The existing output file is overwritten.
Status
Optional.
Syntax
--force=true|false
Default value
true
Valid values
true
The existing output file is overwritten.
false
The existing output file is not overwritten.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--insecure-skip-tls-verify When set to 'true', the object store's TLS certificate are not checked for validity (not recommended for production).
Status
Optional.
Syntax
--insecure-skip-tls-verify=true|false
Default value
false
Valid values
false
The object store's TLS certificate are not checked for validity.
true
When set to 'true', the object store's TLS certificate are not checked for validity (not recommended for production).
--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_INSTANCE}
Valid values
A valid project (namespace) name.

--outfile

-o

 The output file name. The name defaults to <output-file-name>-data.tar.gz in the current directory.
Status
Optional.
Syntax
--outfile=<output-file-name>-data.tar.gz
Default value
<output-file-name>-data.tar.gz
Valid values
A valid output file name.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

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.

Download Kubernetes manifests for a backup. Persistent volume content is not included in the download.
cpd-cli oadp backup download <cpd-snapshot-name> \
--outfile=<output-file-name>-data.tar.gz \
--force=true