Retrieve the status of an import request.
Syntax
cpd-cli datastage migration get \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--format=<isx-import-report-format>] \
--import-id=<import-id> \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--verbose]
Arguments
The datastage migration get
command
has no arguments.
Options
Option |
Description |
--catalog-id |
Specify either a catalog ID,
project ID, or space ID (specify only one).
- Status
- Optional.
- Syntax
--catalog-id=<catalog-id>
- Default value
- No default.
- Valid values
- A valid catalog, project or space ID.
|
--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
- No default.
- 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-config-location>
- Default value
- No default.
- Valid values
- A valid Cloud Pak for Data space,
project, or catalog scope.
|
--format |
Specify the ISX import report format.
- Status
- Optional.
- Syntax
--format=<isx-import-report-format>
- Default value
- No default.
- Valid values
- A valid ISX import report format.
|
--help
-h
|
Display command
help.
- Status
- Optional.
- Syntax
--help
- Default value
- No default.
- Valid values
- Not applicable.
|
--import-id |
Specify the import identification.
- Status
- Required.
- Syntax
--import-id=<comma-separated-list-of-response-fields>
- Default value
- No default.
- Valid values
- A valid import ID.
|
--jmes-query |
The Lucene
query.
- Status
- Required.
- Syntax
--query=<lucene-query>
- Default value
- No default.
- Valid values
- A valid lucene query.
|
--output |
Specify an output format.
Valid formats include json, yaml, or text (the default
format).
- Status
- Optional.
- Syntax
--output=json|yaml|text
- Default value
text
- Valid values
json|yaml|text
|
--output-file |
Specify a file path where all output is redirected.
- Status
- Required.
- Syntax
--output-file=<output-file-location>
- Default value
- No default.
- Valid values
- A valid output file path location.
|
--profile |
The profile-name from the Cloud
Pak for Data configuration.
- Status
- Required.
- Syntax
--profile=<cpd-configuration-profile-name>
- Default value
- default
- Valid values
- Any valid profile name from the Cloud Pak for Data configuration.
|
--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 in
JSON output mode are not surrounded by quotes.
- Status
- Optional.
- Syntax
--raw-output=true|false
- Default value
false
- Valid values
-
false
- Single values in JSON output mode are surrounded by quotes.
true
- Single values in JSON output mode are not surrounded by quotes.
|
--verbose |
Logs include more detailed
messages.
- Status
- Optional.
- Syntax
--verbose
- Default value
- No
default.
- Valid values
- Not applicable.
|