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 e totalmente descrito 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.

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 apenas em codificação UTF-8 sem BOM.
  • Comentários que começam com "#" são suportados apenas no início da linha.

Parameter details

Plugins.MSSQL.CustomQueriesDir

Specify path to the directory containing user-defined .sql files with custom queries that the plugin can execute.
The plugin loads all available .sql files in the configured directory at startup. This means that any changes to the custom query files will not be reflected until the plugin is restarted. The plugin is started and stopped together with Zabbix agent 2.

Defaults:
/usr/local/share/zabbix/custom-queries/mssql - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\MSSQL - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Plugins.MSSQL.CustomQueriesEnabled

Enable execution of the mssql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false Range: true/false

Plugins.MSSQL.Default.CACertPath

Specify the default file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
The certificate must be in PEM format.

Plugins.MSSQL.Default.Database

Specify the default database name.

Plugins.MSSQL.Default.Encrypt

Specify the level of default encryption.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Default.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate by default.

Plugins.MSSQL.Default.Password

Specify the default password for a protected MSSQL server.

Plugins.MSSQL.Default.TLSMinVersion

Specify the minimum TLS version by default.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Default.TrustServerCertificate

Trust the server certificate without validating it by default.

Range: true, false

Plugins.MSSQL.Default.Uri

Specify the default URI for connecting to MSSQL server.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Default.User

Specify the default username for a protected MSSQL server.

Plugins.MSSQL.KeepAlive

Specify the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300 Range: 60-900

Plugins.MSSQL.Sessions.<SessionName>.CACertPath

Specify the named session file path to the public key certificate of the certificate authority (CA) that issued the certificate of the MSSQL server.
<SessionName> - define name of a session for using in item keys.
The certificate must be in PEM format.

Plugins.MSSQL.Sessions.<SessionName>.Database

Specify the named session database name.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Encrypt

Specify the level of named session encryption.
<SessionName> - define name of a session for using in item keys.

Range:
true - data sending between plugin and server is encrypted;
false - data sending between plugin and server is not encrypted beyond the login packet;
strict - data sending between plugin and server is encrypted E2E using TDS8;
disable - data sending between plugin and server is not encrypted.

Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate

Specify the common name (CN) of the MSSQL server certificate for named session.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.Password

Specify the named session password for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion

Specify the named session minimum TLS version.
<SessionName> - define name of a session for using in item keys.

Range: 1.0, 1.1, 1.2, 1.3

Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate

Trust the named session server certificate without validating it.
<SessionName> - define name of a session for using in item keys.

Range: true, false

Plugins.MSSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to MSSQL server.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
The only supported schema is sqlserver://.
The schema can be omitted.

Default: sqlserver://localhost:1433

Plugins.MSSQL.Sessions.<SessionName>.User

Specify the named session username for a protected MSSQL server.
<SessionName> - define name of a session for using in item keys.

Plugins.MSSQL.System.Path

Specify path to the MSSQL plugin executable.
Global setting for the MSSQL plugin. Applied to all connections.

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

Plugins.MSSQL.Timeout

Set the duration, in seconds, to wait for a server to respond when first connecting and on follow-up operations in the session.

Default: default timeout Range: 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).

Parâmetros

Parameter Mandatory Range Default Description
Plugins.MSSQL.CustomQueriesDir no /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		 Especifica o caminho do arquivo para um 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 personalizada não serão refletidas até que o plugin seja reiniciado. O plugin é iniciado e interrompido junto com o Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Se definido, habilita a execução da chave de item mssql.custom.query. Se desabilitado, nenhuma consulta será carregada do caminho do diretório de consultas personalizadas.
Plugins.MSSQL.Default.CACertPath no O caminho padrão do arquivo para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do server MSSQL. O certificado deve estar no formato PEM.
Plugins.MSSQL.Default.Database no O nome padrão do banco de dados ao qual se conectar.
Plugins.MSSQL.Default.Encrypt no Especifica o tipo padrão de criptografia da conexão. Os valores possíveis são:
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 no O nome comum (CN) do certificado do server MSSQL por padrão.
Plugins.MSSQL.Default.Password no A senha a ser enviada a um server MSSQL protegido por padrão.
Plugins.MSSQL.Default.TLSMinVersion no A versão mínima do TLS a ser usada por padrão. Os valores possíveis são: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Se o plugin deve confiar no certificado do server sem validá-lo por padrão. Valores possíveis: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 A URI padrão para conexão. O único esquema suportado é sqlserver://. Um esquema pode ser omitido. Credenciais incorporadas serão ignoradas.
Plugins.MSSQL.Default.User no O nome de usuário padrão a ser enviado a um server MSSQL protegido.
Plugins.MSSQL.KeepAlive no 60-900 300 O tempo máximo de espera (em segundos) antes que conexões do plugin não utilizadas sejam fechadas.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no O caminho do arquivo para o certificado de chave pública da autoridade certificadora (CA) que emitiu o certificado do server MSSQL para a sessão nomeada. O certificado deve estar no formato PEM.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.Database no O nome do banco de dados ao qual se conectar para a sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Especifica o tipo de criptografia da conexão para a sessão nomeada. Os valores possíveis são:
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.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no O nome comum (CN) do certificado do server MSSQL para a sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.Password no A senha a ser enviada a um server MSSQL protegido para a sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no A versão mínima do TLS a ser usada para a sessão nomeada. Os valores possíveis são: 1.0, 1.1, 1.2, 1.3.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Se o plugin deve confiar no certificado do server sem validá-lo para a sessão nomeada. Valores possíveis: true, false.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 A URI para conexão, para a sessão nomeada. O único esquema suportado é sqlserver://. Um esquema pode ser omitido. Credenciais incorporadas serão ignoradas.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.Sessions.<SessionName>.User no O nome de usuário a ser enviado a um server MSSQL protegido para a sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso em item keys.
Plugins.MSSQL.System.Path no Caminho para o executável do plugin MSSQL.
Configuração global para o plugin MSSQL. Aplicada a todas as conexões.
Exemplo de uso: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout A duração, em segundos, para aguardar uma resposta de um server ao se conectar pela primeira vez e em operações subsequentes na sessão.

Veja também: