service-instance status

Show Cloud Pak for Data service instance status.

Syntax

cpd-cli service-instance status <cpd-service-instance-name> \
[--cpdconfig=<cpd-configuration-location>] \
[--output=json|yaml|text] \
--profile=<cpd-profile-name> \
[--service-type=<cpd-service-type>] \
[--verbose]

Arguments

Table 1: Command arguments
Argument Description
<cpd-service-instance-name> The Cloud Pak for Data service instance name to show the status for.

Options

Table 1: Command options
Option Description
--cpdconfig The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.

--output

-o

 Specify an output format. Valid formats include yaml or json (the default format). The option applies only when a single instance is specified.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
json
Valid values
json|yaml|text
--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.

--service-type

-t

 The Cloud Pak for Data service instance type.
Status
Optional.
Syntax
--service-type=<cpd-service-type>
Default value
No default.
Valid values
Any valid Cloud Pak for Data service type. For example, 'dv'. Use the 'cpd-cli service-instance list' command to find the service type.
--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.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.

Show Cloud Pak for Data service instance status.
cpd-cli service-instance status <cpd-service-instance-name> \
--output=json \
--profile=${CPD_PROFILE_NAME}