[comment]: # ({f372a49b-bdae00e2})
# 4 פרוטוקול תוסף Zabbix agent 2

פרוטוקול Zabbix agent 2 מבוסס על קוד, גודל ומודל נתונים.

[comment]: # ({/f372a49b-bdae00e2})

[comment]: # ({b65bf947-dc813c37})
### קוד

|סוג|גודל|הערות|
|-----|-----|--------|
|בייט| 4 |סוג מטען, כרגע רק JSON נתמך.|

[comment]: # ({/b65bf947-dc813c37})

[comment]: # ({8edb0275-b578c7c3})
### גודל

|סוג|גודל|הערות|
|-----|-----|--------|
|בייט| 4 |גודל המטען הנוכחי בבתים.|

[comment]: # ({/8edb0275-b578c7c3})

[comment]: # ({0351e98f-bed7d280})
### נתוני מטען

|סוג|גודל|הערות|
|-----|-----|--------|
|בייט| מוגדר על ידי שדה *גודל* |נתונים בפורמט JSON.|

[comment]: # ({/0351e98f-bed7d280})

[comment]: # ({60a41fe8-07d42895})
##### הגדרת נתוני מטען

###### נתונים נפוצים

פרמטרים אלה קיימים בכל הבקשות/תגובות:

|שם|סוג|הערות|
|-----|--------|--------|
|id |uint32|עבור בקשות - המזהה ההגדלה המשמש לקישור בקשות לתגובות. ייחודי בתוך כיוון בקשה (כלומר מסוכן לפלאגין או מפלאגין לסוכן).<br>לתגובות - מזהה הבקשה המתאימה.|
|type|uint32|סוג הבקשה.|

[comment]: # ({/60a41fe8-07d42895})

[comment]: # ({3cf942f4-1c1af50c})
###### בקשת יומן

בקשה שנשלחה על ידי תוסף לכתוב הודעת יומן לקובץ היומן של הסוכן.

| | |
|---|---|
|כיוון|תוסף → סוכן|
|תגובה|לא|

פרמטרים ספציפיים לבקשות יומן:

|שם|סוג|הערות|
|--------|--------|--------|
|severity|uint32|חומרת ההודעה (רמת יומן).|
|message|string|ההודעה לרישום.|

*דוגמא:*

     {"id":0,"type":1,"severity":3,"message":"message"}

[comment]: # ({/3cf942f4-1c1af50c})

[comment]: # ({3640b089-9b4addbb})
###### בקשת רישום

בקשה שנשלחה על ידי הסוכן במהלך שלב ההפעלה של הסוכן כדי לקבל מדדים שסופקו לרישום תוסף.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|כן|

פרמטרים ספציפיים לרישום בקשות:

|שם|סוג|הערות|
|--------|--------|--------|
|version|string|גרסת הפרוטוקול <major>.<minor>|

*דוגמא:*

     {"id":1,"type":2,"version":"1.0"}

[comment]: # ({/3640b089-9b4addbb})

[comment]: # ({92946a86-802a684d})
###### תגובת רישום

תגובת הפלאגין לבקשת הרישום.

| | |
|---|---|
|כיוון|תוסף → סוכן|
|תגובה|לא קיימת|

פרמטרים ספציפיים לרישום תגובות:

|שם|סוג|הערות|
|--------|--------|--------|
|name|string|שם הפלאגין.|
|metrics|מערך מחרוזות (אופציונלי)|המדדים עם תיאורים כפי שמשמשים בתוסף. מחזירה RegisterMetrics(). נעדר אם הוחזרה שגיאה.|
|interfaces|uint32 (אופציונלי)|מסכת הסיביות של הממשקים הנתמכים של הפלאגין. נעדר אם הוחזרה שגיאה.|
|error|string (אופציונלי)|הודעת שגיאה הוחזרה אם לא ניתן להפעיל תוסף. נעדר, אם מוחזרים מדדים.|

*דוגמאות:*

     {"id":2,"type":3,"metrics":["external.test", "מבחן יצואן חיצוני."], "ממשקים": 4}

אוֹ

     {"id":2,"type":3,"error":"הודעת שגיאה"}

[comment]: # ({/92946a86-802a684d})

[comment]: # ({f190dd1a-c0bcf831})
###### התחל בקשה

