1 Agente Zabbix 2

O agent Zabbix 2 oferece suporte a todas as chaves de item suportadas para o agent Zabbix em Unix e Windows. Esta página fornece detalhes sobre as chaves de item adicionais, que você pode usar apenas com o agent Zabbix 2, agrupadas pelo plugin ao qual pertencem.

As chaves de item são listadas sem parâmetros e informações adicionais. Clique na chave de item para ver todos os detalhes.

Veja também:

• Plugins embutidos
• Plugins carregáveis

Detalhes da chave do item

Parâmetros sem colchetes angulares são obrigatórios. Parâmetros marcados com colchetes angulares < > são opcionais.

ceph.df.details[connString,<user>,<apikey>]

O uso de dados do cluster e a distribuição entre pools.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.osd.stats[connString,<user>,<apikey>]

Estatísticas agregadas e por OSD.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.osd.discovery[connString,<user>,<apikey>]

A lista de OSDs descobertos. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.osd.dump[connString,<user>,<apikey>]

Os limites de uso e status dos OSDs.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.ping[connString,<user>,<apikey>]

Testa se uma conexão com o Ceph pode ser estabelecida.
Valor de retorno: 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo problemas de AUTENTICAÇÃO e configuração); 1 - a conexão foi bem-sucedida.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.pool.discovery[connString,<user>,<apikey>]

A lista de pools descobertos. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

ceph.status[connString,<user>,<apikey>]

O status geral do cluster.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, apikey - o nome de usuário e a chave de API para conectar ao Ceph.
  

docker.container_info[<ID>,<info>]

Informações de baixo nível sobre um container.
Valor de retorno: A saída da chamada de API ContainerInspect serializada como JSON.

Parâmetros:

• ID - o ID ou nome do container;
  
• info - a quantidade de informações retornadas. Valores suportados: short (padrão) ou full.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.container_stats[<ID>]

As estatísticas de uso de recursos do container.
Valor de retorno: A saída da chamada de API ContainerStats e a porcentagem de uso da CPU serializada como JSON.

Parâmetro:

• ID - o ID ou nome do container.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.containers

A lista de containers.
Valor de retorno: A saída da chamada da API ContainerList serializada como JSON.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.containers.discovery[<options>]

Retorna a lista de containers. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetro:

• options - especifica se todos os containers ou apenas os em execução devem ser descobertos. Valores suportados: true - retorna todos os containers; false - retorna apenas os containers em execução (padrão).

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.data.usage

Informações sobre o uso atual de dados.
Valor de retorno: A saída da chamada de API SystemDataUsage serializada como JSON.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.images

Retorna a lista de imagens.
Valor de retorno: A saída da chamada de API ImageList serializada como JSON.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.images.discovery

Retorna a lista de imagens. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.info

As informações do sistema.
Valor de retorno: A saída da chamada de API SystemInfo serializada como JSON.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

docker.ping

Testa se o daemon do Docker está ativo ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada.

O usuário do Agent 2 ('zabbix') deve ser adicionado ao grupo 'docker' para privilégios suficientes. Caso contrário, a verificação falhará.

ember.get[<uri>,<path>]

Retorna o resultado do dispositivo solicitado.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - URI do dispositivo Ember+. Padrão: 127.0.0.1:9998;
  
• path - Caminho OID para o dispositivo. Vazio por padrão, retorna os dados da coleção raiz.
  

memcached.ping[connString,<user>,<password>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do Memcached.
  

memcached.stats[connString,<user>,<password>,<type>]

Obtém a saída do comando STATS.
Valor de retorno: JSON - a saída é serializada como JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do Memcached;
  
• type - tipo de estatística a ser retornada: items, sizes, slabs ou settings (vazio por padrão, retorna estatísticas gerais).

mongodb.collection.stats[connString,<user>,<password>,<database>,collection]

Retorna várias estatísticas de armazenamento para uma determinada coleção.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB;
  
• database - o nome do banco de dados (padrão: admin);
  
• collection - o nome da coleção.

mongodb.collections.discovery[connString,<user>,<password>]

Retorna uma lista de coleções descobertas. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.collections.usage[connString,<user>,<password>]

Retorna as estatísticas de uso para as coleções.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.connpool.stats[connString,<user>,<password>]

Retorna informações sobre as conexões de saída abertas da instância de banco de dados atual para outros membros do cluster sharded ou do conjunto de réplicas.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.

mongodb.db.stats[connString,<user>,<password>,<database>]

Retorna as estatísticas que refletem o estado do sistema do banco de dados especificado.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB;
  
• database - o nome do banco de dados (padrão: admin).
  

mongodb.db.discovery[connString,<user>,<password>]

Retorna uma lista de bancos de dados descobertos. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.jumbo_chunks.count[connString,<user>,<password>]

Retorna a contagem de jumbo chunks.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.oplog.stats[connString,<user>,<password>]

Retorna o status do conjunto de réplicas, usando dados coletados do oplog.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.ping[connString,<user>,<password>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo problemas de AUTENTICAÇÃO e configuração).

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.rs.config[connString,<user>,<password>]

Retorna a configuração atual do conjunto de réplicas.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.rs.status[connString,<user>,<password>]

Retorna o status do replica set do ponto de vista do membro onde o método é executado.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.server.status[connString,<user>,<password>]

Retorna o estado do banco de dados.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.sh.discovery[connString,<user>,<password>]

Retorna a lista de shards descobertos presentes no cluster.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mongodb.version[connString,<user>,<password>]

Retorna a versão do servidor de banco de dados.
Valor de retorno: String.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

mqtt.get[<broker url>,topic,<user>,<password>]

Assina um tópico específico ou tópicos (com curingas) do broker fornecido e aguarda publicações.
Valor de retorno: Dependendo do conteúdo do tópico. Se curingas forem usados, retorna o conteúdo do tópico como JSON.

Parâmetros:

• broker url - a URL do broker MQTT no formato protocol://host:port sem parâmetros de consulta (protocolos suportados: tcp, ssl, ws). Se nenhum valor for especificado, o agent usará tcp://localhost:1883. Se um protocolo ou porta forem omitidos, o protocolo padrão (tcp) ou porta (1883) serão usados;
  
• topic - o tópico MQTT (obrigatório). Curingas (+,#) são suportados;
  
• user, password - as credenciais de autenticação (se necessário).
  

Comentários:

• O item deve ser configurado como uma verificação ativa (tipo de item 'Zabbix agent (active)');
• Certificados de criptografia TLS podem ser usados salvando-os em um local padrão (por exemplo, diretório /etc/ssl/certs/ para Ubuntu). Para TLS, use o esquema tls://.

mssql.availability.group.get[URI,<user>,<password>]

Retorna grupos de disponibilidade.
Valor de retorno: objeto JSON.

Parâmetros:

• URI - URI do servidor MSSQL (o único esquema suportado é sqlserver://). Credenciais embutidas serão ignoradas. Desde o Zabbix 7.0.6, é possível especificar um nome de instância como parte da URI, ou seja: sqlserver://localhost/InstanceName (sem porta). Se a porta for especificada, o nome da instância será ignorado;
  
• user, password - nome de usuário, senha para enviar ao servidor MSSQL protegido.
  

Para mais informações, consulte o readme do plugin MSSQL.

mssql.custom.query[URI,<user>,<password>,queryName,<args...>]

Retorna o resultado de uma consulta personalizada.
Valor de retorno: objeto JSON.

Parâmetros:

• URI - URI do servidor MSSQL (o único esquema suportado é sqlserver://). Credenciais embutidas serão ignoradas. Desde o Zabbix 7.0.6, é possível especificar um nome de instância como parte da URI, ou seja: sqlserver://localhost/InstanceName (sem porta). Se a porta for especificada, o nome da instância será ignorado;
  
• user, password - nome de usuário, senha para enviar ao servidor MSSQL protegido;
  
• queryName - nome de uma consulta personalizada configurada em Plugins.MSSQL.CustomQueriesDir sem a extensão .sql;
  
• args - um ou vários argumentos separados por vírgula para passar para a consulta.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.db.get

Retorna todos os bancos de dados MSSQL disponíveis.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.job.status.get

Retorna o status dos jobs.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.last.backup.get

Retorna o horário do último backup de todos os bancos de dados.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.local.db.get

Retorna bancos de dados que estão participando de um grupo de disponibilidade Always On e réplica (primária ou secundária) e estão localizados no servidor ao qual a conexão foi estabelecida.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.mirroring.get

Retorna informações de espelhamento.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.nonlocal.db.get

Retorna bancos de dados que estão participando de um grupo de disponibilidade Always On e réplica (primária ou secundária) localizada em outros servidores (o banco de dados não é local para a instância do SQL Server à qual a conexão foi estabelecida).
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.perfcounter.get

Retorna os contadores de desempenho.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.ping

Ping no banco de dados. Teste se a conexão está corretamente configurada.
Valor de retorno: 1 - ativo, 0 - inativo.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.quorum.get

Retorna as informações do quorum.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.quorum.member.get

Retorna os membros do quorum.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.replica.get

Retorna as réplicas.
Valor de retorno: objeto JSON.

Para mais informações, consulte o readme do plugin MSSQL.

mssql.version

Retorna a versão do MSSQL.
Valor de retorno: String.

Para mais informações, consulte o readme do plugin MSSQL.

mysql.custom.query[connString,<user>,<password>,queryName,<args...>]

Retorna o resultado de uma consulta personalizada.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - URI ou nome da sessão;
  
• user, password - credenciais de login do MySQL;
  
• queryName - nome de uma consulta personalizada, deve corresponder ao nome do arquivo SQL sem extensão;
  
• args - um ou vários argumentos separados por vírgula para passar para a consulta.

Para mais informações, consulte o readme do plugin MySQL, seção Consultas personalizadas.

mysql.db.discovery[connString,<user>,<password>]

Retorna a lista de bancos de dados MySQL. Usado para descoberta de baixo nível.
Valor de retorno: O resultado da consulta SQL "show databases" no formato JSON LLD.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

mysql.db.size[connString,<user>,<password>,<database name>]

O tamanho do banco de dados em bytes.
Valor de retorno: Resultado da consulta SQL "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" para um banco de dados específico em bytes.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL;
  
• database name - o nome do banco de dados.

mysql.get_status_variables[connString,<user>,<password>]

Valores das variáveis de status globais.
Valor de retorno: Resultado da consulta SQL "show global status" em formato JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

mysql.ping[connString,<user>,<password>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo problemas de AUTENTICAÇÃO e configuração).

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

mysql.replication.discovery[connString,<user>,<password>]

Retorna a lista de replicações do MySQL. Usado para descoberta de baixo nível.
Valor de retorno: o resultado da consulta SQL SHOW SLAVE STATUS ou SHOW REPLICA STATUS no formato JSON LLD.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]

O status da replicação.
Valor de retorno: resultado da consulta SQL SHOW SLAVE STATUS ou SHOW REPLICA STATUS em formato JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL;
  
• master host - o nome do host mestre de replicação. Se nenhum for encontrado, um erro é retornado. Se este parâmetro não for especificado, todos os hosts serão retornados.
  

mysql.version[connString,<user>,<password>]

A versão do MySQL.
Valor de retorno: String (com a versão da instância do MySQL).

Parâmetros:

• connString - o URI ou nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

net.dns.get[<ip>,name,<type>,<timeout>,<count>,<protocol>,"<flags>"]

Executa uma consulta DNS e retorna informações detalhadas do registro DNS.
Este item é uma versão estendida do item de agent Zabbix net.dns.record com mais tipos de registros e flags personalizáveis suportadas.
Valores de retorno: objeto JSON

Parâmetros:

• ip - o endereço IP do servidor DNS (deixe em branco para o servidor DNS padrão);
• name - o nome DNS a ser consultado;
• type - o tipo de registro a ser consultado (o padrão é SOA);
• timeout - o tempo limite para a solicitação em segundos (o padrão é 1 segundo);
• count - o número de tentativas para a solicitação (o padrão é 2);
• protocol - o protocolo usado para executar consultas DNS: udp (padrão) ou tcp;
• flags - um ou mais argumentos separados por vírgula para passar para uma consulta.

Comentários:

• Os valores possíveis para type são: A, NS, MD, MF, CNAME, SOA, MB, MG, MR, NULL, PTR, HINFO, MINFO, MX, TXT, RP, AFSDB, X25, ISDN, RT, NSAPPTR, SIG, KEY, PX, GPOS, AAAA, LOC, NXT, EID, NIMLOC, SRV, ATMA, NAPTR, KX, CERT, DNAME, OPT, APL, DS, SSHFP, IPSECKEY, RRSIG, NSEC, DNSKEY, DHCID, NSEC3, NSEC3PARAM, TLSA, SMIMEA, HIP, NINFO, RKEY, TALINK, CDS, CDNSKEY, OPENPGPKEY, CSYNC, ZONEMD, SVCB, HTTPS, SPF, UINFO, UID, GID, UNSPEC, NID, L32, L64, LP, EUI48, EUI64, URI, CAA, AVC, AMTRELAY. Observe que os valores devem estar apenas em maiúsculas; valores em minúsculas ou mistos não são suportados.
• Para pesquisas de DNS reverso (quando type é definido como PTR), você pode fornecer o nome DNS tanto no formato invertido quanto no não invertido (veja exemplos abaixo). Observe que quando o registro PTR é solicitado, o nome DNS é na verdade um endereço IP.
• Os valores possíveis para flags são: cdflag ou nocdflag (padrão), rdflag (padrão) ou nordflag, dnssec ou nodnssec (padrão), nsid ou nonsid (padrão), edns0 (padrão) ou noedns0, aaflag ou noaaflag (padrão), adflag ou noadflag (padrão). As flags dnssec e nsid não podem ser usadas junto com noedns0, pois ambas requerem edns0. Observe que os valores devem estar apenas em minúsculas; valores em maiúsculas ou mistos não são suportados.
• Nomes de domínio internacionalizados não são suportados, use nomes codificados em IDNA.
• A saída é um objeto contendo informações do registro DNS com base nos parâmetros fornecidos (veja mais detalhes).

Exemplos:

net.dns.get[192.0.2.0,example.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]

net.dns.get[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]

net.dns.get[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]

oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]

Retorna as estatísticas dos grupos de disco do Automatic Storage Management (ASM).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportada desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• diskgroup - o nome do grupo de disco ASM a ser consultado.

oracle.diskgroups.discovery[connString,<user>,<password>,<service>]

Retorna a lista de grupos de disco ASM. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportada desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta anexar uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.archive.info[connString,<user>,<password>,<service>,<destination>]

As estatísticas dos logs de arquivamento.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas, não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• destination - o nome do destino a ser consultado.

oracle.cdb.info[connString,<user>,<password>,<service>,<database>]

Informações dos Container Databases (CDBs).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• database - o nome do banco de dados a ser consultado.

oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]

O resultado de uma consulta personalizada.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• queryName - o nome de uma consulta personalizada, deve corresponder ao nome do arquivo SQL sem extensão;
  
• args - um ou vários argumentos separados por vírgula para passar para a consulta.

Comentários:

• Os dados retornados são convertidos automaticamente em JSON.
• Evite retornar JSON diretamente das consultas, pois ele será corrompido quando o plugin tentar convertê-lo novamente em JSON.

oracle.datafiles.stats[connString,<user>,<password>,<service>]

Retorna as estatísticas dos arquivos de dados.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportada desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.

oracle.db.discovery[connString,<user>,<password>,<service>]

Retorna a lista de bancos de dados. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese de abertura “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.fra.stats[connString,<user>,<password>,<service>]

Retorna as estatísticas da Fast Recovery Area (FRA).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.instance.info[connString,<user>,<password>,<service>]

As estatísticas da instância.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.pdb.info[connString,<user>,<password>,<service>,<database>]

Informações sobre Pluggable Databases (PDBs).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço do Oracle;
  
• database - o nome do banco de dados a ser consultado.

oracle.pdb.discovery[connString,<user>,<password>,<service>]

Retorna a lista de PDBs. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.pga.stats[connString,<user>,<password>,<service>]

Retorna as estatísticas da Program Global Area (PGA).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.ping[connString,<user>,<password>,<service>]

Testa se uma conexão com o Oracle pode ser estabelecida.
Valor de retorno: 1 - a conexão foi bem-sucedida; 0 - a conexão falhou (se houver qualquer erro apresentado, incluindo problemas de AUTENTICAÇÃO e configuração).

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda são ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (a opção de login não diferencia maiúsculas de minúsculas e não deve conter espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

Exemplos:

oracle.ping[tcp://127.0.0.1:1521,ZABBIX_MON,zabbix,xe]
oracle.ping[localhost,ZABBIX_MON,zabbix,xe]
oracle.ping[zbx_tns_example,ZABBIX_MON,zabbix,xe]
oracle.ping["(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))",ZABBIX_MON,zabbix]

oracle.proc.stats[connString,<user>,<password>,<service>]

Retorna as estatísticas de processos.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda são ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.redolog.info[connString,<user>,<password>,<service>]

As informações do arquivo de log do arquivo de controle.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.sga.stats[connString,<user>,<password>,<service>]

Retorna as estatísticas da System Global Area (SGA).
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportada desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese de abertura “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]

Retorna as estatísticas das sessões.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportada desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço do Oracle;
  
• lockMaxTime - a duração máxima do bloqueio da sessão em segundos para contar a sessão como bloqueada por tempo prolongado. Padrão: 600 segundos.

oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]

Retorna um conjunto de valores de métricas do sistema.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese de abertura “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas, não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• duration - o intervalo de captura (em segundos) dos valores das métricas do sistema. Valores possíveis: 60 — duração longa (padrão), 15 — duração curta.

oracle.sys.params[connString,<user>,<password>,<service>]

Retorna um conjunto de valores de parâmetros do sistema.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas, não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]

Retorna as estatísticas das tablespaces.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• tablespace - nome da tablespace a ser consultada. Padrão (se deixado em branco e type estiver definido):
  • "TEMP" (se type estiver definido como "TEMPORARY");
  • "USERS" (se type estiver definido como "PERMANENT").
• type - o tipo de tablespace a ser consultada. Padrão (se tablespace estiver definido): "PERMANENT".
• conname - nome do container para o qual a informação é necessária.

Se tablespace, type ou conname forem omitidos, o item retornará as estatísticas das tablespaces para todos os containers correspondentes (incluindo PDBs e CDB).

oracle.ts.discovery[connString,<user>,<password>,<service>]

Retorna uma lista de tablespaces. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.

oracle.user.info[connString,<user>,<password>,<service>,<username>]

Retorna informações do usuário Oracle.
Valor de retorno: objeto JSON.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas, não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• username - o nome de usuário para o qual as informações são necessárias. Nomes de usuário em minúsculas não são suportados. Padrão: usuário atual.

oracle.version[connString,<user>,<password>,<service>]

Retorna a versão do servidor de banco de dados.
Valor de retorno: String.

Parâmetros:

• connString - pode ser:
  
  • o URI - se nenhuma sessão com o nome fornecido for encontrada e Plugins.Oracle.ResolveTNS estiver definido como false. Se contiver um esquema (por exemplo, "tcp://"), porta (por exemplo, 1521) ou ambos, a opção ResolveTNS não será considerada e, de qualquer forma, será tratada como URI;
    
  • nome da sessão - se tal nome for encontrado no arquivo de configuração do plugin;
    
  • chave TNS (suportado desde o Zabbix 7.0.19) - se a opção ResolveTNS estiver definida como true e nenhuma das condições acima se aplicar;
    
  • valor TNS (suportado desde o Zabbix 7.0.19) - se começar com o parêntese aberto “(“ (espaços à esquerda são ignorados). Neste caso, a opção ResolveTNS não é considerada.
    
• user - o nome de usuário do Oracle, suporta a adição de uma das opções de login as sysdba, as sysoper, as sysasm, as sysbackup, as sysdg, as syskm ou as sysrac no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço à direita). Observe que apenas as opções de login as sysdba, as sysoper ou as sysasm são suportadas antes do Zabbix 7.0.18;
  
