service-instance list

List all Cloud Pak for Data service instances.

Syntax

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

Arguments

The list command has no arguments.

Options

Option Description
--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.

--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 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.

--service-type

-t

 The Cloud Pak for Data service name.
Status
Optional.
Syntax
--service-type=<cpd-service-name>
Default value
No default.
Valid values
Any valid OpenShift® Container Platform service type.

--service-version

-v

 The Cloud Pak for Data service version (for example 1.0.0.0).
Status
Optional.
Syntax
--service-version=<cpd-service-version>
Default value
No default.
Valid values
Any valid OpenShift Container Platform service version number.
--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.

List all service instances in your Cloud Pak for Data instance.
cpd-cli service-instance list \
--output=json \
--profile=<cpd-configuration-profile-name>