Run scaled-down versions of
end-user workflows to assess the operational capabilities of services. To list supported services,
run the service-functionality list command.
Important: You cannot run any
service-functionality commands as part of the
runcommand command.
Syntax
cpd-cli health service-functionality \
[--control_plane_ns=${PROJECT_CPD_INST_OPERANDS}] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=debug|trace] \
[--profile=<cpd-profile-name>] \
[--save] \
[--services=<Comma-separated list of service keys>] \
[--verbose]
Arguments
The command has no arguments.
Options
Table 1: Command options
| Option |
Description |
--control_plane_ns--c
|
The Cloud Pak for Data control plane namespace.
- Status
- Required.
- Syntax
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS}- Default value
${PROJECT_CPD_INST_OPERANDS}- Valid values
- The Cloud Pak for Data control plane namespace.
|
|
--help
-h
|
Display command
help.
- Status
- Optional.
- Syntax
--help- Default value
- No default.
- Valid values
- Not applicable.
|
|
--image-prefix
|
Specify the image registry prefix.
- Status
- Optional. Required only when the image is pulled from a private container
registry.
- Syntax
--image-prefix=<image-registry-prefix>- Default value
icr.io/cpopen/cpd- Valid values
-
- icr.io/cpopen/cpd
- ${PRIVATE_REGISTRY_LOCATION}
|
--log-level |
The command log level.
- Status
- Optional.
- Syntax
--log-level=debug|trace- Default value
No default.- Valid values
-
debug- Debug messages are written to the log.
trace- Trace messages are written to the log.
|
--profile |
The name of the profile that you
created to store information about an instance of Cloud Pak for Data and your credentials for the
instance.
- Status
- Required.
- Syntax
--profile=<cpd-profile-name>- Default value
- No default.
- Valid values
-
The name of the profile that you created.
|
--save |
Save output, resource YAML files, and pod container logs to the local file system.
- Status
- Optional.
- Syntax
--save- Default value
false- Valid values
true|false
|
--services |
Run service functionality
checks on the comma-separated list of service keys. If service keys are not provided, all checks
will run on all supported services.
- Status
- Optional.
- Syntax
--services
<Comma-separated list of service keys>- Default value
All supported services.- Valid values
<Comma-separated list of service keys>-
| For this service |
Use this service key |
| DataStage |
datastage |
| Db2 |
db2oltp |
| IBM Knowledge Catalog |
wkc |
| Watson Discovery |
discovery |
| Watson Studio |
ws |
| watsonx.data |
watsonx-data |
| watsonx Assistant |
assistant |
- If service keys are not provided, the command runs all available checks on all available
services.
|
--verbose |
Display detailed information about resources in table format.
- Status
- Optional.
- Syntax
--verbose- Default value
false- Valid values
true|false
|