connection list

List defined connections.

Syntax

cpd-cli connection list \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--entity-context=source|target|source,target] \
[--entity-datasource-type=<catalog-project-or-space-id>] \
[--entity-flags=<flag1,flag2,...>] \
[--entity-name=<asset-type-name>] \
[--entity-properties=<connection-properties>] \
[--inject-token=true|false] \
[--jmes-query=<jmespath-query>] \
[--limit=<resource-limit>] \
[--metadata-creator=<connection-creator>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--sort=<field-sort-order>] \
[--space-id=<space-identifier>] \
[--start=<start-token>] \
[--verbose]

Arguments

The connection list 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.
--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 Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data 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 Cloud Pak for Data space, project, or catalog scope.
--entity-context Specify the connection context.
 Available options are "source", "target", or
"source,target".
Status
Optional.
Syntax
--entity-context=source|target|source,target
Valid values
source|target|source,target
--entity-datasource-type Specify the data source connection
 type.
Status
Optional.
Syntax
--entity-datasource-type=<catalog-project-or-space-id>
Default value
No default.
Valid values
A valid catalog, project, or space ID.
--entity-flags Specify a comma-separated list of
 flags that must be present for the connection to be included in the list. Only connections with no
 flags are returned when the option is not specified.
Status
Optional.
Syntax
--entity-flags=<flag1,flag2,...>
Default value
No default.
Valid values
A comma-separated list of flags.
--entity-name Specify a connection
 name.
Status
Optional.
Syntax
--entity-name=<asset-type-name>
Default value
No default.
Valid values
A valid connection name.
--entity-properties Specify the connection properties
 that must match so that the connection is included in the list.
Status
Optional.
Syntax
--entity-properties=<connection-properties>
Default value
No default.
Valid values
Valid connection properties.

--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 The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid Lucene query.
--limit Specify the total number of resources.
Status
Optional.
Syntax
--limit=<resource-limit>
Default value
100
Valid values
An integer value in the range 0 - 200.
--metadata-creator Specify the connection
 creator.
Status
Optional.
Syntax
--metadata-creator=<connection-creator>
Default value
No default.
Valid values
A valid connection creator name.
--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 a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-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.
--sort The field to
 sort the results on, including whether to sort ascending (+) or descending (-). For example,
 '--sort=-metadata.create_time'.
Status
Optional.
Syntax
--sort=<field-sort-order>
Default value
No default.
Valid values
A valid field sort order.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--start Specify the token that represents
 the first resource.
Status
Optional.
Syntax
--start=<start-token>
Default value
No default.
Valid values
A valid token that represents the first resource.
--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.
List connections for the specified Cloud Pak for Data project.
cpd-cli connection list \
--project-id=${PROJECT_CPD_INST_OPERANDS}