service-instance get

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Retrieve a Cloud Pak for Data service instance.

Syntax

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

Arguments

Argument Description
<cpd-service-instance-name> The Cloud Pak for Data service instance name to retrieve.

Table 1: Command arguments

Options

Option Description

--all

-a

 Retrieve all Cloud Pak for Data service instances and save to the specified --output-dir location (when an --output-dir location is specified).
Status
Optional.
Syntax
--all
Default value
No default.
Valid values
Not applicable.
--cpdconfig The Cloud Pak for Data
 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 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

--output-dir

-f

 Specify a directory in which to write output. The option applies only when the --all option is specified.
Status
Optional.
Syntax
--output-dir=<output-directory>
Default value
<$HOME/cpd-service-instance-name>
Valid values
A valid Cloud Pak for Data service instance directory.
--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-configuration-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.

Table 2: Command options

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.

Retrieve details on all service instances of the same service type (<cpd-service-type>.
cpd-cli service-instance get <cpd-service-type> \
--all \
--service-type=<cpd-service-type> \
--output-dir=<output-directory> \
--profile=<cpd-configuration-profile-name>