drule.get

תיאור

integer/array drule.get(object parameters)

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

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

פרמטרים

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

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

פרמטר	סוג	תיאור
dhostids	string/array	החזר רק כללי גילוי שיצרו את המארחים שנתגלו.
druleids	string/array	החזר רק כללי גילוי עם המזהים הנתונים.
dserviceids	string/array	החזר רק כללי גילוי שיצרו את השירותים שנתגלו.
selectDChecks	query	החזר מאפיין dchecks עם בדיקות הגילוי המשמשות את כלל הגילוי. תומך ב'count'.
selectDHosts	query	החזר מאפיין dhosts עם המארחים שהתגלו שנוצרו על ידי כלל הגילוי. תומך ב'count'.
limitSelects	integer	מגביל את מספר הרשומות המוחזרות על ידי subselects. חל על תת-הבחירות הבאות: `selectDChecks` - התוצאות ימוינו לפי `dcheckid`; `selectDHosts` - תוצאות ימוינו לפי `dhostsid`.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `druleid` ו-`name`.
countOutput	boolean	הפרמטרים הללו המשותפים לכל שיטות ה-'get' מתוארים בפירוט בפירוש ההתייחסות.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

אחזר את כל כללי הגילוי

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

בַּקָשָׁה:

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

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "druleid": "2",
                    "proxy_hostid": "0",
                    "name": "רשת מקומית",
                    "iprange": "192.168.3.1-255",
                    "delay": "5s",
                    "nextcheck": "1348754327",
                    "status": "0",
                    "dchecks": [
                        {
                            "dcheckid": "7",
                            "druleid": "2",
                            "type": "3",
                            "key_": "",
                            "snmp_community": "",
                            "ports": "21",
                            "snmpv3_securityname": "",
                            "snmpv3_securitylevel": "0",
                            "snmpv3_authpassphrase": "",
                            "snmpv3_privpassphrase": "",
                            "uniq": "0",
                            "snmpv3_authprotocol": "0",
                            "snmpv3_privprotocol": "0",
                            "host_source": "1",
                            "name_source": "0"
                        },
                        {
                            "dcheckid": "8",
                            "druleid": "2",
                            "type": "4",
                            "key_": "",
                            "snmp_community": "",
                            "ports": "80",
                            "snmpv3_securityname": "",
                            "snmpv3_securitylevel": "0",
                            "snmpv3_authpassphrase": "",
                            "snmpv3_privpassphrase": "",
                            "uniq": "0",
                            "snmpv3_authprotocol": "0",
                            "snmpv3_privprotocol": "0",
                            "host_source": "1",
                            "name_source": "0"
                        }
                    ]
                },
                {
                    "druleid": "6",
                    "proxy_hostid": "0",
                    "name": "גילוי סוכן Zabbix",
                    "iprange": "192.168.1.1-255",
                    "delay": "1h",
                    "nextcheck": "0",
                    "status": "0",
                    "dchecks": [
                        {
                            "dcheckid": "10",
                            "druleid": "6",
                            "type": "9",
                            "key_": "system.uname",
                            "snmp_community": "",
                            "ports": "10050",
                            "snmpv3_securityname": "",
                            "snmpv3_securitylevel": "0",
                            "snmpv3_authpassphrase": "",
                            "snmpv3_privpassphrase": "",
                            "uniq": "0",
                            "snmpv3_authprotocol": "0",
                            "snmpv3_privprotocol": "0",
                            "host_source": "2",
                            "name_source": "3"
                        }
                    ]
                }
            ],
            "מזהה": 1
       }

מידע נוסף

מקור

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

Documentation