ESET Online Help

Search English
Select the topic

Commands

This section lists a few basic eShell commands with descriptions.


note

Commands are not case sensitive, you can use uppercase (capital) or lowercase letters and the command will execute regardless.

Example commands (contained within the ROOT context):

ABOUT

Lists information about the program. It shows information such as:

Name of your ESET security product installed and its version number.

Operating system and basic hardware details.

Username (including domain), Full computer name (FQDN, if your server is a member of a domain) and Seat name.

Installed components of your ESET security product, including version number of each component.

CONTEXT PATH:

root

PASSWORD

To execute password-protected commands, you are prompted to type in a password for security reasons. This applies to commands that disable protection and those that may affect ESET Mail Security configuration. You will be prompted for a password every time you execute such a command. You can define this password to avoid entering a password every time. It will be remembered by eShell and automatically entered when a password-protected command is executed.


note

Your password only works for the current eShell interactive session. This defined password will be dropped when you exit eShell. When you start eShell again, the password needs to be defined again.

Defined password can also be used when running unsigned batch files or scripts. Make sure to set ESET Shell execution policy to Full access when running unsigned batch files. Here is an example of such a batch file:

eshell set password plain <yourpassword> "&" computer set real-time status disabled

This concatenated command above defines a password and disables protection.


important

We recommend that you use signed batch files whenever you can. This way, you'll avoid plain text passwords in the batch file (if the method is described above). See Batch files / Scripting (Signed batch files section) for more details.

CONTEXT PATH:

root

SYNTAX:

[get] | restore password

set password [plain <password>]

OPERATIONS:

get - Show password

set - Set or clear password

restore - Clear password

ARGUMENTS:

plain - Switch to type password as parameter

password - Password

EXAMPLES:

set password plain <yourpassword> - Sets a password which will be used for password-protected commands

restore password - Clears password

EXAMPLES:

get password - Use this to see whether the password is configured or not (this only shows asterisks "*", it does not list the password itself), when no asterisks are visible, it means that there is no password set

set password plain <yourpassword> - Use this to set a defined password

restore password - This command clears the defined password

STATUS

Shows information about the current Real-time protection status of ESET Mail Security, also enables you to pause / resume protection (similar to GUI).

CONTEXT PATH:

computer real-time

SYNTAX:

[get] status

set status enabled | disabled  [ 10m | 30m | 1h | 4h | temporary ]

restore status

OPERATIONS:

get - Returns current setting/status

set - Sets value/status

restore - Restores default settings/object/file

ARGUMENTS:

enabled - Enable protection/feature

disabled - Disable protection/feature

10m - Disable for 10 minutes

30m - Disable for 30 minutes

1h - Disable for 1 hour

4h - Disable for 4 hours

temporary - Disable until reboot


note

You cannot disable all protection features with a single command. Using the status command, you can manage protection features and modules one by one. Each protection feature or module has its status command.

List of features with status command:

Feature

Context and command

Automatic exclusions

COMPUTER AUTO-EXCLUSIONS STATUS

Host Intrusion Prevention System (HIPS)

COMPUTER HIPS STATUS

Real-time file system protection

COMPUTER REAL-TIME STATUS

Device control

DEVICE STATUS

Botnet protection

NETWORK ADVANCED STATUS-BOTNET

Network attack protection (IDS)

NETWORK ADVANCED STATUS-IDS

Network isolation

NETWORK ADVANCED STATUS-ISOLATION

ESET Cluster

TOOLS CLUSTER STATUS

Diagnostic logging

TOOLS DIAGNOSTICS STATUS

Presentation mode

TOOLS PRESENTATION STATUS

Anti-Phishing protection

WEB-AND-EMAIL ANTIPHISHING STATUS

Email client protection

WEB-AND-EMAIL MAIL-CLIENT STATUS

Web access protection

WEB-AND-EMAIL WEB-ACCESS STATUS

VIRLOG

This is an alias of the DETECTIONS command. It is useful when you need to view information about detected infiltrations.

WARNLOG

This is an alias of the EVENTS command.  It is useful when you need to view information about various events.