manage shutdown

Shut down the specified components and any dependencies. The component will be shut down after the dependencies are shut down.

Extended description

You can shut down a service temporarily when you are not using it. For example, over holidays, or when you are performing maintenance, to conserve CPU and memory resources, and then restart the service when you want to use it again.

Important: You cannot shut down a service when autoscaling is enabled for the service. For more information, see Automatically scaling resources for services.

Syntax

cpd-cli manage shutdown \
--components=<comma-separated-list-of-component-names> \
--cpd_instance_ns=<project-name> \
[--force=true|false] \
[--include_dependency=true|false] \
[--preview=true|false] \
[--tethered_instance_ns=<project-name>]

Arguments

The shutdown command has no arguments.

Options

Table 1: Command options
Option Description
--components The components to shutdown. If the components have any dependencies, they will also be shutdown.
Status
Required.
Syntax
--components=<comma-separated-list-of-component-names>
Default value
No default.
Valid values
For the list of components, see Component IDs.
--cpd_instance_ns The project (namespace) where the component is installed.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The project (namespace) where the component is installed.
--force Apply the node settings, even if they have already been applied.
Status
Optional.
Syntax
--force=true|false
Default value
false

If you omit this option, the default value is used.

Valid values
false
Wait for the status to progress from shutdownInProgress to shutdown.
true
Immediately shut down the service.
--include_dependency Specify whether you want to shut down the dependencies for the specified components. If a dependency is being used by a running component, it will not be shut down.
Status
Optional.
Syntax
--include_dependency=true|false
Default value
false
Valid values
false
Dependencies are not shut down for the specified components.
true
Dependencies are shut down for the specified components.
--preview Preview the commands that run when you issue this CLI command.
Status
Optional.
Syntax
--preview=true|false
Default value
false
Valid values
false
Do not preview the commands that are run when you issue this CLI command.
true
Preview the commands that run when you issue this CLI command.
--tethered_instance_ns A tethered project (namespace) where the shutdown command will shut down installed service instances.
Status
Optional.
Syntax
--tethered_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
When the service allows tethered namespaces, a tethered Cloud Pak for Data namespace.
-v
-vv
-vvv
Display verbose output.

Options are listed from least verbose to the most verbose.

Status
Optional.
Syntax
Verbose output
-v
Very verbose output
-vv
Most verbose output
-vvv
Default value
Not applicable.
Valid values
Not applicable.

Examples

The following example shuts down the Db2 service.

cpd-cli manage shutdown \
--components=db2oltp \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}