Skip to content

IECTL Configuration

IECTL uses persistent configurations to store connection details for various Industrial Edge services. This guide explains how to add, manage, and use configurations for IEM, IED, IEHUB, and publisher. Once configured, IECTL commands will use the active configuration by default.

Overview

IECTL configurations store authentication and connection information for:

  • IEM (Industrial Edge Management): For managing Edge devices and applications
  • IED (Industrial Edge Device): For direct device operations
  • IEHUB: For accessing the Industrial Edge Hub and marketplace
  • Publisher: For application development and publishing

Adding Configurations

General Syntax

iectl config add <service-type> --name <config-name> --url <service-url> --user <username> --password-stdin

NOTICE

Security Best Practice
Always use --password-stdin flag to provide a password through STDIN. Using STDIN prevents the password from ending up in the shell's history, or log-files.

IEM Configuration

iectl config add iem --name my-iem-prod --url https://iem.example.com --user myuser@company.com --password-stdin

IED Configuration

iectl config add ied --name my-device-01 --url https://192.168.1.100 --user admin --password-stdin

IEHUB Configuration

iectl config add iehub --name my-iehub --url https://iehub.eu1.edge.siemens.cloud --user myuser@company.com --password-stdin

NOTICE

Provide url without tenant name.

Publisher Configuration

iectl config add publisher --name my-workspace --workspace-path /path/to/workspace --docker-url unix:///var/run/docker.sock

Configuration Names

  • Configuration names are case-insensitive and must be unique
  • Choose descriptive names like prod-iem, dev-device-01, staging-iehub
  • Names can include letters, numbers, hyphens, and underscores

Managing Configurations

List All Configurations

iectl config list

View Active Configuration

iectl config active

Switch Active Configuration

iectl config switch --name my-iem-prod --type iem-prod

Delete Configuration

iectl config delete --name my-old-config --type iem-prod

Environment-Specific Configurations

Development Environment

iectl config add iem --name dev-iem --url https://iem-dev.company.com --user dev@company.com --password-stdin
iectl config add ied --name dev-device --url https://192.168.1.10 --user admin --password-stdin
iectl config add publisher --name dev-workspace --workspace-path ./workspace --docker-url unix:///var/run/docker.sock

Production Environment

iectl config add iem --name prod-iem --url https://iem-prod.company.com --user prod@company.com --password-stdin
iectl config add iehub --name prod-iehub --url https://iehub.siemens.io --user prod@company.com --password-stdin

Secure Password Input

When prompted for a password with --password-stdin, type your password and press Enter:

$ iectl config add iem --name my-iem --url https://iem.example.com --user myuser@company.com --password-stdin
Password: [type password here - it won't be visible]
Configuration 'my-iem' added successfully

The following example reads a password from a file:

    cat ~/my_password.txt | iectl config add iem --name my-iem-prod --url https://iem.example.com --user myuser@company.com --password-stdin

Configuration Storage

IECTL stores configurations on your local system:

  • Linux/macOS: ~/.iectl/config
  • Windows: %USERPROFILE%\.iectl\config

Common Issues and Troubleshooting

Invalid URL Format

Ensure URLs include the protocol (https:// or http://):

# Correct
--url https://iem.example.com

# Incorrect
--url iem.example.com

Duplicate Configuration Names

Configuration names must be unique (case-insensitive):

# This will overwrite 'my-iem' if already exists
iectl config add iem --name MY-IEM --url https://other-iem.com --user user@company.com --password-stdin