import

Import a ZIP package into IICS. Supports a full automated pipeline (import run) or individual steps for advanced control. Alias: imp.

Synopsis

iics import <subcommand> [flags]
iics imp <subcommand> [flags]

Subcommands

Subcommand	Description
`run`	Full pipeline: upload, start, poll, download log
`upload`	Upload a ZIP package and get a job ID
`start`	Start an import job from an uploaded package
`status`	Check import job status
`download-log`	Download the import log to a file

import run

The recommended command for most use cases. Uploads the ZIP, starts the import, polls until complete, and optionally prints the log.

Flags

Flag	Short	Type	Required	Default	Description
`--zip-file`	`-z`	string	yes		ZIP package to import
`--name`		string		zip filename	Import job name
`--conflict-resolution`		string		`REUSE`	How to handle conflicts: `REUSE` or `OVERWRITE`
`--from-file`		string			JSON file with full import specification (overrides other flags)
`--polling-interval`		int		10	Seconds between status polls
`--max-wait-time`		int		300	Maximum seconds to wait
`--detailed-polling`		bool		false	Print per-object status on every poll
`--print-import-log`		bool		false	Print the import log after completion
`--expand`		bool		false	Expand object list in final output
`--object-status-fields`		string		see below	Comma-separated list of object fields to display

All global flags apply.

Object status fields

When --expand or --detailed-polling is set, a per-object table is printed. The default columns are sourceId,sourcePath,sourceName,sourceType,targetName,state,message.

Override with --object-status-fields using any combination of:

Field name	Description
`sourceId`	Source object ID
`sourceName`	Source object name
`sourcePath`	Source object path
`sourceType`	Source object type
`sourceDescription`	Source object description
`targetId`	Target object ID (if assigned)
`targetName`	Target object name
`targetPath`	Target object path
`targetType`	Target object type
`targetDescription`	Target object description
`state`	Import state for this object
`message`	Status message for this object

A warning is printed to stderr for each object where sourceName differs from targetName (indicates a potential rename or duplicate).

Conflict resolution modes

Mode	Behaviour
`REUSE`	(default) Keep existing objects; skip conflicting imports
`OVERWRITE`	Replace existing objects with imported versions

Examples

# Basic import
iics import run --zip-file release-v2.zip

# Overwrite existing objects
iics import run --zip-file release-v2.zip --conflict-resolution OVERWRITE

# With verbose polling and log output
iics import run \
  --zip-file release-v2.zip \
  --verbose \
  --detailed-polling \
  --print-import-log \
  --expand

# Custom job name with extended timeout
iics import run \
  --zip-file big-package.zip \
  --name "Release 3.0 - Full Deploy" \
  --polling-interval 30 \
  --max-wait-time 1800

# Using a full import specification JSON
iics import run --from-file import-spec.json --zip-file package.zip

# CI/CD pipeline pattern
iics import run \
  --zip-file "$ARTIFACT_PATH" \
  --conflict-resolution OVERWRITE \
  --print-import-log \
  --expand \
  --profile prod

# Basic import
iics import run --zip-file release-v2.zip

# Overwrite existing objects
iics import run --zip-file release-v2.zip --conflict-resolution OVERWRITE

# With verbose polling and log output
iics import run `
  --zip-file release-v2.zip `
  --verbose `
  --detailed-polling `
  --print-import-log `
  --expand

# Custom job name with extended timeout
iics import run `
  --zip-file big-package.zip `
  --name "Release 3.0 - Full Deploy" `
  --polling-interval 30 `
  --max-wait-time 1800

# Using a full import specification JSON
iics import run --from-file import-spec.json --zip-file package.zip

# CI/CD pipeline pattern
iics import run `
  --zip-file $env:ARTIFACT_PATH `
  --conflict-resolution OVERWRITE `
  --print-import-log `
  --expand `
  --profile prod

import upload

Upload a ZIP package to IICS to get a job ID. Use import start to begin the actual import.

Flags

Flag	Short	Type	Required	Description
`--file`	`-f`	string	yes	ZIP file to upload

All global flags apply.

Examples

iics import upload --file release.zip

# Capture the job ID for subsequent commands
JOB_ID=$(iics import upload --file release.zip --output json | jq -r '.id')

iics import upload --file release.zip

# Capture the job ID for subsequent commands
$job = iics import upload --file release.zip --output json | ConvertFrom-Json
$jobId = $job.id

import start

Start an import job from a previously uploaded package.

Flags

Flag	Type	Required	Default	Description
`--id`	string	yes		Job ID from `import upload`
`--name`	string			Import job name
`--conflict-resolution`	string		`REUSE`	`REUSE` or `OVERWRITE`
`--from-file`	string			JSON file with full import specification
`--wait`	bool		false	Wait for the job to complete before returning

All global flags apply.

Examples

iics import start --id "$JOB_ID" --conflict-resolution OVERWRITE --wait

iics import start --id $jobId --conflict-resolution OVERWRITE --wait

import status

Check the current status of an import job.

Flags

Flag	Type	Required	Description
`--id`	string	yes	Import job ID
`--expand`	bool		Show per-object import status table
`--object-status-fields`	string		Comma-separated object fields to display (see `import run` section)

All global flags apply.

Output columns

Job summary table:

Column	Description
`id`	Job ID
`name`	Job name
`status.state`	`SUCCESSFUL`, `FAILED`, `IN_PROGRESS`, etc.
`status.message`	Status detail

When --expand is set, a second per-object table is printed below the summary using the fields specified by --object-status-fields (default: sourceId,sourcePath,sourceName,sourceType,targetName,state,message).

Examples

iics import status --id <job-id>

# Show per-object results with default columns
iics import status --id <job-id> --expand

# Show only name and state columns
iics import status --id <job-id> --expand --object-status-fields sourceName,targetName,state,message

iics import status --id <job-id>

# Show per-object results with default columns
iics import status --id <job-id> --expand

# Show only name and state columns
iics import status --id <job-id> --expand --object-status-fields sourceName,targetName,state,message

import download-log

Download the import log file for a completed job.

Flags

Flag	Type	Required	Default	Description
`--id`	string	yes		Import job ID
`--log-path`	string	yes		Directory to save the log file
`--log-name`	string		`<name>_<id>_<status>.log`	Log filename

All global flags apply.

Examples

iics import download-log --id <job-id> --log-path ./logs

# Custom filename
iics import download-log --id <job-id> --log-path ./logs --log-name import-prod.log

Job states

State	Meaning
`QUEUED`	Job is waiting to start
`STARTING`	Job is initialising
`IN_PROGRESS`	Import is running
`SUCCESSFUL`	Import completed successfully
`WARNINGS`	Completed with warnings
`FAILED`	Import failed
`ERROR`	System error

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

import

Synopsis

Subcommands

import run

Flags

Object status fields

Conflict resolution modes

Examples

import upload

Flags

Examples

import start

Flags

Examples

import status

Flags

Output columns

Examples

import download-log

Flags

Examples

Job states

See also

FilesExpand file tree

import.md

Latest commit

History

import.md

File metadata and controls

import

Synopsis

Subcommands

import run

Flags

Object status fields

Conflict resolution modes

Examples

import upload

Flags

Examples

import start

Flags

Examples

import status

Flags

Output columns

Examples

import download-log

Flags

Examples

Job states

See also