[comment]: # translation:outdated

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

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

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

[comment]: # ({6ee8e193-9c6db006})
### Script

El objeto de script tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|scriptid|cadena|ID del script.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *solo lectura*<br>- *obligatorio* para operaciones de actualización|
|name|cadena|Nombre del script.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio* para operaciones de creación|
|type|entero|Tipo de script.<br><br>Valores posibles si `scope` está configurado en "operación de acción":<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;< br>3 - TELNET;<br>5 - Webhook.<br><br>Valores posibles si `alcance` está configurado en "acción manual del host" o "acción de evento manual":<br>6 - URL.<br> <br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio* para operaciones de creación|
|command|cadena|Comando a ejecutar.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio* si `tipo` está configurado en "Script", "IPMI", "SSH", "TELNET" o "Webhook"|
|scope|entero|Alcance del script.<br><br>Valores posibles:<br>1 - operación de acción;<br>2 - acción manual del host;<br>4 - acción de evento manual.<br><br>[ Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio* para operaciones de creación|
|execute\_on|entero|Dónde ejecutar el script.<br><br>Valores posibles:<br>0 - ejecutar en el agente Zabbix;<br>1 - ejecutar en el servidor Zabbix;<br>2 - *(predeterminado )* ejecutar en el servidor Zabbix (proxy).<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):< 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.<br><br>Valores posibles:<br>0 - contraseña;<br>1 - clave pública.<br><br>[Comportamiento de la propiedad](/manual /api/reference_commentary#property-behavior):<br>- *compatible* si `type` está configurado en "SSH"|
|username|cadena|Nombre de usuario utilizado para la autenticación.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si se establece `tipo` a "SSH" o "TELNET"|
|groupid|cadena|ID del grupo de equipos en el que se puede ejecutar el script.<br><br>Si se establece en "0", el script estará disponible en todos los grupos de hosts.<br><br>Predeterminado: 0 .|
|usrgrpid|string|ID del grupo de usuarios al que se le permitirá ejecutar el script.<br><br>Si se establece en "0", el script estará disponible para todos los grupos de usuarios.<br><br>Valor predeterminado: 0.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>Valores posibles:<br>2 - *(predeterminado)* lectura;<br>3 - escritura.<br><br>[ Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está configurado en "acción manual del equipo" o "acción manual del evento"|
|confirmation|cadena|Texto emergente de confirmación.<br>La ventana emergente aparecerá cuando intente ejecutar el script desde la interfaz de Zabbix.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior ):<br>- *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).<br><br>Valores posibles: 1-60 s.<br><br>Predeterminado: 30 s.<br><br>[Comportamiento de la propiedad](/manual/api /reference_commentary#property-behavior):<br>- *obligatorio* si `tipo` está configurado en "Webhook"|
|parameters|matriz|Matriz de [parámetros de entrada del webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior ):<br>- *compatible* si `tipo` está configurado en "Webhook"|
|description|cadena|Descripción del script.|
|url|cadena|URL definida por el usuario.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio* si `tipo` está establecido en "URL"|
|new_window|entero|Abrir URL en una nueva ventana.<br><br>Valores posibles:<br>0 - No;<br>1 - *(predeterminado)* Sí.<br><br>[Comportamiento de la propiedad] (/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `type` está configurado en "URL"|

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

[comment]: # ({24e86350-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|cadena|Nombre del parámetro.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio*|
|value|cadena|Valor del parámetro. Admite [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/24e86350-05b0e37d})

[comment]: # ({5ab53a02-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]: # ({/5ab53a02-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})