Documentation Center
Scripts Training Guide
Table of Contents
Scripting is one of the core RMM features in Syncro. We designed our Scripting module to have maximum flexibility and interoperability with tools you already use, including PowerShell, Batch, VB Script, and Mac Bash.
If you're a Technical Leader interested in using scripting to gain maximum flexibility and interoperability with tools you already use, here are some basics you should know.
Notes:
- Throughout the documentation, you'll sometimes see text in italic font. This means the term is defined in our Syncro Glossary.
- You can also download this guide as a PDF.
All of your scripts appear in a table when you click the Scripts tab:
From this table you can mark your Favorites, access Script Categories so you can further organize the list, access the Community Script library, add Script Files, and view scripts scheduled to run.
Before we move onto that, check the Prerequisites for scripting, then take a look at the security permissions available for Scripts and Script categories to make sure they're configured the way you want.
Step 1: Manage Your Scripts
The Scripts tab shows the list of your available scripts:
Use the search bar at the top (or scroll the page) to locate a script you're interested in, then use the ellipsis menu to Favorite it. Next, select “Script Categories” from the View menu, and create a new Script Category.
Step 2: Find & Import a Script
If you're looking for a script that's not currently available in your list, it's a good idea to check the Community Script library before going off to create your own. That's because Syncro Users like yourself have contributed many ready-made scripts that you can import and use for yourself. This can save you lots of time!
Watch this short video to learn more:
Use the View menu on the Scripts tab to access the Community Script Library, then find and import a script. As part of this process, add it to the Script Category you previously created.
Step 3: Create Your Own Scripts
If you find a script that's ALMOST what you want but not quite, you can use the Clone feature (available under that script's the ellipsis menu) to make a copy that you can then edit to better your needs.
If you'd rather create your own script from scratch you can do that too.
For all types of scripts, you can upload required files (up to 200 MB). The attached file will download in the location you specify before the script runs on an asset. This enables downloading of functions, libraries, or executables that are needed to execute your scripts.
For Windows, you can also use environment variables to include options that allow you to specify any file location on the asset.
At the bottom of every New Script or Edit Script page, you'll find that Quick Help is always available:
Find an existing script and use the ellipsis menu to Edit or Clone it. Check out the Scripts Reference documentation to learn more about the custom functions available for PowerShell and Mac Bash scripts.
Step 4: Understand How to Run Scripts
Once you have the set of scripts that will help you the most, you can run those scripts on individual assets, or in bulk on multiple assets. These are the simplest and most common ways to do it:
A. From the Assets & RMM Tab
- From the Assets & RMM tab's Actions menu, select Run Script:
- From the Assets & RMM tab's Bulk Actions menu, after you check the boxes next to multiple Assets:
Either way, this will open the Run Scripts pop-up window where you can choose which script to run. What's even more powerful is that you can also set your scripts to run on a recurring schedule.
B. From an Asset's Details Page
Another way you can run scripts is from an individual asset's Details Page. In the Scripts subtab you'll see any recurring (Scheduled) Scripts, scripts in the Script Queue, and the Script History:
Click Add to Queue to open the pop-up window. Note that you always have the option to exclude or include assets that are offline.
C. As Part of a Policy
You can also add a script to a Policy to have it run whenever that Policy gets applied to an asset, or on a schedule:
D. As Part of an Automated Remediation
Lastly, you can use Automated Remediations to run scripts as a way to mitigate issues Syncro sends you alerts about. For example, when a disk full alert triggers, this automated remediation sends an email and runs a File Clean script automatically:
Review the best practices for running scripts. Then, set a script so that it runs on a recurring schedule. (Bonus: Run this script on multiple assets!)
Next Steps
If you've completed these steps, you are ready to use Syncro's scripting engine to do all sorts of things.
- Check out one or more of the following script examples:
- Or, start learning about Syncro REST API so you can also build custom extensions, apps, and add-ons.