Documentation
Table of Contents
> Objeto de secuencia de comandos
Los siguientes objetos están directamente relacionados con la API script.
Guion
El objeto de guion tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| scriptid | cadena | (solo lectura) ID del guion. |
| nombre (obligatorio) |
cadena | Nombre del guion. |
| tipo (obligatorio) |
número entero | Tipo de guion. Valores posibles: 0 - Script; 1 - IPMI; 2 - SSH;<br >3 - Telnet; 5 - (predeterminado) Gancho web. |
| comando (obligatorio) |
cadena | Comando a ejecutar. |
| alcance | número entero | Alcance del guion. Valores posibles: 1 - operación de acción predeterminada; 2 - acción manual del host; 4 - acción de evento manual. |
| ejecutar_on | número entero | Dónde ejecutar el guion. Se usa si tipo es 0 (script).Valores posibles: 0 - ejecutar en el Zabbix agente;<br >1 - ejecutar en el servidor Zabbix; 2 - (predeterminado) ejecutar en el servidor Zabbix (proxy). |
| menu_path | cadena | Carpetas separadas por barra que forman un menú como navegación en la interfaz cuando se hace clic en el host o evento. Se usa si scope es 2 o 4. |
| authtype | número entero | Método de autenticación utilizado para el tipo de script SSH. Se utiliza si tipo es 2.Valores posibles: 0 - contraseña; 1 - clave pública. |
| nombre de usuario | cadena | Nombre de usuario utilizado para la autenticación. Obligatorio si tipo es 2 o 3. |
| contraseña | cadena | Contraseña utilizada para guiones SSH con autenticación de contraseña y guiones Telnet. Se usa si type es 2 y authtype es 0 o type es 3. |
| clave pública | cadena | Nombre del archivo de clave pública utilizado para guiones SSH con autenticación de clave pública. Obligatorio si el tipo es 2 y authtype es 1. |
| llaveprivada | cadena | Nombre del archivo de clave privada utilizado para guiones SSH con autenticación de clave pública. Obligatorio si el tipo es 2 y authtype es 1. |
| puerto | cadena | Número de puerto utilizado para guiones SSH y Telnet. Se utiliza si el tipo es 2 o 3. |
| groupid | cadena | ID del grupo de hosts en el que se puede ejecutar el guion. Si se establece en 0, el guion estará disponible en todos los grupos de hosts. Valor predeterminado: 0. |
| usrgrpid | cadena | ID del grupo de usuarios al que se le permitirá ejecutar el guion. Si se establece en 0, el guion estará disponible para todos los grupos de usuarios. Se utiliza si scope es 2 o 4.Predeterminado: 0. |
| host_access | número entero | Permisos de host necesarios para ejecutar el guion. Se utiliza si scope es 2 o 4.Valores posibles: 2 - (predeterminado) leer; 3 - escribir. |
| confirmación | cadena | Texto pop up de confirmación. El pop up aparecerá cuando intente ejecutar el guion desde la interfaz de Zabbix. Se usa si scope es 2 o 4. |
| timeout | cadena | Tiempo de espera de ejecución del guion del gancho web en segundos. Se admiten sufijos de tiempo, p. 30s, 1m. Obligatorio si tipo es 5.Valores posibles: 1-60s Valor predeterminado: 30s |
| parámetros | matriz | Matriz de webhook input parameters. Se utiliza si tipo es 5. |
| descripción | cadena | Descripción del script. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Parámetros del webhook
Los parámetros pasados al script de webhook cuando se llama tienen las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name (obligatorio) |
cadena | Nombre del parámetro. |
| value | cadena | Valor del parámetro. Admite macros. |
Depurar
Información de depuración del script de webhook ejecutado. El objeto de depuración tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| logs | matriz | Matriz de entradas de registro. |
| ms | cadena | Duración de la ejecución del script en milisegundos. |
Entrada de registro
El objeto de entrada de registro tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| level | entero | Nivel de registro. |
| ms | cadena | El tiempo transcurrido en milisegundos desde que se ejecutó el script antes de agregar la entrada de registro. |
| message | cadena | Mensaje de registro. |