• password - a senha do Oracle;
  
• service - o nome do serviço do Oracle.

pgsql.autovacuum.count[uri,<username>,<password>,<database name>]

O número de workers de autovacuum.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database de postgresql.conf é usado).
  

pgsql.archive[uri,<username>,<password>,<database name>]

As informações sobre arquivos arquivados.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database de postgresql.conf é usado).
  

pgsql.bgwriter[uri,<username>,<password>,<database name>]

O número combinado de checkpoints para o cluster de banco de dados, dividido por tipo de checkpoint.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database de postgresql.conf é usado).
  

pgsql.cache.hit[uri,<username>,<password>,<database name>]

A taxa de acerto do buffer cache do PostgreSQL.
Valor de retorno: Float.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.connections[uri,<username>,<password>,<database name>]

Retorna conexões por tipo.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]

Retorna o resultado de uma consulta personalizada.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• queryName - o nome de uma consulta personalizada, deve corresponder ao nome do arquivo SQL sem extensão;
  
• args - um ou vários argumentos separados por vírgula para passar para a consulta.

pgsql.db.age[uri,<username>,<password>,<database name>]

A idade do FrozenXID mais antigo do banco de dados.
Valor de retorno: Inteiro.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]

O número de tabelas inchadas por banco de dados.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.db.discovery[uri,<username>,<password>,<database name>]

