Table of Contents
Objeto script
Los siguientes objetos están directamente relacionados con la API de script.
Script
El objeto script tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| scriptid | ID | ID del script. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| name | string | Nombre del script. Comportamiento de la propiedad: - requerido para operaciones de creación |
| type | integer | Tipo de script. Valores posibles si scope está establecido en "acción de operación":0 - Script; 1 - IPMI; 2 - SSH; 3 - TELNET; 5 - Webhook. Valores posibles si scope está establecido en "acción manual de equipo" o "acción manual de evento":6 - URL. Comportamiento de la propiedad: - requerido para operaciones de creación |
| command | string | Comando a ejecutar. Comportamiento de la propiedad: - requerido si type está establecido en "Script", "IPMI", "SSH", "TELNET" o "Webhook" |
| scope | integer | Ámbito del script. Valores posibles: 1 - acción de operación; 2 - acción manual de equipo; 4 - acción manual de evento. Comportamiento de la propiedad: - requerido para operaciones de creación |
| execute_on | integer | Dónde ejecutar el script. Valores posibles: 0 - ejecutar en el agente Zabbix; 1 - ejecutar en el servidor Zabbix. Soportado solo si la ejecución de scripts globales está habilitada en el servidor Zabbix; 2 - (por defecto) ejecutar en el servidor Zabbix o proxy. Comportamiento de la propiedad: - soportado si type está establecido en "Script" |
| menu_path | string | Carpetas separadas por barra que forman una navegación tipo menú en el frontend al hacer clic en equipo o evento. Comportamiento de la propiedad: - soportado si scope está establecido en "acción manual de equipo" o "acción manual de evento" |
| authtype | integer | Método de autenticación utilizado para el tipo de script SSH. Valores posibles: 0 - contraseña; 1 - clave pública. Comportamiento de la propiedad: - soportado si type está establecido en "SSH" |
| username | string | Nombre de usuario utilizado para la autenticación. Comportamiento de la propiedad: - requerido si type está establecido en "SSH" o "TELNET" |
| password | string | Contraseña utilizada para scripts SSH con autenticación por contraseña y scripts TELNET. Comportamiento de la propiedad: - soportado si type está establecido en "SSH" y authtype está establecido en "contraseña", o type está establecido en "TELNET" |
| publickey | string | Nombre del archivo de clave pública utilizado para scripts SSH con autenticación por clave pública. Comportamiento de la propiedad: - requerido si type está establecido en "SSH" y authtype está establecido en "clave pública" |
| privatekey | string | Nombre del archivo de clave privada utilizado para scripts SSH con autenticación por clave pública. Comportamiento de la propiedad: - requerido si type está establecido en "SSH" y authtype está establecido en "clave pública" |
| port | string | Número de puerto utilizado para scripts SSH y TELNET. Comportamiento de la propiedad: - soportado si type está establecido en "SSH" o "TELNET" |
| groupid | ID | ID del grupo de equipos en el que se puede ejecutar el script. Si se establece en "0", el script estará disponible en todos los grupos de equipos. Por defecto: 0. |
| usrgrpid | ID | ID del grupo de usuarios al que se le permitirá ejecutar el script. Si se establece en "0", el script estará disponible para todos los grupos de usuarios. Por defecto: 0. Comportamiento de la propiedad: - soportado si scope está establecido en "acción manual de equipo" o "acción manual de evento" |
| host_access | integer | Permisos de equipo necesarios para ejecutar el script. Valores posibles: 2 - (por defecto) lectura; 3 - escritura. Comportamiento de la propiedad: - soportado si scope está establecido en "acción manual de equipo" o "acción manual de evento" |
| confirmation | string | Texto de confirmación emergente. La ventana emergente aparecerá al intentar ejecutar el script desde el frontend de Zabbix. Comportamiento de la propiedad: - soportado si scope está establecido en "acción manual de equipo" o "acción manual de evento" |
| timeout | string | Tiempo de espera de ejecución del script Webhook en segundos. Se admiten sufijos de tiempo (por ejemplo, 30s, 1m). Valores posibles: 1-60s. Por defecto: 30s. Comportamiento de la propiedad: - requerido si type está establecido en "Webhook" |
| parameters | array | Array de parámetros de entrada de webhook. Comportamiento de la propiedad: - soportado si type está establecido en "Webhook" |
| description | string | Descripción del script. |
| url | string | URL definida por el usuario. Comportamiento de la propiedad: - requerido si type está establecido en "URL" |
| new_window | integer | Abrir la URL en una nueva ventana. Valores posibles: 0 - No; 1 - (por defecto) Sí. Comportamiento de la propiedad: - soportado si type está establecido en "URL" |
| manualinput | integer | Indica si el script acepta entrada proporcionada por el usuario. Valores posibles: 0 - (por defecto) Deshabilitado; 1 - Habilitado; Comportamiento de la propiedad: - soportado si scope está establecido en "acción manual de equipo" o "acción manual de evento" |
| manualinput_prompt | string | Texto de solicitud de entrada manual. Comportamiento de la propiedad: - requerido si manualinput está establecido en "Habilitado" |
| manualinput_validator | string | Un campo de cadena de caracteres utilizado para validar la entrada proporcionada por el usuario. La cadena consiste en una expresión regular o un conjunto de valores separados por comas. Comportamiento de la propiedad: - requerido si manualinput está establecido en "Habilitado" |
| manualinput_validator_type | integer | Determina el tipo de entrada de usuario esperada. Valores posibles: 0 - (por defecto) Cadena. Indica que manualinput_validator debe tratarse como una expresión regular; 1 - Lista. Indica que manualinput_validator debe tratarse como una lista de valores de entrada posibles separados por comas. Comportamiento de la propiedad: - soportado si manualinput está establecido en "Habilitado" |
| manualinput_default_value | string | Valor por defecto para autocompletar la entrada del usuario. Comportamiento de la propiedad: - soportado si manualinput_validator_type está establecido en "Cadena" |
Parámetros de webhook
Los parámetros pasados al script de webhook cuando se llama tienen las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del parámetro. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del parámetro. Soporta macros. |
Depuración
Información de depuración del script webhook ejecutado. El objeto de depuración tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| logs | array | Array de entradas de registro. |
| ms | string | 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 | integer | Nivel de registro. |
| ms | string | El tiempo transcurrido en milisegundos desde que se ejecutó el script antes de que se añadiera la entrada de registro. |
| message | string | Mensaje de registro. |