Skripta objekts

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

Skripts

Skripta objektam ir šādi rekvizīti.

Property Type Description
scriptid ID Skripta ID.

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

Rekvizīta 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ā vērtība, ja scope ir iestatīts uz "manual host action" vai "manual event action":
6 - URL.

Rekvizīta darbība:
- obligāts izveides operācijām
command string Izpildāmā komanda.

Rekvizīta 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 - action operation;
2 - manual host action;
4 - manual event action.

Rekvizīta darbība:
- obligāts izveides operācijām
execute_on integer Vieta, kur izpildīt skriptu.

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

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "Script"
menu_path string Ar slīpsvītru atdalītas mapes, kas, noklikšķinot uz hosts vai notikuma, lietotāja saskarnē veido izvēlni līdzīgu navigāciju.

Rekvizīta darbība:
- atbalstīts, ja scope ir iestatīts uz "manual host action" vai "manual event action"
authtype integer SSH skripta tipam izmantotā autentifikācijas metode.

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

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "SSH"
username string Autentifikācijai izmantotais lietotājvārds.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SSH" vai "TELNET"
password string Parole, ko izmanto SSH skriptiem ar paroles autentifikāciju un TELNET skriptiem.

Rekvizīta 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, ko izmanto SSH skriptiem ar publiskās atslēgas autentifikāciju.

Rekvizīta 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, ko izmanto SSH skriptiem ar publiskās atslēgas autentifikāciju.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "SSH" un authtype ir iestatīts uz "public key"
port string SSH un TELNET skriptiem izmantotais porta numurs.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "SSH" vai "TELNET"
groupid ID Hostu grupas ID, kurā skriptu var izpildīt.

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.

Rekvizīta 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.

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

Rekvizīta 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.

Rekvizīta darbība:
- obligāts, ja type ir iestatīts uz "Webhook"
parameters array Webhook ievades parametru masīvs.

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

Rekvizīta 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ā.

Rekvizīta darbība:
- atbalstīts, ja type ir iestatīts uz "URL"
manualinput integer Norāda, vai skripts pieņem lietotāja ievadi.

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

Rekvizīta 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.

Rekvizīta darbība:
- obligāts, ja manualinput ir iestatīts uz "Enabled"
manualinput_validator string Rakstzīmju virknes lauks, ko izmanto lietotāja ievadītās vērtības validēšanai. Virkne sastāv no regulārās izteiksmes vai ar komatiem atdalīta vērtību kopuma.

Rekvizīta 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 jāapstrādā kā regulārā izteiksme;
1 - saraksts. Norāda, ka manualinput_validator jāapstrādā kā ar komatiem atdalīts iespējamo ievades vērtību saraksts.

Rekvizīta 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.

Rekvizīta 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.