export-import schedule-export purge

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.

Purge IBM® Cloud Pak for Data schedule exports that are older than the specified retention time.

Syntax

cpd-cli export-import schedule-export purge \
[--arch=<system-cpu-architecture>] \
[--cpdconfig=<cpd-configuration-location>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--no-prompt] \
--profile=<cpd-configuration-profile-name> \ 
[--retention-time=<h,m,s>] \
[--verbose]

Arguments

The command has no arguments.

Options

Option Description
--arch Provide the system architecture.
Status
Optional.
Syntax
--arch=<system-cpu-architecture>
Default value
x86_64
Valid values
x86_64
The 64-bit version of the x86 instruction set architecture.
ppc64le
The little-endian variant of the PowerPC 64-bit architecture.
--cpdconfig The Cloud Pak for Data configuration location.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.

--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 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.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--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 IBM Cloud Pak for Data schedule exports that are older than the specified retention time.
cpd-cli export-import schedule-export purge \
--arch=$CPU_ARCH \
--namespace=${PROJECT_CPD_INSTANCE} \
--no-prompt \
--retention-time=720h0m0s