Copyright ©2023 by ESET, spol. s r.o.
ESET Direct Endpoint Management for N-able RMM was developed by ESET, spol. s r.o.
For more information visit https://www.eset.com.
All rights reserved. No part of this documentation may be reproduced, stored in a retrieval system or transmitted
in any form or by any means, electronic, mechanical, photocopying, recording, scanning, or otherwise without
permission in writing from the author.
ESET, spol. s r.o. reserves the right to change any of the described application software without prior notice.
Technical Support: https://support.eset.com
REV. 3/29/2023
1 Introduction 1 .......................................................................................................................................
2 System requirements 1 ........................................................................................................................
3 Add scripts 2 ........................................................................................................................................
3.1 Windows scripts 3 .........................................................................................................................
3.2 Mac scripts 5 ................................................................................................................................
3.3 Linux scripts 7 ..............................................................................................................................
4 Using checks, tasks and templates 9 ...................................................................................................
4.1 Add checks 9 ................................................................................................................................
4.2 Add task 14 ..................................................................................................................................
4.3 Create a monitoring template 18 ....................................................................................................
4.4 Apply template to other computers 20 ............................................................................................
5 Support and troubleshooting 22 ...........................................................................................................
5.1 Feedback 23 .................................................................................................................................
5.2 Changelog 23 ...............................................................................................................................
1
Introduction
Thank you for using the ESET Direct Endpoint Management for N-able RMM.
The ESET Direct Endpoint Management for N-able RMM is a Remote Management and Monitoring (RMM) tool
that makes monitoring and management easy for ESET Managed Service Providers (MSPs). RMM tools typically
monitor system information, patch status, antivirus status and other computer health issues. RMM tools also
provide a certain level of automation for fixing health issues that arise or creating a support ticket for the MSP to
resolve when automation cannot fix an issue.
Contact your local ESET partner or visit the ESET Managed Service Provider Program page for more information
about the ESET MSP program.
Managing ESET endpoint products from ESET PROTECT
The ESET PROTECT offers additional functionality such as reporting, dynamic groups and specific client task
policies. If you would like to take advantage of these additional functionalities, you must install the ESET
Management Agent on the endpoints you are managing.
Integrating with ESET endpoint products
ESET Direct Endpoint Management for N-able RMM allows MSPs to verify the ESET endpoint product installation
status and monitor the protection status and scan/threat logs of endpoint machines using Automation Policies
and Custom Services.
See the system requirements for the supported ESET endpoint and server products list.
System requirements
The ESET Direct Endpoint Management for N-able RMM automation policies and custom services must be
imported to your N-able RMM server. These components have been developed to work with ESET endpoint
products down to version 6.6 without using ESET PROTECT. While the ESET PROTECT is not required with these
components, it can still be used in conjunction for additional functionality.
Currently, these components support the following ESET endpoint products:
• ESET Endpoint Antivirus 6.6 and later
• ESET Endpoint Security 6.6 and later
• ESET Endpoint Antivirus for macOS 6.7 and later
• ESET Endpoint Security for macOS 6.7 and later
• ESET Endpoint Antivirus for Linux 8.x
• ESET Server Security for Linux 8.1
• ESET File Security for Microsoft Windows Server 7.0 and later
2
• ESET Mail Security for Microsoft Exchange Server 7.0 and later
For ESET endpoint requirements, refer to the system requirements.
These components rely on a companion program eRMM, which is downloaded automatically to each endpoint
after an ESET-specific automation policy has been run on the endpoint. This software automatically updates and
only requires an internet connection. The eRMM software acts as a means of communication between ESET and
N-able RMM.
EULA: https://update.esetusa.com/plugin/ermm/esetlicense.pdf
The ESET Direct Endpoint Management for N-able RMM provides checks and tasks for Windows, Mac and Linux
endpoints.
Add scripts
ESET Direct Endpoint Management for N-able RMM provides files that need to be uploaded to the N-able RMM
server manually.
Download the ESET-provided plugin script files stored in a .zip file and extract the archive. The extracted archive
contains three folders with specific scripts for each OS:
• Windows: Checks and tasks in AMP files (file extension .amp)
• Mac: Checks and tasks in BASH files (file extension .sh)
• Linux: Checks and tasks in BASH files (file extension .sh)
Add script files
Important
When adding the script, it is important to correctly define the script type (Script Check or Automated Task)
and OS (Windows, Mac or Linux).
1. In the Dashboard, click Settings > Script Manager.
2. In the next window, click the + New button to add scripts.
3. In the Add User Defined Scripts window, type the script's Name and (optionally) the Description. Leave the
Default Timeout value unchanged.
4. Select the script Type from the available options: Script Check or Automated Task.
5. Select the correct OS.
6. Browse the computer to Upload a script file for the specific OS.
7. Click Save.
3
You have now added user-defined script to the N-able RMM server.
Continue with adding tasks and checks.
Syntax schemes
You can find syntax schemes for tasks and checks in the Windows, Mac and Linux topics.
Windows scripts
Windows AMP file scripts syntax
Checks
Check Parameter Note
Product Activated Fails if the product is not activated.
Suggested action: Activate
4
Check Parameter Note
Product Installed Fails if the product is not installed.
Suggested action: Deploy w Activate
Protection Status Reports status.
Flags if the status is not “Fully Protected”.
Scans Reports if new scans have been performed since last
checked.
Threats Flags if new threats have been detected.
Suggested action: Perform In-Depth scan
Was Configured age (in following format:
n[m|h|d] as in 4d for 4 days, or
2h for 2 hours…)
Flags if the last configuration change was performed earlier
than age parameter.
Was Updated age (in following format:
n[m|h|d] as in 4d for 4 days, or
2h for 2 hours…)
Flags if the last update was performed earlier than age
parameter.
Tasks
Task Parameter Note
Activate License in the form of a license key (“XXXX-XXXX-XXXX-XXXX-XXXX”) or
ESET MSP Administrator Credentials and Public License ID (“username
password PLI-DPLIDP”)
Configure Configuration file path.
Deactivate Product {EEA|EES|EFSW|EMSX}
License in the form of a license key (“XXXX-XXXX-XXXX-XXXX-XXXX”) or
ESET MSP Administrator Credentials and Public License ID (“username
password PLI-DPL-IDP”)
Deploy w Activate
Repair Product {EEA|EES|EFSW|EMSX}
License in the form of a license key (“XXXX-XXXX-XXXX-XXXX-XXXX”) or
ESET MSP Administrator Credentials and Public License ID (“username
password PLI-DPL-IDP”)
This task reruns
the following
checks and acts
on the issues as
necessary:
• If the product
is not installed,
Repair attempts
installation
• If the product
is not activated,
Repair attempts
activation
• If new threats
were detected,
Repair starts an
In-depth scan
• In all cases,
Repair performs
a signature
update
5
Task Parameter Note
On-demand Scan Targets: “|” (pipe) separated list of Files, Folders or Macros, examples:
“c:\users\john\file.tmp”
“c:\users\john”
“${DriveAll}|${Memory}”
Profile: scan profile, examples:
“@Smart profile”
“@In-depth profile”
Uninstall Uninstall Password (if set)
Update Module
Upgrade Product {EEA|EES|EFSW|EMSX}
Mac scripts
Mac Bash file scripts syntax
Checks
Check Parameter Note
Product Activated Fails if the product is not activated.
Suggested action: Activate
Product Installed Fails if the product is not installed.
Suggested action: Deploy w Activate
Protection Status Reports status, Flags if the status is not “Fully Protected”.
Scans Reports if new scans have been performed since last
checked.
Threats Flags if new threats have been detected.
Suggested action: Perform In-Depth scan
Was Configured --age (in following format:
n[m|h|d] as in 4d for 4 days, or
2h for 2 hours…)
Example: --age 10m
Flags if the last configuration change was performed earlier
than age parameter.
Was Updated --age (in following format:
n[m|h|d] as in 4d for 4 days, or
2h for 2 hours…)
Example: --age 10m
Flags if the last update was performed earlier than age.
Tasks
Task Parameter Note
Activate activation “XXXX-XXXX-XXXX-XXXX-XXXX|EBA_user EBA_password
EBA_public_key” (use license key or ESET Business Administrator
username, password, and public key)
Example:
--activation “ABCD-EFGH-IJKL-1234-5678”
6
Task Parameter Note
Configure --file filePath.config (configuration file path)
Example:
--file “config000.xml”
Deactivate
Deploy w Activate --accept_eula (mandatory)
--product {EEA|EES}
--activation (see activate above)
Example:
--accept_eula --product EEA --activation “ABCD-EFGH-
IJKL-1234-5678”
Repair --accept_eula (mandatory)
--product {EEA|EES}
--activation (see activate above)
Example:
--accept_eula --product EEA --activation “ABCD-EFGH-
IJKL-1234-5678”
This task reruns
the following
checks and acts
on the issues as
necessary:
• If the product
is not installed,
Repair attempts
installation
• If the product
is not activated,
Repair attempts
activation
• If new threats
were detected,
Repair starts an
In-depth scan
• In all cases,
Repair performs
a signature
update
On-demand Scan --targets {file|folder}
--profile profile
Example:
--targets “/” --profile “@Smart scan”
Uninstall
Update Module
Upgrade --accept_eula (mandatory)
--product {EEA|EES}
--activation (see activate above)
Example:
--accept_eula --product EES --activation “ABCD-EFGH-
IJKL-1234-5678”
7
Linux scripts
Linux Bash file scripts syntax
Checks
Check Parameter Note
Product Activated Fails if the product is not activated.
Suggested action: Activate
Product Installed Fails if the product is not installed.
Suggested action: Deploy w Activate
Protection Status Reports status, Flags if the status is not “Fully Protected”.
Scans Reports if new scans have been performed since last checked.
Threats Flags if new threats have been detected.
Suggested action: Perform In-Depth scan
Was Updated -i (in following format:
n[m|h|d] as in 4d for 4
days, or 2h for 2 hours…)
Example: -i 10m
Flags if the last update was performed earlier than age.
Tasks
Task Parameter Note
Activate -k EBA_License
-i EBA_Public_License_ID
-u EBA_Username
-p EBA_Password
Example:
-k EXAM-PLEL-ICEN-SEST-RING
-i EXA-MPL-EID -u [email protected] -p
examplepassword
Activation method options:
• License Key
• ESET Business Administrator
(EBA) username, password and
public license ID
Configure -f /filePath/configFile (configuration file path)
Example: -f /tmp/config.xml
Deactivate
Deploy w Activate -P Product {EEA(default)|EES}
-L Language {enu|See the complete list}
-k EBA_License
-i EBA_Public_License_ID
-u EBA_Username
-p EBA_Password
Example:
-P EEA -L enu -k EXAM-PLEL-ICEN-SEST-RING
-P EES -L enu -i EXA-MPL-EID -u
[email protected] -p examplepassword
Command execution without:
• Activation arguments installs
the product without activation
• Any parameters installs ESET
Endpoint Antivirus (EEA) in the
default language (English)
without activation
8
Task Parameter Note
On-demand Scan -t Target {file|folder}
-p "Scan_profile"
Example:
-t /home/user/ -p "@In-depth scan"
-t /home/user/file.tmp -p "@Smart scan"
Uninstall
Upgrade
List of available language arguments
Abbreviation Language
enu English (default)
bgr Bulgarian
csy Czech
dan Danish
deu German
ell Greek
esn Spanish—Spain
esl Spanish—Chile
eti Estonian
fin Finnish
fra French—France
frc French—Canada
hrv Croatian
hun Hungarian
ita Italian
jpn Japanese
kor Korean
lth Lithuanian
nor Norwegian
nld Dutch
plk Polish
ptb Portuguese
rom Romanian
rus Russian
sky Slovak
slv Slovenian
srl Serbian
sve Swedish
tha Thai
9
Abbreviation Language
trk Turkish
ukr Ukrainian
chs Chinese—China
cht Chinese—Taiwan
are Arabic
kdi Kazakh
Using checks, tasks and templates
Adding Checks and Tasks
Checks can be performed at regular intervals (for example, every 30 minutes) or at a predetermined time daily.
When a check fails, an associated task can be performed to fix the issue. Tasks can be set to execute at regular
intervals (for example, periodic scans), manually on demand or after the check's failure.
Setting Monitoring Templates
Computers with assigned checks and tasks can be used as templates to assign checks and tasks to other
computers. Create a monitoring template from a computer and then assign that template to other machines.
Add checks
Checks can be performed at regular intervals (for example, every 30 minutes) or daily (at a predetermined time).
When a check fails, an associated task can be performed to fix the problem detected by a check.
Syntax schemes
You can find syntax schemes for tasks and checks in the Windows, Mac and Linux topics.
1. In the Dashboard, click File > Add check.
2. Click Choose Check and select Windows, Linux or Mac > 24x7 Checks or DSC checks (Daily Safety Checks)
depending on the frequency you need > Script Check.
OS-specific check
You can apply a check only on computers running the specific OS (Windows, Mac or Linux).
10
3. Select a target for the check (Servers or Workstations) and the client/location where you want the check(s)
applied.
11
4. Click Add New to add more scripts.
12
5. In the Add Script Check window, scroll down to the User Defined section, select the applicable script and
click Next.
13
6. Choose an execution timeout, then click Finish.
14
Add task
Syntax schemes
You can find syntax schemes for tasks and checks in the Windows, Mac and Linux topics.
1. Select the applicable Windows, Mac or Linux computers in the Workstations tab.
OS-specific task
You can apply a task only on computers running the specific OS (Windows, Mac or Linux).
2. Right-click the computer, and from the drop-down menu, select Task > Add.
15
3. In the Add Automated Task window, scroll down to the User Defined section, select the desired task, and
click Next.
16
4. In the selected task (for example, ESET Activate), type the task Description Name and the applicable Script
Parameters and click Next.
5. Select the frequency method (for example, Manual) and click Next.
17
(Optional) If you choose On Check Failure, you can choose which previously added check should trigger a given
task.
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
-
1
-
2
-
3
-
4
-
5
-
6
-
7
-
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
Ask a question and I''ll find the answer in the document
Finding information in a document is now easier with AI
Related papers
-
ESET DEM plugins DEM plugin Owner's manual
-
-
-
-
-
-
ESET Endpoint Security User guide
-
-
-
