Onboarding IEM and IE Device

This document highlights steps to onboard the IEM and an IE Device.

Quick Start Guide

• Onboard IE Device
  • Add IE Device Configuration
  • Add IEM Configuration for IE Device
  • Create IE Device in IEM
  • Activate IE Device

Onboard IE Device

Add IE Device Configuration

To onboard an IE Device, you must first add the IE Device configuration. To add the IE Device configuration, use the following command:

$ cat ~/my_password.txt | iectl config add device \
        --name "device-config-dev" \      # name of the config
            --url "https://device-url.com" \  # your Device url 
            --user email@siemens.com \        # email address registered on IED
            --password "password"             # password of the IED user

NOTICE

We recommend using the --password-stdin option instead of --password, as it allows you to securely pass a password to a command through standard input (stdin) rather than typing it directly in the command. This prevents the password from being exposed in shell history or process lists, enhancing security. For more information, refer to the guide: "How to use --password-stdin".

Add IEM Configuration for IE Device

To onboard an IE Device, you must also add the IEM configuration of the IEM in which the IE Device should be onboarded. To add the IEM configuration, use the following command:

$ cat ~/my_password.txt | iectl config add iem \
        --name "iem-config-dev" \                 # name of the config
            --url "https://portaldev7.siemenspx.us" \ # your IEM url 
            --user email@siemens.com \                # email address registered on IEM
            --password "password"                     # password of the IEM user

NOTICE

We recommend using the --password-stdin option instead of --password, as it allows you to securely pass a password to a command through standard input (stdin) rather than typing it directly in the command. This prevents the password from being exposed in shell history or process lists, enhancing security. For more information, refer to the guide: "How to use --password-stdin".

Create IE Device in IEM

To create an IE Device in the IEM, use the following command:

iectl iem device create --body '{"device":{"onboarding":{"localUserName":"email@siemens.com","localPassword":"P@ssword1234","deviceName":"mydevice","deviceTypeId":"core.ieipc","platformActualName":"x86-64"},"Device":{"Network":{"Interfaces":[{"MacAddress":"00:00:00:00:00:00","GatewayInterface":true,"DHCP":"enabled","Static":{"IPv4":"","NetMask":"","Gateway":""},"DNSConfig":{"PrimaryDNS":"8.8.8.8","SecondaryDNS":"8.8.8.9"}}]}},"ntpServers":[{"ntpServer":"time.google.com","preferred":true}],"proxies":[]}}'

Save the output of the command in a file and provide that file path as input for the activate IE Device command.

deviceTypeId and platformActualName can be listed using command iectl iem device-types

NOTICE

To generate --body template you can use iectl iem device create-template command. This command prints the device body as a helping guide for the iem device create command. You can change the body according to your needs.

Activate IE Device

To activate an IE Device in the IEM, use the following command:

$ iectl ied system activate \
             --files "/mnt/hgfs/share/device-configuration" #Configuration file previously retrieved from IEM, from `iectl iem device create` command output

Provide the configuration file that was previously obtained from the response to the iectl iem device create command.