Create Batch Job - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

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.