oadp backup status

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.

Check the backup status.

Syntax

cpd-cli oadp backup status <cpd-snapshot-name>\
[--cacert=<certificate-bundle-path>] \
[--csi-enabled=true|false] \
[--details <cpd-snapshot-name>] \
[--help] \
[--insecure-skip-tls-verify=true|false] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--verbose]

Arguments

Table 1: Command arguments
Argument Description
<cpd-snapshot-name> The name of the snapshot to check the status 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.
--csi-enabled Enables or disables CSI in the cluster. When set to 'true', VolumeSnapshotContent objects are retrieved.
Status
Optional.
Syntax
--csi-enabled=true|false
Default value
false
Valid values
false
VolumeSnapshotContent objects are not retrieved.
true
VolumeSnapshotContent objects are retrieved.
--details Display additional information in the command output.
Status
Optional.
Syntax
--details
Default value
No default.
Valid values
Not applicable.

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

Check the status of the <cpd-snapshot-name> backup.
cpd-cli oadp backup status <cpd-snapshot-name>\
--cacert=<certificate-bundle-path> \
--csi-enabled=true \
--namespace=${PROJECT_CPD_INSTANCE} \
--details <backup-name>