Documentation
Table of Contents
> Kaartobject
De volgende objecten zijn direct gerelateerd aan de map API.
Script
Het scriptobject heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| scriptid | string | ID van het script. Eigenschapsgedrag: - alleen-lezen - vereist voor updatebewerkingen |
| name | string | Naam van het script. Eigenschapsgedrag: - vereist voor create-bewerkingen |
| type | integer | Scripttype. Mogelijke waarden als scope is ingesteld op "action operation":0 - Script; 1 - IPMI; 2 - SSH; 3 - TELNET; 5 - Webhook. Mogelijke waarden als scope is ingesteld op "manual host action" of "manual event action":6 - URL. Eigenschapsgedrag: - vereist voor create-bewerkingen |
| command | string | Uit te voeren opdracht. Eigenschapsgedrag: - vereist als type is ingesteld op "Script", "IPMI", "SSH", "TELNET" of "Webhook" |
| scope | integer | Scriptomvang. Mogelijke waarden: 1 - actiebewerking; 2 - handmatige hostactie; 4 - handmatige gebeurtenisactie. Eigenschapsgedrag: - vereist voor create-bewerkingen |
| execute_on | integer | Waar het script moet worden uitgevoerd. Mogelijke waarden: 0 - uitvoeren op Zabbix-agent; 1 - uitvoeren op Zabbix-server; 2 - (standaard) uitvoeren op Zabbix-server (proxy). Eigenschapsgedrag: - ondersteund als type is ingesteld op "Script" |
| menu_path | string | Mappen gescheiden door een schuine streep die een menuachtige navigatie vormen in de frontend wanneer er op een host of gebeurtenis wordt geklikt. Eigenschapsgedrag: - ondersteund als scope is ingesteld op "manual host action" of "manual event action" |
| authtype | integer | Authenticatiemethode die wordt gebruikt voor het scripttype SSH. Mogelijke waarden: 0 - wachtwoord; 1 - openbare sleutel. Eigenschapsgedrag: - ondersteund als type is ingesteld op "SSH" |
| username | string | Gebruikersnaam die wordt gebruikt voor authenticatie. Eigenschapsgedrag: - vereist als type is ingesteld op "SSH" of "TELNET" |
| password | string | Wachtwoord dat wordt gebruikt voor SSH-scripts met wachtwoordauthenticatie en TELNET-scripts. Eigenschapsgedrag: - ondersteund als type is ingesteld op "SSH" en authtype is ingesteld op "password", of type is ingesteld op "TELNET" |
| publickey | string | Naam van het openbare-sleutelbestand dat wordt gebruikt voor SSH-scripts met openbare-sleutelauthenticatie. Eigenschapsgedrag: - vereist als type is ingesteld op "SSH" en authtype is ingesteld op "public key" |
| privatekey | string | Naam van het privésleutelbestand dat wordt gebruikt voor SSH-scripts met openbare-sleutelauthenticatie. Eigenschapsgedrag: - vereist als type is ingesteld op "SSH" en authtype is ingesteld op "public key" |
| port | string | Poortnummer dat wordt gebruikt voor SSH- en TELNET-scripts. Eigenschapsgedrag: - ondersteund als type is ingesteld op "SSH" of "TELNET" |
| groupid | string | ID van de hostgroep waarop het script kan worden uitgevoerd. Als ingesteld op "0", zal het script beschikbaar zijn in alle hostgroepen. Standaard: 0. |
| usrgrpid | string | ID van de gebruikersgroep die het script mag uitvoeren. Als ingesteld op "0", zal het script beschikbaar zijn voor alle gebruikersgroepen. Standaard: 0. Eigenschapsgedrag: - ondersteund als scope is ingesteld op "manual host action" of "manual event action" |
| host_access | integer | Machtigingen voor host die nodig zijn om het script uit te voeren. Mogelijke waarden: 2 - (standaard) lezen; 3 - schrijven. Eigenschapsgedrag: - ondersteund als scope is ingesteld op "manual host action" of "manual event action" |
| confirmation | string | Tekst voor bevestigingspop-up. De pop-up verschijnt wanneer wordt geprobeerd het script uit te voeren vanuit de Zabbix-frontend. Eigenschapsgedrag: - ondersteund als scope is ingesteld op "manual host action" of "manual event action" |
| timeout | string | Time-out voor de uitvoering van een webhook-script in seconden. Tijdsachtervoegsels worden ondersteund (bijv. 30s, 1m). Mogelijke waarden: 1-60s. Standaard: 30s. Eigenschapsgedrag: - vereist als type is ingesteld op "Webhook" |
| parameters | array | Array van webhook-invoerparameters. Eigenschapsgedrag: - ondersteund als type is ingesteld op "Webhook" |
| description | string | Beschrijving van het script. |
| url | string | Door de gebruiker gedefinieerde URL. Eigenschapsgedrag: - vereist als type is ingesteld op "URL" |
| new_window | integer | Open de URL in een nieuw venster. Mogelijke waarden: 0 - Nee; 1 - (standaard) Ja. Eigenschapsgedrag: - ondersteund als type is ingesteld op "URL" |
Webhook parameters
Parameters die worden doorgegeven aan een webhook-script wanneer het wordt aangeroepen, hebben de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| name | string | Naam van de parameter. Eigenschapsgedrag: - vereist |
| value | string | Waarde van de parameter. Ondersteunt macro's. |
Debug
Debuginformatie van het uitgevoerde webhook-script. Het debugobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| logs | array | Array van logboekvermeldingen. |
| ms | string | Uitvoeringsduur van het script 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. |