A lista de bancos de dados do PostgreSQL. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database de postgresql.conf é usado).
  

pgsql.db.size[uri,<username>,<password>,<database name>]

O tamanho do banco de dados em bytes.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, é usado o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf).
  

pgsql.dbstat[uri,<username>,<password>,<database name>]

Coleta as estatísticas por banco de dados. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.dbstat.sum[uri,<username>,<password>,<database name>]

Os dados resumidos para todos os bancos de dados em um cluster.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.locks[uri,<username>,<password>,<database name>]

Informações sobre bloqueios concedidos por banco de dados. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.oldest.xid[uri,<username>,<password>,<database name>]

A idade do XID mais antigo.
Valor de retorno: Inteiro.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.ping[uri,<username>,<password>,<database name>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo problemas de AUTENTICAÇÃO e configuração).

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.queries[uri,<username>,<password>,<database name>,período de tempo]

Métricas de consultas por tempo de execução.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado);
  
• período de tempo - o limite de tempo de execução para a contagem de consultas lentas (deve ser um inteiro positivo).

pgsql.replication.count[uri,<username>,<password>]

O número de servidores standby.
Valor de retorno: Inteiro.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.process[uri,<username>,<password>]

O atraso de flush, atraso de gravação e atraso de reprodução por cada processo de envio.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.process.discovery[uri,<username>,<password>]

