[comment]: # translation:outdated

[comment]: # ({8b1700c1-8b1700c1})
# > Objeto de secuencia de comandos

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

[comment]: # ({/8b1700c1-8b1700c1})

[comment]: # ({cd8ec58e-9c6db006})
### Guion

El objeto de guion tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#tipos_de_datos)|Descripción|
|--|--|------|
|scriptid|cadena|*(solo lectura)* ID del guion.|
|**nombre**<br>(obligatorio)|cadena|Nombre del guion.|
|**tipo**<br>(obligatorio)|número entero|Tipo de guion.<br><br>Valores posibles:<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br >3 - Telnet;<br>5 - *(predeterminado)* Gancho web.|
|**comando**<br>(obligatorio)|cadena|Comando a ejecutar.|
|alcance|número entero|Alcance del guion.<br><br>Valores posibles:<br>1 - operación de acción *predeterminada*;<br>2 - acción manual del host;<br>4 - acción de evento manual.|
|ejecutar\_on|número entero|Dónde ejecutar el guion.<br>Se usa si `tipo` es `0` (script).<br><br>Valores posibles:<br>0 - ejecutar en el Zabbix agente;<br >1 - ejecutar en el servidor Zabbix;<br>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.<br>Se usa si `scope` es `2` o `4`.|
|authtype|número entero|Método de autenticación utilizado para el tipo de script SSH.<br>Se utiliza si `tipo` es `2`.<br><br>Valores posibles:<br>0 - contraseña;<br>1 - clave pública. |
|nombre de usuario|cadena|Nombre de usuario utilizado para la autenticación.<br>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.<br>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.<br>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.<br>Obligatorio si el tipo es `2` y `authtype` es `1`.|
|puerto|cadena|Número de puerto utilizado para guiones SSH y Telnet.<br>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.<br><br>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.<br>Se utiliza si `scope` es `2` o `4`.<br><br>Predeterminado: 0.|
|host\_access|número entero|Permisos de host necesarios para ejecutar el guion.<br>Se utiliza si `scope` es `2` o `4`.<br><br>Valores posibles:<br>2 - *(predeterminado) * leer;<br>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.<br>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.<br>Obligatorio si `tipo` es `5`.<br><br>Valores posibles:<br>1-60s<br><br>Valor predeterminado:<br>30s|
|parámetros|matriz|Matriz de [webhook input parameters](/manual/api/reference/script/object#Parámetros del gancho web).<br>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.

[comment]: # ({/cd8ec58e-9c6db006})

[comment]: # ({3378eaae-05b0e37d})
### Parámetros del webhook

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

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**name**<br>(obligatorio)|cadena|Nombre del parámetro.|
|value|cadena|Valor del parámetro. Admite [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/3378eaae-05b0e37d})

[comment]: # ({44d8d2c4-587d2fd0})
### Depurar

Información de depuración del script de webhook ejecutado. El objeto de depuración tiene las
siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|logs|matriz|Matriz de [entradas de registro](/manual/api/reference/script/object#log-entry).|
|ms|cadena|Duración de la ejecución del script en milisegundos.|

[comment]: # ({/44d8d2c4-587d2fd0})

[comment]: # ({63401e0b-8ea23127})
### Entrada de registro

El objeto de entrada de registro tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|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.|

[comment]: # ({/63401e0b-8ea23127})
