datastage migration create-from-zip

Create data flows from a job export file.

Syntax

cpd-cli datastage migration create-from-zip \
--body=<isx-file-name> \
[--catalog-id=<catalog-id>] \
[--conflict-resolution=<conflict-resolution-name>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--enable-notification=true|false] \
[--file-name=<input-file-name>] \
[--import-only] \
[--include-dependencies=true|false] \
[--jmes-query=<jmespath-query>] \
[--on-failure=<import-failure-option>] \
[--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 create-from-zip command has no arguments.

Options

Option Description
--body Specify the ISX file to import. The maximum file size is 1GB.
Status
Required.
Syntax
--body=<isx-file-name>
Default value
No default.
Valid values
Any valid ISX file name.
--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.
--conflict-resolution Specify the resolution to use when the imported data flow name conflicts with an existing data flow name in the project or catalog.
Status
Optional.
Syntax
--conflict-resolution=<conflict-resolution-name>
Default value
skip
Valid values
rename
Appends the _Import_NNNN suffix to the original name and uses the new name for the imported data flow.
replace
Removes the existing data flow with the same name and then imports the new data flow.
rename-replace
This setting is used when the flow name is already in use and a new flow name with the suffix _DATASTAGE_ISX_IMPORT is used. If the data flow name is not currently used, the imported flow is created with this name. When the new name is already in use, the existing flow is removed before the imported flow is created. With the rename_replace option, job creation is determined by the following factors.
  • If the job name is already in use, a new job name with the suffix .DataStage job is used.
  • If the new job name is not currently used, the job is created with this name.
  • When the new job name is already in use, job creation does not happen and an error is generated.
skip
Skips the data flow (it is not imported). This is the default setting.
--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.
--enable-notification Enable or disable notifications.
Status
Optional.
Syntax
--enable-notification=true|false
Default value
true
Valid values
false
Notifications are not enabled.
true
Notifications are enabled.
--file-name Specify the input file name.
Status
Optional.
Syntax
--file-name=<input-file-name>
Default value
No default.
Valid values
A valid input file name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--import-only Skip flow compilation.
Status
Optional.
Syntax
--import-only
Default value
Not applicable.
Valid values
Not applicable.
--include-dependencies When set to false dependencies are skipped and only flows are imported. When the option is not specified or set to true, both flows and dependencies are imported.
Status
Optional.
Syntax
--include-dependencies=true|false
Default value
true
Valid values
true
Dependencies are skipped and only flows are imported
false
Both flows and dependencies are imported
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid lucene query.
--on-failure Specify the action when the first import failure occurs.
Status
Optional.
Syntax
--on-failure=<import-failure-option>
Default value
continue
Valid values
continue
Continue importing the remaining data flows.
stop
Stop the import operation after the first error.
--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.