Skripta objekts

Tālāk norādītie objekti ir tieši saistīti ar script API.

Skripts

Skripta objektam ir šādas īpašības.

Īpašība Tips Apraksts
scriptid ID Skripta ID.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas operācijām
name string Skripta nosaukums.

Īpašības darbība:
- obligāts izveides operācijām
type integer Skripta tips.

Iespējamās vērtības, ja scope ir iestatīts uz "action operation":
0 - Skripts;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Iespējamās vērtības, ja scope ir iestatīts uz "manual host action" vai "manual event action":
6 - URL.

Īpašības darbība:
- obligāts izveides operācijām
command string Komanda, ko izpildīt.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Script", "IPMI", "SSH", "TELNET" vai "Webhook"
scope integer Skripta tvērums.

Iespējamās vērtības:
1 - darbības operācija;
2 - manuāla hosta darbība;
4 - manuāla notikuma darbība.

Īpašības darbība:
- obligāts izveides operācijām
execute_on integer Kur izpildīt skriptu.

Iespējamās vērtības:
0 - izpildīt uz Zabbix aģenta;
1 - izpildīt uz Zabbix servera. Tas tiek atbalstīts tikai tad, ja Zabbix serverī ir iespējota globālo skriptu izpilde;
2 - (noklusējums) izpildīt uz Zabbix servera vai starpniekservera.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Script"
menu_path string Mapes, kas atdalītas ar slīpsvītru un veido izvēlnei līdzīgu navigāciju lietotāja saskarnē, noklikšķinot uz hosta vai notikuma.

Īpašības darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
authtype integer Autentifikācijas metode, kas izmantota SSH skripta tipam.

Iespējamās vērtības:
0 - parole;
1 - publiskā atslēga.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "SSH"
username string Lietotājvārds, kas izmantots autentifikācijai.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "SSH" vai "TELNET"
password string Parole, kas izmantota SSH skriptiem ar paroles autentifikāciju un TELNET skriptiem.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "SSH" un authtype ir iestatīts uz "password", vai type ir iestatīts uz "TELNET"
publickey string Publiskās atslēgas faila nosaukums, kas izmantots SSH skriptiem ar publiskās atslēgas autentifikāciju.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "SSH" un authtype ir iestatīts uz "public key"
privatekey string Privātās atslēgas faila nosaukums, kas izmantots SSH skriptiem ar publiskās atslēgas autentifikāciju.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "SSH" un authtype ir iestatīts uz "public key"
port string Porta numurs, kas izmantots SSH un TELNET skriptiem.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "SSH" vai "TELNET"
groupid ID Hostu grupas ID, uz kuras var izpildīt skriptu.

Ja iestatīts uz "0", skripts būs pieejams visās hostu grupās.

Noklusējums: 0.
usrgrpid ID Lietotāju grupas ID, kurai būs atļauts izpildīt skriptu.

Ja iestatīts uz "0", skripts būs pieejams visām lietotāju grupām.

Noklusējums: 0.

Īpašības darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
host_access integer Hosta atļaujas, kas nepieciešamas skripta izpildei.

Iespējamās vērtības:
2 - (noklusējums) lasīšana;
3 - rakstīšana.

Īpašības darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
confirmation string Apstiprinājuma uznirstošā loga teksts.
Mēģinot izpildīt skriptu no Zabbix lietotāja saskarnes, tiks parādīts uznirstošais logs.

Īpašības darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
timeout string Webhook skripta izpildes taimauts sekundēs. Tiek atbalstīti laika sufiksi (piemēram, 30s, 1m).

Iespējamās vērtības: 1-60s.

Noklusējums: 30s.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "Webhook"
parameters array webhook ievades parametru masīvs.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "Webhook"
description string Skripta apraksts.
url string Lietotāja definēts URL.

Īpašības darbība:
- obligāts, ja type ir iestatīts uz "URL"
new_window integer Atvērt URL jaunā logā.

Iespējamās vērtības:
0 - Nē;
1 - (noklusējums) Jā.

Īpašības darbība:
- atbalstīts, ja type ir iestatīts uz "URL"
manualinput integer Norāda, vai skripts pieņem lietotāja ievadītu ievadi.

Iespējamās vērtības:
0 - (noklusējums) Atspējots;
1 - Iespējots;

Īpašības darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
manualinput_prompt string Manuālās ievades uzvednes teksts.

Īpašības darbība:
- obligāts, ja manualinput ir iestatīts uz "Enabled"
manualinput_validator string Rakstzīmju virknes lauks, kas izmantots lietotāja ievadītās ievades validēšanai. Virkne sastāv vai nu no regulārās izteiksmes, vai no vērtību kopas, kas atdalītas ar komatiem.

Īpašības darbība:
- obligāts, ja manualinput ir iestatīts uz "Enabled"
manualinput_validator_type integer Nosaka sagaidāmās lietotāja ievades tipu.

Iespējamās vērtības:
0 - (noklusējums) Virkne. Norāda, ka manualinput_validator ir jāapstrādā kā regulārā izteiksme;
1 - Saraksts. Norāda, ka manualinput_validator ir jāapstrādā kā ar komatiem atdalīts iespējamo ievades vērtību saraksts.

Īpašības darbība:
- atbalstīts, ja manualinput ir iestatīts uz "Enabled"
manualinput_default_value string Noklusējuma vērtība lietotāja ievades automātiskai aizpildīšanai.

Īpašības darbība:
- atbalstīts, ja manualinput_validator_type ir iestatīts uz "String"

Webhook parametri

Parametriem, kas tiek nodoti webhook skriptam tā izsaukšanas laikā, ir šādas īpašības.

Īpašība Tips Apraksts
name string Parametra nosaukums.

Īpašības darbība:
- obligāts
value string Parametra vērtība. Atbalsta makro.

Atkļūdošana

Izpildītā webhook skripta atkļūdošanas informācija. Atkļūdošanas objektam ir šādas īpašības.

Īpašība Type Apraksts
logs array Žurnāla ierakstu masīvs.
ms string Skripta izpildes ilgums milisekundēs.

Žurnāla ieraksts

Žurnāla ieraksta objektam ir šādas īpašības.

Īpašība Tips Apraksts
level integer Žurnāla līmenis.
ms string Milisekundēs izteiktais laiks, kas pagājis kopš skripta palaišanas, pirms tika pievienots žurnāla ieraksts.
message string Žurnāla ziņojums.