Guia de referência de API

5 de abril de 2024

ID 211453

Este guia de referência da OpenAPI do Kaspersky Security Center foi projetado para ajudar nas seguintes tarefas:

  • Automação e personalização. É possível automatizar tarefas que pode não querer tratar manualmente usando o Console de Administração. Você também pode implementar cenários personalizados que ainda não são compatíveis no Console de Administração. Por exemplo, como administrador, é possível usar o Kaspersky Security Center OpenAPI para criar e executar scripts que facilitarão o desenvolvimento da estrutura dos grupos de administração e manterão essa estrutura atualizada.
  • Desenvolvimento personalizado. Por exemplo, é possível desenvolver um Console de Administração baseado em MMC alternativo para seus clientes, que permite um conjunto limitado de ações.

No Guia de referência da OpenAPI, é possível usar o campo de pesquisa à direita da tela para localizar as informações necessárias.

unloc_icon_API_open GUIA DE REFERÊNCIA DA OPENAPI

Exemplos de scripts

O guia de referência do OpenAPI contém exemplos dos scripts Python listados na tabela abaixo. Os exemplos mostram como você pode chamar métodos OpenAPI e realizar automaticamente várias tarefas para proteger sua rede, por exemplo, criar uma hierarquia "principal/secundária", executar tarefas no Kaspersky Security Center ou atribuir pontos de distribuição. Você pode executar as amostras como estão ou criar seus próprios scripts com base nos exemplos.

