Skip to content

Quick Start Guide

This document highlights steps to create and track batch jobs on the IEM.

Pre-requisites to submitting Batch Jobs

Batch job commands

Add Portal Configuration to access the IEM

To access batch-jobs commands, you should have already added an IEM configuration. Use the following command to add an IEM configuration:

$ iectl config add iem \
        --name "iemtest" \
        --url "https://iem-url" \
        --user "test@siemens.com" \
        --password "password" \
    # https://portaldev7.siemenspx.us is IEM url
    # test@siemens.com is registered IEM user
    # password for IEM user test@siemens.com

Activate Device

Use this command to activate device:

$ iectl ied system activate \
      --files "/home/user/Downloads/device-14b7798c0f5b4c56a69c9b0b7fb1e8fe" \
      # device-4b7798c0f5b4c56a69c9b0b7fb1e8fe is downloaded from "Edge Device" page of IEM

Publish application version on Catalog

Use this command to publish application version on Catalog:

$ iectl iem app-project publish \
      --app-name "appName" \
      --version-name "0.0.2" \

IECTL Portal Batches Commands

In the IECTL, you can use the following commands to create a batch of jobs to perform operations on various Industrial Edge Devices simultaneously:

  • batch-create
  • status
  • batch-status

Create Batch Job

This method executes commands (install, uninstall or update) on an app in the IEM. Valid operations for this commands are:

  • installApplication
  • updateApplication
  • uninstallApplication
  • startApplication
  • restartApplication
  • stopApplication
  • updateAppConfig
  • deleteAppConfig

The batch-create command will provide a batch-id, to get info about that batch, for further use cases.

$ iectl iem job batch-create \
    --appid "46d2ac22e41a4b65af55a434c887578e" \
    --operation "installApplication" \
    --infoMap "{"devices":["14b7798c0f5b4c56a69c9b0b7fb1e8fe","d39b707268a24306845b9a6aae951ec5"]}" \

# 46d2ac22e41a4b65af55a434c887578e is unique id of the application on which batch actions will be performed
# Operation type to be applied to the application (should be a valid operation name)
# The infoMap object contains unique Edge Device IDs 14b7798c0f5b4c56a69c9b0b7fb1e8fe and d39b707268a24306845b9a6aae951ec5, along with other configuration and resource information. Device IDs will determine on which devices the given operation should be performed.

This command will provide the batch-id in response. Use that batch-id to get the batch status and jobs associated with the batch.

Get Jobs associated with the Batch

The list command can be used to get information about the jobs associated with a batch by using the unique ID of that batch.

$ iectl iem job list --batchId  \
        --batchId "0f9a067e8fd447698d9b58527797c167" \
        # Unique id of batch (received after "batch-create" command) for which you want the jobs info

Get Batch Status

The batch-status command provides the batch status by using the batch-id.

Batch status can be:

  • READY: Batch is completed and soon its jobs will get created
  • PROCESSED: All its jobs are created
$ iectl iem job batch-status  \
          --batchId "0f9a067e8fd447698d9b58527797c167" \ 
          # Unique id of batch (received after "batch-create" command) for which you want the jobs info