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

Просмотр списка задач

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

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

Где:

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

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

• Name – имя задачи.
• ID – идентификатор задачи.
• Type – тип задачи.
• State – текущее состояние задачи.

Просмотр статуса задачи

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

kics-control [-T] --get-task-state <task ID|name> [--json]

Где:

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

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

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

• Started – задача запущена.
• Starting – задача запускается.
• Stopped – задача остановлена.
• Stopping – задача останавливается.

Задачи типов ODS, ODFIM и InventoryScan могут также находиться в одном из следующих состояний:

• Pausing – приостанавливается.
• Suspended – приостановлена.
• Resuming – возобновляется.

Создание задачи

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

Создавать можно только пользовательские задачи. Предустановленные задачи недоступны для создания.

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

kics-control [-T] --create-task <task name> --type <task type>

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

kics-control [-T] --create-task <task name> --type <task type> [--file <path to file>] [--json]

Где:

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

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

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

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

Удаление задачи

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

Удалять можно только пользовательские задачи. Предустановленные задачи недоступны для удаления.

kics-control [-T] --delete-task <task ID|name>

Где:

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

Запуск задачи

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

Можно запускать все предустановленные и пользовательские задачи, кроме задачи типа License.

kics-control [-T] --start-task <task ID|name> [-W] [--progress]

Где:

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

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

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

Остановка задачи

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

Можно останавливать все предустановленные и пользовательские задачи, кроме задачи типа License.

kics-control [-T] --stop-task <task ID|name> [-W]

Где:

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

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

Приостановка задачи

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

Можно приостановить только задачи типов ODS, ODFIM и InventoryScan.

kics-control [-T] --suspend-task <task ID|name>

Где:

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

Возобновление задачи

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

Можно возобновить только задачи типов ODS, ODFIM и InventoryScan.

kics-control [-T] --resume-task <task ID|name>

Где:

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

Выборочная проверка

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

kics-control [-T] --scan-file <path> [--action <action>]

Где:

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

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

Выборочная проверка контейнера или образа

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

kics-control [-T] --scan-container <ID|name[:tag]>

Где:

<ID|name[:tag]> – имя или идентификатор контейнера или образа. Для проверки нескольких объектов можно использовать маски.