connection get

Retrieve details for a specific connection definition.

Syntax

cpd-cli connection get \
--connection-id=<connection-id> \
--profile=<cpd-profile-name> \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--entity-product=<string1,string2,...>] \
[--inject-token=true|false] \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The connection get command has no arguments.

Options

Table 1: Command options
Option Description
--catalog-id Specify either a catalog ID,
 project ID, or space ID (specify one only).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project, or space ID.
--connection-id Specify the connection ID.
Status
Required.
Syntax
--connection-id=<connection-id>
Default value
No default.
Valid values
A valid connection ID.
--context Specify whether assets are discovered for reading (source) or writing (target). 'source' is the default when
 no value is specified.
Status
Optional.
Syntax
--context=source|target
Default value
source
Valid values
source
Assets are discovered for reading.
target
Assets are discovered for writing.
--cpd-config The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.
--cpd-scope The IBM Software Hub space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid IBM Software Hub space, project, or catalog scope.
--detail When the option is set to 'true', additional asset-specific details are returned. When the option is set to 'false' specified, the details are
 not returned.
Status
Optional.
Syntax
--detail=true|false
Default value
true
Valid values
true
Additional asset-specific details are returned.
false
Additional asset-specific details are not returned.
--entity-product Specify the product that the data
source type must support to be returned. The available products are 'catalog', 'cpd',
'datastage', 'dv', 'igc', 'mdi', 'ml', and 'studio'. Filtering is not applied unless the entity product is specified. Use a comma-separated string to specify multiple environments. For example,
--entity-product=catalog,studio.
Status
Optional.
Syntax
--entity-product=<string1,string2,...>
Default value
No default.
Valid values
A valid product name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--inject-token Indicate whether the cluster username and access token should be injected into the connection properties. The access token is not revealed
 unintentionally together with connection properties.
Status
Optional.
Syntax
--inject-token=true|false
Default value
false
Valid values
false
The cluster username and access token are not injected into the connection properties.
true
The cluster username and access token are not injected into the connection properties.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--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.
--project-id Specify an IBM Software Hub project instance.
Status
Optional.
Syntax
--project-id=<project-id>
Default value
No default.
Valid values
A valid project identifier.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Define the environment variables.
export CONNECTION_ID=<The connection identifier>
Retrieve a connection.
cpd-cli connection get \
--connection-id=${CONNECTION_ID} \
--project-id=zen