Run a combination of commands as
one command. For example, the cluster, nodes, operands, and operators commands can be invoked
together.
Important: You cannot run any
service-functionality commands as part of the
runcommand command.
Syntax
cpd-cli health runcommand \
[--all=true|false] \
[--commands=<cluster,
network-connectivity, network-performance, nodes, operands, operators, storage-performance,
storage-validation>] \
[--control_plane_ns=<project-cpd-inst-operands>] \
[--image-prefix=<image-registry-prefix>] \
[--image-tag=<image-tag> \
[--include_ns=<instance-namespace-list>] \
[--log-level=debug|trace] \
[--minbandwidth=<MBytes/sec>] \
[--operator_ns=<operator-namespace-list>] \
[--remote_physical_location] \
[--param <path of param.yml file>] \
[--save] \
[--verbose]
Arguments
The command has no arguments.
Options
Table 1: Command options
| Option |
Description |
--all |
Run all cpd-cli health
commands.Note: The results from the
storage-performance and storage-validation commands are not included in the results of
the --save option. These commands produce a separate
TAR file when the command is run.
- Status
- Optional. Use
--commands to specify a list
of commands to run.
- Syntax
--all=true|false- Default value
false- Valid values
- true|false
Do not use
--all and --commands at the same time.
|
--commands |
A comma-separated list of commands
to run. For example 'cluster, network-connectivity, network-performance, nodes, operands, operators,
storage-performance, storage-validation.
- Status
- Optional. Use
--all to run all health commands.
- Syntax
--commands=<cluster,
network-connectivity, network-performance, nodes, operands, operators, storage-performance,
storage-validation>- Default value
No default.- Valid values
- A comma-separated list of commands
to run. For example 'cluster, network-connectivity, network-performance, nodes, operands, operators,
storage-performance, storage-validation.
Do not use --all and --commands at the same time.
|
--control_plane_ns |
The project where the IBM Software
Hub control plane is installed.
- Status
- Required if
operands or operators are included in the --commands option or if the --all option is used.
- Syntax
--control_plane_ns=<project-cpd-inst-operands>- Default value
<project-cpd-inst-operands>- Valid values
- The project where the IBM Software
Hub control plane is installed.
|
|
--help
-h
|
Display command
help.
- Status
- Optional.
- Syntax
--help- Default value
- No default.
- Valid values
- Not applicable.
|
|
--image-prefix
|
Specify the registry that the
image should be pulled from.
- 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}
|
|
--image-tag
|
Specify the tag that identifies
the image in the repository.
- Status
- Optional. Used to specify an image tag for the image name in a registry that is specified by the
--image-prefix option. You can specify the --image-tag=<image-tag> option
when you specify the --image-prefix option.
- Syntax
--image-tag=<image-tag>- Default value
No
default.- Valid values
-
The --image-prefix is the image registry. The
<image-tag> is the specific image tag for an
image in a registry. You can provide this option if you are using a local mirrored image where the
full location of an image is: <registry url path>/<image name>:<image
tag>.
|
--include_ns |
A comma-separated list of instance
namespaces to gather cpd-cli health info from.
- Status
- Optional.
- Syntax
A comma-separated list of instance
namespaces to gather cpd-cli health info from.=<instance-namespace-list>- Default value
<instance-namespace-list>- Valid values
- A comma-separated list of instance
namespaces to gather cpd-cli health info from.
-
This option is optional for gathering the resources and health checks for tethered
namespaces.
|
--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.
|
|
--minbandwidth
-b
|
Minimum acceptable bandwidth
between nodes in MBytes/sec.
- Status
- Optional.
- Syntax
--minbandwidth=<MBytes/sec>- Default value
300- Valid values
- A floating point integer that is
greater than or equal to 300 MBytes/sec.
If you provide a value that is less than
350 MBytes/sec, 350 MBytes/sec is used
|
--operator_ns |
A comma-separated list of operator
namespaces.
- Status
- Required if
operators is included in the --commands option or if the --all option is used.
- Syntax
--operator_ns=<operator-namespace-list>- Default value
<operator-namespace-list>- Valid values
- A comma-separated list of operator
namespaces.
|
--param |
The path of the param.yml file
that includes additional parameters for storage validation and storage performance.
- Status
- Required if you are passing either storage-validation or storage-performance in the runcommand.
- Syntax
--param
<path of param.yml file>- Default value
No default.- Valid values
- <path of param.yml file>
|
--remote_physical_location |
A physical location health
check.
- Status
- Optional.
- Syntax
--remote_physical_location- Default value
false- Valid values
true|false
|
--save |
Save output and
resource YAML files to the local file system.
- Status
- Optional.
- Syntax
--save- Default value
false- Valid values
true|false
|
--verbose |
Display detailed information about
resources in table format.
- Status
- Optional.
- Syntax
--verbose- Default value
false- Valid values
true|false
|
Examples
cpd-cli health runcommand \
--commands=cluster,nodes,operators,operands \
--control_plane_ns=${PROJECT_CPD_INST_OPERANDS} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--verbose \
--save