Create scripts

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

To deploy ESET DEM plugin for Kaseya VSA X, download and unpack the ESET-provided script bundle. Because you cannot import ready-to-use scripts, configure the first script manually and then clone the prepared script to create all other tasks and monitoring scripts by adjusting its parameters.

Kaseya VSA X Create Scripts

Windows only

ESET DEM plugin for Kaseya VSA X currently only supports scripts for the Windows platform.

Download the script bundle

1.Visit the ESET plugin download page and click the Download button. You will download a .zip file.

2.Unpack the .zip file.

3.Explore the unpacked package that contains folders with scripts, policies and workflows.

Configure the first script

1.Click Automation > Scripts.

2.(Optional) Click Create folder, type the folder name and click Save.

3.Click New Script. In the next window in the Details section, type the script Name (for example, ESET task: Onboard).

4.(Optional) Type the script Description.

5.In the Inputs section, click the + New, and in the Add Variable window, type the exact variable Name (for example, esetOnboardWindows) from the table below. Click the toggle next to Use custom field value and use the Custom Field drop-down menu to select the related custom field (in this example, ESET Onboard Windows). Click Save Variable.

Repeat steps

Repeat these steps for each variable from the table below.

Variable Name	Custom Field
esetLicense	ESET License
esetOnboardLinux	ESET Onboard Linux
esetOnboardMac	ESET Onboard Mac
esetOnboardWindows	ESET Onboard Windows
esetProtectUrlPrefix	ESET PROTECT URL Prefix
esetScanProfile	ESET Scan Profile
esetScanTargets	ESET Scan Targets
esetSetupLanguage	ESET Setup Language
esetSetupPassword	ESET Setup Password
esetSetupProduct	ESET Setup Product

6.To add the specific task to the script, in the Inputs section, click the + New, and in the Add Variable window, type esetTask in the Name field. Keep the Variable type as Text. In the Default Value field, type the related ESET Task default value from the table below (in this example, --onboard). Click Save Variable. NOTE: You can define only one specific task for each script.

7.In the Outputs section, click the + New, and in the Add Variable window, type the variable Name (for example, esetLastScanDate) exactly as in the table below. Click the Variable Type drop-down menu to select the desired value from the table below (in this example, Date). Click the Default Value drop-down menu to select the default value from the table below. Click the toggle next to Set custom field value and use the Custom Field drop-down menu to select the related custom field (in this example, ESET Last Scan Date). Click Save Variable.

Repeat steps

Repeat these steps for each variable from the table below.

Variable Name	Variable Type	Default Value	Custom Field
esetLastScanDate	Date	01/01/2001	ESET Last Scan Date
esetLastTaskResult	Text	( ) Space character	ESET Last Task Result
esetLastThreatDate	Date	01/01/2001	ESET Last Threat Date
esetLastThreatName	Text	( ) Space character	ESET Last Threat Name
esetLicensePublicId	Text	( ) Space character	ESET License Public ID
esetModuleVersion	Text	( ) Space character	ESET Module Version
esetProductName	Text	( ) Space character	ESET Product Name
esetProductVersion	Text	( ) Space character	ESET Product Version
esetProtectUrl	Text	( ) Space character	ESET PROTECT URL
esetProtectionStatus	Text	( ) Space character	ESET Protection Status

8.In the Windows section, click the toggle next to Enable. Keep the Script type as PowerShell. Copy/paste the script content from the downloaded kaseya-vsax-windows.ps1 file into the text field below the # Inputs and # Outputs sections.

9.Click Save. In the Save Confirmation window, ignore the output variables warning and click Save. NOTE: The ESET-provided companion software ERMMA handles the writing of values for output variables and not the script itself.

A blue notification message will appear: The Script was saved successfully.

Clone the prepared script

1.Click Automation > Scripts.

2.Hover the mouse over the prepared script name. Click the Clone icon.

3.In the next window, in the Details section, type the new script Name and Description. Create the desired task and monitoring scripts from the table below.

Script Type	Suggested Script Name
Task	ESET Task: Onboard
Task	ESET Task: Offboard
Task	ESET Task: Activate
Task	ESET Task: Deactivate
Task	ESET Task: Scan
Task	ESET Task: Update
Task	ESET Task: Configure
Monitor	ESET Monitor
Monitor	ESET Monitor: Threat
Monitor	ESET Monitor: Scan
Monitor	ESET Monitor: Protection
Monitor	ESET Monitor: Installed
Monitor	ESET Monitor: Activation

4.In the Inputs section, hover the mouse over the esetTask variable and click the Edit icon. Type the new Default Value from the table below, then click Save Variable.

ESET Task Default Value	Description
--onboard	Install and activate the ESET security product on the managed device.
--offboard	Uninstall the ESET security product on the managed device.
--activate	Activate installed ESET security product on the managed device.
--deactivate	Deactivate installed ESET security product on the managed device.
--scan	Perform on-demand scan on a managed device.
--update	Perform detection engine update on the managed device.
--configure	Apply the configuration task or policy to the managed device.
--monitor	Execute all monitoring scripts (threat, scan , protection, installed, activation) at once.
--monitor=threat	Return threat detected in the (previous) monitor run.
--monitor=scan	Return the result of the scan run (within the time frame of the last monitor), including a number of files scanned, infected and cleaned.
--monitor=protection	Return any protection status issue (for example, product not activated, real time file system protection disabled, ...).
--monitor=installed	Return ESET security product installation status on the managed device.
--monitor=activation	Return ESET security product activation status on the managed device.

5.Click Save. In the Save Confirmation window, ignore the output variables warning and click Save. NOTE: The ESET-provided companion software ERMMA handles the writing of the values for the output variables (not the script itself).

A blue notification message will appear: The Script was saved successfully.

˄˅