hostinterface.get

תיאור

integer/array hostinterface.get(object parameters)

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

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

פרמטרים

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

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

פרמטר סוג תיאור
hostids string/array החזר רק ממשקי מארח המשמשים את המארחים הנתונים.
interfaceids string/array החזר רק ממשקי מארח עם המזהים הנתונים.
itemids string/array החזר רק ממשקי מארח המשמשים את הפריטים הנתונים.
triggerids string/array החזר רק ממשקי מארח המשמשים פריטים בטריגרים הנתונים.
selectItems query החזר מאפיין items עם הפריטים המשתמשים בממשק.

תומך ב'count'.
selectHosts query החזר מאפיין hosts עם מערך של מארחים המשתמשים בממשק.
limitSelects integer מגביל את מספר הרשומות המוחזרות על ידי subselects.

חל על subselects הבאות:
selectItems.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: interfaceid, dns, ip.
countOutput boolean הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
nodeids מחרוזת/מערך
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled boolean
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

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

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

דוגמאות

אחזר ממשקי מארח

אחזר את כל הנתונים על הממשקים המשמשים את המארח "30057".

בַּקָשָׁה:

{
     "jsonrpc": "2.0",
     "method": "hostinterface.get",
     "params": {
         "output": "להרחיב",
         "hostids": "30057"
     },
     "auth": "038e1d7b1735c6a5436ee9eae095879e",
     "מזהה": 1
}

תְגוּבָה:

{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "interfaceid": "50039",
             "hostid": "30057",
             "main": "1",
             "סוג 1",
             "useip": "1",
             "ip": "::1",
             "dns": "",
             "port": "10050",
             "available": "0",
             "error": "",
             "errors_from": "0",
             "disable_until": "0",
             "פרטים": []
         },
         {
             "interfaceid": "55082",
             "hostid": "30057",
             "main": "0",
             "סוג 1",
             "useip": "1",
             "ip": "127.0.0.1",
             "dns": "",
             "port": "10051",
             "available": "0",
             "error": "",
             "errors_from": "0",
             "disable_until": "0",
             "פרטים": {
                 "גרסה 2",
                 "bulk": "0",
                 "קהילה": "{$SNMP_COMMUNITY}"
             }
         }
     ],
     "מזהה": 1
}

מידע נוסף

מקור

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