hostgroup.get

תיאור

integer/array hostgroup.get(object parameters)

השיטה מאפשרת לאחזר קבוצות מארחות בהתאם לנתון פרמטרים.

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

פרמטרים

(object) פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

פרמטר	סוג	תיאור
graphids	string/array	החזר רק קבוצות מארח המכילות מארחים או תבניות עם הגרפים הנתונים.
groupids	string/array	החזר רק קבוצות מארחות עם מזהי הקבוצה המארחת שנתנו.
hostids	string/array	החזר רק קבוצות מארחים המכילות את המארחים הנתונים.
maintenanceids	string/array	החזר רק קבוצות מארחות המושפעות מהתחזוקה הנתונות.
monitored_hosts	flag	החזר רק קבוצות מארחים המכילות מארחים מנוטרים.
real_hosts	flag	החזר רק קבוצות מארחים המכילות מארחים.
templated_hosts	flag	החזר רק קבוצות מארח המכילות תבניות.
templateids	string/array	החזר רק קבוצות מארחות המכילות את התבניות הנתונות.
triggerids	string/array	החזר רק קבוצות מארח המכילות מארחים או תבניות עם הטריגרים הנתונים.
with_graphs	flag	החזר רק קבוצות מארח המכילות מארחים עם גרפים.
with_graph_prototypes	flag	החזר רק קבוצות מארח המכילות מארחים עם אבות טיפוס של גרפים.
with_hosts_and_templates	flag	החזר רק קבוצות מארחים המכילות מארחים או תבניות.
with_httptests	flag	החזר רק קבוצות מארחים המכילות מארחים עם בדיקות אינטרנט. עובר את הפרמטר `with_monitored_httptests`.
with_items	flag	החזר רק קבוצות מארחות המכילות מארחים או תבניות עם פריטים. עובר את הפרמטרים `with_monitored_items` ו-`with_simple_graph_items`.
with_item_prototypes	flag	החזר רק קבוצות מארח המכילות מארחים עם אבות טיפוס של פריטים. עובר את הפרמטר `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	החזר רק קבוצות מארח המכילות מארחים עם אבות טיפוס של פריטים, המופעלים ליצירה ובעלי סוג מידע מספרי.
with_monitored_httptests	flag	החזר רק קבוצות מארחים המכילות מארחים עם בדיקות אינטרנט מופעלות.
with_monitored_items	flag	החזר רק קבוצות מארח המכילות מארחים או תבניות עם פריטים מופעלים. עובר את הפרמטר `with_simple_graph_items`.
with_monitored_triggers	flag	החזר רק קבוצות מארחים המכילות מארחים עם טריגרים מופעלים. יש להפעיל גם את כל הפריטים המשמשים בטריגר.
with_simple_graph_items	flag	החזר רק קבוצות מארח המכילות מארחים עם פריטים מספריים.
with_triggers	flag	החזר רק קבוצות מארחים המכילות מארחים עם טריגרים. עוקף את הפרמטר `with_monitored_triggers`.
selectDiscoveryRule	query	החזר מאפיין discoveryRule עם כלל LLD שיצר את הקבוצה המארחת.
selectGroupDiscovery	query	החזר מאפיין `groupDiscovery` עם אובייקט הגילוי של קבוצת המארח. אובייקט הגילוי של קבוצת המארח מקשר קבוצה מארחת שהתגלתה לאב-טיפוס של קבוצת מארח ויש לו את המאפיינים הבאים: `groupid` - `(string)` מזהה של קבוצת המארח שהתגלתה; `lastcheck` - `(timestamp)` זמן שבו הקבוצה המארחת התגלתה לאחרונה; `name` - `(string)` שם של אב-טיפוס של קבוצת מארח; `parent_group_prototypeid` - `(string)` מזהה אב הטיפוס של הקבוצה המארחת שממנו נוצרה הקבוצה המארחת; `ts_delete` - זמן `(timestamp)` כאשר קבוצת מארח היא לא יתגלה עוד יימחק.
selectHosts	query	החזר מאפיין hosts עם המארחים השייכים לקבוצת המארחים. תומך ב'count'.
selectTemplates	query	החזר מאפיין templates עם התבניות השייכות לקבוצת המארח. תומך ב'count'.
limitSelects	integer	מגביל את מספר הרשומות המוחזרות על ידי subselects. חל על תת-הבחירות הבאות: `selectHosts` - התוצאות ימוינו לפי `host`; `selectTemplates` - תוצאות ימוינו לפי `מארח`.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `groupid`, `name`.
countOutput	boolean	הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

(מספר שלם/מערך) מחזיר אחד:

מערך של חפצים;
ספירת האובייקטים שאוחזרו, אם יש לפרמטר countOutput נעשה שימוש.

דוגמאות

אחזור נתונים לפי שם

אחזר את כל הנתונים על שתי קבוצות מארחות בשם "שרתי Zabbix" ו "שרתי לינוקס".

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hostgroup.get",
            "params": {
                "output": "להרחיב",
                "מסנן": {
                    "שם": [
                        "שרתי Zabbix",
                        "שרתי לינוקס"
                    ]
                }
            },
            "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "groupid": "2",
                    "name": "שרתי לינוקס",
                    "internal": "0"
                },
                {
                    "groupid": "4",
                    "name": "שרתי Zabbix",
                    "internal": "0"
                }
            ],
            "מזהה": 1
       }

מידע נוסף

מקור

CHostGroup::get()‎ בתוך ui/include/classes/api/services/CHostGroup.php.

Documentation