Documentation
Table of Contents
> עצם לוח מחוונים
העצמים הבאים קשורים ישירות ל־API dashboard.
לוח מחוונים
לאובייקט לוח המחוונים יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| dashboardid | string | (לקריאה בלבד) מזהה לוח המחוונים. |
| שם (חובה) |
מחרוזת | שם לוח המחוונים. |
| userid | string | זיהוי משתמש של בעל לוח המחוונים. |
| private | integer | סוג שיתוף לוח המחוונים. ערכים אפשריים: 0 - לוח מחוונים ציבורי; 1 - (ברירת מחדל) לוח מחוונים פרטי. |
| display_period | integer | תקופת ברירת המחדל להצגת דף (בשניות). ערכים אפשריים: 10, 30, 60, 120, 600, 1800, 3600. ברירת מחדל: 30. |
| auto_start | integer | התחל אוטומטית של מצגת. ערכים אפשריים: 0 - אל תפעיל אוטומטית מצגת; 1 - (ברירת מחדל) התחל אוטומטית של מצגת. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
דף לוח המחוונים
לאובייקט עמוד לוח המחוונים יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| dashboard_pageid | string | (לקריאה בלבד) מזהה דף לוח המחוונים. |
| name | string | שם דף לוח המחוונים. ברירת מחדל: מחרוזת ריקה. |
| display_period | מספר שלם | תקופת הצגת דף לוח המחוונים (בשניות). ערכים אפשריים: 0, 10, 30, 60, 120, 600, 1800, 3600. ברירת מחדל: 0 (ישתמש בתקופת ברירת המחדל של תצוגת העמוד). |
| widgets | מערך | מערך של האובייקטים יישומון לוח המחוונים. |
ווידג'ט של לוח המחוונים
לאובייקט הווידג'ט של לוח המחוונים יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| widgetid | string | (לקריאה בלבד) מזהה הווידג'ט של לוח המחוונים. |
| סוג (נדרש) |
מחרוזת | סוג הווידג'ט של לוח המחוונים. ערכים אפשריים: actionlog - יומן פעולות; שעון - שעון; ( הוצא משימוש) dataover - סקירת נתונים; גילוי - סטטוס גילוי; תרשימים - גרפים מועדפים; מפות - מפות מועדפות; גרף - גרף (קלאסי); אב-טיפוס גרף - אב טיפוס של גרף; hostavail - זמינות מארח; פריט - ערך פריט; מפה - מפה; navtree - עץ ניווט מפה; טקסט פשוט - טקסט רגיל; מארחים בעיות - מארחים בעיה; >בעיות - בעיות; problemsbysv - בעיות לפי חומרה; slareport - SLA report; svggraph - Graph; systeminfo - system information; tophosts - Top hosts; trigover - סקירת טריגר; כתובת אתר - URL; אינטרנט - ניטור אינטרנט. |
| name | string | שם ווידג'ט מותאם אישית. |
| x | integer | מיקום אופקי מהצד השמאלי של לוח המחוונים. ערכים חוקיים נעים בין 0 ל-23. |
| y | integer | מיקום אנכי מהחלק העליון של לוח המחוונים. ערכים חוקיים נעים בין 0 ל-62. |
| width | integer | רוחב הווידג'ט. ערכים חוקיים נעים בין 1 ל-24. |
| height | integer | גובה הווידג'ט. ערכים חוקיים נעים בין 2 ל-32. |
| view_mode | integer | מצב תצוגת הווידג'ט. ערכים אפשריים: 0 - (ברירת מחדל) תצוגת ווידג'ט ברירת מחדל; 1 - עם כותרת נסתרת; |
| fields | array | מערך של שדה הווידג'ט של לוח המחוונים. |
שדה הווידג'ט של לוח המחוונים
לאובייקט שדה הווידג'ט של לוח המחוונים יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| סוג (נדרש) |
מספר שלם | סוג שדה הווידג'ט. ערכים אפשריים: 0 - מספר שלם; 1 - מחרוזת; 2 - מארח group; 3 - מארח; 4 - פריט; 5 - אב טיפוס של פריט; 6 - גרף; 7 - אב טיפוס גרף; 8 - מפה; 9 - שירות; 10 - SLA. |
| שם (חובה) |
מחרוזת | שם שדה ווידג'ט. ערכים אפשריים: ראה שדות יישומון של לוח מחוונים. |
| ערך (נדרש) |
מעורב | ערך שדה ווידג'ט בהתאם לסוג. ערכים אפשריים: ראה שדות יישומון של לוח מחוונים . |
קבוצת משתמשים בלוח המחוונים
רשימת הרשאות לוח המחוונים מבוססת על קבוצות משתמשים. יש לו את הדברים הבאים נכסים.
| Property | Type | תיאור |
|---|---|---|
| usrgrpid (נדרש) |
string | מזהה קבוצת משתמשים. |
| הרשאה (נדרש) |
מספר שלם | סוג רמת ההרשאה. ערכים אפשריים: 2 - לקריאה בלבד; 3 - קריאה-כתיבה; |
משתמש בלוח המחוונים
רשימת הרשאות לוח המחוונים מבוססת על משתמשים. יש לו את הדברים הבאים נכסים.
| Property | Type | תיאור |
|---|---|---|
| userid (נדרש) |
string | מזהה משתמש. |
| הרשאה (נדרש) |
מספר שלם | סוג רמת ההרשאה. ערכים אפשריים: 2 - לקריאה בלבד; 3 - קריאה-כתיבה; |