Complemento MSSQL

Resumen

Los parámetros de configuración permiten personalizar el comportamiento del plugin MSSQL.

Se recomienda especificarlos en su propio archivo de configuración (por ejemplo, mssql.conf), en lugar de en el archivo de configuración de agent 2. Luego use la directiva Include para incluir este archivo en la configuración de Zabbix agent 2.

El plugin MSSQL es un plugin cargable y está disponible y completamente descrito en el repositorio del plugin MSSQL.

Todos los parámetros son opcionales, salvo que se indique explícitamente que el parámetro es obligatorio.

Tenga en cuenta que:

  • Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración suministrados.
  • Los valores admiten variables de entorno;
  • Zabbix solo admite archivos de configuración en codificación UTF-8 sin BOM.
  • Los comentarios que comienzan con "#" solo se admiten al principio de la línea.

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

Opciones

Parameter Description
-V --version Muestra la versión del plugin y la información de la licencia.
-h --help Muestra la información de ayuda (forma abreviada).
-t, --test <item key> Inicia el plugin para pruebas (se ignora la configuración del plugin).

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, donde * es el nombre de la unidad de la variable de entorno ProgramFiles		 Especifica la ruta de archivo a un directorio que contiene archivos .sql definidos por el usuario con consultas personalizadas que el plugin puede ejecutar. El plugin carga todos los archivos .sql disponibles en el directorio configurado al iniciarse. Esto significa que cualquier cambio en los archivos de consultas personalizadas no se reflejará hasta que se reinicie el plugin. El plugin se inicia y se detiene junto con Zabbix agent 2.
Plugins.MSSQL.CustomQueriesEnabled no false Si se establece, habilita la ejecución de la clave de item mssql.custom.query. Si está deshabilitado, no se cargará ninguna consulta desde la ruta del directorio de consultas personalizadas.
Plugins.MSSQL.Default.CACertPath no La ruta de archivo predeterminada al certificado de clave pública de la autoridad de certificación (CA) que emitió el certificado del server MSSQL. El certificado debe estar en formato PEM.
Plugins.MSSQL.Default.Database no El nombre de base de datos predeterminado al que conectarse.
Plugins.MSSQL.Default.Encrypt no Especifica el tipo de cifrado de conexión predeterminado. Los valores posibles son:
true - el envío de datos entre el plugin y el server está cifrado;
false - el envío de datos entre el plugin y el server no está cifrado más allá del paquete de inicio de sesión;
strict - el envío de datos entre el plugin y el server está cifrado de extremo a extremo usando TDS8;
disable - el envío de datos entre el plugin y el server no está cifrado.
Plugins.MSSQL.Default.HostNameInCertificate no El nombre común (CN) del certificado del server MSSQL de forma predeterminada.
Plugins.MSSQL.Default.Password no La contraseña que se enviará a un server MSSQL protegido de forma predeterminada.
Plugins.MSSQL.Default.TLSMinVersion no La versión mínima de TLS que se usará de forma predeterminada. Los valores posibles son: 1.0, 1.1, 1.2, 1.3.
Plugins.MSSQL.Default.TrustServerCertificate no Indica si el plugin debe confiar en el certificado del server sin validarlo de forma predeterminada. Valores posibles: true, false.
Plugins.MSSQL.Default.Uri no sqlserver://localhost:1433 La URI predeterminada para conectarse. El único esquema compatible es sqlserver://. Se puede omitir un esquema. Las credenciales incrustadas se ignorarán.
Plugins.MSSQL.Default.User no El nombre de usuario predeterminado que se enviará a un server MSSQL protegido.
Plugins.MSSQL.KeepAlive no 60-900 300 El tiempo máximo de espera (en segundos) antes de cerrar las conexiones del plugin no utilizadas.
Plugins.MSSQL.Sessions.<SessionName>.CACertPath no La ruta de archivo al certificado de clave pública de la autoridad de certificación (CA) que emitió el certificado del server MSSQL para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.Database no El nombre de la base de datos a la que conectarse para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.Encrypt no Especifica el tipo de cifrado de conexión para la sesión con nombre. Los valores posibles son:
true - el envío de datos entre el plugin y el server está cifrado;
false - el envío de datos entre el plugin y el server no está cifrado más allá del paquete de inicio de sesión;
strict - el envío de datos entre el plugin y el server está cifrado de extremo a extremo usando TDS8;
disable - el envío de datos entre el plugin y el server no está cifrado.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.HostNameInCertificate no El nombre común (CN) del certificado del server MSSQL para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.Password no La contraseña que se enviará a un server MSSQL protegido para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.TLSMinVersion no La versión mínima de TLS que se usará para la sesión con nombre. Los valores posibles son: 1.0, 1.1, 1.2, 1.3.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.TrustServerCertificate no Indica si el plugin debe confiar en el certificado del server sin validarlo para la sesión con nombre. Valores posibles: true, false.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.Uri no sqlserver://localhost:1433 La URI para conectarse, para la sesión con nombre. El único esquema compatible es sqlserver://. Se puede omitir un esquema. Las credenciales incrustadas se ignorarán.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.Sessions.<SessionName>.User no El nombre de usuario que se enviará a un server MSSQL protegido para la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MSSQL.System.Path no Ruta al ejecutable del plugin MSSQL.
Configuración global para el plugin MSSQL. Se aplica a todas las conexiones.
Ejemplo de uso: Plugins.MSSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mssql
Plugins.MSSQL.Timeout no 1-30 global timeout La duración, en segundos, de la espera a que un server responda al conectarse por primera vez y en las operaciones posteriores de la sesión.

Véase también: