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-config-location>] \
[--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-configuration-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
| Option | Description |
|---|---|
--catalog-id |
Specify either a catalog ID,
project ID, or space ID (specify only one).
|
--context |
Specify whether assets are discovered for the purpose of reading (source) or writing (target). 'source' is the default when
no value is specified.
|
--cpd-config |
The Cloud Pak for Data
configuration location (for example, $HOME/.cpd-cli/config).
|
--cpd-scope |
The Cloud Pak for Data space, project, or catalog scope (for example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135).
|
--entity-context |
Specify the connection context.
Available options are "source", "target", or
"source,target".
|
--entity-datasource-type |
Specify the data source connection
type.
|
--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.
|
--entity-name |
Specify a connection
name.
|
--entity-properties |
Specify the connection properties
that must match in order for the connection to be included in the list.
|
|
|
Display command
help.
|
--inject-token |
Indicate if the cluster user name and access token should be injected into the connection properties. The access token is not revealed
unintentionally together with connection properties.
|
--jmes-query |
The Lucene
query.
|
--limit |
Specify the total number of
resources.
|
--metadata-creator |
Specify the connection
creator.
|
--output |
Specify an output format.
Valid formats include json, yaml, or text (the default
format).
|
--output-file |
Specify a file path where all output is redirected.
|
--profile |
The profile-name from the Cloud
Pak for Data configuration.
|
--project-id |
Specify a Cloud Pak for Data project instance.
|
--quiet |
Suppress verbose messages.
|
--raw-output |
When set to true, single values in
JSON output mode are not surrounded by quotes.
|
--sort |
The field upon which to
sort the results, including whether to sort ascending (+) or descending (-) (for example,
--sort=-metadata.create_time).
|
--space-id |
Specify a space identifier.
|
--start |
Specify the token that represents
the first resource.
|
--verbose |
Logs include more detailed
messages.
|
Examples
Note: The following examples use environment variables. Use a script to create
environment variables with the correct values for your environment. You can optionally add the
listed environment variables to the install variables script. For more information, see Best practice: Setting up install variables.
- Define the environment variables.
-
export PROJECT_CPD_INSTANCE=<The Cloud Pak for Data project instance> - List connections for the specified Cloud Pak for Data project.
-
cpd-cli connection list \ --project-id=${PROJECT_CPD_INSTANCE}