asset import start

Start the asset import process for the specified space, project, or catalog.

Syntax

cpd-cli asset import start \
[--async] \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--encryption-key=<encryption-key>] \
[--file-content-type=<file-content-type>] \
[--import-dir=<import-directory>] \
--import-file=<import-file> \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The asset import start command has no arguments.

Options

Table 1: Command options
Option Description
--async Run the command asynchronously. By default, processing finishes before the command runs.
Status
Optional.
Syntax
--async
Default value
Not applicable.
Valid values
Not
 applicable.
--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 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.
--encryption-key Specify the encryption key that is
 used to encrypt sensitive data during export.
Status
Optional.
Syntax
--encryption-key=<encryption-key>
Default value
No default.
Valid values
A valid encryption key.
--file-content-type Specify the file content type.
Status
Optional.
Syntax
--file-content-type=<file-content-type>
Default value
No default.
Valid values
A valid file content type.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--import-dir Specify the directory path to import. The option is mutually exclusive with
 '--import-file'.
Status
Optional.
Syntax
--import-dir=<import-directory>
Default value
No default.
Valid values
A valid directory path.
--import-file Specify the file to import. The
 option is mutually exclusive with '--import-dir'.
Status
Required.
Syntax
--import-file=<import-file>
Default value
No default.
Valid values
A valid file to import.
--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.
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.
--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.

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.
Define the environment variables.
Replace the following properties with your data.
export SPACE_ID=<The deployment space identifier>
export SPACE_NAME='space-for-scripts'
Import assets from an exported archive to a specific space.
cpd-cli asset import start \
--import-file=<space-archive-path> \
--jmes-query="metadata.id" \
--name=${SPACE_NAME} \
--output=json \
--space-id=${SPACE_ID}