service-instance list

List all Cloud Pak for Data service instances.

Extended description

The list command returns a list of service instances. It connects to a Cloud Pak for Data instance by using profile information. Instances that are owned by the user or associated with the user are displayed.

Syntax

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

Arguments

The list command has no arguments.

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.

--exclude-user-count

 If set to true, computation of the total number of users added to a service instance will be skipped for all instances and omitted from the output.
Status
Optional.
Syntax
--exclude-user-count=true|false
Default value
The default is false for service-instance list and service-instance get commands.
The --exclude-user-count option defaults to true for all other service-instance commands since the option does not apply to these commands.
Valid values
true|false

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

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

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.

List all service instances in your Cloud Pak for Data instance.
cpd-cli service-instance list \
--output=json \
--profile=${CPD_PROFILE_NAME}