Справочное руководство API
Справочное руководство по Kaspersky Security Center OpenAPI предназначено для решения следующих задач:
- Автоматизация и настройка. Вы можете автоматизировать задачи, которые, возможно, не хотите выполнять вручную, с помощью Консоли администрирования. Вы также можете использовать собственные сценарии, которые еще не поддерживаются в Консоли администрирования. Например, как администратор вы можете использовать Kaspersky Security Center OpenAPI для создания и запуска сценариев, которые упростят разработку структуры групп администрирования и поддержат ее в актуальном состоянии.
- Пользовательская разработка. Например, вы можете разработать альтернативную Консоль администрирования на основе консоли Microsoft Management Console (MMC) для своих клиентов, которая разрешает ограниченный набор действий.
Вы можете использовать поле поиска в правой части экрана, чтобы найти нужную информацию в справочном руководстве OpenAPI.
Справочное руководство OpenAPI
Примеры сценариев
Справочное руководство по OpenAPI содержит примеры сценариев Python, перечисленные в таблице ниже. Примеры показывают, как вы можете вызывать методы OpenAPI и автоматически выполнять различные задачи по защите вашей сети, например, создавать иерархию "главный/подчиненный", запускать задачи в Kaspersky Security Center или назначать точки распространения. Вы можете запускать примеры как есть или создавать собственные сценарии на их основе.
Чтобы вызвать методы OpenAPI и запустить сценарии:
- Загрузите архив KlAkOAPI.tar.gz. Этот архив включает в себя пакет KlAkOAPI и примеры (их можно скопировать из архива или справочного руководства по OpenAPI). Также архив KlAkOAPI.tar.gz находится в папке установки Kaspersky Security Center Linux.
- Установите пакет KlAkOAPI из архива KlAkOAPI.tar.gz на устройстве, на котором установлен Сервер администрирования.
Вызывать методы OpenAPI, запускать примеры и свои сценарии можно только на устройствах, на которых установлены Сервер администрирования и пакет KlAkOAPI.
Сопоставление пользовательских сценариев и примеров методов Kaspersky Security Center OpenAPI
Пример
Назначение примера
Сценарий
Вы можете извлекать и обрабатывать данные, используя
KlAkParamsструктуру данных. В примере показано, как работать с этой структурой данных.Пример вывода может быть представлен по-разному. Вы можете получить данные для отправки HTTP-метода или использовать их в своем коде.
Вы можете добавить подчиненный Сервер администрирования и установить таким образом отношение иерархии "главный Сервер – подчиненный Сервер". Или вы можете исключить подчиненный Сервер администрирования из иерархии.
Создайте иерархию группы со структурой на основе подразделения Active Directory.
Вы можете выполнить опрос подразделения Active Directory и сформировать иерархию обнаруженных групп устройств.
Создайте иерархию группы со структурой на основе кешированного подразделения Active Directory.
Вы можете сформировать иерархию групп управляемых устройств на основе ранее выполненного опроса подразделения Active Directory. Если новые устройства появляются в Active Directory после последнего опроса, они будут добавлены в группу, так как их нет в сохраненных результатах опроса.
Загрузите файлы списка сетей с помощью шлюза соединения на указанное устройство
Вы можете подключиться к Агенту администрирования на нужном устройстве, используя шлюз соединения, а затем загрузить файл со списком сетей на свой компьютер.
Вы можете подключиться к главному Серверу администрирования, загрузить с него необходимый лицензионный ключ и передать этот ключ на все подчиненные Серверы администрирования, входящие в иерархию.
Вы можете создать разные отчеты. Например, вы можете сгенерировать отчет об эффективных правах пользователя, используя этот пример. В этом отчете представлена информация о правах, которыми обладает пользователь в зависимости от его группы и роли.
Вы можете загрузить отчет в формате HTML, PDF или Excel.
Вы можете подключиться к Агенту администрирования на нужном устройстве, используя шлюз соединения, а затем запустить необходимую задачу.
Создание IP-подсетей на основе сайта и служб Active Directory
Вы можете создать IP-подсеть на основе используемого подразделения Active Directory.
В примере запускается опрос указанного диапазона IP-адресов и удаляются обнаруженные подсети, чтобы избежать их конфликта с новой подсетью. Поэтому не запускайте такой пример в сети, где важно сохранить подсети.
После опроса пример кода обращается к Active Directory, проверяет каждое устройство в нем и создает IP-подсеть. Для этого в примере используются маски и IP-адреса всех устройств.
Вы можете назначить управляемые устройства точками распространения (ранее они назывались "агенты обновлений").
Вы можете выполнять различные действия с группами администрирования. В примере показано, как выполнить следующее:
- Получить идентификатор корневой группы "Управляемые устройства".
- Переместить по иерархии групп.
- Получить полную развернутую иерархию групп с их именами и вложенностью.
Вы можете ознакомиться со следующей информацией:
- Историей выполнения задачи.
- Текущим статусом задачи.
- Количеством задач в разных статусах.
Вы также можете запустить задачу. По умолчанию пример запускает задачу после вывода статистики.
Вы можете создать задачу. Укажите в примере следующие параметры задачи:
- Тип.
- Способ запуска.
- Имя.
- Группа устройств, для которой будет использоваться задача.
По умолчанию в примере создается задача типа "Показать сообщение". Вы можете запустить эту задачу для всех управляемых устройств Сервера администрирования. При необходимости вы можете указать свои параметры задачи.
Вы можете получить список всех активных лицензионных ключей для программ "Лаборатории Касперского", установленных на управляемых устройствах Сервера администрирования. Список содержит подробные сведения о каждом лицензионном ключе, такие как имя, тип или срок действия.
Вы можете создать учетную запись для дальнейшей работы.
Вы можете создать категорию программ с требуемыми параметрами.
Вы можете использовать класс SrvView для запроса подробной информации с Сервера администрирования. Например, вы можете получить список пользователей, используя этот пример.
Программы, взаимодействующие с Kaspersky Security Center через OpenAPI
Некоторые программы взаимодействуют с Kaspersky Security Center через OpenAPI. К таким программам относятся, например, Kaspersky Anti Targeted Attack Platform или Kaspersky Security для виртуальных сред. Это также может быть пользовательская клиентская программа, разработанная вами на основе OpenAPI.
Программы, взаимодействующие с Kaspersky Security Center через OpenAPI, подключаются к Серверу администрирования. Если вы настроили список разрешенных IP-адресов для подключения к Серверу администрирования, добавьте IP-адреса устройств, на которых установлены программы, использующие Kaspersky Security Center OpenAPI. Чтобы узнать, работает ли используемая вами программа с OpenAPI, обратитесь к справке этой программы.
