Documentation
Table of Contents
discoveryrule.get
תיאור
integer/array discoveryrule.get(object parameters)
השיטה מאפשרת לשלוף כללי LLD לפי הנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
פרמטרים
(object) פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| itemids | string/array | החזר רק כללי LLD עם המזהים הנתונים. |
| groupids | string/array | החזר רק כללי LLD השייכים למארחים מהקבוצות הנתונות. |
| hostids | string/array | החזר רק כללי LLD השייכים למארחים הנתונים. |
| herited | boolean | אם מוגדר כ-'true' החזר רק כללי LLD שעברו בירושה מתבנית. |
| interfaceids | string/array | החזר רק כללי LLD משתמשים בממשקי המארח הנתונים. |
| monitored | boolean | אם הוגדר כ-'true' החזר רק כללי LLD מופעלים השייכים למארחים מנוטרים. |
| templated | boolean | אם מוגדר כ-'true' החזר רק כללי LLD השייכים לתבניות. |
| templateids | string/array | החזר רק כללי LLD השייכים לתבניות הנתונות. |
| selectFilter | query | החזר מאפיין filter עם נתונים של המסנן המשמש את כלל LLD. |
| selectGraphs | query | מחזיר מאפיין graphs עם אבות טיפוס של גרפים השייכים לכלל LLD. תומך ב'count'. |
| selectHostPrototypes | query | החזר מאפיין hostPrototypes עם אבות טיפוס מארח השייכים לכלל LLD. תומך ב'count'. |
| selectHosts | query | החזר מאפיין hosts עם מערך של מארחים שכלל ה-LLD שייך אליהם. |
| selectItems | query | החזר מאפיין items עם אבות טיפוס של פריטים השייכים לכלל LLD. תומך ב'count'. |
| selectTriggers | query | החזר מאפיין triggers עם אבות טיפוס של טריגר השייכים לכלל LLD. תומך ב'count'. |
| selectLLDMacroPaths | query | החזר מאפיין lld_macro_paths עם רשימה של פקודות מאקרו LLD ונתיבים לערכים שהוקצו לכל מאקרו מתאים. |
| selectPreprocessing | query | החזר מאפיין preprocessing עם אפשרויות עיבוד מקדים של כלל LLD.יש לו את המאפיינים הבאים: type - (string) סוג אפשרות העיבוד המוקדם:5 - התאמת ביטוי רגולרי; 11 - XML XPath; 12 - JSONPath; 15 - לא תואם לביטוי רגולרי; 16 - בדוק אם יש שגיאה ב-JSON; 17 - בדוק אם יש שגיאה ב-XML; 20 - הסר ללא שינוי עם פעימות לב; 23 - Prometheus ל-JSON; 24 - CSV ל-JSON; 25 - החלף; 27 - XML ל-JSON. params - (מחרוזת) פרמטרים נוספים המשמשים את אפשרות העיבוד המקדים. פרמטרים מרובים מופרדים על ידי תו LF (\n).error_handler - (מחרוזת) סוג פעולה המשמש במקרה של כשל בשלב העיבוד המקדים:0 - הודעת השגיאה מוגדרת על ידי שרת Zabbix;<br >1 - Discard value; 2 - הגדר ערך מותאם אישית; 3 - הגדר הודעת שגיאה מותאמת אישית. error_handler_params - (string) פרמטרי מטפל בשגיאות. |
| selectOverrides | query | החזר מאפיין lld_rule_overrides עם רשימה של מסנני עקיפה, תנאים ופעולות המבוצעות על אובייקטי אב טיפוס. |
| filter | object | החזר רק את התוצאות שתואמות בדיוק את המסנן הנתון. מקבל מערך, כאשר המפתחות הם שמות מאפיינים, והערכים הם ערך בודד או מערך של ערכים שיש להתאים. תומך במסננים נוספים: מארח - שם טכני של המארח שאליו שייך כלל LLD. |
| limitSelects | integer | מגביל את מספר הרשומות המוחזרות על ידי subselects. חל על תת-הבחירות הבאות: selctItems;selectGraphs;selectTriggers. |
| sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: itemid, name, key_, delay, type ו-status. |
| countOutput | boolean | הפרמטרים הללו המשותפים לכל שיטות ה-'get' מתוארים בפירוט בפירוש ההתייחסות. |
| עריכה | בוליאנית | |
| excludeSearch | בולאני | |
| limit | מספר שלם | |
| פלט | שאילתה | |
| preservekeys | בולאני | |
| חיפוש | אובייקט | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | מחרוזת/מערך | |
| startSearch | boolean |
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
דוגמאות
אחזור כללי גילוי ממארח
אחזר את כל כללי הגילוי עבור מזהה מארח ספציפי.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": "להרחיב",
"hostids": "10202"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"itemid": "27425",
"type": "0",
"snmp_oid": "",
"hostid": "10202",
"name": "גילוי ממשק רשת",
"key_": "net.if.discovery",
"delay": "1h",
"status": "0",
"trapper_hosts": "",
"templateid": "22444",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "119",
"description": "גילוי ממשקי רשת כפי שהוגדרו בביטוי רגולרי גלובלי \"ממשקי רשת לגילוי\".",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "",
"query_fields": [],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"retrieve_mode": "0",
"request_method": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"פרמטרים": []
},
{
"itemid": "27426",
"type": "0",
"snmp_oid": "",
"hostid": "10202",
"name": "גילוי מערכת קבצים מותקן",
"key_": "vfs.fs.discovery",
"delay": "1h",
"status": "0",
"trapper_hosts": "",
"templateid": "22450",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "119",
"description": "גילוי של מערכות קבצים מסוגים שונים כפי שהוגדרו בביטוי רגולרי גלובלי \"מערכות קבצים לגילוי\".",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "",
"query_fields": [],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"כותרות": [],
"retrieve_mode": "0",
"request_method": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"פרמטרים": []
}
],
"מזהה": 1
}אחזור תנאי מסנן
אחזר את השם של כלל LLD "24681" ואת תנאי הסינון שלו. ה מסנן משתמש בסוג ההערכה "ו", כך שהמאפיין נוסחה הוא ריק ו-eval_formula נוצר באופן אוטומטי.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": ["שם"],
"selectFilter": "להרחיב",
"itemids": ["24681"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"itemid": "24681",
"name": "כלל LLD מסונן",
"מסנן": {
"evaltype": "1",
"נוסחה": "",
"תנאים": [
{
"macro": "{#MACRO1}",
"value": "@regex1",
"מפעיל": "8",
"formulaid": "א"
},
{
"macro": "{#MACRO2}",
"value": "@regex2",
"מפעיל": "9",
"formulaid": "B"
},
{
"macro": "{#MACRO3}",
"ערך": "",
"מפעיל": "12",
"formulaid": "C"
},
{
"macro": "{#MACRO4}",
"ערך": "",
"מפעיל": "13",
"formulaid": "D"
}
],
"eval_formula": "A ו-B ו-C ו-D"
}
}
],
"מזהה": 1
}אחזר כלל LLD לפי כתובת URL
אחזר כלל LLD עבור מארח לפי ערך שדה כתובת URL של כלל. רק התאמה מדויקת של מחרוזת כתובת האתר שהוגדרה עבור כלל LLD נתמכת.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"hostids": "10257",
"מסנן": {
"סוג": 19,
"url": "http://127.0.0.1/discoverer.php"
}
},
"מזהה": 39,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"itemid": "28336",
"type": "19",
"snmp_oid": "",
"hostid": "10257",
"name": "סוכן API HTTP",
"key_": "api_discovery_rule",
"delay": "5s",
"status": "0",
"trapper_hosts": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"שם משתמש": "",
"סיסמה": "",
"מפתח ציבורי": "",
"מפתח פרטי": "",
"interfaceid": "5",
"תיאור": "",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3 שניות",
"url": "http://127.0.0.1/discoverer.php",
"query_fields": [
{
"mode": "json"
},
{
"elements": "2"
}
],
"פוסטים": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": {
"X-Type": "API",
"Authorization": "נושא mF_A.B5f-2.1JcM"
},
"retrieve_mode": "0",
"request_method": "1",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"פרמטרים": []
}
],
"מזהה": 39
}אחזר כלל LLD עם עקיפות
אחזר כלל LLD אחד שיש לו הגדרות עקיפה שונות.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": ["שם"],
"itemids": "30980",
"selectOverrides": ["שם", "שלב", "עצור", "מסנן", "פעולות"]
},
"מזהה": 39,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": [
{
"name": "גלה מארח מסד הנתונים",
"עוקף": [
{
"name": "גלה מארח MySQL",
"שלב 1",
"stop": "1",
"מסנן": {
"evaltype": "2",
"נוסחה": "",
"תנאים": [
{
"macro": "{#UNIT.NAME}",
"מפעיל": "8",
"value": "^mysqld\\.service$",
"formulaid": "א"
},
{
"macro": "{#UNIT.NAME}",
"מפעיל": "8",
"value": "^mariadb\\.service$",
"formulaid": "B"
}
],
"eval_formula": "A או B"
},
"פעולות": [
{
"operationobject": "3",
"מפעיל": "2",
"value": "מארח מסד נתונים",
"opstatus": {
"סטטוס": "0"
},
"optag": [
{
"tag": "מסד נתונים",
"value": "MySQL"
}
],
"optemplate": [
{
"templateid": "10170"
}
]
}
]
},
{
"name": "גלה מארח PostgreSQL",
"שלב 2",
"stop": "1",
"מסנן": {
"evaltype": "0",
"נוסחה": "",
"תנאים": [
{
"macro": "{#UNIT.NAME}",
"מפעיל": "8",
"value": "^postgresql\\.service$",
"formulaid": "א"
}
],
"eval_formula": "א"
},
"פעולות": [
{
"operationobject": "3",
"מפעיל": "2",
"value": "מארח מסד נתונים",
"opstatus": {
"סטטוס": "0"
},
"optag": [
{
"tag": "מסד נתונים",
"value": "PostgreSQL"
}
],
"optemplate": [
{
"templateid": "10263"
}
]
}
]
}
]
}
],
"מזהה": 39
}ראה גם
מקור
CDiscoveryRule::get() בתוך ui/include/classes/api/services/CDiscoveryRule.php.