iectl onboard¶
iectl onboard¶
Description
Basic onboard commands.
Usage
iectl onboard [OPTIONS]
Options
-h, --help help for onboard
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl onboard onboard-iem¶
Description
Create IEM twin in the IE Hub and activate the IEM inclusive cluster creation.
Usage
iectl onboard onboard-iem [OPTIONS]
Options
--cert-path string path to the cert used for the IEM (if you omit this, the cluster creation will be done with self-signed certs)
--cn string Common Name for initial certificate/ca creation: CN
--country string country for initial certificate/ca creation, e.g. DE, AU, US (default "DE")
--description string Description of the IEM [optional]
-d, --devicebuilder IEM can be enabled to manage device types if this flag is passed [optional]
-f, --follow To track the cluster creation process [optional]
-h, --help help for onboard-iem
--iem-domain string domain name under which the IEM shall be accessible (if you omit this, the cluster creation will be done with self-signed certs)
--iem-url string url of the IEM-Appliance
--key-path string path to the key used for the IEM (if you omit this, the cluster creation will be done with self-signed certs)
--loc string locality for initial certificate/ca creation, e.g. Munich
--name string unique iem name
--org string org for initial certificate/ca creation: O
--ou string orgUnit for initial certificate/ca creation: OU
--password string initial password, will be set for IEM and IEM-Appliance
--pod-cidr string CIDR to be used for Kubernetes Pod Network, if not passed default pod-cidr will be used as "10.0.0.0/12" (default "10.0.0.0/12")
--province string province for initial certificate/ca creation, e.g. Bavaria
--proxy-host string proxy-host
--proxy-password string proxy-password
--proxy-port int proxy-port
--proxy-user string proxy-user
--reg-domain string domain name under which the IEM Docker registry shall be accessible (if you omit this, the cluster creation will be done with self-signed certs)
--street string street for initial certificate/ca creation, e.g. Broad st.
--svc-cidr string CIDR to be used for Kubernetes Service Network, if not passed default svc-cidr will be used as "10.96.0.0/12" (default "10.96.0.0/12")
--username string initial username, will be set for IEM and IEM-Appliance
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output
iectl onboard device¶
Description
Create IED twin on the IEM and activate the IED.
Usage
iectl onboard device [OPTIONS]
Options
-h, --help help for device
--id string ID of the device.
--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"}}"
--ntp-servers stringArray list of ntp servers that shall be configured to be used by the device.
--password string initial password
--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 initial 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
iectl onboard iem-status¶
Description
check whether all IEM services are up and running after onboarding.
Usage
iectl onboard iem-status [OPTIONS]
Options
-h, --help help for iem-status
-p, --password string password of user
-u, --url string iem app url
-e, --username string iem username
Options inherited from parent commands
-o, --output string output format
-q, --query string query on result of object
-v, --verbose verbose output