Приложение 2. Команды управления Kaspersky

Управление приложением Kaspersky в командной строке выполняется с помощью команд управления.

Вы можете посмотреть справку по командам управления приложением с помощью команды:

kfl-control --help <префикс группы команд>

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

• -B – команды управления резервным хранилищем.
• -E – команды управления событиями приложения.
• -J – команды управления сбором метрик о состоянии операционной системы.
• -L – команды управления лицензионными ключами.
• -N – команды управления параметрами проверки защищенных соединений.
• -S – команды статистики.
• -T – команды управления задачами и параметрами приложения.
• -U – команды управления пользователями и ролями пользователей.
• -W – команды вывода событий.

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

-T – префикс, указывающий, что команда принадлежит к группе команд управления параметрами и задачами приложения.

-N – префикс, указывающий, что команда принадлежит к группе команд управления параметрами проверки защищенных соединений.

Команда kfl-control --export-settings

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

Синтаксис команды

kfl-control [-T] --export-settings [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

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

--json – выводить параметры в формате JSON. Если вы не укажете ключ --json, параметры будут выведены в формате INI.

Команда kfl-control --import-settings

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

Синтаксис команды

kfl-control [-T] --import-settings --file <путь к конфигурационному файлу> [--json]

Аргументы и ключи

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

--json – импортировать параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

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

Команда kfl-control --get-app-settings

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

Синтаксис команды

kfl-control [-T] --get-app-settings [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

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

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

--json – выводить параметры в формате JSON. Если вы не укажете ключ --json, параметры будут выведены в формате INI.

Команда kfl-control --set-app-settings

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

Синтаксис команды

Задать параметры с помощью ключей команды:

kfl-control [-T] --set-app-settings <имя параметра>=<значение параметра> [<имя параметра>=<значение параметра>]

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

kfl-control [-T] --set-app-settings --file <путь к конфигурационному файлу> [--json]

Аргументы и ключи

<имя параметра>=<значение параметра> – имя и значение одного из общих параметров приложения.

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

--json – импортировать в приложение параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

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

Команда kfl-control --get-settings

Команда позволяет вывести в консоль или в конфигурационный файл текущие значения параметров указанной задачи.

Синтаксис команды

kfl-control [-T] --get-settings <идентификатор/имя задачи> [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

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

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

--json – выводить параметры в формате JSON. Если вы не укажете ключ --json, параметры будут выведены в формате INI.

Команда kfl-control --set-settings

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

Синтаксис команды

Задать параметры с помощью ключей команды:

kfl-control [-T] --set-settings <идентификатор/имя задачи> <имя параметра>=<значение параметра> [<имя параметра>=<значение параметра>] [--add-path <путь>] [--del-path <путь>] [--add-exclusion <путь>] [--del-exclusion <путь>]

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

kfl-control [-T] --set-settings <идентификатор/имя задачи> --file <путь к конфигурационному файлу> [--json]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

<имя параметра>=<значение параметра> – имя и значение одного из параметров задачи.

--add-path <путь> – добавить путь к директории с проверяемыми объектами.

--del-path <путь> – удалить путь к директории с проверяемыми объектами.

--add-exclusion <путь> – добавить путь к директории с объектами, которые нужно исключить из проверки.

--del-exclusion <путь> – удалить путь к директории с исключаемыми объектами.

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

--json – импортировать параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

Команда kfl-control --set-to-default

Команда позволяет восстановить значения по умолчанию для параметров указанной задачи.

Синтаксис команды

kfl-control [-T] --set-settings <идентификатор/имя задачи> --set-to-default

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

Команда kfl-control --get-schedule

Команда позволяет вывести в консоль или в конфигурационный файл текущее расписание запуска указанной задачи.

Синтаксис команды

kfl-control [-T] --get-schedule <идентификатор/имя задачи> [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

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

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

--json – выводить параметры в формате JSON. Если вы не укажете ключ --json, параметры будут выведены в формате INI.

Команда kfl-control --set-schedule

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

Синтаксис команды

Задать параметры с помощью ключей команды:

kfl-control [-T] --set-schedule <идентификатор/имя задачи> <имя параметра>=<значение параметра> [<имя параметра>=<значение параметра>]

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

kfl-control [-T] --set-schedule <идентификатор/имя задачи> --file <путь к конфигурационному файлу> [--json]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

<имя параметра>=<значение параметра> – имя и значение одного из параметров расписания задач.

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

--json – импортировать параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

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

Команда kfl-control --get-task-list

Команда позволяет вывести список существующих задач приложения.

Синтаксис команды

kfl-control [-T] --get-task-list [--json]

Аргументы и ключи

--json – выводить параметры в формате JSON.

Команда kfl-control --get-task-state

Команда позволяет вывести состояние указанной задачи.

Синтаксис команды

kfl-control [-T] --get-task-state <идентификатор/имя задачи> [--json]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

--json – выводить параметры в формате JSON.

Команда kfl-control --create-task

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

Синтаксис команды

Создать задачу с параметрами по умолчанию:

kfl-control [-T] --create-task <имя задачи> --type <тип задачи>

Создать задачу с параметрами из конфигурационного файла:

kfl-control [-T] --create-task <имя задачи> --type <тип задачи> [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

<имя задачи> – имя, которое вы задаете для новой задачи.

<тип задачи> – обозначение типа создаваемой задачи.

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

--json – импортировать параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

Команда kfl-control --delete-task

Команда позволяет удалить задачу.

Синтаксис команды

kfl-control [-T] --delete-task <идентификатор/имя задачи>

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

Команда kfl-control --start-task

Команда позволяет запустить задачу.

Синтаксис команды

kfl-control [-T] --start-task <идентификатор/имя задачи> [-W] [--progress]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

[-W] – включить вывод текущих событий.

[--progress] – отображать ход выполнения задачи.

Команда kfl-control --stop-task

Команда позволяет остановить задачу.

Синтаксис команды

kfl-control [-T] --stop-task <идентификатор/имя задачи> [-W]

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

[-W] – включить вывод текущих событий.

Команда kfl-control --suspend-task

Команда позволяет приостановить задачу.

Синтаксис команды

kfl-control [-T] --suspend-task <идентификатор/имя задачи>

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

Команда kfl-control --resume-task

Команда позволяет возобновить выполнение задачи.

Синтаксис команды

kfl-control [-T] --resume-task <идентификатор/имя задачи>

Аргументы и ключи

<идентификатор/имя задачи> – идентификатор, присвоенный задаче в момент создания, или имя задачи в командной строке.

Команда kfl-control --scan-file

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

Синтаксис команды

kfl-control [-T] --scan-file <путь> [--action <действие>]

Аргументы и ключи

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

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

Команды управления параметрами проверки защищенных соединений

-N – префикс, указывающий, что команда принадлежит к группе команд управления параметрами проверки защищенных соединений.

Команда kfl-control -N --query

Команда позволяет выводить списки исключений из проверки защищенных соединений:

• список исключений, добавленных пользователем;
• список исключений, добавленных приложением;
• список исключений, полученных из баз приложения.

Синтаксис команды

kfl-control -N --query user

kfl-control -N --query auto

kfl-control -N --query kl

Команда kfl-control --clear-web-auto-excluded

Команда позволяет очистить список доменов, которые приложение автоматически исключило из проверки.

Синтаксис команды

kfl-control -N --clear-web-auto-excluded

Команда kfl-control --get-net-settings

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

Синтаксис команды

kfl-control [-N] --get-net-settings [--file <путь к конфигурационному файлу>] [--json]

Аргументы и ключи

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

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

--json – выводить параметры в формате JSON. Если вы не укажете ключ --json, параметры будут выведены в формате INI.

Команда kfl-control --set-net-settings

Команда позволяет устанавливать значения параметров проверки защищенных соединений с помощью ключей команды или путем импорта параметров из указанного конфигурационного файла.

Синтаксис команды

Задать параметры с помощью ключей команды:

kfl-control [-N] --set-net-settings <имя параметра>=<значение параметра> [<имя параметра>=<значение параметра>]

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

kfl-control [-N] --set-net-settings --file <путь к конфигурационному файлу> [--json]

Аргументы и ключи

<имя параметра>=<значение параметра> – имя и значение одного из параметров проверки защищенных соединений.

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

--json – импортировать в приложение параметры из конфигурационного файла формата JSON. Если вы не укажете ключ --json, приложение попытается выполнить импорт из файла формата INI. При невозможности импорта отображается ошибка.

Команда kfl-control --list-certificates

Команда позволяет вывести список доверенных корневых сертификатов.

Синтаксис команды

kfl-control [-N] --list-certificates

Команда kfl-control --add-certificate

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

Синтаксис команды

kfl-control [-N] --add-certificate <путь к сертификату>

Аргументы и ключи

<путь к сертификату> – путь к файлу сертификата, который вы хотите добавить, в формате PEM или DER.

Команда kfl-control --remove-certificate

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

Синтаксис команды

kfl-control [-N] --remove-certificate <субъект сертификата>

Команды статистики

-S – префикс указывающий, что команда принадлежит к группе команд статистики.

Команда kfl-control --app-info

Команда позволяет вывести информацию о приложении.

Синтаксис команды

kfl-control [-S] --app-info [--json]

Аргументы и ключи

--json – выводить параметры в формате JSON.

Команда kfl-control --omsinfo

Команда позволяет создать файл формата JSON для интеграции с Microsoft Operations Management Suite.

Синтаксис команды

kfl-control [-S] --omsinfo --file <путь к файлу>

Команды вывода событий

Команда kfl-control -W

Команда включает вывод текущих событий приложения. Команда возвращает название события и дополнительную информацию о событии. Вы можете использовать команду для вывода всех текущих событий приложения или только событий, связанных с запущенной задачей.

Синтаксис команды

kfl-control -W [--query "<условия фильтра>"]

Аргументы и ключи

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

Команды управления событиями приложения

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

Команда kfl-control -E

Команда позволяет вывести информацию обо всех событиях из журнала событий приложения. С помощью утилиты less вы можете перемещаться по списку отображаемых событий.

Синтаксис команды

kfl-control -E

Команда kfl-control -E --query

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

Синтаксис команды

kfl-control -E --query "<условия фильтра>" [--db <файл базы данных>] [-n <количество>] [--file <путь к файлу>] [--json] [--reverse]

Аргументы и ключи

<файл базы данных> – полный путь к файлу базы данных журнала событий, из которого вы хотите вывести события. По умолчанию приложение сохраняет информацию о событиях в базе данных /var/opt/kaspersky/kfl/private/storage/events.db. Расположение базы данных определяется общим параметром приложения EventsStoragePath.

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

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

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

Если вы не укажете ключ --file, список событий будет выведен в консоль.

--json – выводить события в формате JSON.

--reverse – выводить события в обратном порядке (от самого нового события наверху к более старым внизу).

Команды управления лицензионными ключами

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

Команда kfl-control --add-active-key

Команда позволяет добавить в приложение активный лицензионный ключ.

Синтаксис команды

kfl-control [-L] --add-active-key <код активации>

Аргументы и ключи

<код активации> – код активации.

Команда kfl-control --add-reserve-key

Команда позволяет добавить в приложение резервный лицензионный ключ.

Если активный ключ еще не добавлен в приложение на устройстве, команда завершается с ошибкой.

Синтаксис команды

kfl-control [-L] --add-reserve-key <код активации>

Аргументы и ключи

<код активации> – код активации.

Команда kfl-control --remove-active-key

Команда позволяет удалить активный лицензионный ключ.

Синтаксис команды

kfl-control [-L] --remove-active-key

Команда kfl-control --remove-reserve-key

Команда позволяет удалить резервный лицензионный ключ.

Синтаксис команды

kfl-control [-L] --remove-reserve-key

Команда kfl-control -L --query

Команда -L --query позволяет вывести информацию о лицензии, по которой активировано приложение, и об используемом лицензионном ключе.

Синтаксис команды

kfl-control -L --query [--json]

Аргументы и ключи

--json – выводить данные в формате JSON.

Команды управления резервным хранилищем

-B – префикс, указывающий, что команда принадлежит к группе команд управления резервным хранилищем.

Команда kfl-control --mass-remove

Команда позволяет удалить из резервного хранилища все или только указанные объекты.

Синтаксис команды

Удалить все объекты:

kfl-control [-B] --mass-remove

Удалить объекты, соответствующие условиям фильтра:

kfl-control [-B] --mass-remove --query "<условия фильтра>"

Аргументы и ключи

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

Команда kfl-control -B --query

Команда позволяет вывести информацию об объектах резервного хранилища.

Синтаксис команды

Вывести информацию обо всех объектах резервного хранилища:

kfl-control -B --query [-n <количество>] [--json] [--reverse]

Вывести информацию об объектах резервного хранилища, соответствующих условиям фильтра:

kfl-control -B --query ["<условия фильтра>"] [-n <количество>] [--json] [--reverse]

Аргументы и ключи

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

<количество> – количество последних объектов из хранилища, которые нужно вывести. Если вы не укажете ключ -n, будут выведены последние 30 объектов. Чтобы показать все объекты, укажите значение 0.

--json – выводить данные в формате JSON.

--reverse – выводить объекты в обратном порядке (от самого нового объекта наверху к более старым внизу).

Команда kfl-control --restore

Команда позволяет восстановить объект из резервного хранилища.

Синтаксис команды

kfl-control [-B] --restore <идентификатор объекта> [--file <путь к файлу>]

Аргументы и ключи

<идентификатор объекта> – идентификатор объекта в резервном хранилище.

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

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

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

Команда kfl-control --get-user-list

Команда позволяет вывести список пользователей и ролей.

Синтаксис команды

kfl-control [-U] --get-user-list

Команда kfl-control --grant-role

Команда позволяет присвоить роль определенному пользователю.

Синтаксис команды

kfl-control [-U] --grant-role <роль> <пользователь>

Команда kfl-control --revoke-role

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

Синтаксис команды

kfl-control [-U] --revoke-role <роль> <пользователь>

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

Команда kfl-control --export-metrics

Команда позволяет настроить сбор метрик о состоянии операционной системы.

Синтаксис команды

kfl-control [-J] --export-metrics [--period <интервал времени между выводами в секундах>|--interactive]

Аргументы и ключи

--period – периодический вывод результатов в командную строку;

<интервал времени между выводами в секундах> – интервал времени между выводами результатов команды в командную строку (в секундах);

--interactive – интерактивный вывод (по нажатию клавиши Enter).