Para chamar os métodos OpenAPI e executar scripts:

  1. Baixe o arquivo KlAkOAPI.tar.gz. Este arquivo inclui o pacote e exemplos KlAkOAPI (você pode copiá-los do arquivo ou do guia de referência OpenAPI). O arquivo KlAkOAPI.tar.gz também está localizado na pasta de instalação do Kaspersky Security Center.
  2. Instale o pacote KlAkOAPI do arquivo KlAkOAPI.tar.gz em um dispositivo onde o Servidor de Administração está instalado.

    Você poderá chamar os métodos OpenAPI, executar os exemplos e seus próprios scripts somente em dispositivos onde o Servidor de Administração e o pacote KlAkOAPI estiverem instalados.

    Correspondência entre cenários de usuário e exemplos de métodos de OpenAPI do Kaspersky Security Center

    Exemplo

    Objetivo do exemplo

    Cenário

    Log KlAkParams

    É possível extrair e processar dados usando a estrutura de dados KlAkParams. O exemplo mostra como trabalhar com essa estrutura de dados.

    A saída, nesse exemplo, pode estar presente de maneiras diferentes. É possível obter os dados para enviar um método HTTP ou para usar em seu código.

    Monitoramento e relatórios

    Criar e excluir uma hierarquia primária/secundária

    Você pode adicionar um Servidor de Administração secundário e estabelecer uma hierarquia "primária/secundária". Como alternativa, é possível desconectar o Servidor de Administração secundário da hierarquia.

    Criar a hierarquia do grupo com uma estrutura baseada na unidade do Active Directory

    É possível pesquisar a unidade do Active Directory e formar uma hierarquia de grupos de dispositivos descobertos.

    Criação de grupos de administração

    Criar a hierarquia do grupo com uma estrutura baseada na unidade do Active Directory em cache

    É possível formar uma hierarquia dos grupos de dispositivos gerenciados com base na unidade do Active Directory pesquisada anteriormente. Se novos dispositivos aparecerem no Active Directory após a última pesquisa, eles não serão adicionados ao grupo porque não estão nos resultados de pesquisa salvos.

    Criação de grupos de administração

    Baixar arquivos de lista de rede por meio do gateway de conexão para o dispositivo especificado

    É possível conectar o Agente de Rede no dispositivo necessário usando um gateway de conexão e depois baixar um arquivo com a lista de redes no computador.

    Ajuste de pontos de distribuição e gateways de conexão

    Instalar uma chave de licença armazenada no repositório principal do Servidor de Administração nos Servidores de Administração secundários

    É possível se conectar ao Servidor de Administração principal, baixar uma chave de licença necessária a partir dele e transmitir essa chave para todos os Servidores de Administração secundários incluídos em uma hierarquia.

    Licenciamento de aplicativos gerenciados

    Criar um relatório de direitos efetivos do usuário

    É possível criar relatórios diferentes. Por exemplo, é possível gerar o relatório dos direitos efetivos do usuário usando este exemplo. Este relatório descreve os direitos de um usuário, dependendo do seu grupo e função.

    É possível baixar o relatório no formato HTML, PDF ou Excel.

    Como gerar e visualizar um relatório

    Iniciar uma tarefa para um dispositivo

    É possível se conectar ao Agente de Rede no dispositivo necessário usando um gateway de conexão e executar na sequência a tarefa necessária.

    Como iniciar uma tarefa manualmente

    Criar subredes IP com base no site e nos serviços do Active Directory

    É possível criar uma subrede IP com base na unidade do Active Directory usada por você.

    No exemplo, é iniciada a pesquisa do intervalo de IP especificado, excluindo as subredes descobertas para evitar conflito com uma nova subrede. Portanto, não execute as operações desse exemplo em uma rede onde é importante salvar subredes.

    Após a pesquisa, o exemplo é referenciado no Active Directory, examina todos os dispositivos nele e cria a subrede IP. Para tanto, no exemplo são usadas máscaras e endereços IP de todos os dispositivos.

    Configuração da proteção da rede

    Registrar os pontos de distribuição para dispositivos em um grupo

    É possível atribuir dispositivos gerenciados como pontos de distribuição (anteriormente conhecidos como agentes de atualização).

    Atualização dos bancos de dados e dos aplicativos da Kaspersky

    Enumerar todos os grupos

    É possível executar as seguintes ações nos grupos de administração: No exemplo é mostrado como fazer o seguinte:

    • Obtenha um identificador do grupo raiz "Dispositivos gerenciados"
    • Percorra a hierarquia do grupo
    • Recupere a hierarquia completa e expandida de grupos, junto com seus nomes e aninhamento

    Configurando o Servidor de Administração

    Enumerar tarefas, consultar estatísticas de tarefas e executar uma tarefa

    É possível descobrir as seguintes informações:

    • Histórico de progresso da tarefa
    • Status da tarefa atual
    • Número de tarefas em diferentes status

    É possível também executar uma tarefa. Por padrão, a amostra executa uma tarefa depois de gerar estatísticas.

    Monitoramento de execução de tarefa

    Criar e executar uma tarefa

    É possível criar uma tarefa. Especifique os seguintes parâmetros de tarefa no exemplo:

    • Tipo
    • Método de execução
    • Nome
    • Grupo de dispositivos para o qual a tarefa será usada

    Por padrão, no exemplo é criada uma tarefa do tipo "Mostrar mensagem". É possível executar esta tarefa para todos os dispositivos gerenciados do Servidor de Administração. Se necessário, é possível especificar seus próprios parâmetros de tarefa.

    Criar uma tarefa

    Enumerar chaves de licença

    É possível obter uma lista de todas as chaves de licença ativas para os aplicativos Kaspersky instalados em dispositivos gerenciados do Servidor de Administração. A lista contém dados detalhados sobre cada chave de licença, como nome, tipo ou data de expiração.

    Visualizando de informações sobre chaves de licença em uso

    Criar e encontrar um usuário interno

    É possível criar uma conta para trabalhos futuros.

    Selecionar a conta para iniciar o Servidor de Administração

    Criar uma categoria personalizada

    É possível criar a categoria do aplicativo com os parâmetros necessários.

    Criar uma categoria de aplicativos com conteúdo adicionado manualmente

    Enumerar usuários usando SrvView

    É possível usar a classe SrvView para solicitar informações detalhadas do Servidor de Administração. Por exemplo, é possível obter uma lista de usuários usando este exemplo.

    Como gerenciar contas de usuário

Aplicativos que interagem com o Kaspersky Security Center via OpenAPI

Alguns aplicativos interagem com o Kaspersky Security Center via OpenAPI. Esses aplicativos incluem, por exemplo, Kaspersky Anti Targeted Attack Platform ou Kaspersky Security for Virtualization. Também pode ser um aplicativo cliente personalizado, desenvolvido por terceiros, baseado em OpenAPI.

Os aplicativos que interagem com o Kaspersky Security Center via OpenAPI conectam-se ao Servidor de Administração. Caso tenha configurado uma lista de permissão de endereços IP para se conectar ao Servidor de Administração, adicione os endereços IP de dispositivos nos quais os aplicativos que usam o Kaspersky Security Center OpenAPI estão instalados. Para saber se o aplicativo usado funciona por OpenAPI, consulte a Ajuda do aplicativo.

Este artigo foi útil?
O que podemos melhorar?
Agradecemos o seu comentário! Ele nos ajuda a melhorar.
Agradecemos o seu comentário! Ele nos ajuda a melhorar.