Skip to content

Migrating from IEM to IEM V2

This guide helps you migrate from iectl iem commands to the new iectl iem-v2 command structure.

Command Group Overview

Command Group IEM V1 IEM V2 Status
app-config iectl iem app-config iectl iem-v2 device-app-config Renamed
app-project iectl iem app-project Not available Removed
catalog iectl iem catalog Not available Removed
device iectl iem device iectl iem-v2 device Available
device-apps iectl iem device-apps iectl iem-v2 device-apps Available
device-logs iectl iem device-logs iectl iem-v2 device Available (moved to device group)
device-setting iectl iem device-setting iectl iem-v2 device Available (log-streaming commands moved to device group)
device-types iectl iem device-types iectl iem-v2 device device-types Available (moved to device group)
iem-extensions iectl iem iem-extensions iectl iem-v2 iem-extensions Available
job iectl iem job iectl iem-v2 job Available
system iectl iem system Not available Removed
token iectl iem token iectl iem-v2 token Available

Device Applications

The following are the Device application related commands.

Description IEM V1 IEM V2 Status
Get app details iectl iem device-apps app-details iectl iem-v2 device-apps details Available
List device apps iectl iem device-apps list iectl iem-v2 device-apps list Available
Upload app iectl iem device-apps upload iectl iem-v2 device-apps import Renamed

Application Config

The following are the Device application configuration management commands.

Description IEM V1 IEM V2 Status
Create app config iectl iem app-config add Not available Removed
Delete config iectl iem app-config delete Not available Removed
Delete config version iectl iem app-config delete-version Not available Removed
Download config template iectl iem app-config get-template iectl iem-v2 device-app-config get-template Available
List app configs iectl iem app-config list iectl iem-v2 device-app-config list Available

Device

The following are the Device management related commands.

Description IEM V1 IEM V2 Status
List app statistics iectl iem device app-statistics iectl iem-v2 device app-statistics Available
Create device iectl iem device create iectl iem-v2 device create Available
Create template iectl iem device create-template iectl iem-v2 device create-template Available
Delete device iectl iem device delete iectl iem-v2 device delete Available
Get device details iectl iem device get-details iectl iem-v2 device details Available
Get device statistics iectl iem device get-statistics iectl iem-v2 device statistics Renamed
List devices iectl iem device list iectl iem-v2 device list Available
List device apps iectl iem device list-apps Not available Removed (iectl iem-v2 device list will also include list of apps installed)
Onboard device iectl iem device onboard iectl iem-v2 device onboard Available
System commands iectl iem device system iectl iem-v2 device system Available

Device Logs & Device Types

Description IEM V1 IEM V2 Status
Download device logs iectl iem device-logs generate-link iectl iem-v2 device download-logs Renamed (moved to device group)
List device logs iectl iem device-logs list iectl iem-v2 device list-logs Renamed (moved to device group)
Get device types iectl iem device-types iectl iem-v2 device device-types Available

Device Firmware Commands

Description IEM V1 IEM V2 Status
List firmware iectl iem device firmware list iectl iem-v2 device firmware list Available
Update firmware iectl iem device firmware update iectl iem-v2 device firmware update Available
Update status iectl iem device firmware update-status iectl iem-v2 device firmware update-status Available

Device Label Commands

Description IEM V1 IEM V2 Status
Allocate labels iectl iem device label allocate iectl iem-v2 device label allocate Available
Deallocate labels iectl iem device label deallocate iectl iem-v2 device label deallocate Available

Device Log-Streaming Commands

Description IEM V1 IEM V2 Status
Configure log streaming iectl iem device log-streaming configure iectl iem-v2 device log-streaming configure Available
Sync status iectl iem device log-streaming sync-status iectl iem-v2 device log-streaming sync-status Available
View log streaming iectl iem device log-streaming view iectl iem-v2 device log-streaming view Available

IEM Extensions

IEM extensions commands.

Description IEM V1 IEM V2 Status
Delete extension iectl iem iem-extensions delete iectl iem-v2 iem-extensions delete Available
Install extension iectl iem iem-extensions install iectl iem-v2 iem-extensions install Available
List extensions iectl iem iem-extensions list iectl iem-v2 iem-extensions list Available
List extension versions iectl iem iem-extensions list-version iectl iem-v2 iem-extensions list-version Available
Package extension iectl iem iem-extensions package iectl iem-v2 iem-extensions package Available
Uninstall extension iectl iem iem-extensions uninstall iectl iem-v2 iem-extensions uninstall Available
Upload extension iectl iem iem-extensions upload iectl iem-v2 iem-extensions upload Available

Job

The following are the Batch jobs related commands.

Description IEM V1 IEM V2 Status
Perform job action iectl iem job action iectl iem-v2 job retry-rollback Renamed
Batch create app jobs iectl iem job batch-create iectl iem-v2 job batch-create Available
Batch create device jobs iectl iem job batch-create-device iectl iem-v2 job batch-create-device Available
Get batch status iectl iem job batch-status iectl iem-v2 job batch-status Available
Delete jobs iectl iem job delete iectl iem-v2 job delete Available
List device jobs iectl iem job device-job-list iectl iem-v2 job device-job-list Available
Wait for device job iectl iem job device-job-wait iectl iem-v2 job device-job-wait Available
List import jobs iectl iem job import-job-list iectl iem-v2 job import-job-list Available
Wait for import job iectl iem job import-job-wait iectl iem-v2 job import-job-wait Available
Get batch jobs iectl iem job list iectl iem-v2 job get-batch-jobs Renamed
Get job status iectl iem job status iectl iem-v2 job install-job-status Renamed

Token

The following are the IEM token related commands.

Description IEM V1 IEM V2 Status
Fetch token iectl iem token fetch iectl iem-v2 token fetch Available
Invalidate the token iectl iem token invalidate Not available Removed
Verify token iectl iem token verify iectl iem-v2 token verify Available

New Commands

New commands introduced in IEM V2 with no equivalent in IEM V1.

Description IEM V1 IEM V2 Status
Check import status Not available iectl iem-v2 device-apps import-status New
Validate app Not available iectl iem-v2 device-apps validate New

NOTICE

  • Available - Functionality available in IEM-V2
  • Removed - No longer supported in IEM-V2
  • Renamed - Functionality available in IEM-V2 but with a different command name
  • New - New functionality introduced in IEM-V2

NOTICE

  1. There might be changes in command parameters and options, use --help flag to check the details for each command.
  2. Please refer to the specific command documentation for more details and examples.
  3. Before migration to V2 make sure you logout Industrial Edge App Publisher.
  4. In case Publisher is not responding then you have to clear the cache by deleting the following folders :
  5. For Windows %LOCALAPPDATA%\industrial-edge-app-publisher
  6. For Linux ~/.cache/industrial-edge-app-publisher

Additional Resources