Guía de referencia de API
17 de abril de 2023
ID 211453
Esta guía de referencia de Kaspersky Security Center OpenAPI está diseñada para ayudar en las siguientes tareas:
- Automatización y personalización. Usted puede automatizar tareas que quizás no desee gestionar de forma manual mediante la Consola de administración. También puede implementar escenarios personalizados que aún no sean compatibles con la Consola de administración. Por ejemplo, como administrador, puede utilizar Kaspersky Security Center OpenAPI para crear y ejecutar scripts que faciliten el desarrollo de la estructura de los grupos de administración y la mantengan actualizada.
- Desarrollo a la medida. Por ejemplo, puede desarrollar una Consola de administración alternativa basada en MMC para sus clientes, que permita un conjunto limitado de acciones.
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.
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 "primario/secundario", ejecutar tareas en Kaspersky Security Center, 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:
- 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).
- 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 de Kaspersky Security Center OpenAPI
Muestra
Propósito de la muestra
Escenario
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.
Puede añadir 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 la jerarquía de grupo con una estructura basada en la unidad de Active Directory
Puede sondear la unidad de Active Directory y formar una jerarquía de grupos con los dispositivos descubiertos.
Crear la jerarquía de grupo con una estructura basada en la unidad de Active Directory en caché
Puede formar una jerarquía de los grupos de dispositivos administrados en función de la unidad de Active Directory sondeada anteriormente. Si después del último sonde aparecen nuevos dispositivos en el directorio activo, no se los añade al grupo porque no están en los resultados de sondeo guardados.
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
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.
Puede conectarse al Agente de red en el dispositivo necesario utilizando una pasarela de conexión y luego ejecutar la tarea necesaria.
Creación de subredes IP basadas en el sitio y los servicios de Active Directory
Puede crear una subred IP según la unidad de Active Directory que use.
La muestra inicia el sondeo del rango de IP especificado y elimina las subredes descubiertas para impedir que entren en conflicto con una nueva subred. Por lo tanto, no ejecute esta muestra en la red donde sea importante guardar subredes.
Después de realizar el sondeo, la muestra recurre a Active Directory, examina cada dispositivo en él y crea la subred IP. Para ello, la muestra utiliza las máscaras y las direcciones IP de todos los dispositivos.
Registrar puntos de distribución para dispositivos en un grupo
Puede asignar dispositivos administrados como puntos de distribución (antes conocidos como agentes de actualización).
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.
Enumerar tareas, consultar estadísticas de 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.
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.
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 claves de licencias en uso
Puede crear una cuenta para un trabajo adicional.
Selección de una cuenta para iniciar el Servidor de administración
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
Puede usar la clase SrvView para solicitar información detallada al Servidor de administración de Kaspersky Security Center. Por ejemplo, puede obtener una lista de usuarios utilizando esta muestra.