Формат вызова

1. Формат вызова утилиты управления из командной строки

Утилита управления работой Dr.Web для Linux имеет следующий формат вызова:

$ drweb-ctl [<общие опции> | <команда> [<аргумент>] [<опции команды>]]

Где:

<общие опции> – опции, которые могут быть использованы при запуске без указания команды или для любой из команды. Не являются обязательными для запуска.

<команда> – команда, которая должна быть выполнена Dr.Web для Linux (например, запустить проверку файлов, вывести содержимое карантина и т.п.).

<аргумент> – аргумент команды. Зависит от указанной команды. У некоторых команд аргументы отсутствуют.

<опции команды> – опции, управляющие работой указанной команды. Зависит от команды. У некоторых команд опции отсутствуют.

2. Общие опции

Доступны следующие общие опции:

Опция

Описание

-h,
--help

Вывести на экран краткую общую справку и завершить работу.

Для вывода справки по любой команде используйте вызов:

drweb-ctl -h <команда>  или drweb-ctl <команда> -h

-v,
--version

Вывести на экран версию модуля и завершить работу

-d,
--debug

Предписывает выводить на экран расширенные диагностические сообщения во время выполнения указанной команды.

Не имеет смысла без указания команды. Используйте вызов

drweb-ctl -d <команда>

3. Команды

Команды управления Dr.Web для Linux разделены на следующие группы:

Команды антивирусной проверки.

Команды управления обновлением и работой в режиме централизованной защиты.

Команды управления конфигурацией.

Команды управления угрозами и карантином.

Информационные команды.

3.1. Команды антивирусной проверки

Доступны следующие команды антивирусной проверки файловой системы:

Команда

Описание

scan <путь>

Назначение:

Инициировать проверку Сканером указанного файла или каталога.

Аргументы:

<путь> – путь к файлу или каталогу, который нужно проверить.

Этот аргумент может быть опущен в случае использования опции --stdin или --stdin0.

Для проверки перечня файлов, выбираемых по некоторому условию, рекомендуется использовать утилиту find (см. примеры) и опции --stdin или --stdin0.

Опции:

-a [--Autonomous] – запустить отдельную копию антивирусного ядра и Сканера для выполнения заданной проверки, завершив их работу после окончания проверки. Обратите внимание, что угрозы, обнаруженные при автономном сканировании, не будут добавлены в общий список обнаруженных угроз, выводимый командой threats (см. ниже).

--stdin – получить список путей для проверки из стандартного потока ввода (stdin).

Пути в списке должны быть разделены символом новой строки ('\n').

--stdin0 – получить список путей для проверки из стандартного потока ввода (stdin).

Пути в списке должны быть разделены нулевым символом NUL ('\0').

Обратите внимание, что при использовании обеих этих опций пути в списке не должны содержать шаблонов.

Предпочтительное использование опций --stdin и --stdin0 – обработка в команде scan списка путей, сформированного внешней утилитой, например, find (см. примеры).

--Report <BRIEF|DEBUG> – установить тип отчета о проверке.

Возможные значения:

BRIEF – краткий отчет.

DEBUG – подробный отчет.

Значение по умолчанию: BRIEF

--ScanTimeout <число> – установить тайм-аут на проверку одного файла в мс.

Значение 0 указывает, что время проверки не ограничено.

Значение по умолчанию: 0

--PackerMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке запакованных объектов.

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--ArchiveMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке архивов (zip, rar и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--MailMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке почтовых файлов (pst, tbb и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--ContainerMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке прочих контейнеров (HTML и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--MaxCompressionRatio <степень> – установить максимальную допустимую степень сжатия проверяемых объектов.

Должна быть не менее 2.

Значение по умолчанию: 3000

--HeuristicAnalysis <On|Off> – использовать ли Эвристический анализ.

Значение по умолчанию: On

--OnKnownVirus <действие>действие, которое следует выполнить в случае если методами сигнатурного анализа обнаружена известная угроза.

Возможные действия: REPORT, CURE, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnIncurable <действие> – действие, которое следует выполнить в случае если лечение (CURE) обнаруженной угрозы окончилось неудачей или оно невозможно.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnSuspicious <действие> – действие, которое следует выполнить в случае если Эвристический анализ обнаружит подозрительный объект.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnAdware <действие> – действие, которое следует выполнить в случае если обнаружена рекламная программа.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnDialers <действие> – действие, которое следует выполнить в случае если обнаружена программа дозвона.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnJokes <действие> – действие, которое следует выполнить в случае если обнаружена программа-шутка.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnRiskware <действие> – действие, которое следует выполнить в случае если обнаружена потенциально опасная программа.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnHacktools <действие> – действие, которое следует выполнить в случае если обнаружена программа взлома.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

bootscan

<устройство> | ALL

Назначение:

Инициировать проверку Сканером загрузочной записи на указанных дисковых устройствах. Проверяются как записи MBR, так и записи VBR.

Аргументы:

<устройство> – путь к блочному файлу дискового устройства, загрузочная запись на котором подлежит проверке. Может быть указано несколько дисковых устройств через пробел.

Если вместо файла устройства указано ALL, будут проверены все загрузочные записи на всех доступных дисковых устройствах.

Обязательный аргумент.

Опции:

-a [--Autonomous] – запустить отдельную копию антивирусного ядра и Сканера для выполнения заданной проверки, завершив их работу после окончания проверки. Обратите внимание, что угрозы, обнаруженные при автономном сканировании, не будут добавлены в общий список обнаруженных угроз, выводимый командой threats (см. ниже).

--Report <BRIEF|DEBUG> – установить тип отчета о проверке.

Возможные значения:

BRIEF – краткий отчет.

DEBUG – подробный отчет.

Значение по умолчанию: BRIEF

--ScanTimeout <число> – установить тайм-аут на проверку одного файла в мс.

Значение 0 указывает, что время проверки не ограничено.

Значение по умолчанию: 0

--HeuristicAnalysis <On|Off> – использовать ли Эвристический анализ.

Значение по умолчанию: On

--Cure <Yes|No> – требуется ли делать попытки лечения обнаруженных угроз.

Если указано no, то производится только информирование об обнаруженной угрозе.

Значение по умолчанию: No

--ShellTrace – включить вывод дополнительной отладочной информации при проверке загрузочной записи.

procscan

Назначение:

Инициировать проверку Сканером содержимого исполняемых файлов, содержащих код процессов, запущенных в системе.

Аргументы:

Нет.

Опции:

-a [--Autonomous] – запустить отдельную копию антивирусного ядра и Сканера для выполнения заданной проверки, завершив их работу после окончания проверки. Обратите внимание, что угрозы, обнаруженные при автономном сканировании, не будут добавлены в общий список обнаруженных угроз, выводимый командой threats (см. ниже).

--Report <BRIEF|DEBUG> – установить тип отчета о проверке.

Возможные значения:

BRIEF – краткий отчет.

DEBUG – подробный отчет.

Значение по умолчанию: BRIEF

--ScanTimeout <число> – установить тайм-аут на проверку одного файла в мс.

Значение 0 указывает, что время проверки не ограничено.

Значение по умолчанию: 0

--HeuristicAnalysis <On|Off> – использовать ли Эвристический анализ.

Значение по умолчанию: On

--PackerMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке запакованных объектов.

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--OnKnownVirus <действие>действие, которое следует выполнить в случае если методами сигнатурного анализа обнаружена известная угроза.

Возможные действия: REPORT, CURE, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnIncurable <действие> – действие, которое следует выполнить в случае если лечение (CURE) обнаруженной угрозы окончилось неудачей или оно невозможно.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnSuspicious <действие> – действие, которое следует выполнить в случае если Эвристический анализ обнаружит подозрительный объект.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnAdware <действие> – действие, которое следует выполнить в случае если обнаружена рекламная программа.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnDialers <действие> – действие, которое следует выполнить в случае если обнаружена программа дозвона.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnJokes <действие> – действие, которое следует выполнить в случае если обнаружена программа-шутка.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnRiskware <действие> – действие, которое следует выполнить в случае если обнаружена потенциально опасная программа.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

--OnHacktools <действие> – действие, которое следует выполнить в случае если обнаружена программа взлома.

Возможные действия: REPORT, QUARANTINE, DELETE.

Значение по умолчанию: REPORT

Обратите внимание, что при обнаружении угроз в исполняемом файле все запущенные из него процессы принудительно завершаются Dr.Web для Linux.

cloudscan

Назначение:

Инициировать проверку указанного файла или каталога с обращением к облачному сервису Dr.Web Cloud за информацией о вредоносности данного файла.

Аргументы:

<путь> – путь к файлу или каталогу, который нужно проверить.

Опции:

--Report <BRIEF|DEBUG> – установить тип отчета о проверке.

Возможные значения:

BRIEF – краткий отчет.

DEBUG – подробный отчет.

Значение по умолчанию: BRIEF

--ScanTimeout <число> – установить тайм-аут на проверку одного файла в мс.

Значение 0 указывает, что время проверки не ограничено.

Значение по умолчанию: 0

--PackerMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке упакованных объектов.

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--ArchiveMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке архивов (zip, rar и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--MailMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке почтовых файлов (pst, tbb и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--ContainerMaxLevel <число> – установить максимальный уровень вложенности объектов при проверке прочих контейнеров (HTML и т.п.).

Значение 0 указывает, что вложенные объекты будут пропущены.

Значение по умолчанию: 8

--MaxCompressionRatio <степень> – установить максимальную допустимую степень сжатия проверяемых объектов.

Должна быть не менее 2.

Значение по умолчанию: 3000

--HeuristicAnalysis <On|Off> – использовать ли Эвристический анализ.

Значение по умолчанию: On

--Cure <Yes|No> – требуется ли делать попытки лечения обнаруженных угроз.

Если указано No, то производится только информирование об обнаруженной угрозе.

Значение по умолчанию: No

--ShellTrace – включить вывод дополнительной отладочной информации при проверке файла.

3.2. Команды управления обновлением и работой в режиме централизованной защиты

Доступны следующие команды управления обновлением и работой в режиме централизованной защиты:

Команда

Описание

update

Назначение:

Инициировать процесс обновления Компонентом обновления вирусных баз и антивирусного ядра с серверов обновлений компании «Доктор Веб», или прервать уже запущенный процесс обновления.

Команда не имеет эффекта, если Dr.Web для Linux работает под управлением сервера централизованной защиты.

Аргументы:

Нет.

Опции:

--Stop – прервать уже идущий процесс обновления.

esconnect

<сервер>[:порт]

Назначение:

Подключить Dr.Web для Linux к указанному серверу централизованной защиты (например, Dr.Web Enterprise Server). О режимах работы Dr.Web для Linux см. в разделе Режимы работы.

Аргументы:

<сервер> – IP-адрес или имя хоста в сети, на котором располагается сервер централизованной защиты. Обязательный аргумент.

<порт> – номер порта, используемого сервером централизованной защиты. Необязательный аргумент, указывается только в случае, если сервер централизованной защиты использует нестандартный порт).

Опции:

--Key <путь> – путь к файлу публичного ключа сервера централизованной защиты, к которому производится подключение.

--Login <ID> – логин (идентификатор рабочей станции) для подключения к серверу централизованной защиты.

--Password <пароль> – пароль для подключения к серверу централизованной защиты.

--Group <ID> – идентификатор группы на сервере, в которую следует поместить рабочую станцию при подключении.

--Rate <ID> – идентификатор тарифной группы, которую следует применить к рабочей станции при ее включении в группу на сервере централизованной защиты (может быть указана только совместно с опцией --Group).

--Compress <On|Off> – принудительно инициировать сжатие передаваемых данных (On) или запретить его (Off). Если опция не указана, использование сжатия определяется сервером.

--Encrypt <On|Off> – принудительно инициировать шифрование передаваемых данных (On) или запретить его (Off). Если опция не указана, использование шифрования определяется сервером.

--Newbie – подключиться как «новичок» (получить новую учетную запись на сервере).

--WithoutKey – разрешать подключаться к серверу без использования публичного ключа сервера.

--WrongKey – разрешать подключаться к серверу, даже если указан некорректный публичный ключ сервера.

Опции --Key и --WithoutKey являются взаимоисключающими. При этом в команде обязательно должна быть указана любая из них.

Обратите внимание, что для выполнения этой команды требуется, чтобы drweb-ctl была запущена от имени суперпользователя.

esdisconnect

Назначение:

Отключить Dr.Web для Linux от сервера централизованной защиты и перевести его в автономный режим работы.

Команда не имеет смысла, если Dr.Web для Linux находится в автономном режиме.

Аргументы:

Нет.

Опции:

Нет.

Обратите внимание, что для выполнения этой команды требуется, чтобы drweb-ctl была запущена от имени суперпользователя.

3.3. Команды управления конфигурацией

Доступны следующие команды управления конфигурацией:

Команда

Описание

cfset

<секция>.<параметр> <значение>

Назначение:

Изменить активное значение указанного параметра текущей конфигурации.

Обратите внимание, что знак равенства не используется.

Аргументы:

<секция> – имя секции конфигурационного файла, в которой находится изменяемый параметр. Обязательный аргумент.

<параметр> – имя изменяемого параметра. Обязательный аргумент.

<значение> – значение, которое следует присвоить изменяемому параметру. Обязательный аргумент.

Для задания значения параметров всегда используется формат <секция>.<параметр> <значение>

Описание конфигурационного файла доступно в документации man drweb.ini(5).

Опции:

-a [--Add] – не заменять текущее значение параметра, а добавить указанное значение в список значений параметра (допустимо только для параметров, которые могут иметь список значений).

-e [--Erase] – не заменять текущее значение параметра, а удалить указанное значение из его списка (допустимо только для параметров, которые имеют список значений).

-r [--Reset] – сбросить параметр в значение по умолчанию. <значение> в этом случае в команде не указывается, а если указано – игнорируется.

Опции не являются обязательными. Если они не указаны, то текущее значение параметра (в том числе – список значений) заменяется на указанное значение.

Для опции -r предусмотрен также особый синтаксис вызова команды cfset:

cfset <секция>.* -r

В этом случае все параметры указанной секции сбрасываются в значения по умолчанию.

Обратите внимание, что для выполнения этой команды требуется, чтобы drweb-ctl была запущена от имени суперпользователя.

cfshow

[<секция>][.<параметр>]

Назначение:

Вывести на экран параметры текущей конфигурации программного комплекса.

Для вывода параметров по умолчанию используется формат <секция>.<параметр> = <значение>. Секции и параметры не установленных компонентов по умолчанию не выводятся.

Аргументы:

<секция> – имя секции конфигурационного файла, параметры которой нужно вывести на экран. Необязательный аргумент. Если не указан, то на экран выводятся параметры всех секций конфигурационного файла.

<параметр> – имя выводимого параметра. Необязательный аргумент. Если не указан, выводятся все параметры указанной секции, в противном случае выводится только этот параметр. Если указан без имени секции, то выводятся все вхождения этого параметра во все секции конфигурационного файла.

Опции:

--Uncut – вывести на экран все параметры конфигурации, а не только те, которые используются текущим установленным набором компонентов. В противном случае выводятся только те параметры, которые используются имеющимися компонентами.

--Ini – вывести значения параметров в формате INI-файла: сначала в отдельной строке выводится имя секции, заключенное в квадратные скобки, после чего параметры, принадлежащие секции, перечисляются в виде пар <параметр> = <значение> (по одному в строке).

3.4. Команды управления угрозами и карантином

Доступны следующие команды управления угрозами и карантином:

Команда

Описание

threats

[<действие> <объект>]

Назначение:

Выполнить указанное действие с обнаруженными ранее угрозами по их идентификаторам. Тип действия определяется указанной опцией команды.

Если действие не указано, то вывести на экран информацию об обнаруженных, но не обезвреженных угрозах.

Аргументы:

Нет.

Опции:

-f [--Follow] – выполнять ожидание поступления новых сообщений об угрозах и выводить их сразу, как только они будут поступать (^C прерывает ожидание).

--Cure <список угроз> – выполнить попытку лечения перечисленных угроз (идентификаторы угроз перечисляются через запятую).

--Quarantine <список угроз> – выполнить перемещение в карантин перечисленных угроз (идентификаторы угроз перечисляются через запятую)

--Delete <список угроз> – выполнить удаление перечисленных угроз (идентификаторы угроз перечисляются через запятую).

--Ignore <список угроз> – игнорировать перечисленные угрозы (идентификаторы угроз перечисляются через запятую).

Если требуется применить данную команду ко всем обнаруженным угрозам, вместо <список угроз> следует указать all.

Например, команда

drweb-ctl threats --Quarantine all

перемещает в карантин все обнаруженные объекты с угрозами.

quarantine

[<действие> <объект>]

Назначение:

Применить действие к указанному объекту, находящемуся в карантине.

Если действие не указано, то вывести на экран информацию об объектах, находящихся в карантине, с указанием их идентификаторов и краткой информации об исходных файлах, перемещенных в карантин.

Аргументы:

Нет.

Опции:

--Delete <объект> – удалить указанный объект из карантина.

Обратите внимание, что удаление из карантина – необратимая операция.

--Cure <объект> – попытаться вылечить указанный объект в карантине.

Обратите внимание, что, даже если объект был успешно вылечен, то он все равно останется в карантине. Для извлечения объекта из карантина следует воспользоваться командой восстановления --Restore.

--Restore <объект> – восстановить указанный объект из карантина в исходное место.

Обратите внимание, что для выполнения этой команды может потребоваться, чтобы drweb-ctl была запущена от имени суперпользователя. Восстановить файл из карантина можно даже если он инфицирован.

В качестве <объект> используется идентификатор объекта в карантине. Если требуется применить данную команду ко всем объектам, находящимся в карантине, вместо <объект> следует указать all.

Например, команда

drweb-ctl quarantine --Restore all

восстанавливает из карантина все имеющиеся в нем объекты.

3.5. Информационные команды

Доступны следующие информационные команды:

Команда

Описание

appinfo

Назначение:

Вывести на экран информацию о работающих модулях Dr.Web для Linux.

Аргументы:

Нет.

Опции:

-f [--Follow] – выполнять ожидание поступления новых сообщений об изменении состояния модулей и выводить их на экран сразу, как только они будут поступать (^C прерывает ожидание).

baseinfo

Назначение:

Вывести на экран информацию о текущей версии антивирусного ядра и состоянии вирусных баз.

Аргументы:

Нет.

Опции:

Нет.

license

Назначение:

Вывести на экран информацию об активной лицензии.

Аргументы:

Нет.

Опции:

Нет.