Guía de referencia de API

Esta guía de referencia de OpenAPI de Kaspersky Security Center está diseñada para ayudar en las siguientes tareas:

• Automatización y personalización. Usted puede automatizar las tareas que no desee gestionar de forma manual. Por ejemplo, como administrador, puede utilizar OpenAPI de Kaspersky Security Center para crear y ejecutar scripts que faciliten el desarrollo de la estructura de los grupos de administración y mantengan dicha estructura actualizada.
• Desarrollo personalizado. Usando OpenAPI, puede desarrollar una aplicación cliente.

Puede usar el campo de búsqueda en la parte derecha de la pantalla para encontrar la información que necesita en la guía de referencia de OpenAPI.

GUÍA DE REFERENCIA DE OPENAPI

Muestras de scripts

La guía de referencia de OpenAPI contiene muestras de los scripts de Python que se enumeran en la siguiente tabla. Los ejemplos muestran cómo puede llamar a métodos OpenAPI y realizar automáticamente varias tareas para proteger su red, por ejemplo, crear una jerarquía "principal/secundario", ejecutar tareas en Kaspersky Security Center Linux, o asignar puntos de distribución. Puede ejecutar los ejemplos o crear sus propios scripts basados en los ejemplos.

Para llamar a los métodos OpenAPI y ejecutar scripts:

1. Descargue el archivo KlAkOAPI.tar.gz. Este archivo incluye el paquete KlAkOAPI y las muestras (puede copiarlas del archivo o de la guía de referencia de OpenAPI). El archivo KlAkOAPI.tar.gz también se encuentra en la carpeta de instalación de Kaspersky Security Center Linux.
2. Instale el paquete KlAkOAPI del archivo KlAkOAPI.tar.gz en un dispositivo donde esté instalado el Servidor de administración.

   Puede llamar a los métodos de OpenAPI, ejecutar las muestras y sus propios scripts solo en dispositivos donde estén instalados el Servidor de administración y el paquete KlAkOAPI.

   Coincidencia entre escenarios de usuario y ejemplos de métodos OpenAPI de Kaspersky Security Center

   Ejemplo	Propuesta del ejemplo	Escenario
   Registro KlAkParams	Puede extraer y procesar datos utilizando la estructura de datos KlAkParams. La muestra indica cómo trabajar con esta estructura de datos. La salida de la muestra se puede presentar de diferentes maneras. Puede obtener los datos para enviar un método HTTP o para usarlo en su código.	Supervisión e informes
   Crear y eliminar una jerarquía "principal/secundario"	Puede agregar un Servidor de administración secundario para establecer una jerarquía "principal/secundario". Alternativamente, puede desconectar de la jerarquía el Servidor de administración secundario.	Crear una jerarquía de Servidores de administración, agregar un Servidor de administración secundario, y eliminar una jerarquía de Servidores de Administración
   Descargar archivos de lista de red a través de la puerta de enlace de conexión al host especificado	Puede conectarse al agente de red en el dispositivo necesario utilizando una pasarela de conexión y luego descargar un archivo con la lista de red a su dispositivo.	Ajuste de puntos de distribución y puertas de enlace de conexión
   Instalar una clave de licencia almacenada en el repositorio del Servidor de administración principal en los servidores de administración secundarios	Puede conectarse al Servidor de administración principal, descargar desde allí la clave de licencia necesaria y transmitirla a todos los Servidores de administración secundarios incluidos en una jerarquía.	Licencias de aplicaciones administradas
   Crear un informe de derechos de usuario efectivos	Puede crear diferentes informes Por ejemplo, puede generar el informe de derechos de usuario efectivos utilizando esta muestra. Este informe describe los derechos que tiene un usuario, dependiendo de su grupo y papel. Puede descargar el informe en formato HTML, PDF o Excel.	Generación y visualización de un informe
   Iniciar la tarea del dispositivo	Puede conectarse al Agente de red en el dispositivo necesario utilizando una pasarela de conexión y luego ejecutar la tarea necesaria.	Iniciar una tarea manualmente
   Registrar puntos de distribución para los dispositivos de un grupo	Puede asignar dispositivos administrados como puntos de distribución (antes conocidos como agentes de actualización).	Actualización de las bases de datos y las aplicaciones de Kaspersky
   Enumerar todos los grupos	Puede realizar varias acciones en los grupos de administración: El ejemplo muestra cómo hacer lo siguiente: Obtener un identificador del grupo raíz "Dispositivos administrados" Moverse a través de la jerarquía de grupo Recuperar la jerarquía completa y ampliada de los grupos, junto con sus nombres y nivel de anidación	Configuración del Servidor de administración
   Enumerar las tareas, consultar las estadísticas de las tareas y ejecutar una tarea	Puede averiguar la siguiente información: Historial de progreso de la tarea. Estado de la tarea actual. Número de tareas en diferentes estados. También puedes ejecutar una tarea. De forma predeterminada, la muestra ejecuta una tarea después de emitir sus estadísticas.	Administración de tareas
   Crear y ejecutar una tarea	Puede crear una tarea. Especifique los siguientes parámetros de la tarea en la muestra: Tipo. Método de ejecución. Nombre. Grupo de dispositivos para el cual se utilizará la tarea. De forma predeterminada, la muestra crea una tarea con el tipo "Mostrar mensaje". Puede ejecutar esta tarea para todos los dispositivos administrados del Servidor de administración. Si es necesario, puede especificar sus propios parámetros de tarea.	Crear una tarea
   Enumerar las claves de licencia	Puede obtener una lista de todas las claves de licencia activas para aplicaciones Kaspersky instaladas en dispositivos administrados de Administration Server. La lista contiene datos detallados sobre cada clave de licencia, como un nombre, tipo o fecha de vencimiento.	Visualización de información sobre las claves de licencia en uso
   Crear y encontrar un usuario interno	Puede crear una cuenta para un trabajo adicional.	Agregar una cuenta de un usuario interno
   Crear una categoría personalizada	Puede crear la categoría de aplicación con los parámetros necesarios.	Creación de una categoría de aplicaciones con contenido agregado manualmente
   Enumerar los usuarios mediante SrvView	Puede usar la clase SrvView para solicitar información detallada al Servidor de administración. Por ejemplo, puede obtener una lista de usuarios utilizando esta muestra.	Administración de usuarios y roles de usuario

Aplicaciones que interactúan con Kaspersky Security Center Linux a través de OpenAPI

Algunas aplicaciones interactúan con Kaspersky Security Center Linux a través de OpenAPI. Ejemplo de ellas son Kaspersky Anti Targeted Attack Platform y Kaspersky Security for Virtualization. También pueden ser aplicaciones cliente personalizadas, desarrolladas por usted para utilizar OpenAPI.

Las aplicaciones que interactúan con Kaspersky Security Center Linux a través de OpenAPI se conectan al Servidor de administración. Si ha configurado un lista de direcciones IP permitidas para conectarse al Servidor de administración, agregue las direcciones IP de los dispositivos donde están instaladas las aplicaciones que utilizan Kaspersky Security Center Linux OpenAPI. Para saber si una aplicación utiliza OpenAPI, consulte la ayuda de esa aplicación.