`backup-restore volume-backup purge`

Purge IBM® Cloud Pak for Data volume backups older than the specified retention time.

Syntax

cpd-cli backup-restore volume-backup purge <${PROJECT_CPD_INSTANCE}-backup-name> \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--no-prompt] \
[--retention-time=<h,m,s>] \
[--verbose]

Arguments

Table 1: Command arguments

Argument	Description
`<${PROJECT_CPD_INSTANCE}-backup-name>`	The name of the volume to purge volume backups older than the specified retention time for.

Options

Option	Description
`--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.
`--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.
`--no-prompt`	Prompt for confirmation before proceeding with the operation. Status Optional. Syntax `--no-prompt` Default value No default. Valid values Not applicable.
`--retention-time`	Specify how long to keep the data ('h' for hours, 'm' for minutes, 's' for seconds). Status Optional. Syntax `--retention-time=<h,m,s>` Default value `720h0m0s` Valid values Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
`--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.

Purge the <${PROJECT_CPD_INSTANCE}-backup-name> volume backup for the ${PROJECT_CPD_INSTANCE} namespace after the specified retention time.

cpd-cli backup-restore volume-backup purge <${PROJECT_CPD_INSTANCE}-backup-name> \
--namespace=${PROJECT_CPD_INSTANCE} \
--retention-time=720h0m0s