ESET Online Help

Search English
Select the topic

Run On-demand scan from a Terminal window

Syntax: /opt/eset/efs/bin/odscan [OPTIONS..]

Options - short form

Options - long form

Description

-l

--list

Show currently running scans

 

--list-profiles

Show all available scan profiles

 

--all

Show also scans executed by other user (requires root privileges)

-r

--resume=session_id

Resume previously paused scan identified by session_id

-p

--pause=session_id

Pause scan identified by session_id

-t

--stop=session_id

Stop scan identified by session_id

-s

--scan

Start scan

 

--show-scan-info

Display basic information (including log_name) about the started scan

 

--profile=PROFILE

Scan with selected PROFILE

 

--profile-priority=PRIORITY

Task will be run with the specified priority.
Priority can be: normal, lower, lowest, idle

 

--readonly

Scan without cleaning

 

--local

Scan local drives

 

--network

Scan network drives

 

--removable

Scan removable media

 

--boot-local

Scan the boot sectors of local drive

 

--boot-removable

Scan the boot sectors of removable media

 

--boot-main

Scan the main boot sector

 

--exclude=FILE

Skip selected file or directory

 

--ignore-exclusions

Scan also excluded paths and extensions

The odscan utility ends with an exit code after completed scan. Execute echo $? in the Terminal window after completed scan to display the exit code.

Exit codes

Exit code

Meaning

0

No threat found

1

Threat found and cleaned

10

Some files could not be scanned (may be threats)

50

Threat found

100

Error

Example

Run On-demand scan of /root/ directory recursively with "@Smart scan" scan profile as a background process:

/opt/eset/efs/bin/odscan --scan --profile="@Smart scan" /root/ &

Run On-demand scan with "@Smart scan" scan profile regarding multiple destinations recursively:

/opt/eset/efs/bin/odscan --scan --profile="@Smart scan" /root/ /tmp/ /home/

List all running scans

/opt/eset/efs/bin/odscan -l

Pause scan with session-id "15". Each scan has its own unique session-id generated when it is started.

/opt/eset/efs/bin/odscan -p 15

Stop scan with session-id "15". Each scan has its own unique session-id generated when it is started.

/opt/eset/efs/bin/odscan -t 15

Run On-demand scan with an excluded directory /root/exc_dir and an excluded file /root/eicar.com:

/opt/eset/efs/bin/odscan --scan --profile="@In-depth scan" --exclude=/root/exc_dir/ --exclude=/root/eicar.com /

Scan the boot sector of removable devices. Execute the command below as a privileged user.

sudo /opt/eset/efs/bin/odscan --scan --profile="@In-depth scan" --boot-removable