Configurando Integrações

Integrações do PanOps Terminal

Atualmente o PanOps Terminal dispõe de dois tipos de integrações:

Baseada em API
Baseada em Query Parameters

Integração Baseada em API

API Customizada

As informações necessárias para realizar o preenchimento do formulário de conexão podem estar espalhadas em diversas ferramentas, pensando nisso o PanOps Terminal é capaz de realizar chamadas em uma API criada pelo cliente através do método GET e autenticação do tipo BASIC.

Os parâmetros digitados pelo usuário que preencheu o formulário são enviados através do query parameters search para sua API customizada:

GET https://api.company.com/?search=server1

HEADERS
Authorization: Basic abcdefghijklmnopqrstuvxywz1234567890=

E o resultado esperado é um array com os objetos que serão exibidos para seleção:

[
    {
        "name": "Server_1",
        "username": "support",
        "password": "rjq6tFK_enmFvhN",
        "port": 22,
        "hostname": "183.232.11.141",
        "protocol": "ssh"
    },
    {
        "name": "Server_10",
        "username": "Administrator",
        "password": "rjq6tFK_enmFvhN",
        "port": 389,
        "domain": "company.com",
        "hostname": "183.232.11.121",
        "protocol": "rdp"
    }
]

Onde os campos do objeto são:

name - Nome visualizado pelo usuário para seleção.
hostname - Valor que será utilizado no campo IP/Hostname.
username - Valor que será utilizado no campo Usuário.
password - Valor que será utilizado no campo Senha.
port - Valor que será utilizado no campo Porta.
protocol - Valor que será utilizado no campo Protocolo.
domain - Valor que será utilizado no campo domínio em caso de protocolo RDP.

Para realizar a configuração desse tipo de integração, acesse CONFIGURAÇÃO > SERVIDORES DE ACESSO e clique em editar no servidor desejado:

Em seguida vá em ATIVAR INTEGRAÇÃO selecione e altere o valor de "Tipo de Integração" para "Customizada" e preencha as informações necessárias:

URL da API - Endereço da API Zabbix que será utilizado pela integração.
Usuário da API - Usuário que será utilizado para buscar informações.
Senha da API - Senha do usuário da API utilizado.

API do Zabbix 5.x

O PanOps Terminal pode utilizar a base de cadastro de hosts do Zabbix para preencher as informações necessárias para conexão em um equipamento. Para isso basta realizar a integração entre a API do Zabbix e o servidor de acesso aos equipamentos gerenciados pelo Zabbix.

Para isso acesso o menu CONFIGURAÇÃO > SERVIDORES DE ACESSO e clique em Editar o servidor desejado:

Em seguida vá em ATIVAR INTEGRAÇÃO selecione e altere o valor de "Tipo de Integração" para "Zabbix" e preencha as informações necessárias:

URL da API - Endereço da API Zabbix que será utilizado pela integração
Usuário da API - Usuário que será utilizado para buscar informações
Senha da API - Senha do usuário da API utilizado.

Importante!

Recomendamos que seja utilizado um usuário permissões do tipo read-only na integração.

Importante!

É possível utilizar o mesmo Zabbix para integração com diversos servidores de acesso.

Macros do Zabbix

As seguintes macros podem ser configuradas para trazer maiores informações para o formulário de nova sessão:

{$PANOPS_USERNAME} - Usuário de conexão com equipamento.
{$PANOPS_PASSWORD} - Senha do usuário de conexão com equipamento.
{$PANOPS_PROTOCOL} - Protocolo utilizado, apenas os valores: ssh, telnet, rdp ou vnc.
{$PANOPS_PORT} - Porta de conexão com equipamento
{$PANOPS_DOMAIN} - Domínio para conexão via RDP.

Importante!

Macros devem ser atribuídas aos hosts ou a templates ligados diretamente aos hosts. Caso uma macro seja inserida em um template e esse seja ligado a outro template, o host herdará a macro porém a integração não será capaz de buscar essas informações.

Integração com PostgreSQL

A PanOps Solutions também oferece uma solução baseada em integração com PostgreSQL, na qual disponibilizamos uma API customizada de consulta com suporte a autenticação do tipo BASIC, e argumentos passados via request parameter.

O parâmetro disponível para isso é:

Exemplo:

GET https://localhost.com:8088?search=server1

HEADERS
Authorization: Basic abcdefghijklmnopqrstuvxywz1234567890=

Para realizar a instalação da solução se faz necessário rodar o comando docker com os seguintes parâmetros:

$ docker run \
  -d \
  -e API_USER= Usuário da API \
  -e API_PASSWORD= Senha usuário da API \
  -e PSQL_USER= Usuário do PostgreSQL \
  -e PSQL_PASSWORD= Senha do usuário do PostgreSQL \
  -e PSQL_HOST= Endereço/Nome do Host \
  -e PSQL_PORT= Porta do PostgreSQL \
  -e PSQL_DATABASE= Nome da base do Banco de dados
  -p 8088:8000 \
  --name zabbix-db-psql \
  --restart=always \
  panops/zabbix-db-psql

Importante!

Caso deseje customizar a porta da API para seu ambiente, troque o parâmetro -p 8088:8000 para -p {PORT}:8000, onde deve ser uma porta livre no servidor

No primeiro acesso, caso API_USER e API_PASSWORD não estejam na base de dados, é feito a criação automática do usuário da API.

Importante!

Caso uma Macro tenha sido definida no template ligado ao host e no próprio host, a API será capaz de buscar essas informações, e irá prevalecer no resultado a Macro que foi definida no host.

Integração Baseada em Query Parameters

É possível preencher os campos e iniciar uma nova sessão passando as informações diretamente através do URL do PanOps Terminal.

Os parâmetros disponíveis para isso são:

host
port
proto
user
password
domain
server
connect

O parâmetro server deve possuir o ID de um servidor que o usuário logado tem acesso. O valor pode ser verificado por um administrador em CONFIGURAÇÃO > SERVIDORES DE ACESSO na coluna "Server ID" conforme imagem abaixo:

O parâmetro connect deve ter apenas o valor 'true' para que a sessão seja conectada automáticamente.

Exemplo:

https://terminal.panops.com.br/?server=5e09da1c-d7b0-4e68-8d4f-f92ecd410062&host=192.168.0.1&user=panops&password=panops&proto=ssh&port=22&connect=true

Módulo Zabbix - PanOps Terminal

A versão 5.x do Zabbix permite a utilização de módulos customizados em seu FrontEnd. Dessa forma os usuários do Zabbix podem utilizar o PanOps Terminal para verificar o funcionamento dos seus equipamentos diretamente da interface do Zabbix.

Para ter acesso a essa funcionalidade basta seguir os passos abaixo:

Clique aqui para fazer o download do módulo do Zabbix 5.0