hostprototype.get

תיאור

integer/array hostprototype.get(object parameters)

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

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

פרמטרים

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

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

פרמטר	סוג	תיאור
hostids	string/array	החזר רק אבות טיפוס מארח עם המזהים הנתונים.
discoveryids	string/array	החזר רק אב טיפוס מארח השייך לכללי ה-LLD הנתונים.
inherited	boolean	אם מוגדר כ-'true' החזר רק פריטים שעברו בירושה מתבנית.
selectDiscoveryRule	query	החזר מאפיין discoveryRule עם כלל LLD שאליו שייך אב הטיפוס המארח.
selectInterfaces	query	החזר מאפיין ממשקים עם ממשקים מותאמים אישית של אב טיפוס מארח.
selectGroupLinks	query	החזר מאפיין groupLinks עם קישורי הקבוצה של אב הטיפוס המארח.
selectGroupPrototypes	שאילתה	החזר מאפיין groupPrototypes עם אבות הטיפוס של הקבוצה של אב הטיפוס המארח.
selectMacros	query	החזר מאפיין macros עם פקודות מאקרו של אב טיפוס מארח.
selectParentHost	query	החזר מאפיין parentHost עם המארח שאליו שייך אב הטיפוס המארח.
selectTags	query	החזר מאפיין tags עם תגי אב טיפוס מארח.
selectTemplates	query	החזר מאפיין templates עם התבניות המקושרות לאב הטיפוס המארח. תומך ב'count'.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `hostid`, `host`, `name` ו-`status`.
countOutput	boolean	הפרמטרים האלה, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בדף Generic Zabbix API information.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

אחזור אבות טיפוס מארח מכלל LLD

אחזר את כל אבות הטיפוס של המארח, קישורי הקבוצה שלהם, אבות טיפוס קבוצתיים ו תגים מכלל LLD.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "hostprototype.get",
            "params": {
                "output": "להרחיב",
                "selectInterfaces": "להרחיב",
                "selectGroupLinks": "להרחיב",
                "selectGroupPrototypes": "להרחיב",
                "selectTags": "להרחיב",
                "discoveryids": "23554"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "hostid": "10092",
                    "host": "{#HV.UUID}",
                    "name": "{#HV.UUID}",
                    "status": "0",
                    "templateid": "0",
                    "discover": "0",
                    "custom_interfaces": "1",
                    "inventory_mode": "-1",
                    "קבוצת קישורים": [
                        {
                            "group_prototypeid": "4",
                            "hostid": "10092",
                            "groupid": "7",
                            "templateid": "0"
                        }
                    ],
                    "groupPrototypes": [
                        {
                            "group_prototypeid": "7",
                            "hostid": "10092",
                            "name": "{#CLUSTER.NAME}",
                            "templateid": "0"
                        }
                    ],
                    "תגים": [
                        {
                            "tag": "מרכז נתונים",
                            "value": "{#DATACENTER.NAME}"
                        },
                        {
                            "tag": "סוג מופע",
                            "value": "{#INSTANCE_TYPE}"
                        }
                    ],
                    "ממשקים": [
                        {
                            "main": "1",
                            "type": "2",
                            "useip": "1",
                            "ip": "127.0.0.1",
                            "dns": "",
                            "port": "161",
                            "פרטים": {
                                "גרסה 2",
                                "bulk": "1",
                                "קהילה": "{$SNMP_COMMUNITY}"
                            }
                        }
                    ]
                }
            ],
            "מזהה": 1
       }

מידע נוסף

מקור

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

Documentation