This is a translation of the original English documentation page. Help us make it better.

Sidebar

> Kaartobject

De volgende objecten zijn direct gerelateerd aan de map API.

Script

Het scriptobject heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
scriptid string (alleen-lezen) ID van het script.
name
(verplicht)
string Naam van het script.
type
(vereist)
geheel getal Scripttype.

Mogelijke waarden:
0 - Script;
1 - IPMI;
2 - SSH;<br >3 - Telnet;
5 - (standaard) Webhook.
opdracht
(vereist)
string Opdracht om uit te voeren.
scope integer Scriptbereik.

Mogelijke waarden:
1 - default actiebewerking;
2 - handmatige hostactie;
4 - handmatige gebeurtenisactie.
execute_on integer Waar het script moet worden uitgevoerd.
Gebruikt als type 0 is (script).

Mogelijke waarden:
0 - uitgevoerd op Zabbix-agent;<br >1 - draaien op Zabbix-server;
2 - (standaard) draaien op Zabbix-server (proxy).
menu_path string Mappen gescheiden door schuine streep die een menu vormen, zoals navigatie in frontend wanneer op host of gebeurtenis wordt geklikt.
Gebruikt als scope 2 of 4 is.
authtype integer Verificatiemethode gebruikt voor SSH-scripttype.
Gebruikt als type 2 is.

Mogelijke waarden:
0 - wachtwoord;
1 - openbare sleutel.
username string Gebruikersnaam gebruikt voor authenticatie.
Vereist als type 2 of 3 is.
password string Wachtwoord gebruikt voor SSH-scripts met wachtwoordverificatie en Telnet-scripts.
Gebruikt als type 2 is en authtype 0 of type 3 is.
publickey string Naam van het openbare-sleutelbestand dat wordt gebruikt voor SSH-scripts met openbare-sleutelverificatie.
Vereist als het type 2 en authtype 1 is.
privatekey string Naam van het privésleutelbestand dat wordt gebruikt voor SSH-scripts met openbare-sleutelverificatie.
Vereist als het type 2 en authtype 1 is.
port string Poortnummer gebruikt voor SSH- en Telnet-scripts.
Gebruikt als type 2 of 3 is.
groupid string ID van de hostgroep waarop het script kan worden uitgevoerd. Indien ingesteld op 0, is het script beschikbaar voor alle hostgroepen.

Standaard: 0.
usrgrpid string ID van de gebruikersgroep die het script mag uitvoeren. Indien ingesteld op 0, is het script beschikbaar voor alle gebruikersgroepen.
Gebruikt als scope 2 of 4 is.

Standaard: 0.
host_access integer Hostmachtigingen nodig om het script uit te voeren.
Gebruikt als scope 2 of 4 is.

Mogelijke waarden:
2 - (standaard) lezen;
3 - schrijven.
confirmation string Bevestiging pop-up tekst. De pop-up verschijnt wanneer u probeert het script uit te voeren vanaf de Zabbix-frontend.
Gebruikt als scope 2 of 4 is.
timeout string Time-out voor uitvoering van webhook-script in seconden. Tijdachtervoegsels worden ondersteund, b.v. 30s, 1m.
Vereist als type 5 is.

Mogelijke waarden:
1-60s

Standaardwaarde:
30s
parameters array Array van webhook-invoerparameters.
Gebruikt als type 5 is.
description string Beschrijving van het script.

Webhook-parameters

Parameters die worden doorgegeven aan het webhook-script wanneer het wordt aangeroepen, hebben het volgende: eigendommen.

Eigenschap Type Beschrijving
naam
(verplicht)
string Parameternaam.
value string Parameterwaarde. Ondersteunt macro's.

Debuggen

Foutopsporingsinformatie van uitgevoerd webhook-script. Het debug-object heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
logs array Array van logitems.
ms string Duur van scriptuitvoering in milliseconden.

Logboekinvoer

Het logboekinvoerobject heeft de volgende eigenschappen.

Eigenschap Type Beschrijving
level geheel getal Logniveau.
ms string De verstreken tijd in milliseconden sinds het script werd uitgevoerd voordat de logboekinvoer werd toegevoegd.
message string Log bericht.