backup-restore snapshot 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 volume snapshot.

Syntax

cpd-cli backup-restore snapshot create <volume-snapshot-name> \
[--dry-run=true|false] \
[--log-level=info|debug|warn|error|panic] \
[--max-retries=<retry-value>] \
[--namespace=<namespace-name>] \
[--post-exec-rule=<rule-name>] \
[--pre-exec-rule=<rule-name>] \
[--verbose]

Arguments

Argument Description
<volume-snapshot-name> The name of the volume to create a snapshot for.

Table 1: Command arguments

Options

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

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--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.
--max-retries The number of times to retry on failure.
Status
Optional.
Syntax
--max-retries=<retry-value>
Default value
No default.
Valid values
Integer greater than or equal to 0

--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.
--post-exec-rule The rule to run after the group volume snapshot (applicable to Stork only).
Status
Optional.
Syntax
--post-exec-rule=<rule-name>
Default value
No default.
Valid values
Any valid rule.
--pre-exec-rule The rule to run before the group volume snapshot (applicable to Stork only).
Status
Optional.
Syntax
--pre-exec-rule=<rule-name>
Default value
No default.
Valid values
Any valid rule.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

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.

Create local volume snapshots for the ${PROJECT_CPD_INST_OPERANDS} namespace.
cpd-cli backup-restore snapshot create <volume-snapshot-name> \
--namespace=${PROJECT_CPD_INST_OPERANDS}