Skip to content

iectl iem-v2 device onboard

onboard Edge Device

Synopsis

This method onboards an Edge Device.

iectl iem-v2 device onboard [flags]

Options

      --device-architecture string   architecture type of device (x86-64, arm64)
                                     use this flag with respect to --id. It is fetched automatically from the device type details. The value of this flag is considered only if the system is unable to fetch the device type details from the connected edge management (default "x86-64")
  -h, --help                         help for onboard
      --id string                    device type id, will be used to identify the device type
                                     use command "iectl iem device-types" to list available device types (default "core.ieipc")
      --name string                  IED name, will also be used as unique IED ID
      --nics stringArray             list of network interfaces to be configured for the device. Must be a valid JSON string.
                                     example: "{"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"}}"
                                     DHCP can be enabled or disabled. If DHCP is enabled, Static IP configuration will be ignored
      --ntp-servers stringArray      ntp servers info that shall be configured to be used by the device
                                     example: "{"ntpServer":"time.google.com","preferred":true}"
      --password string              password to login to IED
      --proxy stringArray            network proxy information for the device onboarding
                                     example : "{"host": "proxy.org:8081", "protocol": "http", "user": "proxyuser", "password": "proxypassword", "noProxy": "", "customPorts": [666, 8080]}"
      --url string                   url of device to onboard, will be used to activate device.Can be IP address if hostname of device is not resolving
  -u, --username string              username to login to IED (default "admin@edge.siemens.cloud")

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

$ iectl iem-v2 device onboard --name "sampleDevice" --url "device.example.com" --id "core.ieipc" --device-architecture "x86-64" --username "admin@edge.siemens.cloud" --password "samplePassword" --nics '{"MacAddress":"00:00:00:00:00:00","GatewayInterface":true,"DHCP":"enabled"}' --ntp-servers '{"ntpServer":"time.google.com","preferred":true}'

SEE ALSO