Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Únase a nuestro proyecto de traducción y ayude a traducir la documentación de Zabbix a su lengua materna.

> Objeto de script

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

Script

El objeto de script tiene las siguientes propiedades.

Propiedad Tipo Descripción
scriptid cadena ID del script.

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

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

Valores posibles si scope está configurado en "operación de acción":
0 - Script;
1 - IPMI;
2 - SSH;< br>3 - TELNET;
5 - Webhook.

Valores posibles si alcance está configurado en "acción manual del host" o "acción de evento manual":
6 - URL.

Comportamiento de la propiedad:
- obligatorio para operaciones de creación
command cadena Comando a ejecutar.

Comportamiento de la propiedad:
- obligatorio si tipo está configurado en "Script", "IPMI", "SSH", "TELNET" o "Webhook"
scope entero Alcance del script.

Valores posibles:
1 - operación de acción;
2 - acción manual del host;
4 - acción de evento manual.

Comportamiento de la propiedad:
- obligatorio para operaciones de creación
execute_on entero Dónde ejecutar el script.

Valores posibles:
0 - ejecutar en el agente Zabbix;
1 - ejecutar en el servidor Zabbix;
2 - (predeterminado ) ejecutar en el servidor Zabbix (proxy).

Comportamiento de la propiedad:
- compatible si tipo está configurado en "Script"
menu_path cadena Carpetas separadas por barra diagonal que forman un menú similar a la navegación en la interfaz cuando se hace clic en el host o evento.

Comportamiento de la propiedad:< br>- compatible si alcance está configurado en "acción manual del host" o "acción manual de evento"
authtype entero 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:
- compatible si type está configurado en "SSH"
username cadena Nombre de usuario utilizado para la autenticación.

Comportamiento de la propiedad:
- obligatorio si tipo está configurado en "SSH " o "TELNET"
password cadena Contraseña utilizada para secuencias de comandos SSH con autenticación de contraseña y secuencias de comandos TELNET.

Comportamiento de la propiedad:
- compatible si tipo está configurado en "SSH" y authtype está configurado en "contraseña", o type está configurado en "TELNET"
publickey cadena Nombre del archivo de clave pública utilizado para scripts SSH con autenticación de clave pública.

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

Comportamiento de la propiedad:
- obligatorio si type está configurado en "SSH" y authtype está configurado en "clave pública"
port cadena Número de puerto utilizado para secuencias de comandos SSH y TELNET.

Comportamiento de la propiedad:
- compatible si se establece tipo a "SSH" o "TELNET"
groupid cadena 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 hosts.

Predeterminado: 0 .
usrgrpid string 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.

Valor predeterminado: 0.

Comportamiento de la propiedad:
- compatible si alcance está configurado en "acción manual del host" o "acción manual del evento"
host_access integer Permisos de equipo necesarios para ejecutar el script.

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

Comportamiento de la propiedad:
- compatible si scope está configurado en "acción manual del equipo" o "acción manual del evento"
confirmation cadena Texto emergente de confirmación.
La ventana emergente aparecerá cuando intente ejecutar el script desde la interfaz de Zabbix.

Comportamiento de la propiedad:
- compatible si alcance está configurado en "acción manual del host" o "acción de evento manual"
timeout cadena Tiempo de espera de ejecución del script del webhook en segundos. Se admiten sufijos de tiempo (p. ej., 30 s, 1 m).

Valores posibles: 1-60 s.

Predeterminado: 30 s.

Comportamiento de la propiedad:
- obligatorio si tipo está configurado en "Webhook"
parameters matriz Matriz de parámetros de entrada del webhook.

Comportamiento de la propiedad:
- compatible si tipo está configurado en "Webhook"
description cadena Descripción del script.
url cadena URL definida por el usuario.

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

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

[Comportamiento de la propiedad] (/manual/api/reference_commentary#property-behavior):
- compatible si type está configurado en "URL"

Parámetros del webhook

Los parámetros pasados al script de webhook cuando se llama tienen las siguientes propiedades.

Propiedad Tipo Descripción
name cadena Nombre del parámetro.

Comportamiento de la propiedad:
- obligatorio
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.