Documentation
Table of Contents
> עצם תרחיש אתר
העצמים הבאים קשורים ישירות ל־API webcheck.
תרחיש אינטרנט
לאובייקט תרחיש האינטרנט יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| httptestid | string | (לקריאה בלבד) מזהה של תרחיש האינטרנט. |
| hostid (נדרש) |
string | מזהה המארח שאליו שייך תרחיש האינטרנט. |
| שם (חובה) |
מחרוזת | שם תרחיש האינטרנט. |
| agent | string | מחרוזת סוכן משתמש שתשמש את תרחיש האינטרנט. ברירת מחדל: Zabbix |
| authentication | integer | שיטת אימות שתשמש את תרחיש האינטרנט. ערכים אפשריים: 0 - (ברירת מחדל) none; 1 - אימות HTTP בסיסי; 2 - אימות NTLM. |
| delay | string | מרווח ביצוע של תרחיש האינטרנט. מקבל שניות, יחידת זמן עם סיומת ומקרו משתמש. ברירת מחדל: 1m. |
| headers | מערך של שדות HTTP | כותרות HTTP שיישלחו בעת ביצוע בקשה. |
| http_password | string | סיסמה המשמשת עבור אימות HTTP או NTLM בסיסי. |
| http_proxy | string | פרוקסי שישמש את תרחיש האינטרנט שניתן בתור http://[שם משתמש[:סיסמה]@]proxy.example.com[:port]. |
| http_user | string | שם משתמש המשמש לאימות HTTP או NTLM בסיסי. |
| nextcheck | timestamp | (קריאה בלבד) זמן ביצוע תרחיש האינטרנט הבא. |
| retries | integer | מספר הפעמים שתרחיש אינטרנט ינסה לבצע כל שלב לפני כשל. ברירת מחדל: 1. |
| ssl_cert_file | string | שם קובץ אישור ה-SSL המשמש לאימות לקוח (חייב להיות בפורמט PEM). |
| ssl_key_file | string | שם קובץ המפתח הפרטי SSL המשמש לאימות לקוח (חייב להיות בפורמט PEM). |
| ssl_key_password | string | סיסמת מפתח פרטי SSL. |
| status | integer | האם תרחיש האינטרנט מופעל. ערכים אפשריים הם: 0 - (ברירת מחדל) מופעל; 1 - מושבת. |
| templateid | string | (לקריאה בלבד) מזהה של תרחיש האינטרנט של תבנית האב. |
| משתנים | מערך של שדות HTTP | משתני תרחישים באינטרנט. |
| verify_host | integer | האם יש לוודא ששם המארח שצוין בתעודת SSL תואם לזה ששימש בתרחיש. ערכים אפשריים הם: 0 - (ברירת מחדל) דלג על אימות מארח ; 1 - אמת מארח. |
| verify_peer | integer | האם לאמת את אישור ה-SSL של שרת האינטרנט. ערכים אפשריים הם: 0 - (ברירת מחדל) דלג על אימות עמית; 1 - אימות עמית. |
| uuid | string | מזהה ייחודי גלובלי, המשמש לקישור תרחישי אינטרנט מיובאים לאלה שכבר קיימים. משמש רק עבור תרחישי אינטרנט בתבניות. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
תג תרחיש אינטרנט
לאובייקט תג תרחיש אינטרנט יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| תג (נדרש) |
מחרוזת | שם תג תרחיש אינטרנט. |
| value | string | ערך תג תרחיש אינטרנט. |
שלב בתרחיש
אובייקט שלב התרחיש מגדיר בדיקת תרחיש אינטרנט ספציפית. יש לזה המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| httpstepid | string | (לקריאה בלבד) מזהה שלב התרחיש. |
| שם (חובה) |
מחרוזת | שם שלב התרחיש. |
| לא (נדרש) |
מספר שלם | מספר רצף של השלב בתרחיש אינטרנט. |
| כתובת אתר (חובה) |
מחרוזת | כתובת אתר שיש לבדוק. |
| follow_redirects | integer | האם לעקוב אחר הפניות HTTP. ערכים אפשריים הם: 0 - אל תעקוב אחר הפניות מחדש; 1 - (ברירת מחדל) follow redirects. |
| headers | מערך של שדות HTTP | כותרות HTTP שיישלחו בעת ביצוע בקשה. כותרות שלבים בתרחיש יחליפו כותרות שצוינו עבור תרחיש האינטרנט. |
| httptestid | string | (לקריאה בלבד) מזהה תרחיש האינטרנט שאליו שייך הצעד. |
| posts | string מערך של שדות HTTP |
משתני HTTP POST כמחרוזת (נתוני פוסט גולמיים) או כמערך של שדות HTTP (נתוני שדה טופס). |
| required | string | טקסט שחייב להיות קיים בתגובה. |
| retrieve_mode | integer | חלק מתגובת ה-HTTP ששלב התרחיש חייב לאחזר. ערכים אפשריים הם: 0 - (ברירת מחדל) body; 1 - רק כותרות; 2 - כותרות וגוף. |
| status_codes | string | טווחים של קודי מצב HTTP נדרשים מופרדים בפסיקים. |
| timeout | string | בקש פסק זמן תוך שניות. מקבל שניות, יחידת זמן עם סיומת ומאקרו משתמש. ברירת מחדל: 15 שניות. מקסימום: שעה אחת. מינימום: 1 שניות. |
| משתנים | מערך של שדות HTTP | משתני צעד בתרחיש. |
| query_fields | מערך של שדות HTTP | שדות שאילתה - מערך של שדות HTTP שיתווספו לכתובת URL בעת ביצוע בקשה |
שדה HTTP
אובייקט שדה ה-HTTP מגדיר שם וערך המשמשים לציון משתנה, כותרת HTTP, נתוני שדה POST של נתוני שדה שאילתה. יש לזה המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| שם (נדרש) |
מחרוזת | שם של כותרת / משתנה / שדה POST או GET. |
| ערך (נדרש) |
מחרוזת | ערך של שדה כותרת / משתנה / POST או GET. |