[comment]: # aside: 1

[comment]: # ({43284bfe-8b1700c1})
# Objeto script

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

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

[comment]: # ({1c7e0362-9c6db006})
### Script

El objeto script tiene las siguientes propiedades.

|Propiedad|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|scriptid|ID|ID del script.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *solo lectura*<br>- *requerido* para operaciones de actualización|
|name|string|Nombre del script.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* para operaciones de creación|
|type|integer|Tipo de script.<br><br>Valores posibles si `scope` está establecido 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 `scope` está establecido en "acción manual de host" o "acción manual de evento":<br>6 - URL.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* para operaciones de creación|
|command|string|Comando a ejecutar.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* si `type` está establecido en "Script", "IPMI", "SSH", "TELNET" o "Webhook"|
|scope|integer|Alcance del script.<br><br>Valores posibles:<br>1 - operación de acción;<br>2 - acción manual de host;<br>4 - acción manual de evento.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* para operaciones de creación|
|execute\_on|integer|Dónde ejecutar el script.<br><br>Valores posibles:<br>0 - ejecutar en el agent de Zabbix;<br>1 - ejecutar en el server de Zabbix. Solo es *compatible* si la ejecución de scripts globales está habilitada en el server de Zabbix;<br>2 - *(por defecto)* ejecutar en el server o proxy de Zabbix.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* 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 el host o evento.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está establecido en "acción manual de host" o "acción manual de evento"|
|authtype|integer|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á establecido en "SSH"|
|username|string|Nombre de usuario utilizado para la autenticación.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* 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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `type` está establecido en "SSH" o "TELNET"|
|groupid|ID|ID del grupo de hosts 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>Por defecto: 0.|
|usrgrpid|ID|ID del grupo de usuarios que podrá ejecutar el script.<br><br>Si se establece en "0", el script estará disponible para todos los grupos de usuarios.<br><br>Por defecto: 0.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está establecido en "acción manual de host" o "acción manual de evento"|
|host\_access|integer|Permisos de host necesarios para ejecutar el script.<br><br>Valores posibles:<br>2 - *(por defecto)* lectura;<br>3 - escritura.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está establecido en "acción manual de host" o "acción manual de evento"|
|confirmation|string|Texto de confirmación emergente.<br>La ventana emergente aparecerá al intentar ejecutar el script desde el frontend de Zabbix.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está establecido en "acción manual de host" 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).<br><br>Valores posibles: 1-60s.<br><br>Por defecto: 30s.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* si `type` está establecido en "Webhook"|
|parameters|array|Array de [parámetros de entrada de webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `type` está establecido en "Webhook"|
|description|string|Descripción del script.|
|url|string|URL definida por el usuario.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* si `type` está establecido en "URL"|
|new_window|integer|Abrir la URL en una nueva ventana.<br><br>Valores posibles:<br>0 - No;<br>1 - *(por defecto)* Sí.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `type` está establecido en "URL"|
|manualinput|integer|Indica si el script acepta la entrada proporcionada por el usuario.<br><br>Valores posibles:<br>0 - *(por defecto)* Deshabilitado;<br>1 - Habilitado;<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `scope` está establecido en "acción manual de host" o "acción manual de evento"|
|manualinput_prompt|string|Texto de aviso de entrada manual.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *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.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *requerido* si `manualinput` está establecido en "Habilitado"|
|manualinput_validator_type|integer|Determina el tipo de entrada de usuario esperada.<br><br>Valores posibles:<br>0 - *(por defecto)* Cadena. Indica que manualinput_validator debe tratarse como una expresión regular;<br>1 - Lista. Indica que manualinput_validator debe tratarse como una lista separada por comas de posibles valores de entrada.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `manualinput` está establecido en "Habilitado"|
|manualinput_default_value|string|Valor por defecto para autocompletar la entrada del usuario.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *compatible* si `manualinput_validator_type` está establecido en "Cadena"|

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

[comment]: # ({4ab66f57-05b0e37d})
#### Parámetros de webhook

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

|Propiedad|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|name|string|Nombre del parámetro.<br><br>[Comportamiento de la propiedad](/manual/api/reference_commentary#property-behavior):<br>- *obligatorio*|
|value|string|Valor del parámetro. Soporta [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/4ab66f57-05b0e37d})

[comment]: # ({0ba46586-587d2fd0})
### Depuración

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

|Propiedad|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|logs|array|Array de [entradas de registro](/manual/api/reference/script/object#log-entry).|
|ms|string|Duración de la ejecución del script en milisegundos.|

[comment]: # ({/0ba46586-587d2fd0})

[comment]: # ({f7a09e87-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|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.|

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