usermacro.get

תיאור

integer/array usermacro.get(אובייקט פרמטרים)

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

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

פרמטרים

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

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

פרמטר	סוג	תיאור
globalmacro	flag	החזר פקודות מאקרו גלובליות במקום פקודות מאקרו מארח.
globalmacroids	מחרוזת/מערך	החזר רק פקודות מאקרו גלובליות עם המזהים הנתונים.
groupids	string/array	החזר רק פקודות מאקרו מארח השייכות למארחים או תבניות מקבוצות המארחים הנתונות.
hostids	string/array	החזר רק פקודות מאקרו השייכות למארחים או לתבניות הנתונות.
hostmacroids	string/array	החזר רק פקודות מאקרו מארח עם המזהים הנתונים.
herited	boolean	אם הוגדר כ-'true', החזר רק פקודות מאקרו של אב-טיפוס של משתמש מארח שעברו בירושה מתבנית.
selectGroups	query	החזרת קבוצות מארח שהמאקרו המארח שייך להן במאפיין groups. משמש רק בעת אחזור מאקרו מארח.
selectHosts	query	החזר מארחים שהמאקרו המארח שייך להם במאפיין hosts. משמש רק בעת אחזור פקודות מאקרו מארח.
selectTemplates	query	החזר תבניות שהמאקרו המארח שייך להן במאפיין templates. משמש רק בעת אחזור מאקרו מארח.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערך אפשרי: `macro`.
countOutput	boolean	הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	בוליאני
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

אחזור פקודות מאקרו מארח עבור מארח

אחזר את כל פקודות המאקרו המארח שהוגדרו עבור המארח "10198".

בַּקָשָׁה:

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

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "hostmacroid": "9",
                    "hostid": "10198",
                    "macro": "{$INTERFACE}",
                    "value": "eth0",
                    "תיאור": "",
                    "type": "0"
                },
                {
                    "hostmacroid": "11",
                    "hostid": "10198",
                    "macro": "{$SNMP_COMMUNITY}",
                    "value": "ציבורי",
                    "תיאור": "",
                    "type": "0"
                }
            ],
            "מזהה": 1
       }

אחזור פקודות מאקרו גלובליות

אחזר את כל פקודות המאקרו העולמיות.