Objeto script

Los siguientes objetos están directamente relacionados con la API de script.

Script

El objeto script tiene las siguientes propiedades.

Property Type Description
scriptid ID ID del script.

Comportamiento de la propiedad:
- solo lectura
- obligatorio para operaciones de actualización
name string Nombre del script.

Comportamiento de la propiedad:
- obligatorio para operaciones de creación
type integer Tipo de script.

Valores posibles si scope está establecido en "action operation":
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Valores posibles si scope está establecido en "manual host action" o "manual event action":
6 - URL.

Comportamiento de la propiedad:
- obligatorio para operaciones de creación
command string Comando que se ejecutará.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "Script", "IPMI", "SSH", "TELNET" o "Webhook"
scope integer Ámbito del script.

Valores posibles:
1 - action operation;
2 - manual host action;
4 - manual event action.

Comportamiento de la propiedad:
- obligatorio para operaciones de creación
execute_on integer Ubicación donde se ejecutará el script.

Valores posibles:
0 - ejecutar en el Zabbix agent;
1 - ejecutar en el Zabbix server. Solo está admitido si la ejecución de scripts globales está habilitada en el Zabbix server;
2 - (predeterminado) ejecutar en el Zabbix server o proxy.

Comportamiento de la propiedad:
- admitido si type está establecido en "Script"
menu_path string Carpetas separadas por barras que forman una navegación de menú en el frontend al hacer clic en un host o evento.

Comportamiento de la propiedad:
- admitido si scope está establecido en "manual host action" o "manual event action"
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:
- admitido si type está establecido en "SSH"
username string Nombre de usuario utilizado para la autenticación.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "SSH" o "TELNET"
password string Contraseña utilizada para scripts SSH con autenticación mediante contraseña y para scripts TELNET.

Comportamiento de la propiedad:
- admitido si type está establecido en "SSH" y authtype está establecido en "password", o si type está establecido en "TELNET"
publickey string Nombre del archivo de clave pública utilizado para scripts SSH con autenticación mediante clave pública.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "SSH" y authtype está establecido en "public key"
privatekey string Nombre del archivo de clave privada utilizado para scripts SSH con autenticación mediante clave pública.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "SSH" y authtype está establecido en "public key"
port string Número de puerto utilizado para scripts SSH y TELNET.

Comportamiento de la propiedad:
- admitido si type está establecido en "SSH" o "TELNET"
groupid ID ID del grupo de hosts en el que se puede ejecutar el script.

Si se establece en "0", el script estará disponible en todos los grupos de hosts.

Predeterminado: 0.
usrgrpid ID ID del grupo de usuarios al que se permitirá ejecutar el script.

Si se establece en "0", el script estará disponible para todos los grupos de usuarios.

Predeterminado: 0.

Comportamiento de la propiedad:
- admitido si scope está establecido en "manual host action" o "manual event action"
host_access integer Permisos del host necesarios para ejecutar el script.

Valores posibles:
2 - (predeterminado) lectura;
3 - escritura.

Comportamiento de la propiedad:
- admitido si scope está establecido en "manual host action" o "manual event action"
confirmation string Texto de confirmación de la ventana emergente.
La ventana emergente aparecerá al intentar ejecutar el script desde el Zabbix frontend.

Comportamiento de la propiedad:
- admitido si scope está establecido en "manual host action" o "manual event action"
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.

Predeterminado: 30s.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "Webhook"
parameters array Matriz de parámetros de entrada del webhook.

Comportamiento de la propiedad:
- admitido si type está establecido en "Webhook"
description string Descripción del script.
url string URL definida por el usuario.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "URL"
new_window integer Abrir la URL en una ventana nueva.

Valores posibles:
0 - No;
1 - (predeterminado) Sí.

Comportamiento de la propiedad:
- admitido si type está establecido en "URL"
manualinput integer Indica si el script acepta entradas proporcionadas por el usuario.

Valores posibles:
0 - (predeterminado) Deshabilitado;
1 - Habilitado;

Comportamiento de la propiedad:
- admitido si scope está establecido en "manual host action" o "manual event action"
manualinput_prompt string Texto de la solicitud de entrada manual.

Comportamiento de la propiedad:
- obligatorio si manualinput está establecido en "Enabled"
manualinput_validator string Campo de cadena de caracteres utilizado para validar la entrada proporcionada por el usuario. La cadena consta de una expresión regular o de un conjunto de valores separados por comas.

Comportamiento de la propiedad:
- obligatorio si manualinput está establecido en "Enabled"
manualinput_validator_type integer Determina el tipo de entrada de usuario esperado.

Valores posibles:
0 - (predeterminado) String. Indica que manualinput_validator debe tratarse como una expresión regular;
1 - List. Indica que manualinput_validator debe tratarse como una lista de posibles valores de entrada separados por comas.

Comportamiento de la propiedad:
- admitido si manualinput está establecido en "Enabled"
manualinput_default_value string Valor predeterminado para rellenar automáticamente la entrada del usuario.

Comportamiento de la propiedad:
- admitido si manualinput_validator_type está establecido en "String"

Parámetros de webhook

Los parámetros pasados al script del 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.