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 ID Script ID.

Comportament de la propietat:
- només lectura
- obligatori per operacions d'actualització
name string Nom de l'script.

Comportament de la propietat:
- obligatori per operacions de creació
type integer Tipus d'script.

Valors possibles si scope s'ha definit a "operació d'acció":
0 - Script;
1 - IPMI;
2 - SSH;< br>3 - Telnet;
5 - Webhook.

Valors possibles si scope és "acció manual d'equip" o "acció manual d'esdeveniment":
6 - URL.

Comportament de la propietat:
- obligatori per operacions de creació
command string Comanda a executar.

Comportament de la propietat:
- obligatori si type és "Script", "IPMI", "SSH", "TELNET" o "Webhook"
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.

Comportament de la propietat:
- obligatori per operacions de creació
execute_on integer On s'executa l'script.

Valors possibles:
0 - s'executa a l'agent Zabbix;
1 - s'executa al servidor Zabbix. només s'admet si l'execució d'scripts globals s'ha habilitat al servidor Zabbix;
2 - (per defecte) s'executa al servidor o proxy Zabbix.

Comportament de la propietat:
- 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.

Comportament de la propietat:
- 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.

Valors possibles:
0 - mot de pas;
1 - clau pública.

Comportament de la propietat:
- admès si type és "SSH"
username string Nom d'usuari emprat per a l'autenticació.

Comportament de la propietat:
- 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.

Comportament de la propietat:
- 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.

Comportament de la propietat:
- 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.

Comportament de la propietat:
- obligatori si type és "SSH" i authtype és "public key".
port string Nombre de port emprat per als scripts SSH i Telnet.

Comportament de la propietat:
- admès si type és "SSH" o "TELNET"
groupid ID 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 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.

Comportament de la propietat:
- 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.

Valors possibles:
2 - (per defecte) llegir;
3 - escriure.

Comportament de la propietat:
- admès si scope és "acció manual d'equip" o "acció manual d'esdeveniment"
confirmation string Text emergent de confirmació.
Apareix una finestra emergent quan intenteu executar un script des de la interfície Zabbix.

Comportament de la propietat:
- 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.

Valors possibles: 1-60s

Valor predeterminat: 30s

Comportament de la propietat:
- obligatori si type és "Webhook"
parameters array taula de paràmetres d'entrada webhook.

Comportament de la propietat:
- obligatori si type és "Webhook"
description string Descripció de l'script.
url string URL definida de l'usuari.

Comportament de la propietat:
- obligatori si type és "URL"
new_window integer Obrir la URL a una finestra nova.

Valors possibles:
0 - No;
1 - (per defecte) Sí.

Comportament de la propietat:
- obligatori si type és "URL"
manualinput integer Indica si l'script admet entrades proveïdes per l'usuari.

Valors possibles:
0 - (per defecte) Desactivat;
1 - Activat;

Comportament de la propietat:
- 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.

Comportament de la propietat:
- 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.

Comportament de la propietat:
- obligatori si manualinput és "Actiu"
manualinput_validator_type integer Determina el tipus d'entrada d'usuari esperada.

Valors possibles:
0 - (per defecte) Cadena. Indica si el manualinput_validator es tractarà com a expressió regular;
1 - Llista. Tracta el manualinput_validator com una llista de possibles valors d'entrada separats per comes.

Comportament de la propietat:
- admès si manualinput és "Actiu"
manualinput_default_value string Valor per defecte per auto-emplenar l'entrada d'usuari.

Comportament de la propietat:
- admès si manualinput_validator_type és "Cadena"

Paràmetres Webhook

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

Propietat Tipus Descripció
name cadena Nom del paràmetre.

Comportament de la propietat:
- obligatori
value cadena 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.