template.get

תיאור

integer/array template.get(object parameters)

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

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

פרמטרים

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

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

פרמטר	סוג	תיאור
templateids	string/array	החזר רק תבניות עם מזהי התבניות הנתונים.
groupids	string/array	החזר רק תבניות השייכות לקבוצות המארחות הנתונות.
parentTemplateids	string/array	החזר רק תבניות שהן אב לתבניות הנתונות.
hostids	string/array	החזר רק תבניות המקושרות למארחים/תבניות הנתונות.
graphids	string/array	החזר רק תבניות המכילות את הגרפים הנתונים.
itemids	string/array	החזר רק תבניות המכילות את הפריטים הנתונים.
triggerids	string/array	החזר רק תבניות המכילות את הטריגרים הנתונים.
with_items	flag	החזר רק תבניות שיש בהן פריטים.
with_triggers	flag	החזר רק תבניות שיש להן טריגרים.
with_graphs	flag	החזר רק תבניות שיש להן גרפים.
with_httptests	flag	החזר רק תבניות שיש להן תרחישי אינטרנט.
evaltype	integer	כללים לחיפוש תגים. ערכים אפשריים: 0 - (ברירת מחדל) ו/או; 2 - או.
tags	מערך/אובייקט	החזר רק תבניות עם תגיות נתונות. התאמה מדויקת לפי תג וחיפוש תלוי רישיות או רישיות לפי ערך תג בהתאם לערך האופרטור. פורמט: `[{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...]`. מערך ריק מחזיר את כל התבניות. ערכי אופרטור אפשריים: 0 - (ברירת מחדל) מכיל; 1 - שווה; 2 - לא כמו; 3 - לא שווה 4 - קיים; 5 - לא קיים.
selectGroups	query	החזר את קבוצות המארחים שהתבנית שייכת להן במאפיין groups.
selectTags	query	החזר תגי תבנית במאפיין tags.
selectHosts	query	החזר את המארחים המקושרים לתבנית במאפיין hosts. תומך ב'count'.
selectTemplates	query	החזר תבניות שהתבנית היא צאצא, במאפיין `templates`. תומך ב`count`.
selectParentTemplates	query	החזר תבניות שאליהן התבנית היא אב, במאפיין `parentTemplates`. תומך ב`count`.
selectHttpTests	query	החזר את תרחישי האינטרנט מהתבנית במאפיין httpTests. תומך ב'count'.
selectItems	query	החזר פריטים מהתבנית במאפיין items. תומך ב'count'.
selectDiscoveries	query	החזר תגליות ברמה נמוכה מהתבנית במאפיין `discoveries`. תומך ב`count`.
selectTriggers	query	החזרת טריגרים מהתבנית במאפיין triggers. תומך ב'count'.
selectGraphs	query	החזר גרפים מהתבנית במאפיין graphs. תומך ב'count'.
selectMacros	query	החזר את פקודות המאקרו מהתבנית במאפיין `macros`..
selectDashboards	query	החזר לוחות מחוונים מהתבנית במאפיין דשבורדים. תומך ב'count'.
selectValueMaps	query	החזר מאפיין valuemaps עם מפות ערכי תבנית.
limitSelects	integer	מגביל את מספר הרשומות המוחזרות על ידי תת-בחירות. חל על תת-הבחירה הבאות: `selectTemplates` - התוצאות ימוינו לפי `שם`; `selectHosts` - ממוינות לפי `host`; `selectParentTemplates` - ממוין לפי `host`; `selectItems` - ממוין לפי `name`; `selectDiscoveries` - ממוין לפי `name`; `selectTriggers` - ממוין לפי `description`; `selectGraphs` - ממוין לפי `name`; `selectDashboards` - ממוין לפי `name`.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `hostid`, `host`, `name`, `status`.
countOutput	boolean	הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	בוליאני
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

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

אחזר את כל הנתונים על שתי תבניות בשם "Linux" ו-"Windows".

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "template.get",
            "params": {
                "output": "להרחיב",
                "מסנן": {
                    "מנחה": [
                        "לינוקס",
                        "חלונות"
                    ]
                }
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "proxy_hostid": "0",
                    "host": "לינוקס",
                    "status": "3",
                    "disable_until": "0",
                    "error": "",
                    "available": "0",
                    "errors_from": "0",
                    "lastaccess": "0",
                    "ipmi_authtype": "0",
                    "ipmi_privilege": "2",
                    "ipmi_username": "",
                    "ipmi_password": "",
                    "ipmi_disable_until": "0",
                    "ipmi_available": "0",
                    "snmp_disable_until": "0",
                    "snmp_available": "0",
                    "maintenanceid": "0",
                    "maintenance_status": "0",
                    "maintenance_type": "0",
                    "maintenance_from": "0",
                    "ipmi_errors_from": "0",
                    "snmp_errors_from": "0",
                    "ipmi_error": "",
                    "snmp_error": "",
                    "jmx_disable_until": "0",
                    "jmx_available": "0",
                    "jmx_errors_from": "0",
                    "jmx_error": "",
                    "name": "לינוקס",
                    "flags": "0",
                    "templateid": "10001",
                    "תיאור": "",
                    "tls_connect": "1",
                    "tls_accept": "1",
                    "tls_issuer": "",
                    "tls_subject": "",
                    "tls_psk_identity": "",
                    "tls_psk": "",
                    "uuid": "282ffe33afc74cccaf1524d9aa9dc502"
                },
                {
                    "proxy_hostid": "0",
                    "host": "Windows",
                    "status": "3",
                    "disable_until": "0",
                    "error": "",
                    "available": "0",
                    "errors_from": "0",
                    "lastaccess": "0",
                    "ipmi_authtype": "0",
                    "ipmi_privilege": "2",
                    "ipmi_username": "",
                    "ipmi_password": "",
                    "ipmi_disable_until": "0",
                    "ipmi_available": "0",
                    "snmp_disable_until": "0",
                    "snmp_available": "0",
                    "maintenanceid": "0",
                    "maintenance_status": "0",
                    "maintenance_type": "0",
                    "maintenance_from": "0",
                    "ipmi_errors_from": "0",
                    "snmp_errors_from": "0",
                    "ipmi_error": "",
                    "snmp_error": "",
                    "jmx_disable_until": "0",
                    "jmx_available": "0",
                    "jmx_errors_from": "0",
                    "jmx_error": "",
                    "name": "Windows",
                    "flags": "0",
                    "templateid": "10081",
                    "תיאור": "",
                    "tls_connect": "1",
                    "tls_accept": "1",
                    "tls_issuer": "",
                    "tls_subject": "",
                    "tls_psk_identity": "",
                    "tls_psk": "",
                    "uuid": "522d17e1834049be879287b7c0518e5d"
                }
            ],
            "מזהה": 1
       }

Retrieving hosts by template

Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.

Request:

{
           "jsonrpc": "2.0",
           "method": "template.get",
           "params": {
               "output": "templateid",
               "templateids": "10001",
               "selectHosts": ["hostid", "name"]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "templateid": "10001",
                   "hosts": [
                       {
                           "hostid": "10084",
                           "name": "Zabbix server"
                       },
                       {
                           "hostid": "10603",
                           "name": "Host 1"
                       },
                       {
                           "hostid": "10604",
                           "name": "Host 2"
                       }
                   ]
               }
           ],
           "id": 1
       }

חיפוש לפי תגיות תבנית

אחזר תבניות עם התג "שם מארח" שווה ל-"{HOST.NAME}".