[comment]: # aside:1

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

Els següents objectes són relacionats amb l'API `script`.

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

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

L'objecte script té les següents propietats.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|scriptid|ID|Script ID.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *només lectura*<br>- *obligatori* per operacions d'actualització|
|name|string|Nom de l'script.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* per operacions de creació|
|type|integer|Tipus d'script.<br><br>Valors possibles si `scope` s'ha definit a "operació d'acció":<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;< br>3 - Telnet;<br>5 - Webhook.<br><br>Valors possibles si `scope` és "acció manual d'equip" o "acció manual d'esdeveniment":<br>6 - URL.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* per operacions de creació|
|command|string|Comanda a executar.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "Script", "IPMI", "SSH", "TELNET" o "Webhook"|
|scope|integer|Àmbit de l'script.<br><br>Valors possibles:<br>1 - operació d'acció *per defecte*;<br>2 - acció manual a l'equip;<br>4 - acció manual a l'esdeveniment.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* per operacions de creació|
|execute\_on|integer|On s'executa l'script.<br><br>Valors possibles:<br>0 - s'executa a l'agent Zabbix; <br>1 - s'executa al servidor Zabbix. només s'*admet* si l'execució d'scripts globals s'ha habilitat al servidor Zabbix;<br>2 - *(per defecte)* s'executa al servidor o proxy Zabbix.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `type` és "Script"|
|menu\_path|string|Carpetes separades per una barra que formen un menú com la navegació a la interfície quan es fa clic a l'equip o l'esdeveniment.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `scope` és  "acció manual d'equip" o "acció manual d'esdeveniment"|
|authtype|integer|Mètode d'autenticació emprat per al tipus d'script SSH.<br><br>Valors possibles:<br>0 - mot de pas;<br>1 - clau pública.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `type` és "SSH"|
|username|string|Nom d'usuari emprat per a l'autenticació.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "SSH" o "TELNET"|
|password|string|El mot de pas emprat per a scripts SSH amb autenticació de mot de pas i scripts TELNET.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `type` és "SSH" i `authtype` és "password", o `type` és "TELNET"|
|publickey|string|Nom del fitxer de clau pública emprat per als scripts SSH amb autenticació de clau pública.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "SSH" i `authtype` és "public key".|
|privatekey|string|Nom del fitxer de clau privada emprat per als scripts SSH amb autenticació de clau pública.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "SSH" i `authtype` és "public key".|
|port|string|Nombre de port emprat per als scripts SSH i Telnet.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `type` és "SSH" o "TELNET"|
|groupid|ID|ID del grup d'equips en què es pot executar l'script.<br><br>Si el valor és "0", l'script serà disponible a tots els grups d'equips.<br><br>Per defecte: 0.|
|usrgrpid|ID|ID del grup d'usuaris al qual es permetrà executar l'script. Si s'estableix a "0", l'script serà disponible per a tots els grups d'usuaris.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `scope` és "acció manual d'equip" o "acció manual d'esdeveniment"|
|host\_access|integer|Permisos d'equip necessaris per executar l'script.<br><br>Valors possibles:<br>2 - *(per defecte)* llegir;<br>3 - escriure.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `scope` és "acció manual d'equip" o "acció manual d'esdeveniment"|
|confirmation|string|Text emergent de confirmació.<br>Apareix una finestra emergent quan intenteu executar un script des de la interfície Zabbix.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `scope` és "acció manual d'equip" o "acció manual d'esdeveniment"|
|timeout|string|Temps d'espera d'execució de l'script Webhook en segons. S'admeten sufixos de temps, com ara 30s, 1m.<br><br>Valors possibles: 1-60s<br><br>Valor predeterminat: 30s<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "Webhook"|
|parameters|array|taula de [paràmetres d'entrada webhook](/manual/api/reference/script/object#webhook-parameters).<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "Webhook"|
|description|string|Descripció de l'script.|
|url|string|URL definida de l'usuari.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "URL"|
|new_window|integer|Obrir la URL a una finestra nova.<br><br>Valors possibles:<br>0 - No;<br>1 - *(per defecte)* Sí.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `type` és "URL"|
|manualinput|integer|Indica si l'script admet entrades proveïdes per l'usuari.<br><br>Valors possibles:<br>0 - *(per defecte)* Desactivat;<br>1 - Activat;<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `scope` és "acció manual d'equip" o "acció manual d'esdeveniment"|
|manualinput_prompt|string|Text de pregunta per a l'entrada manual.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `manualinput` és "Actiu"|
|manualinput_validator|string|Un camp de cadena de caràcters per validar l'usuari que farà l'entrada. La cadena consisteix en una expressió regular o un conjunt de valors separats per comes.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori* si `manualinput` és "Actiu"|
|manualinput_validator_type|integer|Determina el tipus d'entrada d'usuari esperada.<br><br>Valors possibles:<br>0 - *(per defecte)* Cadena. Indica si el manualinput_validator es tractarà com a expressió regular;<br>1 - Llista. Tracta el manualinput_validator com una llista de possibles valors d'entrada separats per comes.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `manualinput` és "Actiu"|
|manualinput_default_value|string|Valor per defecte per auto-emplenar l'entrada d'usuari.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *admès* si `manualinput_validator_type` és "Cadena"|

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

[comment]: # ({5b738d2f-05b0e37d})
#### Paràmetres Webhook

Els paràmetres passats a l'script webhook quan es crida tenen les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|name|cadena|Nom del paràmetre.<br><br>[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):<br>- *obligatori*|
|value|cadena|Valor del paràmetre. Admet [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/5b738d2f-05b0e37d})

[comment]: # ({5ab53a02-587d2fd0})
### Depuració

Informació de depuració de l'script Webhook executat. L'objecte depuració té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|logs|array|Matriu d'[entrades de registre](/manual/api/reference/script/object#log-entry).|
|ms|string|Temps d'execució de l'script en mil·lisegons.|

[comment]: # ({/5ab53a02-587d2fd0})

[comment]: # ({e069e890-8ea23127})
#### Entrada de registre

L'objecte d'entrada de registre té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|level|integer|Nivell de registre.|
|ms|string|Temps transcorregut en mil·lisegons des que s'executa l'script abans que s'afegeix l'entrada de registre.|
|message|string|Missatge de registre.|

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