Documentation
Table of Contents
> Objecte script
Els següents objectes són relacionats amb l'API script.
Script
L'objecte script té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| scriptid | string | (només lectura) Script ID. |
| name (obligatori) |
string | Nom de l'script. |
| type (obligatori) |
integer | Tipus d'script. Valors possibles: 0 - Script; 1 - IPMI; 2 - SSH;< br>3 - Telnet; 5 - (per defecte) Webhook. |
| command (obligatori) |
string | Comanda a executar. |
| scope | integer | Àmbit de l'script. Valors possibles: 1 - operació d'acció per defecte; 2 - acció manual a l'equip; 4 - acció manual a l'esdeveniment. |
| execute_on | integer | On s'executa l'script. S'empra si type és 0 (script).Valors possibles: 0 - s'executa a l'agent Zabbix; <br >1 - s'executa al servidor Zabbix; 2 - (per defecte) s'executa al servidor Zabbix (proxy). |
| 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. S'empra si scope és 2 o 4. |
| authtype | integer | Mètode d'autenticació emprat per al tipus d'script SSH. S'empra si type és 2.Valors possibles: 0 - mot de pas;<br >1 - clau pública. |
| nom d'usuari | string | Nom d'usuari emprat per a l'autenticació. Obligatori si type és 2 o 3. |
| password | string | El mot de pas emprat per a scripts SSH amb autenticació de mot de pas i scripts Telnet. S'empra si type és 2 i authtype és 0 o type és 3. |
| publickey | string | Nom del fitxer de clau pública emprat per als scripts SSH amb autenticació de clau pública. Obligatori si el tipus és 2 i authtype és 1. |
| privatekey | string | Nom del fitxer de clau privada emprat per als scripts SSH amb autenticació de clau pública. Obligatori si el tipus és 2 i authtype és 1. |
| port | string | Nombre de port emprat per als scripts SSH i Telnet. S'empra si el tipus és '2' o '3'. |
| groupid | string | ID del grup d'equips en què es pot executar l'script. Si el valor és 0, l'script serà disponible a tots els grups d'equips. Per defecte: 0. |
| usrgrpid | string | 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. S'empra si scope és 2 o 4.Per defecte: 0. |
| host_access | integer | Permisos d'equip necessaris per executar l'script. S'empra si scope és 2 o 4.Valors possibles: 2 - * (per defecte)* llegir; 3 - escriure. |
| confirmació | string | Text emergent de confirmació. Apareix una finestra emergent quan intenteu executar un script des de la interfície Zabbix. S'empra si scope és 2 o 4. |
| timeout | string | Temps d'espera d'execució de l'script Webhook en segons. S'admeten sufixos de temps, p. 30 s, 1 m. Obligatori si tipus és 5.Valors possibles: 1-60s Valor predeterminat: 30s |
| description | string | Descripció de l'script. |
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
Paràmetres Webhook
Els paràmetres passats a l'script webhook quan es crida tenen les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| name (obligatori) |
string | Nom del paràmetre. |
| value | string | Valor del paràmetre. Admet macros. |
Depuració
Informació de depuració de l'script Webhook executat. L'objecte depuració té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| logs | array | Matriu d'entrades de registre. |
| ms | string | Temps d'execució de l'script en mil·lisegons. |
Entrada de registre
L'objecte d'entrada de registre té les propietats següents.
| Propietat | Tipus | 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. |