Skip to content

Onboarding IEM and IED

This document highlights steps to onboard the IEM and an IED.

Quick Start Guide

Onboard IED

Add IED Configuration

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

$ 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

Add IEM Configuration for IED

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

$ 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

Create IED in IEM

To create an IED 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 IED command.

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

Note
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 IED

To activate an IED in the IEM, use the following command:

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

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