בקשה לביצוע פונקציית ההתחלה של ממשק ה-Runner.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|לא|

לבקשה אין פרמטרים ספציפיים, היא מכילה רק פרמטרים של [common data](#common-data).

*דוגמא:*

     {"id":3,"type":4}

[comment]: # ({/f190dd1a-c0bcf831})

[comment]: # ({fce4bba2-9c1b2bdc})
###### סיום הבקשה

בקשה שנשלחה על ידי הסוכן לכיבוי תוסף.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|לא|

לבקשה אין פרמטרים ספציפיים, היא מכילה רק פרמטרים של [common data](#common-data).

*דוגמא:*

     {"id":3,"type":5}

[comment]: # ({/fce4bba2-9c1b2bdc})

[comment]: # ({43e9416d-c7292eea})
###### בקשת ייצוא

בקשה לביצוע פונקציית הייצוא של ממשק היצואן.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|לא|

פרמטרים ספציפיים לבקשות ייצוא:

|שם|סוג|הערות|
|--------|--------|--------|
|key|string|מפתח הפלאגין.|
|פרמטרים|מערך מחרוזות (אופציונלי)|הפרמטרים לפונקציית ייצוא.|

*דוגמא:*

     {"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}

[comment]: # ({/43e9416d-c7292eea})

[comment]: # ({33f976c2-4780d401})
###### ייצוא תגובה

תגובה מפונקציית הייצוא של ממשק היצואן.

| | |
|---|---|
|כיוון|תוסף → סוכן|
|תגובה|לא קיימת|

פרמטרים ספציפיים לייצוא תגובות:

|שם|סוג|הערות|
|--------|--------|--------|
|value|string (אופציונלי) |ערך תגובה מהפונקציה Export. נעדר, אם הוחזרה שגיאה.|
|error|string (אופציונלי) |הודעת שגיאה אם פונקציית הייצוא לא בוצעה בהצלחה. נעדר, אם הערך מוחזר.|

*דוגמאות:*

     {"id":5,"type":7,"value":"response"}

אוֹ

     {"id":5,"type":7,"error":"הודעת שגיאה"}

[comment]: # ({/33f976c2-4780d401})

[comment]: # ({96eb71cf-a0e73519})
###### קבע את הבקשה

בקשה להפעיל את הפונקציה *Configure* של ממשק *Configurator*.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|לא קיימת|

פרמטרים ספציפיים לבקשות *הגדר*:

|שם|סוג|הערות|
|--------|--------|--------|
|global_options|אובייקט JSON|אובייקט JSON המכיל אפשרויות תצורת סוכן גלובליות.|
|private_options|אובייקט JSON (אופציונלי)|אובייקט JSON המכיל אפשרויות תצורה פרטיות של תוסף, אם מסופק.|

*דוגמא:*

     {"id":6,"type":8,"global_options":{...},"private_options":{...}}

[comment]: # ({/96eb71cf-a0e73519})

[comment]: # ({99291487-38bbe293})
###### אימות בקשה

בקשה לביצוע פונקציית *validate* של ממשק *Configurator*.

| | |
|---|---|
|כיוון|סוכן → תוסף|
|תגובה|כן|

פרמטרים ספציפיים לבקשות *אמת*:

|שם|סוג|הערות|
|--------|--------|--------|
|private_options|אובייקט JSON (אופציונלי)|אובייקט JSON המכיל אפשרויות תצורה פרטיות של תוסף, אם מסופק.|

*דוגמא:*

     {"id":7,"type":9,"private_options":{...}}

[comment]: # ({/99291487-38bbe293})

[comment]: # ({3b19fa95-7c4cceea})
###### אמת את התגובה

תגובה מפונקציית * Validate* של ממשק *Configurator*.

| | |
|---|---|
|כיוון|תוסף → סוכן|
|תגובה|לא קיימת|

פרמטרים ספציפיים לתגובות *אמת*:

|שם|סוג|הערות|
|--------|--------|--------|
|error|string (אופציונלי)|הודעת שגיאה מוחזרת אם הפונקציה Validate לא מבוצעת בהצלחה. נעדר אם בוצע בהצלחה.|

*דוגמא:*

     {"id":8,"type":10}

אוֹ

     {"id":8,"type":10,"error":"הודעת שגיאה"}

[comment]: # ({/3b19fa95-7c4cceea})