plugin MSSQL

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do plugin MSSQL.

Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, mssql.conf), em vez de no arquivo de configuração do agent 2. Em seguida, use a diretiva Include para incluir esse arquivo na configuração do Zabbix agent 2.

O plugin MSSQL é um plugin carregável e está disponível, com descrição completa, no repositório do plugin MSSQL.

Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Esta página está estruturada da seguinte forma:

  • Visão geral dos parâmetros (para ver os detalhes completos de um parâmetro, clique em seu nome)
  • Detalhes dos parâmetros
Parameter Description
Plugins.MSSQL.CustomQueriesDir Especifique o caminho para o diretório que contém arquivos .sql definidos pelo usuário com consultas personalizadas que o plugin pode executar.
Plugins.MSSQL.CustomQueriesEnabled Habilite a execução da chave de item mssql.custom.query.
Plugins.MSSQL.Default.CACertPath Especifique o caminho padrão do arquivo para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do server MSSQL.
Plugins.MSSQL.Default.Database Especifique o nome padrão do banco de dados.
Plugins.MSSQL.Default.Encrypt Especifique o nível padrão de criptografia.
Plugins.MSSQL.Default.HostNameInCertificate Especifique, por padrão, o nome comum (CN) do certificado do server MSSQL.
Plugins.MSSQL.Default.Password Especifique a senha padrão.
Plugins.MSSQL.Default.TLSMinVersion Especifique, por padrão, a versão mínima do TLS.
Plugins.MSSQL.Default.TrustServerCertificate Confie no certificado do server sem validá-lo, por padrão.
Plugins.MSSQL.Default.Uri Especifique a URI padrão.
Plugins.MSSQL.Default.User Especifique o nome de usuário padrão.
Plugins.MSSQL.KeepAlive Especifique o tempo máximo de espera (em segundos) antes que conexões não utilizadas do plugin sejam encerradas.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath Especifique o caminho do arquivo da sessão nomeada para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do server MSSQL.
Plugins.MSSQL.Sessions.<SessionName>.Database Especifique o nome do banco de dados da sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt Especifique o nível de criptografia da sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate Especifique o nome comum (CN) do certificado do server MSSQL para a sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.Password Especifique a senha da sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion Especifique a versão mínima do TLS da sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate Confie no certificado do server da sessão nomeada sem validá-lo.
Plugins.MSSQL.Sessions.<SessionName>.Uri Especifique a URI da sessão nomeada.
Plugins.MSSQL.Sessions.<SessionName>.User Especifique o nome de usuário da sessão nomeada.
Plugins.MSSQL.System.Path Especifique o caminho para o executável do plugin MSSQL.
Plugins.MSSQL.Timeout Defina a duração, em segundos, para aguardar a resposta de um server na conexão inicial e nas operações subsequentes na sessão.

Observe que:

  • Os valores padrão refletem os padrões do processo, não os valores nos arquivos de configuração fornecidos.
  • Os valores suportam variáveis de ambiente;
  • O Zabbix suporta arquivos de configuração somente em codificação UTF-8 sem BOM.
  • Comentários que começam com "#" são suportados apenas no início da linha.

Detalhes do parâmetro

Plugins.MSSQL.CustomQueriesDir

Especifique o caminho para o diretório que contém arquivos .sql definidos pelo usuário com consultas personalizadas que o plugin pode executar.
O plugin carrega todos os arquivos .sql disponíveis no diretório configurado na inicialização. Isso significa que quaisquer alterações nos arquivos de consulta personalizados não serão refletidas até que o plugin seja reiniciado. O plugin é iniciado e encerrado junto com o Zabbix agent 2.

Padrões:
/usr/local/share/zabbix/custom-queries/mssql - para sistemas Unix,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - para sistemas Windows (onde * é o nome da unidade da variável de ambiente ProgramFiles)

Plugins.MSSQL.CustomQueriesEnabled

Ativa a execução da chave de item mssql.custom.query.
Se desativado, nenhuma consulta será carregada do caminho do diretório de consultas personalizadas.

Padrão: false
Intervalo: true/false

Plugins.MSSQL.Default.CACertPath

Especifique o caminho padrão do arquivo para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do servidor MSSQL.
O certificado deve estar no formato PEM.

Plugins.MSSQL.Default.Database

Especifique o nome padrão do banco de dados.

Plugins.MSSQL.Default.Encrypt

Especifique o nível de criptografia padrão.

Intervalo:
true - o envio de dados entre o plugin e o server é criptografado;
false - o envio de dados entre o plugin e o server não é criptografado além do pacote de login;
strict - o envio de dados entre o plugin e o server é criptografado de ponta a ponta usando TDS8;
disable - o envio de dados entre o plugin e o server não é criptografado.

Plugins.MSSQL.Default.HostNameInCertificate

Especifique, por padrão, o nome comum (CN) do certificado do MSSQL server.

Plugins.MSSQL.Default.Password

Especifique a senha padrão para um servidor MSSQL protegido.

Plugins.MSSQL.Default.TLSMinVersion

Especifique a versão mínima do TLS por padrão.

Intervalo: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Confia no certificado do server sem validá-lo por padrão.

Intervalo: true, false

Plugins.MSSQL.Default.Uri

Especifique a URI padrão para conectar ao server MSSQL.
As credenciais incorporadas serão ignoradas.
O único esquema suportado é sqlserver://.
O esquema pode ser omitido.

Padrão: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Especifique o nome de usuário padrão para um servidor MSSQL protegido.

Plugins.MSSQL.KeepAlive

Especifica o tempo máximo de espera (em segundos) antes que conexões de plugin não utilizadas sejam fechadas.

Padrão: 300
Intervalo: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Especifique o caminho do arquivo da sessão nomeada para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do server MSSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
O certificado deve estar no formato PEM.

Plugins.MSSQL.Sessions.<SessionName>.Database

Especifique o nome do banco de dados da sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Especifique o nível de criptografia da sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Intervalo:
true - os dados enviados entre o plugin e o server são criptografados;
false - os dados enviados entre o plugin e o server não são criptografados além do pacote de login;
strict - os dados enviados entre o plugin e o server são criptografados de ponta a ponta usando TDS8;
disable - os dados enviados entre o plugin e o server não são criptografados.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Especifique o nome comum (CN) do certificado do servidor MSSQL para a sessão nomeada.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Plugins.MSSQL.Sessions.<SessionName>.Password

Especifique a senha da sessão nomeada para um servidor MSSQL protegido.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Especifique a versão mínima do TLS da sessão nomeada.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Intervalo: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Confiar no certificado do servidor da sessão nomeada sem validá-lo.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Intervalo: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Especifique a URI da sessão nomeada para conexão com o server MSSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
As credenciais incorporadas serão ignoradas.
O único esquema suportado é sqlserver://.
O esquema pode ser omitido.

Padrão: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Especifique o nome de usuário da sessão nomeada para um servidor MSSQL protegido.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Plugins.MSSQL.System.Path

Especifique o caminho para o executável do plugin MSSQL.
Configuração global para o plugin MSSQL. Aplicada a todas as conexões.

Exemplo: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql

Plugins.MSSQL.Timeout

Defina a duração, em segundos, para aguardar uma resposta do server ao se conectar pela primeira vez e nas operações subsequentes na sessão.

Padrão: global timeout
Intervalo: 1-30

Opções

Parameter Description
-V --version Exibe a versão do plugin e informações de licença.
-h --help Exibe informações de ajuda (atalho).
-t, --test <item key> Inicia o plugin para teste (a configuração do plugin é ignorada).

Veja também