Retrieve a space with the
specified identifier.
Syntax
cpd-cli space get \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--include=<comma-separated-list-of-space-sections>] \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-profile-name> \
[--quiet] \
[--raw-output=true|false] \
--space-id=<space-identifier> \
[--verbose]
Arguments
The space get command has no
arguments.
Options
Table 1: Command options
| Option |
Description |
--context |
Specify the configuration context
name.
- Status
- Optional.
- Syntax
--context=<catalog-project-or-space-id>- Default value
- Not applicable.
- Valid values
- A valid configuration context name.
|
--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.
|
|
--help
-h
|
Display command
help.
- Status
- Optional.
- Syntax
--help- Default value
- No default.
- Valid values
- Not applicable.
|
--include |
Specify a list of
comma-separated space sections to include in the query
results.
- Status
- Optional.
- Syntax
--include=<comma-separated-list-of-space-sections>- Default value
- No default.
- Valid values
- A comma-separated list of space sections to include in the query results. Possible values include:
members- Returns up to 100 members.
nothing- Does not return space entity and metadata.
|
--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.
|
--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
- Required.
- 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.
|