Log Retrieval Script

This script allows you to collect the complete zipped logs from multiple Edge ACM systems.

1 Contents of Package
2 Usage
3 CSV Formatting
4 Output
5 Logs

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.
LogRetrievalScript.py: LogRetrievalScript.py must be run in the same folder with ApiClient.

Usage

This script will collect zipped log files from every listed device. The script can be run from the command line as follows after navigating to its folder:

python LogRetrivalScript.py

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

python3 LogRetrivalScript.py

When first run, it will create a subfolder named “LogRetrieval”. Place a properly formatted CSV file in this folder and execute the command again to collect the complete zipped logs from every specified device.

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	The unique name for the site, this will be assigned to the to level Node of the edge device. Each Site Name must be unique within the CSV.

Site Name	The unique name for the site, this will be assigned to the to level Node of the edge device. Each Site Name must be unique within the CSV.
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 web interface username used to connect to the Edge Manager website and API. Default: admin
eACM password	The web interface password used to connect to the Edge Manager website and API. Default: admin

Output

While the script is running, files will be collected from the LogRetrieval folder and moved into the Process folder. After running the script, the files will be moved into one of these:

Complete - The script has run successfully on at least one of the devices in the csv. All of the log files will appear in this folder once collected.
Error - The script did not recognize the formatting of the CSV file. Check log for details.
Unrecognized - Files that don’t have the .csv extension in the LogRetrieval folder will be moved here.

Any files that remain in the Process folder when the program is done indicate an unexpected exception. Check the log for further details and contact support if necessary.

Logs

This script will generate its logs in LogRetrieval.log. It can be consulted after the script is run to see why any errors occurred.