Справочное руководство API

06 июня 2024

ID 211453

Справочное руководство по Kaspersky Security Center OpenAPI предназначено для решения следующих задач:

  • Автоматизация и настройка. Вы можете автоматизировать задачи, которые, возможно, не хотите выполнять вручную. Например, как администратор вы можете использовать Kaspersky Security Center OpenAPI для создания и запуска сценариев, которые упростят разработку структуры групп администрирования и поддержат ее в актуальном состоянии.
  • Пользовательская разработка. Используя OpenAPI, вы можете разработать клиентскую программу.

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

unloc_icon_API_open Справочное руководство OpenAPI

Примеры сценариев

Справочное руководство по OpenAPI содержит примеры сценариев Python, перечисленные в таблице ниже. Примеры показывают, как вы можете вызывать методы OpenAPI и автоматически выполнять различные задачи по защите вашей сети, например, создавать иерархию "главный/подчиненный", запускать задачи в Kaspersky Security Center Linux или назначать точки распространения. Вы можете запускать примеры как есть или создавать собственные сценарии на их основе.

Чтобы вызвать методы OpenAPI и запустить сценарии:

  1. Загрузите архив KlAkOAPI.tar.gz. Этот архив включает в себя пакет KlAkOAPI и примеры (их можно скопировать из архива или справочного руководства по OpenAPI). Также архив KlAkOAPI.tar.gz находится в папке установки Kaspersky Security Center Linux.
  2. Установите пакет KlAkOAPI из архива KlAkOAPI.tar.gz на устройстве, на котором установлен Сервер администрирования.

    Вызывать методы OpenAPI, запускать примеры и свои сценарии можно только на устройствах, на которых установлены Сервер администрирования и пакет KlAkOAPI.

    Сопоставление пользовательских сценариев и примеров методов Kaspersky Security Center OpenAPI

    Пример

    Назначение примера

    Сценарий

    Журнал событий KlAkParams

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

    Пример вывода может быть представлен по-разному. Вы можете получить данные для отправки HTTP-метода или использовать их в своем коде.

    Мониторинг и отчеты

    Создание и удаление иерархии "главный/подчиненный"

    Вы можете добавить подчиненный Сервер администрирования и установить таким образом отношение иерархии "главный Сервер – подчиненный Сервер". Или вы можете исключить подчиненный Сервер администрирования из иерархии.

    Создание иерархии Серверов администрирования: добавление подчиненного Сервера администрирования и удаление иерархии Серверов администрирования

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

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

    Настройка точек распространения и шлюзов соединений

    Установить лицензионный ключ, хранящийся в хранилище главного Сервера администрирования, на подчиненные Серверы администрирования

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

    Лицензирование управляемых программ

    Создайте отчет об эффективных правах пользователей

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

    Вы можете загрузить отчет в формате HTML, PDF или Excel.

    Генерация и просмотр отчета

    Запустите задачу на устройстве

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

    Запуск задачи вручную

    Регистрация точек распространения для устройств в группе

    Вы можете назначить управляемые устройства точками распространения (ранее они назывались "агенты обновлений").

    Обновление баз и программ "Лаборатории Касперского"

    Перечисление всех групп

     

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

    • Получить идентификатор корневой группы "Управляемые устройства".
    • Переместить по иерархии групп.
    • Получить полную развернутую иерархию групп с их именами и вложенностью.

    Настройка Сервера администрирования

    Перечисление задач, запрос статистики задач и запуск задач

    Вы можете ознакомиться со следующей информацией:

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

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

    Управление задачами

    Создание и запуск задачи

    Вы можете создать задачу. Укажите в примере следующие параметры задачи:

    • Тип.
    • Способ запуска.
    • Имя.
    • Группа устройств, для которой будет использоваться задача.

    По умолчанию в примере создается задача типа "Показать сообщение". Вы можете запустить эту задачу для всех управляемых устройств Сервера администрирования. При необходимости вы можете указать свои параметры задачи.

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

    Перечисление лицензионных ключей

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

    Просмотр информации об используемых лицензионных ключах

    Создание и поиск внутреннего пользователя

    Вы можете создать учетную запись для дальнейшей работы.

    Добавление учетной записи внутреннего пользователя

    Создание пользовательской категории

    Вы можете создать категорию программ с требуемыми параметрами.

    Создание пополняемой вручную категории программ

    Перечисление пользователей с помощью SrvView

    Вы можете использовать класс SrvView для запроса подробной информации с Сервера администрирования. Например, вы можете получить список пользователей, используя этот пример.

    Управление пользователями и ролями пользователей

Программы, взаимодействующие с Kaspersky Security Center Linux через OpenAPI

Некоторые программы взаимодействуют с Kaspersky Security Center Linux через OpenAPI. К таким программам относятся, например, Kaspersky Anti Targeted Attack Platform или Kaspersky Security для виртуальных сред. Это также может быть пользовательская клиентская программа, разработанная вами на основе OpenAPI.

Программы, взаимодействующие с Kaspersky Security Center Linux через OpenAPI, подключаются к Серверу администрирования. Если вы настроили список разрешенных IP-адресов для подключения к Серверу администрирования, добавьте IP-адреса устройств, на которых установлены программы, использующие Kaspersky Security Center Linux OpenAPI. Чтобы узнать, работает ли используемая вами программа с OpenAPI, обратитесь к справке этой программы.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!