script.execute

תיאור

object script.execute(object parameters)

שיטה זו מאפשרת להריץ סקריפט על מארח או אירוע.

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

פרמטרים

(object) פרמטרים המכילים את המזהה של הסקריפט להפעלה וגם אחד מהם מזהה המארח או מזהה האירוע.

פרמטר סוג תיאור
scriptid
(נדרש)
מחרוזת מזהה של הסקריפט להרצה.
hostid string מזהה המארח שעליו להפעיל את הסקריפט.
eventid string מזהה האירוע שעליו להפעיל את הסקריפט.

החזר ערכים

(object) מחזירה את התוצאה של ביצוע סקריפט.

Property Type תיאור
response string האם הסקריפט הופעל בהצלחה.

ערך אפשרי - הצלחה.
value string פלט סקריפט.
debug object מכיל debug object אם מבוצע סקריפט webhook. עבור סוגי סקריפט אחרים, הוא מכיל אובייקט ריק.

דוגמאות

הפעל סקריפט webhook

הפעל סקריפט webhook ששולח בקשת HTTP לשירות חיצוני.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "script.execute",
            "params": {
                "scriptid": "4",
                "hostid": "30079"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": {
                "response": "הצלחה",
                "value": "{\"status\":\"שלח\",\"חותמת זמן\":\"1611235391\"}",
                "לנפות": {
                    "יומנים": [
                         {
                             "רמה 3,
                             "ms": 480,
                             "message": "[סקריפט Webhook] מצב HTTP: 200."
                         }
                     ],
                     "ms": 495
                }
            },
            "מזהה": 1
       }

הפעל סקריפט מותאם אישית

הפעל סקריפט "פינג" על מארח.

בַּקָשָׁה:

{
            "jsonrpc": "2.0",
            "method": "script.execute",
            "params": {
                "scriptid": "1",
                "hostid": "30079"
            },
            "auth": "038e1d7b1735c6a5436ee9eae095879e",
            "מזהה": 1
       }

תְגוּבָה:

{
            "jsonrpc": "2.0",
            "תוצאה": {
                "response": "הצלחה",
                "value": "PING 127.0.0.1 (127.0.0.1) 56(84) בתים של נתונים.\n64 בתים מ-127.0.0.1: icmp_req=1 ttl=64 time=0.074 ms\n64 בתים מ-127.0.0.0ic. 2 ttl=64 time=0.030 ms\n64 בתים מ-127.0.0.1: icmp_req=3 ttl=64 time=0.030 ms\n\n--- 127.0.0.1 סטטיסטיקות ping ---\n3 מנות שודרו, 3 התקבלו, 0 % אובדן מנות, זמן 1998ms\nrtt min/avg/max/mdev = 0.030/0.044/0.074/0.022 ms\n",
                "לנפות": []
            },
            "מזהה": 1
       }

מקור

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