> עצם סקריפט

העצמים הבאים קשורים ישירות ל־API‏ script.

סקריפט

לאובייקט הסקריפט יש את המאפיינים הבאים.

Property Type תיאור
scriptid string (לקריאה בלבד) מזהה הסקריפט.
שם
(חובה)		 מחרוזת שם הסקריפט.
סוג
(נדרש)		 מספר שלם סוג סקריפט.

ערכים אפשריים:
0 - סקריפט;
1 - IPMI;
2 - SSH;<br >3 - Telnet;
5 - (ברירת מחדל) Webhook.
פקודה
(חובה)		 string פקודה להפעלה.
scope integer היקף סקריפט.

ערכים אפשריים:
1 - פעולת פעולה ברירת מחדל;
2 - פעולת מארח ידנית;
4 - פעולה ידנית של אירוע.
execute_on integer היכן להפעיל את הסקריפט.
משמש אם type הוא 0 (script).

ערכים אפשריים:
0 - הפעל על סוכן Zabbix;<br >1 - הפעלה על שרת Zabbix;
2 - (ברירת מחדל) הפעלה על שרת Zabbix (פרוקסי).
menu_path string תיקיות מופרדות באמצעות לוכסן היוצרים תפריט כמו ניווט ב-frontend כאשר לוחצים על מארח או אירוע.
משמש אם scope הוא 2 או 4.
authtype integer שיטת אימות המשמשת עבור סוג סקריפט SSH.
משמש אם type הוא 2.

ערכים אפשריים:
0 - סיסמה;
1 - מפתח ציבורי.
username string שם משתמש המשמש לאימות.
נדרש אם סוג הוא 2 או 3.
password string הסיסמה המשמשת עבור סקריפטים של SSH עם אימות סיסמה וסקריפטים של Telnet.
משמשת אם סוג הוא 2 וauthtype הוא 0 או סוג הוא 3.
publickey string שם קובץ המפתח הציבורי המשמש עבור סקריפטים של SSH עם אימות מפתח ציבורי.
נדרש אם הסוג הוא 2 ו-authtype הוא 1.
privatekey string שם קובץ המפתח הפרטי המשמש עבור סקריפטים של SSH עם אימות מפתח ציבורי.
נדרש אם הסוג הוא 2 ו-authtype הוא 1.
port string מספר יציאה בשימוש עבור סקריפטים של SSH ו-Telnet.
משמש אם הסוג הוא 2 או 3.
groupid string מזהה של קבוצת המארח שעליה ניתן להפעיל את הסקריפט. אם מוגדר ל-0, הסקריפט יהיה זמין בכל קבוצות המארחים.

ברירת מחדל: 0.
usrgrpid string מזהה של קבוצת המשתמשים שתורשה להפעיל את הסקריפט. אם מוגדר ל-0, הסקריפט יהיה זמין עבור כל קבוצות המשתמשים.
משמש אם scope הוא 2 או 4.

ברירת מחדל: 0.
host_access integer דרושות הרשאות מארח להפעלת הסקריפט.
משמש אם scope הוא 2 או 4.

ערכים אפשריים:
2 - (ברירת מחדל) קרא;
3 - כתוב.
confirmation string טקסט קופץ לאישור. החלון הקופץ יופיע בעת ניסיון להריץ את הסקריפט מהחזית של Zabbix.
משמש אם scope הוא 2 או 4.
timeout string פסק זמן לביצוע סקריפט Webhook בשניות. סיומות זמן נתמכות, למשל. 30s, 1m.
נדרש אם סוג הוא 5.

ערכים אפשריים:
1-60s

ערך ברירת מחדל:
30s
parameters מערך מערך של [פרמטרי קלט webhook](/manual/api/reference/script/object#Webhook פרמטרים).
משמש אם סוג הוא 5.
description string תיאור התסריט.

שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.

פרמטרים של Webhook

לפרמטרים המועברים לסקריפט webhook כאשר הוא נקרא יש את הדברים הבאים נכסים.

Property Type תיאור
שם
(חובה)		 מחרוזת שם הפרמטר.
value string ערך פרמטר. תומך בmacros.

לנפות

איתור באגים של סקריפט webhook שבוצע. לאובייקט ניפוי הבאגים יש את המאפיינים הבאים.

Property Type תיאור
logs מערך מערך של [רשומות יומן](/manual/api/reference/script/object#כניסת יומן).
ms string משך ביצוע סקריפט באלפיות שניות.

לנפות

איתור באגים של סקריפט webhook שבוצע. לאובייקט ניפוי הבאגים יש את המאפיינים הבאים.

Property Type תיאור
logs מערך מערך של [רשומות יומן](/manual/api/reference/script/object#כניסת יומן).
ms string משך ביצוע סקריפט באלפיות שניות.