dhost.get

תיאור

integer/array dhost.get(object parameters)

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

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

פרמטרים

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

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

פרמטר	סוג	תיאור
dhotids	string/array	החזר רק מארחים שהתגלו עם המזהים הנתונים.
druleids	string/array	החזר רק מארחים שהתגלו שנוצרו לפי כללי הגילוי הנתונים.
dserviceids	string/array	החזר רק מארחים שהתגלו המריצים את השירותים הנתונים.
selectDRules	query	החזר מאפיין drules עם מערך של כללי הגילוי שזיהה את המארח.
selectDServices	query	החזר מאפיין dservices כשהשירותים שהתגלו פועלים על המארח. תומך ב'count'.
limitSelects	integer	מגביל את מספר הרשומות המוחזרות על ידי subselects. חל על subselects הבאות: `selectDServices` - התוצאות ימוינו לפי `dserviceid`.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `dhostid` ו-`druleid`.
countOutput	boolean	הפרמטרים הללו המשותפים לכל שיטות ה-'get' מתוארים בפירוט בפירוש ההתייחסות.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

אחזר מארחים שהתגלו לפי כלל גילוי

אחזר את כל המארחים ואת השירותים שהתגלו שהם מריצים זוהו על ידי כלל גילוי "4".

בַּקָשָׁה:

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

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": [
                {
                    "dservices": [
                        {
                            "dserviceid": "1",
                            "dhostid": "1",
                            "type": "4",
                            "key_": "",
                            "ערך": "",
                            "port": "80",
                            "status": "0",
                            "lastup": "1337697227",
                            "lastdown": "0",
                            "dcheckid": "5",
                            "ip": "192.168.1.1",
                            "dns": "station.company.lan"
                        }
                    ],
                    "dhostid": "1",
                    "druleid": "4",
                    "status": "0",
                    "lastup": "1337697227",
                    "lastdown": "0"
                },
                {
                    "dservices": [
                        {
                            "dserviceid": "2",
                            "dhostid": "2",
                            "type": "4",
                            "key_": "",
                            "ערך": "",
                            "port": "80",
                            "status": "0",
                            "lastup": "1337697234",
                            "lastdown": "0",
                            "dcheckid": "5",
                            "ip": "192.168.1.4",
                            "dns": "john.company.lan"
                        }
                    ],
                    "dhostid": "2",
                    "druleid": "4",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0"
                },
                {
                    "dservices": [
                        {
                            "dserviceid": "3",
                            "dhostid": "3",
                            "type": "4",
                            "key_": "",
                            "ערך": "",
                            "port": "80",
                            "status": "0",
                            "lastup": "1337697234",
                            "lastdown": "0",
                            "dcheckid": "5",
                            "ip": "192.168.1.26",
                            "dns": "printer.company.lan"
                        }
                    ],
                    "dhostid": "3",
                    "druleid": "4",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0"
                },
                {
                    "dservices": [
                        {
                            "dserviceid": "4",
                            "dhostid": "4",
                            "type": "4",
                            "key_": "",
                            "ערך": "",
                            "port": "80",
                            "status": "0",
                            "lastup": "1337697234",
                            "lastdown": "0",
                            "dcheckid": "5",
                            "ip": "192.168.1.7",
                            "dns": "mail.company.lan"
                        }
                    ],
                    "dhostid": "4",
                    "druleid": "4",
                    "status": "0",
                    "lastup": "1337697234",
                    "lastdown": "0"
                }
            ],
            "מזהה": 1
       }

מידע נוסף

מקור

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

Documentation