A descoberta do nome do processo de replicação.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.recovery_role[uri,<username>,<password>]

O status de recuperação.
Valor de retorno: 0 - modo master; 1 - a recuperação ainda está em andamento (modo standby).

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.status[uri,<username>,<password>]

O status da replicação.
Valor de retorno: 0 - streaming está inativo; 1 - streaming está ativo; 2 - modo master.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication_lag.b[uri,<username>,<password>]

O atraso de replicação em bytes.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication_lag.sec[uri,<username>,<password>]

O atraso de replicação em segundos.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.uptime[uri,<username>,<password>,<database name>]

O tempo de atividade do PostgreSQL em milissegundos.
Valor de retorno: Float.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.version[uri,<username>,<password>,<database name>]

Retorna a versão do PostgreSQL.
Valor de retorno: String.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

pgsql.wal.stat[uri,<username>,<password>,<database name>]

As estatísticas do WAL.
Valor de retorno: objeto JSON.

Parâmetros:

• uri - o URI ou nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados (se omitido, o valor de Plugins.PostgreSQL.Default.Database do postgresql.conf é usado).
  

redis.config[connString,<password>,<pattern>]

Obtém os parâmetros de configuração de uma instância Redis que correspondem ao padrão.
Valor de retorno: JSON - se um padrão de estilo glob foi usado; valor único - se um padrão não contiver nenhum caractere curinga.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• password - a senha do Redis;
  
• pattern - um padrão de estilo glob (* por padrão).

Comentário:

• Aviso de segurança: redis.config executa o comando CONFIG GET do Redis e pode retornar parâmetros de configuração sensíveis (por exemplo, requirepass, masterauth, configurações relacionadas a TLS e outros segredos). Usar o padrão padrão (*) ou padrões amplos pode expor esses segredos a qualquer pessoa com permissão para visualizar valores de item no Zabbix.

redis.info[connString,<password>,<section>]

Obtém a saída do comando INFO.
Valor de retorno: JSON - a saída é serializada como JSON.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• password - a senha do Redis;
  
• section - a seção de informações (default por padrão).
  

