Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This script applies remote binary update files to the specified devices

Table of Contents
Info

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

Contents of Package

This scripts script is composed of 2 python files:

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

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

Usage

This script will apply supplied binary updates to the described specified devices. The script can be run To execute this command from the command line as follows after navigating , navigate to its folder and use:

Code Block
python BinaryUpdateScript.py

Or, if on a system with both python 2 and 3 installedIf the system has multiple versions of Python installed, instead use:

Code Block
python3 BinaryUpdateScript.py

It The first time the BinaryUpdateScript.py script executes, it will create a subfolder named “Binary” when first run. If a csv . To apply binaries, place a CSV list of devices is placed in that folder, along with applicable devices and the MQTT and/or eACM folders containing that contain the binary updates (including a bin and lib folder) , the next time the script is run inside. Execute the command again and it will apply those binaries to the listed devices.

Binary Formatting

The update script is looking for folders requires the folders to be named “MQTT” or “eACM”. It will transfer these folders to the remote device then install the contents of “lib” and “bin”

...

Each column's meaning is detailed below

Column Name

Description

Edge Device IP

The IP address or url URL of the edge Edge device; this is the IP we will attempt to contact. Unless otherwise specified, it will be assumped an IP or url is of the format, Eg 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, eg e.g. https://192.168.0.10:8181”. Each Edge Device IP must be unique within the CSV.

OS username

The operating system username

OS password

The operating system password

Output

The script will log the progresss progress of its update application; due .

Note

Due to the complexity of applying a binary remotely it is advised that each device be confirmed manually.

Logs

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