Script Writing Guidelines
The following section is designed to provide an overview of the basic requirements for authoring a script for use in our system.
We have incorporated the ability to upload, deploy and run your own scripts as both Daily and 24x7 Monitoring Checks - generating Alerts and appearing in the Dashboard and relevant Client Reports as well as Automated Tasks (Windows and Macs) displaying the results in the Dashboard and Automated Tasks Report.
The Linux Monitoring Agent and Mac Agent supports Shell scripts and interpreted languages such as Perl, PHP, Python, Ruby for which there is a handler installed.
The status of the script - pass or fail - can be reported to the Dashboard through exit codes. Zero indicates success, with any other number recorded as a failure.
Please note, we have reserved the exit codes 1 to 999 for use by the system scripts. As such we would suggest returning an exit code greater than 1000 in your scripts to ensure the text output is displayed correctly in the Dashboard.
Rather than create custom scripts for each eventuality, arguments may be passed to the script and applied when the script runs.
Unfortunately as the Agent service executes the script (through the service process) user or desktop interaction (including dialogs and messages) is not possible.
Please be aware that we support scripts up to a maximum of 65535 characters in size and a script output size of 10000 characters.
Although we have provided the mechanism to run your own scripts on your servers and workstations. We are not responsible for custom scripts made or used in conjunction with this product. We are not liable for loss incurred from system, hardware or data loss. It is the customer/developers responsibility to verify the integrity, actions and impact of any custom scripts.
What do you want to do?
- View the supported script types
- Check the requirements for returning Script results to the Dashboard
- Determine whether the end user can interact with the script
- Parse Command Line Arguments to the script
Upload the Script to the Dashboard
- Deploy the Script on one of more devices
- Learn about the Windows Automation Manager
- View script Troubleshooting suggestions
- Read our scripting FAQs