redis.ping[connString,<password>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está quebrada (se houver qualquer erro apresentado, incluindo problemas de AUTH e configuração).

Parâmetros:

• connString - o URI ou nome da sessão;
  
• password - a senha do Redis.
  

redis.slowlog.count[connString,<password>]

O número de entradas de log lento desde que o Redis foi iniciado.
Valor de retorno: Integer.

Parâmetros:

• connString - o URI ou nome da sessão;
  
• password - a senha do Redis.
  

smart.attribute.discovery

Retorna uma lista de atributos do dispositivo S.M.A.R.T.
Valor de retorno: objeto JSON.

Comentários:

• As seguintes macros e seus valores são retornados: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
• Os tipos de unidade HDD, SSD e NVME são suportados. As unidades podem estar sozinhas ou combinadas em um RAID. {#NAME} terá um complemento em caso de RAID, por exemplo: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.discovery[<type>]

Retorna uma lista de dispositivos S.M.A.R.T.
Valor de retorno: objeto JSON.

Parâmetro:

• type - especifica um valor para verificar os discos. Valores possíveis: id, name (padrão). id não é suportado no Windows e retornará um erro se selecionado

Comentários:

• As seguintes macros e seus valores são retornados: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
• Os tipos de unidade HDD, SSD e NVME são suportados. Se uma unidade não pertencer a um RAID, o {#RAIDTYPE} estará vazio. {#NAME} terá um complemento no caso de RAID, por exemplo: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.get[<path>,<raid type>]

Retorna todas as propriedades disponíveis dos dispositivos S.M.A.R.T.
Valor de retorno: objeto JSON.

Parâmetros:

• path - o caminho do disco, a macro {#PATH} pode ser usada como valor;
  
• raid_type - o tipo de RAID, a macro {#RAID} pode ser usada como valor

Comentários:

• Os tipos de unidade HDD, SSD e NVME são suportados. As unidades podem ser isoladas ou combinadas em um RAID;
  
• Os dados incluem a versão do smartctl e argumentos de chamada, e campos adicionais:
  disk_name - contém o nome com os complementos necessários para a descoberta de RAID, por exemplo: {"disk_name": "/dev/sda cciss,2"}
  disk_type - contém o tipo de disco HDD, SSD ou NVME, por exemplo: {"disk_type": "ssd"};
  
• Se nenhum parâmetro for especificado, o item retornará informações sobre todos os discos.

systemd.unit.get[unit name,<interface>]

Retorna todas as propriedades de uma unidade systemd.
Valor de retorno: objeto JSON.

Parâmetros:

• unit name - o nome da unidade (você pode querer usar a macro {#UNIT.NAME} no protótipo de item para descobrir o nome);
  
• interface - o tipo de interface da unidade, valores possíveis: Unit (padrão), Service, Socket, Device, Mount, Automount, Swap, Target, Path.

Comentários:

• Este item é suportado apenas na plataforma Linux;
• LoadState, ActiveState e UnitFileState para a interface Unit são retornados como texto e inteiro: "ActiveState":{"state":1,"text":"active"}.

systemd.unit.info[nome da unidade,<propriedade>,<interface>]

Informação da unidade systemd.
Valor de retorno: String.

Parâmetros:

• nome da unidade - o nome da unidade (você pode querer usar a macro {#UNIT.NAME} no protótipo de item para descobrir o nome);
  
• propriedade - propriedade da unidade (por exemplo, ActiveState (padrão), LoadState, Description);
• interface - o tipo de interface da unidade (por exemplo, Unit (padrão), Socket, Service).

Comentários:

• Este item é suportado apenas na plataforma Linux;
• Este item permite recuperar uma propriedade específica de um tipo específico de interface, conforme descrito na API dbus.

Exemplos:

systemd.unit.info["{#UNIT.NAME}"] #coleta informações do estado ativo (active, reloading, inactive, failed, activating, deactivating) das unidades systemd descobertas
systemd.unit.info["{#UNIT.NAME}",LoadState] #coleta informações do estado de carregamento das unidades systemd descobertas
systemd.unit.info[mysqld.service,Id] #recupera o nome técnico do serviço (mysqld.service)
systemd.unit.info[mysqld.service,Description] #recupera a descrição do serviço (MySQL Server)
systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #recupera a última vez que o serviço entrou no estado ativo (1562565036283903)
systemd.unit.info[dbus.socket,NConnections,Socket] #coleta o número de conexões desta unidade de socket

systemd.unit.discovery[<type>]

Lista de unidades systemd e seus detalhes. Usado para descoberta de baixo nível.
Valor de retorno: objeto JSON.

Parâmetro:

• type - valores possíveis: all, automount, device, mount, path, service (padrão), socket, swap, target.

Este item é suportado apenas na plataforma Linux.

web.certificate.get[hostname,<port>,<address>]

Valida os certificados e retorna detalhes do certificado.
Valor de retorno: objeto JSON.

Parâmetros:

• hostname - pode ser IP ou DNS.
  Pode conter o esquema da URL (https apenas), caminho (será ignorado) e porta.
  Se uma porta for fornecida tanto no primeiro quanto no segundo parâmetro, seus valores devem coincidir.
  Se o endereço (o 3º parâmetro) for especificado, o hostname será usado apenas para SNI e verificação do hostname;
  
• port - o número da porta (o padrão é 443 para HTTPS);
  
• address - pode ser IP ou DNS. Se especificado, será usado para conexão, e o hostname (o 1º parâmetro) será usado para SNI e verificação do host. Caso o 1º parâmetro seja um IP e o 3º parâmetro seja DNS, o 1º parâmetro será usado para conexão, e o 3º parâmetro será usado para SNI e verificação do host.

Comentários:

• Este item se torna não suportado se o destino especificado na configuração do host não existir, estiver indisponível ou se o handshake TLS falhar com qualquer erro, exceto um certificado inválido;
  
• Atualmente, a extensão X.509 AIA (Authority Information Access), CRLs e OCSP (incluindo OCSP stapling) e Certificate Transparency não são suportados;
• Campos de resposta JSON:
  • x509: contém os detalhes do certificado X.509.
    • version: a versão X.509 (por exemplo, 3).
    • serial_number: o número de série do certificado.
    • signature_algorithm: o algoritmo usado para assinar o certificado (por exemplo, SHA256-RSA).
    • issuer: o emissor do certificado.
    • not_before: a data de início da validade do certificado.
    • not_after: a data de expiração do certificado.
    • subject: o sujeito do certificado.
    • public_key_algorithm: o algoritmo usado para a chave pública (por exemplo, RSA).
    • alternative_names: nomes alternativos do sujeito (se presentes), caso contrário null.
  • result: contém o resultado da validação.
    • value: o status da validação (veja os valores possíveis abaixo).
    • message: mensagem detalhada da validação (por exemplo, "certificate verified successfully").
  • sha1_fingerprint: a impressão digital SHA-1 do certificado.
  • sha256_fingerprint: a impressão digital SHA-256 do certificado.
• O campo $.result.value indica o resultado da validação do certificado. Valores possíveis incluem:
  • valid – o certificado é válido e confiável.
  • valid-but-self-signed – o certificado é válido, mas autoassinado, ou seja, seu sujeito corresponde ao seu emissor.
  • invalid – o certificado é inválido devido a um problema como expiração, hostname incorreto ou uma autoridade de assinatura desconhecida.

Exemplo:

web.certificate.get[example.com,443]

Resposta JSON:

{
  "x509": {
    "version": 3,
    "serial_number": "0ad893bafa68b0b7fb7a404f06ecaf9a",
    "signature_algorithm": "ECDSA-SHA384",
    "issuer": "CN=DigiCert Global G3 TLS ECC SHA384 2020 CA1,O=DigiCert Inc,C=US",
    "not_before": {
      "value": "Jan 15 00:00:00 2025 GMT",
      "timestamp": 1736899200
    },
    "not_after": {
      "value": "Jan 15 23:59:59 2026 GMT",
      "timestamp": 1768521599
    },
    "subject": "CN=*.example.com,O=Internet Corporation for Assigned Names and Numbers,L=Los Angeles,ST=California,C=US",
    "public_key_algorithm": "ECDSA",
    "alternative_names": [
      "*.example.com",
      "example.com"
    ]
  },
  "result": {
    "value": "valid",
    "message": "certificate verified successfully"
  },
  "sha1_fingerprint": "310db7af4b2bc9040c8344701aca08d0c69381e3",
  "sha256_fingerprint": "455943cf819425761d1f950263ebf54755d8d684c25535943976f488bc79d23b"
}