Start Script

This script ensures that MQTT, Edge, and Priority Forward are started or restarted.

For more information on how to execute scripts in different environments, view the “Client Scripts” page.

Contents of Package

This scripts is composed of 2 python files:

  • ApiClient.py: ApiClient.py can be used to interface with the Edge Node’s API but will do nothing if run directly.

  • startScript.py: startScript.py must be run in the same folder with ApiClient.

Usage

This script will connect to specified devices and start or restart the core apps MQTT, Edge ACM, and Priority Forward. The script can be run from the command line as follows after navigating to its folder:

python startScript.py

Or, if on a system with both python 2 and 3 installed:

python3 startScript.py

When first run, the script will create a subfolder named “Start”. Place a properly formatted CSV file containing a list of devices and execute the command again to restart the apps.

CSV Formatting

The CSV file’s top row must include the following headers:

Site Name,Edge Device IP,eACM username,eACM password

Each column's meaning is detailed below

Site Name

A name for the site, primarily used for logging

Edge Device IP

The IP address or URL of the Edge device; this is the IP we will attempt to contact. By default, the IP address will be preceded with “http://” and the port used will be 8080, e.g. “192.168.0.10” will be read as “http://192.168.0.10:8080”. If a different port is expected, or the node is configured for https, that must be included, e.g. “https://192.168.0.10:8181”. Each Edge Device IP must be unique within the CSV.

eACM username

The app manager username

eACM password

The app manager password

Output

The script will log the progress of starting/restarting apps on the end device(s).

Logs

This script will generate its logs in startScript.log. It can be checked for further details if an error appears in the Complete report.

For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.