Documentation
Table of Contents
triggerprototype.get
תיאור
integer/array triggerprototype.get(object parameters)
השיטה מאפשרת לשלוף אבות טיפוס של טריגר בהתאם לנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
פרמטרים
(object) פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| active | flag | החזר רק אבות טיפוס מפעילים מופעלים השייכים למארחים מנוטרים. |
| discoveryids | string/array | החזר רק אבות טיפוס של טריגר השייכים לכללי ה-LLD הנתונים. |
| functions | string/array | החזר רק טריגרים המשתמשים בפונקציות הנתונות. עיין בדף פונקציות נתמכות לקבלת רשימה של פונקציות נתמכות. |
| group | string | החזר רק אבות טיפוס של טריגר השייכים למארחים מקבוצות המארחים עם השם הנתון. |
| groupids | string/array | החזר רק אבות טיפוס מפעילים השייכים למארחים מקבוצות המארחים הנתונות. |
| host | string | החזר רק אבות טיפוס של טריגר השייכים למארחים עם השם הנתון. |
| hostids | string/array | החזר רק אבות טיפוס של טריגר השייכים למארחים הנתונים. |
| herited | boolean | אם מוגדר כ-'true', החזר רק אבות טיפוס שהועברו בירושה מתבנית. |
| maintenance | boolean | אם מוגדר כ-'true', החזר רק אבות-טיפוס פעילים מופעלים השייכים למארחים בתחזוקה. |
| min_severity | integer | החזר רק אבות טיפוס של טריגר עם חומרה גדולה או שווה מהחומרה הנתונה. |
| monitored | flag | החזר רק אבות טיפוס מפעילים מופעלים השייכים למארחים מנוטרים ומכילים רק פריטים מופעלים. |
| templated | boolean | אם מוגדר כ-'true', החזר רק אבות טיפוס ששייכים לתבניות. |
| templateids | string/array | החזר רק אבות טיפוס של טריגר השייכים לתבניות הנתונות. |
| triggerids | string/array | החזר רק אבות טיפוס של טריגר עם המזהים הנתונים. |
| expandExpression | flag | הרחבת פונקציות ופקודות מאקרו בביטוי הטריגר. |
| selectDependencies | query | החזרת אבות טיפוס טריגרים וטריגרים שאב טיפוס הטריגר תלוי בהם במאפיין תלות. |
| selectDiscoveryRule | query | החזר את כלל ה-LLD שאליו שייך אב הטיפוס הטריגר. |
| selectFunctions | query | החזרת פונקציות המשמשות באב-טיפוס הטריגר במאפיין functions.אובייקטי הפונקציה מייצגים את הפונקציות המשמשות בביטוי הטריגר ויש להם את המאפיינים הבאים: functionid - * (מחרוזת)* מזהה הפונקציה;itemid - (מחרוזת) מזהה הפריט המשמש בפונקציה;פונקציה - (מחרוזת) שם הפונקציה;parameter - פרמטר (מחרוזת) מועבר לפונקציה. פרמטר שאילתה מוחלף בסמל $ במחרוזת שהוחזרה. |
| selectGroups | query | החזר את קבוצות המארחים להן שייך אב הטיפוס של הטריגר במאפיין קבוצות. |
| selectHosts | query | החזר את המארחים שאליהם שייך אב-טיפוס הטריגר במאפיין hosts. |
| selectItems | query | החזרת פריטים ואבות טיפוס של פריטים השתמשו באב-טיפוס הטריגר במאפיין items. |
| selectTags | query | החזר את תגי אב הטיפוס של טריגר במאפיין tags. |
| filter | object | החזר רק את התוצאות שתואמות בדיוק את המסנן הנתון. מקבל מערך, כאשר המפתחות הם שמות מאפיינים, והערכים הם ערך בודד או מערך של ערכים שיש להתאים. תומך במסננים נוספים: host - שם טכני של המארח שאליו שייך אב הטיפוס הטריגר;hostid - מזהה המארח שאליו שייך אב הטיפוס הטריגר. |
| limitSelects | integer | מגביל את מספר הרשומות המוחזרות על ידי subselects. חל על subselects הבאות: selectHosts - התוצאות ימוינו לפי host. |
| sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: triggerid, description, status ו-priority. |
| countOutput | boolean | הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות. |
| עריכה | בוליאנית | |
| excludeSearch | בולאני | |
| limit | מספר שלם | |
| פלט | שאילתה | |
| preservekeys | בולאני | |
| חיפוש | אובייקט | |
| searchByAny | boolean | |
| searchWildcardsEnabled | בוליאני | |
| sortorder | מחרוזת/מערך | |
| startSearch | boolean |
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
דוגמאות
אחזר אבות טיפוס של טריגר מכלל LLD
אחזר את כל אבות הטיפוס של הטריגר ותפקודיהם מכלל LLD.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "להרחיב",
"selectFunctions": "להרחיב",
"discoveryids": "22450"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"triggerid": "13272",
"expression": "{12598}<20",
"description": "אינודים פנויים הם פחות מ-20% בנפח {#FSNAME}",
"url": "",
"status": "0",
"priority": "2",
"תגובות": "",
"templateid": "0",
"type": "0",
"flags": "2",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"discover": "0",
"פונקציות": [
{
"functionid": "12598",
"itemid": "22454",
"triggerid": "13272",
"parameter": "$",
"function": "אחרון"
}
]
},
{
"triggerid": "13266",
"expression": "{13500}<20",
"description": "שטח דיסק פנוי הוא פחות מ-20% בנפח {#FSNAME}",
"url": "",
"status": "0",
"priority": "2",
"תגובות": "",
"templateid": "0",
"type": "0",
"flags": "2",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"discover": "0",
"פונקציות": [
{
"functionid": "13500",
"itemid": "22686",
"triggerid": "13266",
"parameter": "$",
"function": "אחרון"
}
]
}
],
"מזהה": 1
}אחזור אב טיפוס טריגר ספציפי עם תגים
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"פלט": [
"טריגריד",
"תיאור"
]
"selectTags": "להרחיב",
"טריגרידים": [
"17373"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"triggerid": "17373",
"description": "שטח דיסק פנוי הוא פחות מ-20% בנפח {#FSNAME}",
"תגים": [
{
"tag": "נפח",
"value": "{#FSNAME}"
},
{
"tag": "סוג",
"value": "{#FSTYPE}"
}
]
}
],
"מזהה": 1
}מידע נוסף
מקור
CTriggerPrototype::get() בתוך ui/include/classes/api/services/CTriggerPrototype.php.