Commands

This section lists a few basic eShell commands with descriptions.

note_icon_note 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

Normally, to execute password-protected commands, you are prompted to type in a password for security reasons. This applies to commands such as those that disable antivirus 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 in order to avoid entering a password every time. It will be remembered by eShell and automatically  entered when a password-protected command is executed.

note_icon_note NOTE

Your password only works for the current eShell interactive session. Once you exit eShell, this defined password will be dropped. 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> "&" set status disabled

This concatenated command above defines a password and disables protection.

note_icon_important IMPORTANT

We recommend you to use signed batch files whenever possible. This way, you'll avoid having plain text passwords in the batch file (if using the method 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 enter 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 protection status of ESET Mail Security (similar to GUI).

CONTEXT PATH:

      root

SYNTAX:

      [get] | restore status

      set status disabled | enabled

OPERATIONS:

      get - Show antivirus protection status

      set - Disable/Enable antivirus protection

      restore - Restores default settings

ARGUMENTS:

      disabled - Disable antivirus protection

      enabled - Enable antivirus protection

EXAMPLES:

      get status - Shows current protection status

      set status disabled - Disables protection

      restore status - Restores protection to default setting (Enabled)

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.