Команды drweb-ctl

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

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

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

команда управления обновлением,

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

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

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

Команда

Описание

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

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

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

Аргументы:

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

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

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

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

Опции:

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

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

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

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

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

Назначение: Вывести на экран параметры текущей конфигурации Dr.Web для Kerio Control.

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

Аргументы:

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

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

Опции:

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

--Changed – вывести только те параметры, значения которых отличаются от значений по умолчанию.

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

--Value – вывести только значение указанного параметра. В этом случае аргумент <параметр> обязателен.

reload

Назначение: Перезапустить сервисные компоненты Dr.Web для Kerio Control. При этом заново открываются журналы, перечитывается файл конфигурации, и производится попытка перезапустить аварийно завершенные компоненты.

Аргументы: Нет.

Опции: Нет.

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

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

Команда

Описание

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

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

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

идентификатор, присвоенный угрозе (порядковый номер);

полный путь к инфицированному файлу;

информация об угрозе (имя, тип по классификации компании «Доктор Веб»);

информация о файле: размер, пользователь-владелец, дата последнего изменения;

история действий с инфицированным файлом: обнаружение, применявшиеся действия и т. п.

Аргументы: Нет.

Опции:

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

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

--Format "<строка формата>" – выводить информацию об угрозах в указанном формате.

warning_green

Каждая из перечисленных выше опций будет проигнорирована, если она указана совместно с какой-либо из опций-действий.

Опции-действия:

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

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

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

--Quarantine <список угроз> – выполнить перемещение в карантин перечисленных угроз.

Параметр <список угроз> содержит идентификаторы угроз, которые перечисляются через запятую.

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

$ drweb-ctl threats --Quarantine All

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

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

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

идентификатор, присвоенный изолированному объекту в карантине;

исходный путь к файлу, перемещенному в карантин;

дата перемещения файла в карантин;

информация о файле: размер, пользователь-владелец, дата последнего изменения;

информация об угрозе: имя, тип по классификации компании «Доктор Веб».

Аргументы: Нет.

Опции:

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

--Format "<строка формата>" – выводить информацию об объектах, находящихся в карантине, в указанном формате.

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

warning_green

Если опция --Format или -f [--Follow] указана совместно с любой из опций-действий, то она игнорируется.

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

warning_green

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

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

warning_green

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

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

warning_green

Восстановить файл из карантина можно, даже если он инфицирован.

--TargetPath <путь> – восстановить объект из карантина в указанный каталог:

с исходным именем, если в параметре <путь> указан только каталог;

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

warning_green

Обратите внимание, что опция применяется только совместно с опцией восстановления --Restore.

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

$ drweb-ctl quarantine --Restore All

warning_green

Если для варианта --Restore All указана дополнительная опция --TargetPath, то она должна задавать путь к каталогу, а не к файлу.

Форматированный вывод данных для команд threats и quarantine

Формат вывода задается строкой формата, указанной в качестве аргумента необязательной опции --Format. Строка формата обязательно указывается в кавычках. Строка формата может включать в себя как обычные символы, которые будут выведены на экран «как есть», так и специализированные маркеры, которые при выводе будут заменены на соответствующую информацию.

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

общие для команд threats и quarantine:

Маркер

Описание

%{n}

Перевод строки

%{t}

Табуляция

%{threat_name}

Имя обнаруженной угрозы (вируса) по классификации компании «Доктор Веб»

%{threat_type}

Тип угрозы («known virus» и т. д.) по классификации компании «Доктор Веб»

%{size}

Размер исходного файла

%{origin}

Полное имя исходного файла с путем к его расположению

%{path}

Синоним для %{origin}

%{ctime}

Дата/время модификации исходного файла в формате: %Y-%b-%d %H:% M:%S (например, 2018-Jul-20 15:58:01)

%{timestamp}

То же, что и %{ctime}, но в формате времени UNIX timestamp

%{owner}

Пользователь-владелец исходного файла

%{rowner}

Удаленный пользователь-владелец исходного файла. Если маркер не применим или значение неизвестно, то он заменяется на «?».

специфические для команды threats:

Маркер

Описание

%{hid}

Идентификатор записи об угрозе в реестре истории событий, связанных с угрозой

%{tid}

Идентификатор угрозы

%{htime}

Дата/время события, связанного с угрозой

%{app}

Идентификатор компонента, обработавшего угрозу

%{event}

Последнее событие, связанное с угрозой:

FOUND – угроза была обнаружена;

Cure – угроза была вылечена;

Quarantine – файл с угрозой был перемещен в карантин;

Delete – файл с угрозой был удален;

Ignore – угроза была проигнорирована;

RECAPTURED – угроза была обнаружена повторно другим компонентом.

%{err}

Текст сообщения об ошибке. Если ошибки нет, маркер заменяется на пустую строку.

специфические для команды quarantine:

Маркер

Описание

%{qid}

Идентификатор объекта в карантине

%{qtime}

Дата/время перемещения объекта в карантин

%{curetime}

Дата/время попытки лечения объекта, перемещенного в карантин. Если маркер не применим или значение неизвестно, то он заменяется на «?».

%{cureres}

Результат попытки лечения объекта, перемещенного в карантин:

cured – угроза вылечена;

not cured – угроза не вылечена, либо попыток лечения не было.

Команда управления обновлением

Для управления обновлением доступна одна команда:

Команда

Описание

update

Назначение: Инициировать процесс обновления вирусных баз и антивирусного ядра с серверов обновлений компании «Доктор Веб» с помощью компонента Dr.Web Updater или прервать уже запущенный процесс обновления.

Аргументы: Нет.

Опции:

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

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

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

Команда

Описание

appinfo

Назначение: Вывести на экран информацию о работающих модулях Dr.Web для Kerio Control.

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

внутреннее имя;

идентификатор процесса GNU/Linux (PID);

состояние (запущен, остановлен и т. п.);

код ошибки, если работа компонента завершена вследствие ошибки;

дополнительная информация (опционально).

Для демона управления конфигурацией (drweb-configd) в качестве дополнительной информации выводятся:

перечень установленных компонентов (Installed);

перечень компонентов, запуск которых должен быть обеспечен демоном (Should run).

Аргументы: Нет.

Опции:

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

baseinfo

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

Выводится следующая информация:

версия антивирусного ядра,

дата и время выпуска используемых вирусных баз,

число доступных вирусных записей,

момент последнего успешного обновления вирусных баз и антивирусного ядра,

момент следующего запланированного автоматического обновления.

Аргументы: Нет.

Опции:

-l [--List] – вывести полный список загруженных файлов вирусных баз и число вирусных записей в каждом файле.

license

Назначение: Вывести на экран информацию об активной лицензии, получить демонстрационную лицензию или ключевой файл для уже зарегистрированной лицензии (например, на сайте компании «Доктор Веб»).

Если не указана ни одна опция, то при использовании лицензии для автономного режима работы выводится следующая информация:

номер лицензии,

дата и время окончания действия лицензии.

Если используется лицензия, выданная сервером централизованной защиты (для работы в режиме централизованной защиты или в мобильном режиме), то выводится соответствующая информация.

Аргументы: Нет.

Опции:

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

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

warning_green

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

Для регистрации серийного номера и для запроса демонстрационного периода требуется подключение к сети Интернет.

Подробнее о лицензировании продуктов компании «Доктор Веб» см. в разделе Лицензирование.