NAV סרגל ניווט
לוגו
תלתל zcli

Zebet API v4.0 הפניה

ZAPI (Zevenet APplication Pרוגרמות Interface) הוא הכלי של מנהלי המערכת לשלוט בהתנהגות איזון העומסים של Zevenet.

יש צורך להפעיל את משתמש zapi הבסיסי מממשק האינטרנט לפני השימוש בו, מערכת> משתמשים.

לאחר שנוצר ZAPI נוצר, ניתן לשלוח בקשות לשרת HTTP. בקשת URI נראית כך:

HTTP verb https://zevenet_server: 444 / zapi / v4.0 / zapi.cgi /URI_path,

איפה zevenet_server הוא ה- IP שבו שירות ה- HTTP מאזין, ממשק ניהול ה- HTTP וה- URI_path מגדיר את האובייקט אשר יתבקש. כיצד לגשת וכיצד לשנות כל אובייקט של Zevenet יוגדרו בתוך כל קטע תיעוד.

אל האני HTTP verbs המקובלים ל- ZAPI הם:

פרמטרים של ZAPI

פרמטרים של ZAPI

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-H 'Content-Type: application/json' -d ''
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms

A PUT ו POST בקשות תמיד צריכות כמעט פרמטר אם כי לשיחת ZAPI אין צורך בפרמטר נדרש (חובה). אם נשלחת בקשת PUT או POST ללא פרמטרים, ה- ZAPI יחזיר את רשימת הפרמטרים הצפויים ואת האפשרויות האפשריות שלהם.

דוגמה לתגובה:

{
   "description" : "No parameter has been sent. Please, try with:",
   "params" : [
      {
         "name" : "profile",
         "options" : [
            "required"
         ],
         "possible_values" : [
            "http",
            "gslb",
            "l4xnat",
            "datalink"
         ]
      },
      {
         "format" : "ip_addr",
         "name" : "vip",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "expects a port",
         "name" : "vport",
         "options" : [
            "required"
         ]
      },
      {
         "description" : "The farm name is required to have alphabet letters, numbers or hypens (-) only.",
         "format" : "farm_name",
         "name" : "farmname",
         "options" : [
            "required"
         ]
      }
   ]
}

פרמטרים של תגובה

התגובה היא רשימה של שדות המתארת ​​את הפרמטר ואת אפשרויות התצורה האפשריות:

תיאור פרמטר:

שדה סוּג תיאור
שם מחרוזת זה מפתח לערך המקובל. הפרמטרים הבאים משמשים להגדרתו.
תיאור מחרוזת זהו מידע אודות הערך הצפוי.
הפסקה מחרוזת הפרמטר צריך להיות בעל ערך מספרי המכבד את הגבולות הנמוכים, הגבוהים או שניהם. הערכים המשמשים כמגבלות נחשבים תקפים.
פוּרמָט מחרוזת זה יכול להיות רמז עם הפורמט הצפוי של הפרמטר, זה יכול להיות ביטוי רגולרי או מפתח שמזהה את הנתונים.
ערכים אפשריים מחרוזת [] זוהי רשימת הערכים האפשריים שעל הפרמטר להיות.
אפשרויות מחרוזת [] זה מראה יותר תצורה שיש לקחת בחשבון.

רשימת אפשרויות:

שדה תיאור
נדרש אפשרות זו מציינת כי הפרמטר הוא חובה, עליו להישלח בבקשה.
לא ריק אפשרות זו מאפשרת שליחה של מחרוזת ריקה כערך הפרמטר. יכול להיות שימושי לבטל את הגדרת הפרמטר.

קודי שגיאה

ה- ZAPI יכול לענות על אחד מקודי השגיאה הבאים:

קוד שגיאה קצר תיאור
400 בקשה גרועה פרמטר בקשה כלשהו שגוי.
401 לא מורשה מפתח ה- ZAPI שלך שגוי.
402 האישור אינו תקף מאזן העומסים זקוק לאישור תקף כדי לעבד את הבקשה.
403 האסורה לבעל המשתמש של מפתח ZAPI אין הרשאות לבקשה או לאובייקט המשמש בה.
404 לא נמצא ה- URI המשמש או אובייקט אחד המשמש בשיחה אינו קיים.
405 שיטה אסורה הפועל HTTP אינו קיים או אינו מיושם עבור שיחת ZAPI הנוכחית.
406 לא מתקבל תכונה זו אינה זמינה.
409 סְתִירָה הבקשה חוקית, אך לא ניתן היה לעבד אותה, התצורה החדשה יצרה התנגשות עם הנוכחית. סיסלוג יכול להציע מידע נוסף.
410 נעלם תכונה זו הוסרה.
500 שגיאת שרת פנימית אירעה שגיאה בשרת.
504 פסק זמן של שער הגיע הזמן הקצוב לתגובת השרת והבקשה לא הסתיימה בעיבודה.

יומן שינויים

זו רשימת השינויים שנכללו בכל גרסה. רשימת השינויים ברשימת גרסאות ZAPI מתייחסת תמיד לפני כן.

API 4.0.2

גרסת ZAPI זו מהווה הרחבה של גרסת 4.0.1. נוספו כמה פרמטרים ו- URI, אך כל אחד מהם הוסר.

מודול VPN חדש:

נוסף GET|POST|PUT|DELETE /vpns/*

פרמטרים חדשים:

errorWAF, מיקום מחדש (נוספו אפשרויות חדשות רק עבור zproxy), כתוב מחדש, חיבור מוצמד, מדיניות ניתוב, connect_limit:

שונה: GET|PUT /farms/<farmname>. שונה: GET|PUT /farms/<farmname>/services/<id>.

ממשקי API חדשים להוספת rewriterl:

נוסף ADD|DELETE /farms/<farmname>/service/<servicename>/rewriteurl/*

ממשקי API חדשים להוספת כללי כותרות מחדש:

נוסף ADD|DELETE /farms/MyHttpFarm/replacerequestheader/* נוסף ADD|DELETE /farms/MyHttpFarm/replaceresponseheader/*

נוספו בקשות לניהול הפעלות סטטיות (zproxy בלבד):

נוסף GET|POST|DELETE /farms/<farmname>/services/<servicename>/sessions/*

נוסף פרמטר פסק זמן:

שונה: GET /monitoring/fg/<name>. שונה: POST|PUT /monitoring/fg.

הגדר מספר IPS ויציאות:

שונים ADD|POST /system/ssh, קבל כעת מערכים בפרמטרים להאזנה וליציאה.

הגדר מספר IPS ויציאות עבור שרת צ'ירוקי:

שונים ADD|POST /system/http, קבל כעת מערכים בפרמטרים ip ופורטים.

הגדר את אישור השרת:

נוסף GET|POST /system/https/certificate.

נוספו פרמטרים total_sessions ו Ttl:

שונה: GET /stats/farms/<farmname>

נוסף פרמטר ואף_עוזר:

שונים GET|POST /system/global

ממשקי API חדשים של rsyslog להגדרת יומנים כדי לשלוח אותם לשרת מרוחק:

נוסף: GET|POST|DELETE /system/rsyslog.

נוסף פרמטר track_interface:

שונה: GET|PUT /system/cluster.

API 4.0.1

גרסת ZAPI זו מהווה הרחבה של גרסת 4.0. נוספו כמה פרמטרים ו- URI, אך כל אחד מהם הוסר.

הוסף בקשה להצגת עץ עם כל האובייקטים של איזון העומס

הוסף: GET / ids

אפשרות להעתקת משק

שונה: POST /farms

הוסף פרמטרים תגובת תגובה ו מסיר תגובה ולהאריך את הפרמטר http:

שונים GET /farms/<farmname>

שונים PUT /farms/<farmname>

להוסיף POST /farms/<farmname>/addresponseheader|removeresponseheader

להוסיף DELETE /farms/<farmname>/addresponseheader|removeresponseheader/<n>

הוסף בקשות לניהול הפעלות סטטיות:

להוסיף GET /farms/<farmname>/sessions

להוסיף POST /farms/<farmname>/sessions

להוסיף DELETE /farms/<farmname>/sessions/<session>

מודול ניתוב חדש:

נוסף GET|POST|PUT|DELETE /routing/*

Farmguardian יכול להשתמש בכינוי האחורי כשם מארח לבדיקות:

נוסף GET|PUT /monitoring/fg*/<farmguardian>

נהל קבצים לכללי WAF:

נוסף GET|PUT|DELETE /ipds/waf/files

קבל מידע על המערכת:

נוסף: GET /system/info

הגדרות גלובליות השתנו:

נוסף: GET|POST /system/global

אימות באמצעות LDAP:

נוסף GET|POST /rbac/services

נוסף GET|POST /rbac/ldap*

שונים GET|POST /rbac/users

שונים GET|PUT /rbac/users/<user>

API 4.0

ציין סיכום של החוות והשירותים המקובצים למודול:

נוסף: /farms/modules/summary

פעולות לקישור כלל WAF שנקבע לחוות HTTP:

נוסף: GET|POST|PUT|DELETE /farms/<farmname>/ipds/waf/*

שונה: GET /farms/<farm>

העבר אישורים בחוות HTTPS:

נוסף: POST /farms/<farm>/certificates/<cert>/actions

שנה שיחות חוות הקשורות ל- l4xnat כדי לתמוך בליבה החדשה:

שונה: GET|POST|PUT|DELETE /farms/<l4farm>

הוסיף את DHCP ו מק תכונות בשיחות ZAPI הבאות:

שונה: PUT /interfaces/nic/<if>

שונה: PUT /interfaces/bonding/<if>

שונה: POST /interfaces/vlan

שונה: PUT /interfaces/vlan/<if>

שנה את שם הפרמטר כדי להעתיק אפוטרופוס לחווה:

שונה: POST /monitoring/fg

ניהול חבילת ה- IPDS:

נוסף: GET /ipds/package

נוסף: POST /ipds/package/actions

חומת אש חדשה של יישומי אינטרנט, WAF, תכונה:

נוסף: GET|POST|PUT|DELETE /ipds/waf/*

הסר את הקריאה להעתקת כללי RBL. עכשיו זה פרמטר של השיחה היוצרת:

הוסר: POST /ipds/rbl/<name>

שונה: POST /ipds/waf/<name>

התכונות איפוס להגדרות יצרן, פרוקסי ו לבדוק עדכוני חבילות נוסף:

נוסף: POST /system/factory

נוסף: GET /system/proxy

נוסף: POST /system/proxy

נוסף: GET /system/packages

הוסף פרמטר לניהול תפריטי ממשק המשתמש באינטרנט:

נוסף: GET /rbac/menus

שונה: PUT /rbac/roles/<ROLE>

אישורי הפעלה

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

הצג פרטי אישור הפעלה

הצג פרטי אישור הפעלה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation

GET /certificates/activation

הצג את כל המידע הכלול בתעודת ההפעלה, כולל חתימות, אישור זה נשמר בחנות אישורים. אם תעודת ההפעלה נמחקת, המוצר יופסק.

טען אישור הפעלה

טען אישור הפעלה

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/path/to/example.pem
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation

POST /certificates/activation

העלה אישור הפעלה בפורמט PEM, יש צורך באישור זה בכדי לאפשר את כל הפונקציות. אישור זה נשמר במאגר האישורים, אם אישור ההפעלה קיים במאגר האישורים, האישור הקודם מוחלף.

דוגמה לתגובה:

{
   "description" : "Upload activation certificate",
   "message" : "Activation certificate uploaded",
   "success" : "true"
}

מחק את אישור ההפעלה

מחק את אישור ההפעלה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/activation

DELETE /certificates/activation

מחק את אישור ההפעלה המותקן בחנות אישורים. אם האישור נמחק, אזי איזון העומס.

דוגמה לתגובה:

{
   "description" : "Delete activation certificate",
   "message" : "The activation certificate has been deleted",
   "success" : "true"
}

תעודות SSL

Zevenet תומך באישורים בפורמט PEM לשימוש בהם עם חוות HTTP שהוגדרו עם מאזין HTTPS. אם אתה רוצה ללמוד עוד על אופן היצירה פם תעודות, אנא בקרו במאמר הבא: יצירת תעודות ב PEM פורמט

רשום את כל האישורים

רשום את כל האישורים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates
zcli certificate list

GET /certificates

רשימת כל אישורי CSR ו- PEM בחנות אישורים, אישורים אלה ניתן להשתמש עם חוות HTTPS.

דוגמה לתגובה:

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים אישורים, שכל אחד מהם מכיל את מאפייני המפתח להלן.

{
   "description" : "List all certificates",
   "params" : [
      {
         "CN" : "Zen Load Balancer",
         "creation" : "Jan 12 14:49:03 2011 GMT",
         "expiration" : "Jan  9 14:49:03 2021 GMT",
         "file" : "zencert.pem",
         "issuer" : "Zen Load Balancer",
         "type" : "Certificate"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
תפוגה מחרוזת תאריך תפוגה.
פילה מחרוזת זהו שם הקובץ של האישור, תעודת הזהות הייחודית.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
סוג מחרוזת CSR או אישור.

הורד אישור

הורד אישור

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate download example.pem 

GET /certificates/<file>

הורד אישור המותקן בחנות אישורים, השתמש בשם הקובץ בבקשה לזהות אותו.

כותרות תגובה:

התגובה תכלול את הכותרות המצוינות למטה עם מידע על הקובץ. גוף התגובה יהיה תוכן הקובץ.

HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359

הצג פרטי אישור

הצג פרטי אישור

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem/info
zcli certificate get example.pem

GET /certificates/<file>/info

הציגו את כל המידע הכלול באישור נתון בחנות האישורים, כולל חתימות, שם הקובץ נדרש להפניה.

דוגמה לתגובה:

Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number: 14346016480403539444 (0xc71749fb005a45f4)
    Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Validity
            Not Before: Jan 12 14:49:03 2011 GMT
            Not After : Jan  9 14:49:03 2021 GMT
        Subject: C=ES, ST=Spain, L=Spain, O=Sofintel, OU=Telecommunications, CN=Zen Load Balancer/emailAddress=zenloadbalancer-support@lists.sourceforge.net
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (1024 bit)
                Modulus:
...

מחיקת אישור

מחיקת אישור

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate delete example.pem

DELETE /certificates/<file>

מחיקת אישור לפי שם קובץ בחנות אישורים.

דוגמה לתגובה:

{
   "description" : "Delete certificate",
   "message" : "The Certificate example.pem has been deleted.",
   "success" : "true"
}

צור תעודת PEM

צור תעודת PEM

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"host.domain.com","key":"-----BEGIN PRIVATE KEY-----\nRTQwew...",
"ca","-----BEGIN CERTIFICATE-----\nFQOEW...","intermediates":"-----BEGIN CERTIFICATE-----\nQWESw..."}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/pem
zcli certificate-pem create -name host.domain.com -key "-----BEGIN PRIVATE KEY..." -ca "-----BEGIN CERTIFICATE..." -intermediates "-----BEGIN CERTIFICATE..."
"

POST /certificates/pem

צור אישור PEM (קובץ PEM).

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם מחרוזת שם תעודת הזהות. נכון
מפתח מחרוזת ללא מפתח פרטי מוצפן נכון
ca מחרוזת תעודת שרת או תעודת שרשרת מלאה נכון
ביניים מחרוזת תעודות ביניים במידת הצורך שקר

דוגמה לתגובה:

{
   "description" : "Create certificate",
   "message" : "Certificate host.domain.com created",
   "success" : "true"
}

צור אישור אחריות חברתית

צור אישור אחריות חברתית

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates
zcli certificate create -name NewCSR -fqdn host.domain.com -division IT -organization 'Example Corp.' -locality Madrid -state Madrid -country ES -mail info@domain.com

POST /certificates

צור בקשת חתימה של אישור (קובץ CSR).

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם מחרוזת שם תעודת הזהות. נכון
fqdn מחרוזת שם התחום המלא של השרת שלך. נכון
חלוק מחרוזת חלוקת הארגון שלך בטיפול בתעודה. נכון
ארגון מחרוזת השם החוקי של הארגון שלך. נכון
יישוב מחרוזת העיר שבה נמצא הארגון שלך. נכון
היו מחרוזת המדינה / האזור שבהם נמצא הארגון שלך. נכון
מדינה מחרוזת קוד ISO בן שתי אותיות למדינה בה ממוקם הארגון שלך. נכון
דואר מחרוזת כתובת דוא"ל המשמשת ליצירת קשר עם הארגון שלך. נכון

דוגמה לתגובה:

{
   "description" : "Create CSR",
   "message" : "Certificate NewCSR created",
   "success" : "true"
}

העלה אישור

העלה אישור

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/example.pem
zcli certificate upload example.pem /local_path/to/example.pem

POST /certificates/<file>

העלה אישור PEM עבור חוות HTTP עם המאזין HTTPS.

בקש פרמטרים של URI

דורש את הפרמטר --tcp-nodelay, ו --data-binary כדי להעלות את הקובץ במצב בינארי.

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

דוגמה לתגובה:

{
   "description" : "Upload PEM certificate",
   "message" : "Certificate uploaded",
   "success" : "true"
}

רשימת צופן

רשימת צופן

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ciphers

GET /ciphers

ציין את הצפנים הזמינים שבהם יכולה חוות HTTPS להשתמש.

אל האני פריקת SSL צופן יהיה זמין רק אם הוא נתמך על ידי המעבד.

דוגמה לתגובה:

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים אישורים, שכל אחד מהם מכיל את מאפייני המפתח להלן.

{
   "description" : "Get the ciphers available",
   "params" : [
      {
         "ciphers" : "all",
         "description" : "All"
      },
      {
         "ciphers" : "highsecurity",
         "description" : "High security"
      },
      {
         "ciphers" : "customsecurity",
         "description" : "Custom security"
      },
      {
         "ciphers" : "ssloffloading",
         "description" : "SSL offloading"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימה של אובייקטים אישור.

אובייקט אישור

שדה סוּג תיאור
Ciphers מחרוזת הוא משמש כמזהה ייחודי.
תיאור מחרוזת שם ידידותי.

תעודות SSL של Letsencrypt

Zevenet תומך ביצירת אישורי Letsencrypt וחידושם. התעודה לבסוף היא תעודת ZEVENET PEM שניתן להשתמש בה עם חוות HTTPS. . אם אתה רוצה ללמוד עוד על איך ליצור פם תעודות, אנא בקרו במאמר הבא: יצירת תעודות ב PEM פורמט

הצג את תצורת Letsencrypt

הצג את תצורת Letsencrypt

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificate-le-config list

GET /certificates/letsencryptz/config

הצג את תצורת Letsencrypt.

דוגמה לתגובה:

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

{
   "description" : "Get LetsEncrypt Config",
   "params" : {
      "email" : "test_le@zevenet.com"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
אמייל מחרוזת דוא"ל עבור Letsencrypt

שנה את תצורת Letsencrypt

שנה את תצורת Letsencrypt

דוגמה לבקשה:

curl -k -X PUT -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"email":"test_le@zevenet.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/config
zcli certificates-le-config set -email test_le@zevenet.com

PUT /certificates/letsencryptz/config

שנה את תצורת Letsencrypt.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
אמייל מחרוזת דואר אלקטרוני לשימוש כאיש קשר ב- Letsencrypt נכון

דוגמה לתגובה:

התגובה תהיה אובייקט JSON עם הפרמטרים הבאים.

{
   "description" : "Modify LetsEncrypt Config",
   "message" : "The Letsencrypt Config has been updated successfully.",
   "params" : {
      "email" : "test_le@zevenet.com"
   },
   "success" : "true"
}


פרמטרים של תגובה

שדה סוּג תיאור
אמייל מחרוזת דוא"ל עבור Letsencrypt

רשום את כל אישורי Letsencrypt

רשום את כל אישורי Letsencrypt

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le list 

GET /certificates/letsencryptz

רשום את כל אישורי Letsencrypt שנוצרו.

דוגמה לתגובה:

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטי אישור letsencrypt, שכל אחד מהם מכיל את תכונות המפתח שלהלן.

{
   "description" : "List LetsEncrypt certificates",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "May 31 05:51:49 2021 GMT",
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "Aug 29 05:51:49 2021 GMT",
         "file" : "/usr/local/zevenet/config/letsencrypt/acme/*.wildcard.test.zevenet.com/fullchain.cer",
         "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
         "status" : "valid",
         "type" : "LE Certificate",
         "wildcard" : "true"
      },
      {
         "CN" : "*.test1.wildcard.test.zevenet.io",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.test1.wildcard.test.zevenet.io",
               "txt" : "QpbOLzMrJapoQmcbrA5_dr6ciwLzNF-y3z5XR5i-I2c"
            }
         ],
         "domains" : [
            "*.test1.wildcard.test.zevenet.io"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }

   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם.
תפוגה מחרוזת תאריך תפוגה.
dnstxt אובייקט [] רשימה של רשומות DNS TXT עבור כל תחום לאימות אם האישור עדיין לא הונפק.
פילה מחרוזת זהו שם הקובץ של האישור, תעודת הזהות הייחודית.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
מצב מחרוזת מצב התעודה.תקף,האישור תקף.עומד לפוג, האישור עומד לפוג.לא בתוקף, פג תוקף האישור.לא בעייתי, האישור עומד להנפקה.לא ידוע, האישור אינו תקף.
סוג מחרוזת תעודת LE.
כלליים מחרוזת נכון, האישור מיועד לדומיינים של תווים כלליים. שקר, האישור מיועד לדומיינים שאינם תווים כלליים לחיפוש.

אובייקט dnstxt

שדה סוּג תיאור
תחום מחרוזת שם דומיין
txt מחרוזת רשומת DNS txt של LetsEncrypt חייבת לאמת. רשומת ה-DNS TXT תהיה נגישה באמצעות _acme-challenge.domain.

בואו להצפין תעודות SSL Wildcard

Let's Encrypt תעודות תווים כלליים הם אישורים תקפים רק עבור דומיינים עם תווים כלליים לחיפוש.

צור אישור חדש של Let's Encrypt Wildcard

צור אישור חדש של Let's Encrypt Wildcard

דוגמה לבקשה:

url -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"domains":["*.wildcard.test.zevenet.com"],"test":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard
zcli certificate-le-wildcard create -wildcard true 

POST /certificates/letsencryptz-wildcard

צור תעודה חדשה של Let's Encrypt.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם. נכון
מבחן מחרוזת נכון, האישור מונפק על ידי LetsEncrypt Staging Server. שקר, האישור מונפק על ידי LetsEncrypt Server והוא יהיה תקף עבור סביבת ייצור. נכון

דוגמה לתגובה:

{
   "description" : "Create Let's Encrypt Wildcard certificate",
   "params" : [
      {
         "CN" : "*.wildcard.test.zevenet.com",
         "creation" : "",
         "dnstxt" : [
            {
               "domain" : "*.wildcard.test.zevenet.com",
               "txt" : "jtt2WBHXl0cRw33mgoHUo1hbFGLipNbeb2EtTWpRORM"
            }
         ],
         "domains" : [
            "*.wildcard.test.zevenet.com"
         ],
         "expiration" : "",
         "file" : null,
         "issuer" : "",
         "status" : "not issued",
         "type" : "LE Certificate",
         "wildcard" : "true"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
dnstxt אובייקט [] רשימה של רשומות DNS TXT עבור כל תחום לאימות אם האישור עדיין לא הונפק.
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם.
תפוגה מחרוזת תאריך תפוגה.
פילה מחרוזת זהו שם הקובץ של האישור, תעודת הזהות הייחודית.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
מצב מחרוזת מצב התעודה.תקף,האישור תקף.עומד לפוג, האישור עומד לפוג.לא בתוקף, פג תוקף האישור.לא בעייתי, האישור עומד להנפקה.לא ידוע, האישור אינו תקף.
סוג מחרוזת תעודת LE.
כלליים מחרוזת נכון, האישור מיועד לדומיינים של תווים כלליים. שקר, האישור מיועד לדומיינים שאינם תווים כלליים לחיפוש.

אובייקט dnstxt

שדה סוּג תיאור
תחום מחרוזת שם דומיין
txt מחרוזת רשומת DNS txt של LetsEncrypt חייבת לאמת. רשומת ה-DNS TXT תהיה נגישה באמצעות _acme-challenge.domain.

הגדר פעולה בתעודת Let's Encrypt Wildcard

הגדר פעולה בתעודת Let's Encrypt Wildcard

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com/actions
zcli certificate-le-wildcard renew *.example.domain.com

POST /certificates/letsencryptz-wildcard/<domain>/actions

החל פעולה על אישור Let's Encrypt, עיין בטבלת הפרמטרים של בקשת פעולות.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולות מחרוזת הפעולה לביצוע, האפשרויות הן: לחדש, התעודה תחודש; מבחן רשומות ה-dns txt ייבדקו באמצעות שאילתת dns.
כוח_חידוש מחרוזת (רק לפעולת "חידוש") נכון, לאלץ את חידוש האישור גם אם לא פג תוקפו, שקר, האישור יחודש אם הוא אמור להתחדש (פחות מ-30 יום לפוג).
הפעלה מחדש מחרוזת (רק לפעולת "חידוש") נכון, כל החוות המשתמשות בתעודה יופעלו מחדש. שקר, לא יופעלו מחדש חוות המשתמשות בתעודה.
DNS מחרוזת (רק עבור פעולת "בדיקה") שרת Dns שישמש לבדיקת רשומת DNS TXT _acme-challenge.domain.

דוגמה לתגובה:

{
   "description" : "Let's Encrypt wildcard certificate actions",
   "message" : "The action renew has been performed in Let's Encrypt certificate *.test1.wildcard.test.zevenet.io.",
   "params" : {
      "action" : "renew",
      "status" : "valid"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
פעולה מחרוזת תאריך היווצרות.
מצב מחרוזת מצב התעודה.תקף,האישור תקף.עומד לפוג, האישור עומד לפוג.לא בתוקף, פג תוקף האישור.לא בעייתי, האישור עומד להנפקה.לא ידוע, האישור אינו תקף.
dnstxt אובייקט [] (רק עבור פעולת "בדיקה") רשימת רשומות DNS TXT עבור כל תחום ותוצאות שאילתת ה-DNS שלהם דרך שרת DNS.

אובייקט dnstxt

שדה סוּג תיאור
DNS מחרוזת שרת DNS לשימוש. "ריק" פירושו להשתמש בהגדרות המוגדרות במערכת.
תחום מחרוזת שם דומיין
משאב חפץ יש לבדוק משאב DNS.
מצב מחרוזת תוצאה מבדיקת רשומת DNS TXT דרך שרת DNS. מטה אם DNS TXT מחדש

כבל לא נמצא שרת DNS. up אם נמצאה רשומת DNS TXT.

משאב אובייקט

שדה סוּג תיאור
rname מחרוזת שם משאב DNS. בואו להצפין דורש _acme-challenge
סוג מחרוזת סוג רשומת DNS. בואו להצפין דורש TXT
rdata מחרוזת ערך רשומת DNS.

מחק תו כללי Let's Encrypt Certificate

מחק תו כללי Let's Encrypt Certificate

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz-wildcard/*.example.domain.com
zcli certificate-le-wildcard delete *.example.domain.com

DELETE /certificates/letsencryptz-wildcard/<domain>

מחק אישור Let's Encrypt עם תווים כלליים לפי דומיין.

דוגמה לתגובה:

{
   "description" : "Delete Let's Encrypt wildcard certificate",
   "message" : "Let's Encrypt wildcard Certificate example.domain.com has been deleted.",
   "success" : "true"
}

בואו להצפין SSL ללא אישורי תווים כלליים

Let'sEncrypt no אישורי תווים כלליים הם אישורים תקפים רק ללא דומיינים עם תווים כלליים.

צור אישור חדש של Let'sEncrypt No Wildcard

צור אישור חדש של Let's Encrypt No Wildcard

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"lefarm","domains":["test.zevenet.com"],"test":"true","wildcard":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz
zcli certificate-le create -wildcard false 

POST /certificates/letsencryptz

צור תעודה חדשה של Let's Encrypt.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה שבו מוגדר שירות זמני "Let's Encryptz". נכון אם param vip לא נשלח.
החברים מחרוזת IP של המערכת, שבה מוגדרת חווה זמנית "Let's Encryptz". נכון אם Param farmname לא נשלח.
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם. נכון
כלליים מחרוזת נכון, האישור מיועד לדומיינים של תווים כלליים. שקר, האישור מיועד לדומיינים שאינם תווים כלליים לחיפוש. נכון
מבחן מחרוזת נכון, האישור מונפק על ידי LetsEncrypt Staging Server. שקר, האישור מונפק על ידי LetsEncrypt Server והוא יהיה תקף עבור סביבת ייצור. נכון

דוגמה לתגובה:

{
   "description" : "Create Let's Encrypt certificate",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:05:30 2021 GMT",
      "domains" : [
         "test.zevenet.io"
      ],
      "expiration" : "Aug 29 11:05:30 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם.
תפוגה מחרוזת תאריך תפוגה.
פילה מחרוזת זהו שם הקובץ של האישור, תעודת הזהות הייחודית.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
מצב מחרוזת מצב התעודה.תקף,האישור תקף.עומד לפוג, האישור עומד לפוג.לא בתוקף, פג תוקף האישור.לא בעייתי, האישור עומד להנפקה.לא ידוע, האישור אינו תקף.
סוג מחרוזת תעודת LE.
כלליים מחרוזת נכון, האישור מיועד לדומיינים של תווים כלליים. שקר, האישור מיועד לדומיינים שאינם תווים כלליים לחיפוש.

הגדר פעולה ב-Let's Encrypt no Wildcard Certificate

הגדר פעולה ב-Let's Encrypt No Wildcard Certificate

דוגמה לבקשה:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"renew","vip":"192.168.101.44","force_renewal":"true","restart":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com/actions
zcli certificate-le renew example.domain.com ( not implemented )

POST /certificates/letsencryptz/<domain>/actions

הגדר פעולה באישור Let's Encrypt ללא תווים כלליים, ראה את טבלת הפרמטרים של בקשה לפעולות.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת הפעולה לביצוע: האפשרויות הן: לחדש, התעודה תחודש.
שם החווה מחרוזת שם החווה שבו מוגדר שירות זמני "Let's Encryptz" לחידוש האישור. נכון אם param vip לא נשלח.
החברים מחרוזת IP של המערכת, שבה מוגדרת חוות זמנית "Let's Encryptz" לחידוש האישור. נכון אם Param farmname לא נשלח.
כוח_חידוש מחרוזת נכון, לאלץ את חידוש האישור גם אם לא פג תוקפו, שקר, האישור יחודש אם הוא אמור להתחדש (פחות מ-30 יום לפוג).
הפעלה מחדש מחרוזת נכון, כל החוות המשתמשות בתעודה יופעלו מחדש. שקר, לא יופעלו מחדש חוות המשתמשות בתעודה.

דוגמה לתגובה:

{
   "description" : "Let's Encrypt certificate actions",
   "params" : {
      "CN" : "test.zevenet.com",
      "creation" : "May 31 11:35:08 2021 GMT",
      "domains" : [
         "test.zevenet.com"
      ],
      "expiration" : "Aug 29 11:35:08 2021 GMT",
      "file" : "/usr/local/zevenet/config/letsencrypt/live/test.zevenet.com/fullchain.pem",
      "issuer" : "US,(STAGING) Let's Encrypt,(STAGING) Artificial Apricot R3",
      "status" : "valid",
      "type" : "LE Certificate",
      "wildcard" : "false"
   },
   "warning" : "The following farms were been restarted: testl7farm"
}

פרמטרים של תגובה

אם חוות ה- are הופעלו מחדש, ה אזהרה שדה יתאר את זה.

שדה סוּג תיאור
params אובייקט [] רשימת אובייקטים אישורים.

אובייקט אישור

שדה סוּג תיאור
CN מחרוזת שם נפוץ של דומיין.
יצירה מחרוזת תאריך היווצרות.
תחומים מחרוזת [] רשימת הדומיינים שהאישור תקף עבורם.
תפוגה מחרוזת תאריך תפוגה.
פילה מחרוזת זהו שם הקובץ של האישור, תעודת הזהות הייחודית.
מנפיק מחרוזת הרשות המוסמכת חתומה על התעודה.
מצב מחרוזת מצב התעודה.תקף,האישור תקף.עומד לפוג, האישור עומד לפוג.לא בתוקף, פג תוקף האישור.לא בעייתי, האישור עומד להנפקה.לא ידוע, האישור אינו תקף.
סוג מחרוזת תעודת LE.
כלליים מחרוזת נכון, האישור מיועד לדומיינים של תווים כלליים. שקר, האישור מיועד לדומיינים שאינם תווים כלליים לחיפוש.

מחק תעודת ללא תו כללי Let's Encrypt Certificate

מחק תעודת ללא תו כללי Let's Encrypt Certificate

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/certificates/letsencryptz/example.domain.com
zcli certificate-le delete example.domain.com

DELETE /certificates/letsencryptz/<domain>

מחק אישור Let's Encrypt לפי דומיין.

דוגמה לתגובה:

{
   "description" : "Delete Let's Encrypt certificate",
   "message" : "Let's Encrypt Certificate example.domain.com has been deleted.",
   "success" : "true"
}

חוות

Zevenet יכולה לנהל את התעבורה בשלוש דרכים שונות, כל דרך מנוהלת על ידי מודול אחר, איזון עומסי שירות מקומי או מודול LSLB, איזון עומס שירות גלובלי או מודול GSLB ומודול עומס שירות Datalink או מודול DSLB.

כל המודולים עובדים עם תפיסת פרופיל החווה, פרופיל משק הוא קבוצה של פרמטרים שמוכנים לבצע פעולה ספציפית עם תעבורת הרשת, חשוב להבין מה יכול לעשות כל פרופיל משק כדי להשיג את התוצאות הטובות ביותר של Zevenet ADC.

רשימת סיכום חוות

רשום חוות סיכום

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/modules/summary

GET /farms/modules/summary

רשום סיכום עם החוות במערכת, מקובצות לפי מודול.

דוגמה לתגובה:

{
   "description" : "Farm Modules summary",
   "params" : {
      "dslb" : [],
      "gslb" : [
         {
            "name" : "dnsServ",
            "profile" : "gslb",
            "services" : []
         }
      ],
      "lslb" : [
         {
            "name" : "CatalogueWeb",
            "profile" : "http",
            "services" : [
               "technology",
               "food"
            ]
         },
         {
            "name" : "shopApp",
            "profile" : "http",
            "services" : [
               "provider",
               "clients"
            ]
         },
         {
            "name" : "VirtualApps",
            "profile" : "l4xnat"
         }
      ]
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של חוות עם השירותים שלהם.

אובייקט משק חקלאי:

שדה סוּג תיאור
שם החווה מחרוזת שם תיאורי החווה. הוא משמש כמזהה ייחודי לחוות.
פרופיל מחרוזת סוג הפרופיל, ערכי הפרופיל הזמינים הם: http, https or l4xnat עבור מודול LSLB, גסלב עבור מודול GLSB ו DataLink עבור מודול DSLB
שרות מחרוזת [] זוהי רשימת שם השירותים שהחווה מכילה. שדה זה יהיה זמין בחוות מסוג http, https, ו גסלב.

רשום את כל החוות

רשום את כל החוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm list

GET /farms

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

דוגמה לתגובה:

{
   "description" : "List farms",
   "params" : [
      {
         "farmname" : "httpFarm",
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.101.146",
         "vport" : "81"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה מערך של אובייקטים לחידוש משק, שכל אחד מהם מכיל את תכונות המפתח להלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
שם החווה מחרוזת שם תיאורי החווה. הוא משמש כמזהה ייחודי לחוות.
פרופיל מחרוזת סוג הפרופיל, ערכי הפרופיל הזמינים הם: http, https or l4xnat עבור מודול LSLB, גסלב עבור מודול GLSB ו DataLink עבור מודול DSLB.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP וירטואלי שבו החווה מקבלת תנועה.
גווניה מחרוזת יציאה וירטואלית שבה החווה מקבלת תנועה, הערכים הזמינים ליציאה הם: מספר יציאה לפרופילי http [s], l4xnat ו- gslb, קבוצת יציאות המופרדת על ידי "," או טווח יציאות המופרד על ידי ":" עבור פרופילי l4xnat, ב l4xnat ניתן להשתמש בשני ערכי ההפרדה ("," ו- ":") באותו שדה.

מחק משק חקלאי

מחק משק חקלאי

דוגמה לבקשה:

curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm delete FarmHTTP

DELETE /farms/<farmname>

מחק חוות דרך מזהה שם החווה שלה.

דוגמה לתגובה:

{
  "description" : "Delete farm FarmHTTP",
  "message" : "The Farm FarmHTTP has been deleted.",
  "success" : "true"
}

הגדר פעולה בחווה

הגדר פעולה בחווה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmTCP/actions
zcli farm stop FarmTCP

PUT /farms/<farmname>/actions

החל פעולה על חווה, עיין בטבלה פרמטרים בקשה לפעולות.

פרמטרים של בקשה

שדה סוּג תיאור
פעולה מחרוזת הפעולה לביצוע, האפשרויות הן: להפסיק, החווה תיפסק, ותקצץ את הקשרים הנוכחיים ולא תקבל יותר קשרים; התחלה, החווה תתחיל, שתפעיל את המאזין ותאזן בין הקשרים החדשים בין גביה; הפעלה מחדש, החווה תיעצר ותתחיל באופן אוטומטי.

דוגמה לתגובה:

{
  "description" : "Set a new action in FarmHTTP",
  "params" : [
     {
        "action" : "stop"
     }
  ]
}

פרמטרים של תגובה

אם אין בעיות בתצורה, ZAPI תחזיר את הפעולה המבוקשת.

חוות HTTP

פרופיל HTTP הוא שכבת 7 מתקדמת לאיזון עומסים (או בקר למסירת יישומים) עם מאפיינים מיוחדים של proxy. פרופיל זה מציע כמה תכונות כמו איזון עומסים HTTPS בשילוב עם האצת עומס SSL. פרופיל זה מתאים לשירותי אינטרנט (כלולים שרתי יישומי אינטרנט) ולכל פרוטוקולי היישום המבוססים על פרוטוקולי HTTP ו- HTTPS כמו WebDav, RDP מעל HTTP, ICA על HTTP וכו '. להגדרת פרופיל חווה זה, כתובת IP וירטואלית ו- TCP וירטואלי נדרש יציאה.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm
zcli farm get httpFarm

GET /farms/<farmname>

הצג את כל תצורת החווה.

דוגמה לתגובה:

{
   "description" : "List farm httpFarm",
   "ipds" : {
      "blacklists" : [
         {
            "name" : "outside",
            "status" : "down"
         }
      ],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ],
      "waf" : [
         {
            "name" : "XSSi",
            "status" : "down"
         },
         {
            "name" : "SQLi",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "addheader" : [
         {
            "header" : "load-balancer: true",
            "id" : 0
         }
      ],
      "addresponseheader" : [
         {
            "header" : "Session: true",
            "id" : 0
         }
      ],
      "certlist" : [
         {
            "file" : "zencert.pem",
            "id" : 1
         }
      ],
      "cipherc" : "ALL",
      "ciphers" : "all",
      "contimeout" : 20,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "errorWAF"  : "The request was rejected by the server.",
      "error414" : "Request URI is too long.",
      "error500" : "An internal server error occurred. Please try again later.",
      "error501" : "This method may not be used.",
      "error503" : "The service is not available. Please try again later.",
      "headremove" : [
         {
            "id" : 0,
            "pattern" : "^client"
         }
      ],
      "httpverb" : "MSRPCext",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "false",
      "removeresponseheader" : [
         {
            "id" : 0,
            "pattern" : "Host"
         }
      ],
      "reqtimeout" : 30,
      "restimeout" : 45,
      "resurrectime" : 10,
      "rewritelocation" : "enabled",
      "status" : "up",
      "vip" : "192.168.100.211",
      "vport" : 200
   },
   "services" : [
      {
         "backends" : [],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : "check_tcp",
         "httpsb" : "false",
         "id" : "service3",
         "leastresp" : "false",
         "redirect" : "http://192.168.101.254/index.html",
         "redirect_code" : 302,
         "redirecttype" : "default",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
      {
         "backends" : [
            {
               "alias" : "http-server",
               "id" : 0,
               "ip" : "192.168.0.168",
               "port" : 80,
               "status" : "up",
               "timeout" : null,
               "weight" : null,
               "priority" : null
            }
         ],
         "cookiedomain" : "",
         "cookieinsert" : "false",
         "cookiename" : "",
         "cookiepath" : "",
         "cookiettl" : 0,
         "farmguardian" : null,
         "httpsb" : "false",
         "id" : "srv",
         "leastresp" : "false",
         "persistence" : "",
         "redirect" : "",
         "redirecttype" : "",
         "sessionid" : "",
         "sts_status" : "false",
         "sts_timeout" : 0,
         "ttl" : 0,
         "urlp" : "",
         "vhost" : "",
         "pinnedconnection" : 0,
         "routingpolicy" : "ROUND_ROBIN"
      },
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
ipod חפץ רשימת הכללים IPDS החלים על החווה הזו.
params חפץ פרמטרים של תצורה חקלאית.
שירותים אובייקט [] מערך עם כל השירותים שנוצרו בחווה זו ואת התצורה שלה.

אובייקט IPDS:

שדה סוּג תיאור
רשימות שחורות אובייקט [] הכללים השחורים החלים על החווה.
דוס אובייקט [] הכללים DoS להחיל את החווה.
Rbl אובייקט [] הכללים RBL להחיל על החווה.
WAF אובייקט [] זה אובייקט עם מפתח אחד, שם.

רשימה שחורה, DoS ו- RBL אובייקט:

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

אובייקט פרמטרים עבור חוות HTTP:

שדה סוּג תיאור
AddHeader אובייקט [] זוהי רשימה של אובייקטים עם הכותרות להוסיף לבקשת הלקוח.
תגובת תגובת (מ 4.0.1) אובייקט [] זוהי רשימת אובייקטים עם הכותרות להוסיף לתגובת ה- backend.
certlist אובייקט [] רק אם המאזין הוא HTTPS. רשימת האישורים שימשה את החווה, יש להם בפורמט PEM, מותר להוסיף יותר מאישור PEM אחד לאותה החווה לצורך תמיכה ב- SNI. ניתן להשתמש כאן בכל תעודה בחנות האישורים.
cipherc מחרוזת רק במאזין https. זוהי רשימת הצפנים המותאמת אישית המותרת שתתקבל על ידי חיבור ה- SSL, שהיא מחרוזת באותו פורמט כמו בצפני OpenSSL. תכונה זו משמשת רק כאשר Ciphers לשדה יש ​​את הערך "אבטחת מכס".
Ciphers מחרוזת רק אם המאזין הוא HTTPS. משמש לבניית רשימת הצפנים המקובלים על ידי חיבורי SSL כדי להקשיח את חיבור ה- SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; - מכס, רק ciphers טעון ב cipherc שדה יתקבל; או ssloffloading, זה devolves את העבודה להצפין את התהליך, צופן זה תלוי במעבד.
ת מספר כמה זמן החווה הולך לחכות חיבור TCP כדי backend בתוך שניות.
disable_sslv2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה SSL עם גרסה 2 אינם מורשים; אוֹ שקר אם פרוטוקול SSLv2 מותר.
disable_sslv3 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה SSL עם גרסה 3 אינם מורשים; אוֹ שקר אם פרוטוקול SSLv3 מותר.
disable_tlsv1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1 אסורים; או שקר אם פרוטוקול TLSv1 מותר.
disable_tlsv1_1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.1 אסורים; או שקר אם פרוטוקול TLSv1.1 מותר.
disable_tlsv1_2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.2 אסורים; או שקר אם פרוטוקול TLSv1.2 מותר.
errorWAF מחרוזת הודעה מותאמת אישית לתגובה כאשר WAF דוחה בקשה (מ 4.0.2).
error414 מחרוזת הודעה מותאמת אישית לתגובה באמצעות קוד השגיאה 414 HTTP.
error500 מחרוזת הודעה מותאמת אישית לתגובה באמצעות קוד השגיאה 500 HTTP.
error501 מחרוזת הודעה מותאמת אישית לתגובה באמצעות קוד השגיאה 501 HTTP.
error503 מחרוזת הודעה מותאמת אישית לתגובה באמצעות קוד השגיאה 503 HTTP.
ראש אובייקט [] זוהי רשימת ביטויים רגולריים להסרת כותרות מבקשות הלקוח. הכותרות שהוסרו לא יגיעו לגב האחורי.
http מחרוזת שדה זה מציין את הפעולות שיהיו מותרות בבקשות הלקוח של HTTP. הערכים הזמינים הם: סטנדרטי, קיבלו בקשות HTTP GET, POST, HEAD. extendedHTTP, קיבל בקשות HTTP קודמות בתוספת PUT, DELETE. אפשרויות HTTP (מ 4.0.1), הוסף את הפועל OPTIONS לקודמים. תקן, קיבל בקשות HTTP קודמות בתוספת LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, מיזוג, דוח, MSextWebDAV קיבל בקשות HTTP קודמות בתוספת SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT או MSRPCext, קיבל בקשות HTTP קודמות בתוספת RPC_IN_DATA, RPC_OUT_DATA. שים לב שהערכים האלה תלויי רישיות.
התעלם_ 100_ המשך מחרוזת אם לשדה זה יש את הערך נכון מה היא 100 ממשיך כותרת HTTP תתעלם; אם הערך הוא שקר, ה 100 ממשיך הכותרת תעובד.
מאזין מחרוזת המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח.
יומני מחרוזת החווה מתעד את החיבורים של חיבורי HTTP. אם לפרמטר זה יש את הערך נכון, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים.
מסיר תגובהמ 4.0.1) אובייקט [] זוהי רשימת ביטויים רגולריים להסרת כותרות מתגובת ה- backend. הכותרות שהוסרו לא יגיעו ללקוח.
זמן מספר כמה זמן החווה הולך לחכות לבקשת הלקוח בתוך שניות.
restimeout מספר כמה זמן החווה הולך לחכות תגובה מן backends בתוך שניות.
לתחייה מספר התקופה לצאת שרת אמיתי נפל, לאחר תקופה זו איזון עומס בודק אם השרת האמיתי הוא חי, בתוך שניות.
שכתוב מחדש אובייקט [] אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל, הופעל נכה, מושבת או מאופשר- backends רק את כתובת backend מושווה. מ 4.0.2 אפשרויות חדשות זמינות: נתיב מופעל ו enabled-backends-path. הנתיב חל אם ההנחיה RewriteUrl שינתה את כתובת האתר של הבקשה. דגל זה מאלץ לבטל את השינוי בכתובת האתר ש-RewriteUrl ביצע.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.

אובייקט Certlist:

שדה סוּג תיאור
פילה מחרוזת שם האישור, הפניות לאישור בחנות אישורים.
id מספר מזהה תעודה, הסדר ברשימה, הראשון יהיה המשמש כברירת מחדל אם כותרת המארח הווירטואלי אינה תואמת לשדה CN בתעודה. משמש ל- SNI.

אובייקט שירותים עבור חוות HTTP:

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
cookiedomain מחרוזת הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיה. לְאַפשֵׁר עוגיות שדה נדרש.
עוגיות מחרוזת זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נכון, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, שום פעולה לא ננקטת.
cookiename מחרוזת שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש.
cookiepath מחרוזת הוא מנהל את הערך נתיב עוגיות עבור עוגיה נתון. הפעל עוגיות שדה נדרש.
cookiettl מספר זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש.
חקלאי מחרוזת זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד.
https מחרוזת פרמטר זה מציין בפני החווה כי הגיבויים האחוריים מוגדרים לשימוש בשפת HTTPS ואז הנתונים יוצפנו לפני שיישלחו. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.
id מחרוזת שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות.
leastresp מחרוזת זה מאפשר את שיטת איזון התגובה הכי פחות. נכון לעתים קרובות הפרופיל בודק איזה backend לוקח פחות זמן להגיב כדי לשלוח יותר קשרים לזה, ה- שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
הפניה מחרוזת זה מתנהג כמו backend מיוחד, שכן בקשת הלקוח נענתה על ידי הפניה מחדש לכתובת URL חדשה באופן אוטומטי. אם הניתוב מחדש הוגדר אז הבקשה לא תועבר לתמיכה האחורית, הפניה תיענה ללקוח במקום זאת.
קוד מספר זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307,
redirecttype מחרוזת כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארח מוחלט ונתיב להפניה אליו, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה.
sessionid מחרוזת זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת ה- HTTP וינהל את הפעלת הלקוח.
sts_status מחרוזת מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נכון כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות.
sts_timeout מספר זמן (בשניות) כי הלקוח זוכר כי השירות זמין רק עם HTTS.
Ttl מספר רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת ה- URL שהלקוח מבקש באמצעות תבנית URL ספציפית אשר תיבדק באופן תחבירי. תמיכה בביטוי רגיל של PCRE.
ווסט מחרוזת הוא מציין את התנאי שנקבע על ידי שם הדומיין באמצעות אותו IP וירטואלי ויציאה שהוגדרו על ידי חוות HTTP. תמיכה בביטוי רגיל של PCRE.
חיבור מוצמד (מגרסה 4.0.2) מספר ציין אם ברצוננו להצמיד את כל החיבורים, (ברירת מחדל: 0, לא מוצמד). אם Pinnedconnection מוגדר ל-1, zproxy מעביר ישירות את כל הנתונים ללא ניתוח או עריכה.
מדיניות ניתוב (מגרסה 4.0.2) מחרוזת ציין את מדיניות הניתוב. כל האלגוריתמים משוקללים עם כל המשקולות המוגדרות בכל קצה אחורי. ישנן ארבע אפשרויות: רובין העגול השתמש באלגוריתם הרובין כמדיניות ניתוב (ברירת מחדל). LEAST_CONNECTIONS בחר את הקצה האחורי עם הכי פחות חיבורים שנוצרו תוך שימוש כפרופורציה של המשקולות שנקבעו. זמן תגובה בחר את הקצה האחורי עם זמן התגובה הנמוך ביותר תוך שימוש בפרופורציה של המשקולות שנקבעו. PENDING_CONNECTIONS בחר את הקצה האחורי עם החיבורים הממתינים לפחות תוך שימוש בפרופורציה של המשקולות שנקבעו.
כותב מחדש (מגרסה 4.0.2) אובייקט [] הוא בודק דפוס כדי לקבל מחרוזות מ-URL ולהחליף אותן. ניתן להוסיף מספר הנחיות RewriteUrl. כולם יוחלו ברצף על כתובת האתר הנכנסת, אלא אם הוגדר הדגל האחרון שיסיים את שלב השכתוב של כתובת האתר.

אובייקט Backend עבור חוות HTTP:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה לאחור בתוך השירות הנתון.
ip מחרוזת ה- IP של Backend שבו פועל השירות האמיתי.
נמל מספר הנמל של Backend שבו פועל השירות האמיתי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
פסק זמן מספר זה הזמן המקסימלי לחכות לתגובת ה- backend לפני שסמן אותה כלא זמינה. הזמן הזה הוא בשניות.
מִשׁקָל מספר זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה. הערכים האפשריים הם מ 1 ל 9.
עדיפות (מ 4.0.1) מספר (רק כאשר הדור החדש של פרוקסי עובד) זהו ערך העדיפות עבור השרת האמיתי הנוכחי, קצה אחורי עם ערך בעדיפות נמוכה יותר יהיה מוכן לקבל חיבורים לפני יותר מאחרים עם עדיפות גבוהה יותר. ערך ברירת המחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ 1 ל 9
connect_limit (מ 4.0.2) מספר (רק כאשר הדור החדש של פרוקסי עובד) המספר המרבי של חיבורים שנוצרו לכל backend. עם ערך 0, לא תהיה הגבלה ב-backend. הלקוח יקבל שגיאת 503 אם אין קצה אחורי זמין.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"newHTTPfarm", "profile":"http", "vip":"192.168.100.23",
"vport":80}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm create -farmname newHTTPfarm -profile http -vip 192.168.100.23 -vport 80

POST /farms

צור חוות HTTP חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם תיאורי החווה. הוא משמש כמזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות HTTP הוא http. נכון
החברים מחרוזת IP של החווה, שבו השירות הווירטואלי הולך לרוץ. כתובת ה- IP שצוינה חייבת להיות מוגדרת במערכת ו- UP נכון
גווניה מספר נמל החווה, שם השירות הווירטואלי הולך להאזין. אסור להשתמש באותו יציאה וירטואלית ו- IP וירטואלי על ידי משק אחר. נכון
תעתיק מ (מ 4.0.1) מחרוזת פרמטר זה מצפה לשמה של חווה קיימת. אם פרמטר זה נשלח, החווה מועתקת מהחווה שצוינה בה. ה שם החווה, החברים ו גווניה ערכים יידרסו.

דוגמה לתגובה:

{
   "description" : "Creating farm 'newHTTPfarm'",
   "params" : {
      "interface" : "eth0.2",
      "farmname" : "newHTTPfarm",
      "profile" : "http",
      "vip" : "192.168.100.23",
      "vport" : 80
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP", "errorWAF":"Message error WAF",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false", "logs":"true",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP
zcli farm set FarmHTTP -contimeout 22 -newfarmname FarmHTTP2 -vip 178.62.126.152 -vport 88 -ignore_100_continue true -restimeout 47 -resurrectime 12 -reqtimeout 32 -rewritelocation enabled -httpverb standardHTTP -errorcode414 'Message error 414' -logs true

PUT /farms/<farmname>

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

פרמטרים של בקשה

שדה סוּג תיאור
ת מספר כמה זמן את החווה הולך לחכות חיבור backend בתוך שניות.
restimeout מספר כמה זמן החווה הולך לחכות תגובה מן backends בתוך שניות.
לתחייה מספר ערך זה בשניות הוא התקופה להוציא backend ברשימה השחורה ובודק אם הוא חי.
זמן מספר כמה זמן החווה הולך לחכות לבקשת הלקוח בתוך שניות.
disable_sslv2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה SSL עם גרסה 2 אינם מורשים; אוֹ שקר אם פרוטוקול SSLv2 מותר.
disable_sslv3 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה SSL עם גרסה 3 אינם מורשים; אוֹ שקר אם פרוטוקול SSLv3 מותר.
disable_tlsv1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1 אסורים; או שקר אם פרוטוקול TLSv1 מותר.
disable_tlsv1_1 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.1 אסורים; או שקר אם פרוטוקול TLSv1.1 מותר.
disable_tlsv1_2 מחרוזת רק במאזין https. אם לשדה זה יש את הערך נכון החיבורים באמצעות פרוטוקול אבטחה TLS עם גרסה 1.2 אסורים; או שקר אם
שכתוב מחדש מחרוזת אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל מוּפעָל; נכה מוּבטָל; אוֹ מאופשר- backends רק את כתובת backend מושווה.
http מחרוזת שדה זה מציין את הפעולות שיהיו מותרות בבקשות הלקוח של HTTP. הערכים הזמינים הם: סטנדרטי, קיבלו בקשות HTTP GET, POST, HEAD. extendedHTTP, קיבל בקשות HTTP קודמות בתוספת PUT, DELETE. אפשרויות HTTP (מ 4.0.1), הוסף את הפועל OPTIONS לקודמים. תקן, קיבל בקשות HTTP קודמות בתוספת LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, מיזוג, דוח, MSextWebDAV קיבל בקשות HTTP קודמות בתוספת SUBSCRIBE, UNSUBSCRIBE, NOTIFY, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT או MSRPCext, קיבל בקשות HTTP קודמות בתוספת RPC_IN_DATA, RPC_OUT_DATA. שים לב שהערכים האלה תלויי רישיות.
התעלם_ 100_ המשך מחרוזת אם לשדה זה יש את הערך נכון מה היא 100 ממשיך כותרת HTTP תתעלם; אם הערך הוא שקר, ה 100 ממשיך הכותרת תעובד.
errorWAF מחרוזת שגיאת הודעה אישית WAF (מגרסה 4.0.2).
error414 מחרוזת הודעת שגיאה מותאמת אישית 414.
error500 מחרוזת הודעת שגיאה מותאמת אישית 500.
error501 מחרוזת הודעת שגיאה מותאמת אישית 501.
error503 מחרוזת הודעת שגיאה מותאמת אישית 503.
מאזין מחרוזת המאזין מגדיר כיצד החווה הולך לשחק עם הבקשות של הלקוחות. האפשרויות הן: http עבור פרוטוקול לא מאובטח או https עבור פרוטוקול מאובטח.
יומני מחרוזת החווה מתעד את החיבורים של חיבורי HTTP. אם לפרמטר זה יש את הערך נכון, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים.
Ciphers מחרוזת רק מאזין עם ערך https. משמש כדי לבנות רשימה של צופן המקובל על ידי חיבורי SSL כדי להקשיח את חיבור SSL. האפשרויות הן: את כל, כל הצופן יתקבל; אבטחה גבוהה, רק צפנים לביטחון גבוה יתקבלו; - מכס, רק ciphers טעון ב cipherc שדה יתקבל; או ssloffloading, זה devolves את העבודה להצפין את התהליך, צופן זה תלוי במעבד.
cipherc מחרוזת רק במאזין https. זוהי רשימת הצפנים המותאמת אישית המותרת שתתקבל על ידי חיבור ה- SSL, שהיא מחרוזת באותו פורמט כמו בצפני OpenSSL. תכונה זו משמשת רק כאשר Ciphers לשדה יש ​​את הערך "אבטחת מכס".
newfarmname מחרוזת שם החווה החדשה. יש לעצור את החווה.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב, IP זה חייב להיות מוגדר ומעלה במערכת.
שם תעודה מחרוזת תעודת HTTPS הוגדרה

דוגמה לתגובה:

{
   "description" : "Modify farm FarmHTTP",
   "params" : {
      "cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
      "ciphers" : "customsecurity",
      "contimeout" : 22,
      "disable_sslv2" : "true",
      "disable_sslv3" : "false",
      "disable_tlsv1" : "false",
      "disable_tlsv1_1" : "true",
      "disable_tlsv1_2" : "false",
      "errorWAF" : "Message error WAF",
      "error414" : "Message error 414",
      "error500" : "Message error 500",
      "error501" : "Message error 501",
      "error503" : "Message error 503",
      "httpverb" : "standardHTTP",
      "ignore_100_continue" : "true",
      "listener" : "https",
      "logs" : "true",
      "newfarmname" : "FarmHTTP",
      "reqtimeout" : 32,
      "restimeout" : 47,
      "resurrectime" : 12,
      "rewritelocation" : "enabled",
      "vip" : "178.62.126.152",
      "vport" : 88
   }
}

פרמטרים של תגובה

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

הוסף כותרת מותאמת אישית לבקשה

הוסף כותרת מותאמת אישית לבקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

POST /farms/<farmname>/addheader

החווה תוסיף את הכותרת אל backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת זה מחרוזת עם הכותרת כי יישלחו backend. נכון

דוגמה לתגובה:

{
   "description" : "Add addheader directive.",
   "message" : "Added a new item to the addheader list",
   "status" : "needed restart",
   "success" : "true"
}

שנה והוספה של כותרת מותאמת אישית לכלל הבקשה

שנה והוספה של כותרת מותאמת אישית לכלל הבקשה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/id
zcli farm-add-request-header MyHttpFarm -header "loadbalancer: true"

PUT /farms/<farmname>/addheader/<id>

החווה תוסיף את הכותרת אל backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת זה מחרוזת עם הכותרת כי יישלחו backend. נכון

דוגמה לתגובה:

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}

מחק כותרת מותאמת אישית מהבקשה

מחק כותרת מותאמת אישית מהבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addheader/0
zcli farm-add-request-header remove MyHttpFarm 0

DELETE /farms/<farmname>/addheader/<index>

מדד הוא האינדקס של מערך Addheader למחיקה.

דוגמה לתגובה:

{
   "description" : "Delete addheader directive.",
   "message" : "The addheader 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

הוסף כלל להסרת כותרות מהבקשה

הוסף כלל להסרת כותרות מהבקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

POST /farms/<farmname>/headremove

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Add headremove directive.",
   "message" : "Added a new item to the headremove list",
   "status" : "needed restart",
   "success" : "true"
}

שנה הסרת כותרות מכלל הבקשה

שנה הסרת כותרות מכלל הבקשה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/id
zcli farm-remove-request-header add MyHttpFarm -pattern "^client:"

PUT /farms/<farmname>/headremove/<id>

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Modify an headremove directive.",
   "message" : "Modified an item from the headremove list",
   "success" : "true"
}

מחק כלל להסרת כותרות מהבקשה

מחק כלל להסרת כותרות מהבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/headremove/0
zcli farm-remove-request-header remove MyHttpFarm 0

DELETE /farms/<farmname>/headremove/<index>

מדד הוא האינדקס של מערך headremove למחיקה.

דוגמה לתגובה:

{
   "description" : "Delete headremove directive.",
   "message" : "The headremove 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

הוסף כותרת מותאמת אישית לתגובה

הוסף כותרת מותאמת אישית לתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/addresponseheader

החווה תוסיף את הכותרת לתגובת ה- backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת זה מחרוזת עם הכותרת כי יישלחו backend. נכון

דוגמה לתגובה:

{
   "description" : "Add a header to the backend repsonse.",
   "message" : "Added a new header to the backend response",
   "status" : "needed restart",
   "success" : "true"
}

שנה והוספה של כותרת מותאמת אישית לכלל התגובה

שנה והוספה של כותרת מותאמת אישית לכלל התגובה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"loadbalancer: true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/id
zcli farm-add-response-header add MyHttpFarm -header loadbalancer:true

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

החווה תוסיף את הכותרת לתגובת ה- backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת זה מחרוזת עם הכותרת כי יישלחו backend. נכון

דוגמה לתגובה:

{
   "description" : "Modify an addresponseheader directive.",
   "message" : "Modified an item from the addresponseheader list",
   "success" : "true"
}

מחק כותרת מותאמת אישית מהתגובה

מחק כותרת מותאמת אישית מהתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/addresponseheader/0
zcli farm-add-response-header remove torta 0

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/addresponseheader/<index>

מדד הוא האינדקס של מערך addresponseheader למחיקה.

דוגמה לתגובה:

{
   "description" : "Delete a header previously added to the backend response.",
   "message" : "The header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

הוסף כלל להסרת כותרות מתגובה

הוסף כלל להסרת כותרות מתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/removeresponseheader

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Remove a header from the backend response.",
   "message" : "Added a patter to remove reponse headers",
   "status" : "needed restart",
   "success" : "true"
}

שנה כלל הסר כותרות מהתגובה

שנה כלל הסר כותרות מהתגובה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/id
zcli farm-remove-response-header add MyHttpFarm -pattern "^client:"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/removeresponseheader/<id>

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Modify a remove response header directive.",
   "message" : "Modified an item from the removeresponseheader list",
   "success" : "true"
}

מחק כלל להסרת כותרת מתגובה

מחק כלל להסרת כותרת מתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/removeresponseheader/0
zcli farm-remove-response-header remove torta 0

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/removeresponseheader/<index>

מדד הוא האינדקס של מערך removeresponseheader למחיקה.

דוגמה לתגובה:

{
   "description" : "Delete a pattern to remove response headers.",
   "message" : "The pattern 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

הוסף כלל לשכתוב כותרות מתוך בקשה

הוסף כלל לשכתוב כותרות מתוך בקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/replacerequestheader

הוסף כללים כדי לשכתב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

שנה כלל שכתוב כותרות מ-Request

שנה כלל שכתוב כותרות מ-Request

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/replacerequestheader/<id>

הוסף כללים כדי לשכתב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

מחק כלל לשכתוב כותרות מהבקשה

מחק כלל לשכתוב כותרות מהבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/0
zcli farm-replace-request-header remove MyHttpFarm 0

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/replacerequestheader/<index>

מדד הוא האינדקס של מערך replacerequestheader שיש למחוק.

דוגמה לתגובה:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

העבר כותרות שכתוב מכלל בקשה

העבר כותרות שכתוב מכלל בקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replacerequestheader/id/actions
farm-replace-request-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/replacerequestheader/<id>/actions

העבר כותרת ReplaceRequest.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר עמדת כלל חדשה נכון

דוגמה לתגובה:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

הוסף כלל לשכתוב כותרות מהתגובה

הוסף כלל לשכתוב כותרות מהתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/replaceresponseheader

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "status" : "needed restart",
   "success" : "true"
}

שנה כלל שכתוב כותרות מ-Response

שנה כלל שכתוב כותרות מ-Response

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:","match":"^COOKIESESSION=(.*)","replace":"COOKIEUSER=$1"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1` -t$

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/replaceresponseheader/<id>

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

מחק כלל לשכתב כותרות מהתגובה

מחק כלל לשכתב כותרות מהתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/0
zcli farm-replace-response-header remove MyHttpFarm 0

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/replaceresponseheader/<index>

מדד הוא האינדקס של מערך replaceresponseheader שיש למחוק.

דוגמה לתגובה:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header 0 was deleted successfully",
   "status" : "needed restart",
   "success" : "true"
}

העבר כותרות שכתוב מכלל בקשה

העבר כותרות שכתוב מכלל תגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/replaceresponseheader/<id>/actions

העבר כותרת ReplaceRequest.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר עמדת כלל חדשה נכון

דוגמה לתגובה:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

הוסף אישור

הוסף אישור

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"file":"example.pem"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/certificates
zcli farm-certificate add httpFarm -file example.pem

POST /farms/<farmname>/certificates

כלול תעודת PEM זמינה לרשימת ה- SNI או certlist מערך של חוות HTTP עם מאזין HTTPS. התעודה המשומשת חייבת להיות מועלית כבר במערכת, ראה אישורים> רשום את כל האישורים עבור רשימת האישורים הזמינים.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פילה מחרוזת שם קובץ אישור, בעבר יש להעלות את האישור במערכת. נכון

דוגמה לתגובה:

{
   "description" : "Add certificate",
   "message" : "The certificate example.pem has been added to the SNI list of farm httpFarm, you need restart the farm to apply",
   "success" : "true",
   "status": "needed restart"
}

העבר תעודה

העבר תעודה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarm/certificates/certif.pem/actions
zcli farm-certificate move newfarm zertif.pem -position 0

POST /farms/<farmname>/certificates/<file>/actions

ה- URI file הפרמטר הוא שם קובץ האישור שעומד להיות מועבר.

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

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר שלם זה המצב שיהיה לתעודה בתצורת החווה כאשר עיבוד שיחת ZAPI נכון

דוגמה לתגובה:

{
    "description" : "Move service",
    "params" : {
        "position" : 0
    },
    "status" : "needed restart",
    "info" : "There\'re changes that need to be applied, stop and start farm to apply them!",
    "message" : "certif.pem was moved successfully."
}

מחיקת אישור

מחיקת אישור

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/certificates/example.pem
zcli farm-certificate remove MyHttpFarm example.pem

DELETE /farms/<farmname>/certificates/<file>

מחק את האישור עם שם הקובץ שנבחר מרשימת האישורים בחוות HTTP עם מאזין HTTPS. האישור לא יימחק מחנות האישורים.

דוגמה לתגובה:

{
   "description" : "Delete farm certificate",
   "message" : "The Certificate example.pem has been deleted.",
   "success" : "true",
   "status": "needed restart"
}

הוסף כלל IPDS

הוסף כלל IPDS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists
zcli farm-blacklist add httpFarm -name china

POST /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>

החל חווה ברשימה שחורה, DoS, RBL או WAF.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת שם כלל ה- IPDS המשמש כמזהה ייחודי.

דוגמה לתגובה:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm httpFarm.",
   "success" : "true"
}

העבר כלל IPDS

העבר כלל IPDS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/waf/test_waf_ori/rules/0/actions
zcli farm-waf move httpFarm REQUEST-901-INITIALIZATION -position 2

POST /farms/<farmname>/ipds/<waf|blacklists>/<name>/actions

כללי ה-IPDS להזיז זמינים רק עבור כללי WAF ורשימה שחורה. בסוג זה של כללים חשוב הסדר שהולך להיבדק.

אל האני name פרמטר URI הוא שם סט הכללים של הערכה יועבר.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר שלם זה המיקום שלכלל ה-IPDS יהיה בתצורת החווה כאשר קריאת ZAPI תעובד נכון

דוגמה לתגובה:

{
    "message" : "The rule was moved properly to the position 2.",
    "description" : "Move a rule in the set test_waf_ori"
}

הסר כלל IPDS

הסר כלל IPDS

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpFarm/ipds/blacklists/china
zcli farm-blacklist remove httpFarm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl|waf>/<name>

הסר רשימת שחורים, כללי DoS, RBL או WAF מחווה נתונה באמצעות המחוון שלה שם.

דוגמה לתגובה:

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm httpFarm.",
   "success" : "true"
}

HTTP - שירותים

השירותים בחוות פרופיל HTTP מספקים שיטת החלפת תוכן כדי לספק מספר שירותי אינטרנט עם מאפיינים שונים, backends או אפילו שיטות התמדה, באמצעות כמה תנאים דטרמיניסטיים המשמשים את ליבת החווה כדי להתאים את השירות הנכון לכל בקשת לקוח. הגדרת שירות זו תשמש את החווה לקביעת שרתי ה- backends שיכולים לספק את התגובה ללקוח.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/cookiefarm/services/serv
zcli farm get cookiefarm -filter services

GET /farms/<farmname>/services/<id>

הצג את כל התצורה לגבי שירות מסוים.

דוגמה לתגובה:

{
   "description" : "Get services of a farm",
   "services" : {
      "backends" : [
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : 20,
            "weight" : null,
            "priority" : null,
            "connection_limit" : null
         },
         {
            "alias" : "http-server",
            "id" : 0,
            "ip" : "192.168.100.254",
            "port" : 80,
            "status" : "up",
            "timeout" : null,
            "weight" : null,
            "priority" : null,
            "connection_limit" : null
         }
      ],
      "cookiedomain" : "zevenet.cpm",
      "cookieinsert" : "true",
      "cookiename" : "peasocookie",
      "cookiepath" : "/patfh",
      "cookiettl" : 20,
      "farmguardian" : "check_tcp-cut_conns",
      "httpsb" : "false",
      "id" : "serv",
      "leastresp" : "false",
      "persistence" : "COOKIE",
      "redirect" : "",
      "redirect_code" : "",
      "redirecttype" : "",
      "sessionid" : "JSESSIONID",
      "sts_status" : "false",
      "sts_timeout" : 0,
      "ttl" : 18,
      "urlp" : "(?i)^/music$",
      "vhost" : "",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN",
      "replacerequestheader" : [],
      "replaceresponseheader" : [],
      "addrequestheader" : [],
      "addresponseheader" : [],
      "removerequestheader" : [],
      "removeresponseheader" : [],
      "rewriteurl" : [],
      "sessions" : []
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט שירותים עבור חוות HTTP:

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
cookiedomain מחרוזת הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיה. לְאַפשֵׁר עוגיות שדה נדרש.
עוגיות מחרוזת זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נכון, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, לא מתבצעת פעולה.
cookiename מחרוזת שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש.
cookiepath מחרוזת הוא מנהל את הערך נתיב עוגיות עבור עוגיה נתון. הפעל עוגיות שדה נדרש.
cookiettl מספר זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש.
חקלאי מחרוזת זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד.
https מחרוזת פרמטר זה מציין בפני החווה כי ה- backends מוגדרים לשימוש ב- HTTPS, ואז הנתונים יוצפנו לפני שיישלחו. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.
id מחרוזת שם השירות, לא ניתן לשנות אותו לאחר יצירת השירות.
leastresp מחרוזת זה מאפשר את שיטת איזון התגובה הכי פחות. נכון לעתים קרובות הפרופיל בודק איזה backend לוקח פחות זמן להגיב כדי לשלוח יותר קשרים לזה, שקר הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם הפגישה התמדה נעשית בבסיס ערך בסוף URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
הפניה מחרוזת זה מתנהג כמו backend מיוחד, שכן בקשת הלקוח נענתה על ידי הפניה מחדש לכתובת URL חדשה באופן אוטומטי. אם הניתוב מחדש הוגדר אז הבקשה לא תועבר לתמיכה האחורית, הפניה תיענה ללקוח במקום זאת.
קוד מספר זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307.
redirecttype מחרוזת כיצד ניתוב מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארח מוחלט ונתיב להפניה אליו, לצרף, נתיב הבקשה המקורי או ה- URI יצורפו למארח ולנתיב שציינת עם אפשרות ברירת המחדל. אם ה הפניה השדה אינו מוגדר, שדה זה יהיה מחרוזת ריקה.
sessionid מחרוזת זה זמין אם התמדה השדה הוא URL, COOKIE או HEADER, ערך הפרמטר יחפש על ידי החווה בכותרת ה- HTTP וינהל את הפעלת הלקוח.
sts_status מחרוזת מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נכון כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות.
sts_timeout מספר זמן (בשניות) שהלקוח זוכר שהשירות זמין רק עם HTTS.
Ttl מספר רק בהתמדה. ערך זה מציין את זמן החיים המרבי עבור הפעלת לקוח לא פעילה (גיל הפעלה מרבי) בשניות.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת ה- URL שהלקוח מבקש באמצעות תבנית URL ספציפית אשר תיבדק באופן תחבירי. תמיכה בביטוי רגיל של PCRE.
ווסט מחרוזת הוא מציין את התנאי שנקבע על ידי שם הדומיין באמצעות אותו IP וירטואלי ויציאה שהוגדרו על ידי חוות HTTP. תמיכה בביטוי רגיל של PCRE.
חיבור מוצמד (מגרסה 4.0.2) מספר ציין אם ברצוננו להצמיד את כל החיבורים, (ברירת מחדל: 0, לא מוצמד). אם Pinnedconnection מוגדר ל-1, zproxy מעביר ישירות את כל הנתונים ללא ניתוח או עריכה.
מדיניות ניתוב (מגרסה 4.0.2) מחרוזת ציין את מדיניות הניתוב. כל האלגוריתמים משוקללים עם כל המשקולות המוגדרות בכל קצה אחורי. ישנן ארבע אפשרויות: רובין העגול השתמש באלגוריתם הרובין כמדיניות ניתוב (ברירת מחדלט). LEAST_CONNECTIONS בחר את הקצה האחורי עם הכי פחות חיבורים שנוצרו תוך שימוש כפרופורציה של המשקולות שנקבעו. זמן תגובה בחר את הקצה האחורי עם זמן התגובה הנמוך ביותר תוך שימוש בפרופורציה של המשקולות שנקבעו. PENDING_CONNECTIONS בחר את הקצה האחורי עם החיבורים הממתינים לפחות תוך שימוש בפרופורציה של המשקולות שנקבעו.
replacerequestheader (מגרסה 4.0.2) אובייקט [] מערך כללים להחלפת כותרת בבקשה. אם מספר ביטויים רגולריים תואמים בכותרת, רק הראשון יחול. להנחיית replaceHeader בשירותים יש עדיפות על פני המאזין.
replaceresponseheader (מגרסה 4.0.2) אובייקט [] מערך כללים להחלפת כותרת בתגובה. אם מספר ביטויים רגולריים תואמים בכותרת, רק הראשון יחול. להנחיית replaceHeader בשירותים יש עדיפות על פני המאזין.
adrequestheader (מגרסה 4.0.2) אובייקט [] מערך כללים להוספת הכותרת המוגדרת לבקשה המועברת ללקוחות. הכותרת מתווספת מילה במילה.
תגובת תגובת (מגרסה 4.0.2) אובייקט [] מערך כללים להוספת הכותרת המוגדרת לתגובה המועברת ללקוחות. הכותרת מתווספת מילה במילה.
removerequestheader (מגרסה 4.0.2) אובייקט [] מערך כללים להסרת כותרות מסוימות מהבקשה היוצאת, הכותרת הנשלחת על ידי ה-backend לא נשלחת ללקוח.
מסיר תגובהמגרסה 4.0.2) אובייקט [] מערך כללים להסרת כותרות מסוימות מהתגובה היוצאת, הכותרת הנשלחת על ידי ה-backend לא נשלחת ללקוח.
כותב מחדש (מגרסה 4.0.2) אובייקט [] מערך כללים לשינוי כותרות המיקום והתוכן-מיקום בתגובות כדי להציג את המארח הווירטואלי שנשלח בבקשה.
הפעלות (מגרסה 4.0.2) אובייקט [] רשימה של הפעלות סטטיות ודינמיות שנוצרו עבור שירות החווה הזה.

אובייקט Backend עבור חוות HTTP:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה לאחור בתוך השירות הנתון.
ip מחרוזת ה- IP של Backend שבו פועל השירות האמיתי.
נמל מספר הנמל של Backend שבו פועל השירות האמיתי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
פסק זמן מספר זה הזמן המקסימלי לחכות לתגובת ה- backend לפני שמניחים אותה כלא למטה. הזמן הזה הוא בשניות.
מִשׁקָל מספר זה ערך המשקל של השרת האמיתי הנוכחי, גב גב בעל ערך משקל גבוה יותר יקבל יותר חיבורים. ערך ברירת המחדל null, לא משקל מיוחד המשמש עבור backend זה. הערכים האפשריים הם מ 1 ל 9.
עדיפות (מ 4.0.1) מספר (רק כאשר הדור החדש של פרוקסי עובד) זהו ערך העדיפות עבור השרת האמיתי הנוכחי, קצה אחורי עם ערך בעדיפות נמוכה יותר יהיה מוכן לקבל חיבורים לפני יותר מאחרים עם עדיפות גבוהה יותר. ערך ברירת המחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ 1 ל 9.
connect_limit (מ 4.0.2) מספר (רק כאשר הדור החדש של פרוקסי עובד) המספר המרבי של חיבורים שנוצרו לכל backend. עם ערך 0, לא תהיה הגבלה ב-backend. הלקוח יקבל שגיאת 503 אם אין קצה אחורי זמין.

אובייקטי replaceRequestHeader ו-replaceResponseHeader עבור שירותי חוות HTTP:

שדה סוּג תיאור
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב.
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף.
להחליף מחרוזת ערך להחלפת גפרורים.

אובייקט addRequestHeader ו-addResponseHeader עבור שירותי חוות HTTP:

שדה סוּג תיאור
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב.

אובייקט removeRequestHeader ו- removeResponseHeader עבור שירותי חוות HTTP:

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

אובייקט rewriteUrl עבור שירותי חוות HTTP:

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

אובייקט הפעלה עבור שירותי חוות HTTP:

שדה סוּג תיאור
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'IP' מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65;
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם הפגישה אינה מסוג סטטי.

צור שירות חדש

צור שירות חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services
zcli farm-service add FarmHTTP -id newserv

POST /farms/<farmname>/services

יצירת שירות בפרופיל HTTP נתון בחווה. החווה זקוקה לפעולת הפעלה מחדש כדי להחיל שינוי זה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
id מחרוזת שם השירות המשמש כמזהה ייחודי. רק ערכים אלפאנומריים מותרים. נכון

דוגמה לתגובה:

{
   "description" : "New service newserv",
   "params" : {
      "id" : "newserv"
   },
   "status" : "needed restart"
}

שינוי שירות

שינוי שירות

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL", "redirect_code":302,
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","sts_status":"true","sts_timeout":21600000,
"leastresp":"true","httpsb":"true","pinnedconnection":0,"routingpolicy":"ROUND_ROBIN"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/sev2
zcli farm-service set farmHTTP sev2 -vhost www.mywebserver.com -urlp ^/myapp1$ -persistence URL -redirect_code 302 -redirect http://zenloadbalancer.com -ttl 125 -sessionid sid -sts_status true -sts_timeout 21600000 -pinnedconnection 0 -routingpolicy ROUND_ROBIN

PUT /farms/<farmname>/services/<id>

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

פרמטרים של בקשה

שדה סוּג תיאור
ווסט מחרוזת מציין את התנאי שנקבע על ידי שם הדומיין באמצעות אותו IP וירטואלי ויציאה שהוגדרו על ידי חוות פרופילי HTTP. תמיכה בביטוי רגיל של PCRE.
Urlp מחרוזת מאפשר לקבוע שירות אינטרנט לגבי כתובת ה- URL שהלקוח מבקש באמצעות תבנית URL ספציפית אשר תיבדק באופן תחבירי. תמיכה בביטוי רגיל של PCRE.
הפניה מחרוזת זה עובד כמו backend מיוחד, בקשת הלקוח הוא ענה על ידי הפנייה מחדש כתובת אתר חדשה באופן אוטומטי.
קוד מספר זהו קוד ה- HTTP שחוזר בעת הגדרת תצורה להפניה מחדש. הערכים האפשריים הם 301, 302, 307,
redirecttype מחרוזת כיצד תבוצע הפנייה מחדש, שתי אפשרויות: ברירת מחדל, כתובת האתר נלקחת כמארח מוחלט ונתיב להפניה אליו, לצרף, נתיב הבקשה המקורי או URI יצורפו למארח ולנתיב שציינת הפניה שדה. התנהגות זו תחול רק אם הפניה אינו ערך ריק.
עוגיות מחרוזת זה מאפשר הכנסת עוגיות עבור backends מפגשים דביקים. האפשרויות הן נכון, הפרופיל יחפש את העוגיה הנתונה בשדה cookiename, אם זה לא קיים, העוגיה הזו תתווסף, שקר, קובץ Cookie ההכנסה מושבת.
cookiename מחרוזת שם קובץ ה- cookie (מזהה הפעלה) ישמש לזיהוי התהליך הדביק לתיקונים. הפעל עוגיות שדה נדרש.
cookiedomain מחרוזת הכנסת קובצי cookie תבוצע אם הדומיין תואם לתוכן העוגיה. לְאַפשֵׁר עוגיות שדה נדרש.
cookiepath מחרוזת הוא מנהל את ערך נתיב ה- cookie עבור ה- cookie הנתון, אם ה- URI בבקשת הלקוח או בתגובת ה- backend לא תואם עם נתיב cookie, אז לא מוחלת שיטת התמדה להכנסת קובצי cookie. לְאַפשֵׁר עוגיות שדה נדרש.
cookiettl מספר זה הזמן המקסימלי של החיים עבור עוגיה, בתוך שניות. הפעל עוגיות שדה נדרש.
התמדה מחרוזת פרמטר זה מגדיר כיצד שירות HTTP ינהל את הפעלת הלקוח. האפשרויות הן: "" מחרוזת ריקה, לא נעשה שום פעולה, IP את ההתמדה הפגישה נעשית בבסיס של IP הלקוח, בסיסי את ההתמדה מושב נעשה בבסיס BASIC כותרות, כתובת האתר הפגישה התמדה נעשית בבסיס שדה ב- URI, פארם מושב ההתמדה נעשה בבסיס ערך המופרד על ידי ";" בסוף ה- URI, עוגייה את ההתמדה הפגישה נעשית בבסיס של שם קובץ cookie, זה עוגיה יש ליצור על ידי backends, ו HEADER, את ההתמדה מושב נעשה בבסיס של שם הכותרת.
Ttl מספר רק בהתמדה. הזמן המרבי של החיים עבור הפעלת לקוח לא פעיל (גיל הפעלה מירבי) בשניות.
sessionid מחרוזת זה זמין אם התמדה שדה כתובת האתר, עוגייה or HEADER, ערך הפרמטר יחפש לפי הפרופיל בכותרת ה- HTTP וינהל את הפעלת הלקוח.
sts_status מחרוזת מצב הכותרת 'אבטחת התחבורה הקפדנית'. כדי להפעיל תכונה זו, יש צורך להגדיר את מאזין החווה כ- HTTPS. הערכים האפשריים הם: נכון כדי לאפשר הוראת STS בשירות; או שקר כדי להשבית את ההוראה STS בשירות.
sts_timeout מספר זמן (בשניות) שהלקוח זוכר שהשירות זמין רק עם HTTS.
leastresp מחרוזת זה מאפשר את שיטת איזון התגובה הכי פחות. נכון, לעתים קרובות הפרופיל בודק איזה backend לוקח פחות זמן להגיב כדי לשלוח יותר קשרים לזה, שקר, הפרופיל לא בודק איזה backend לוקח פחות זמן להגיב.
https מחרוזת זה מציין בפני החווה ששרתי backends מוגדרים לשימוש ב- HTTPS, ואז הנתונים יוצפנו לפני שיישלחו. נכון, פרופיל שולח את התנועה בפרוטוקול HTTPS כדי backends, שקר, פרופיל שולח את התנועה בפרוטוקול HTTP כדי backends.
חיבור מוצמד (מגרסה 4.0.2) מספר ציין אם ברצוננו להצמיד את כל החיבורים, (ברירת מחדל: 0, לא מוצמד). אם Pinnedconnection מוגדר ל-1, zproxy מעביר ישירות את כל הנתונים ללא ניתוח או עריכה.
מדיניות ניתוב (מגרסה 4.0.2) מחרוזת ציין את מדיניות הניתוב. כל האלגוריתמים משוקללים עם כל המשקולות המוגדרות בכל קצה אחורי. ישנן ארבע אפשרויות: רובין העגול השתמש באלגוריתם הרובין כמדיניות ניתוב (ברירת מחדל). LEAST_CONNECTIONS בחר את הקצה האחורי עם הכי פחות חיבורים שנוצרו תוך שימוש כפרופורציה של המשקולות שנקבעו. זמן תגובה בחר את הקצה האחורי עם זמן התגובה הנמוך ביותר תוך שימוש בפרופורציה של המשקולות שנקבעו. PENDING_CONNECTIONS בחר את הקצה האחורי עם החיבורים הממתינים לפחות תוך שימוש בפרופורציה של המשקולות שנקבעו.
כתוב מחדש (מגרסה 4.0.2) מחרוזת אם היא מופעלת, החווה נאלצת לשנות את מיקום המיקום ותוכן המיקום: כותרות בתגובות ללקוחות עם המארח הווירטואלי. האפשרויות הן: מופעל, הופעל נכה, מושבת או מאופשר- backends רק כתובת הקצה האחורית מושווה. אפשרויות נוספות זמינות: נתיב מופעל ו enabled-backends-path. הנתיב חל אם ההנחיה RewriteUrl שינתה את כתובת האתר של הבקשה. דגל זה מאלץ לבטל את השינוי בכתובת האתר ש-RewriteUrl ביצע.

דוגמה לתגובה:

{
   "description" : "Modify service newsrv in farm newHTTPfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "backends" : [],
      "cookiedomain" : "",
      "cookieinsert" : "false",
      "cookiename" : "",
      "cookiepath" : "",
      "cookiettl" : 0,
      "httpsb" : "true",
      "id" : "newsrv",
      "leastresp" : "true",
      "persistence" : "",
      "redirect" : "http://zenloadbalancer.com",
      "redirect_code" : 302,
      "redirecttype" : "default",
      "sessionid" : "sid",
      "sts_status" : "true",
      "sts_timeout" : 21600000,
      "ttl" : 125,
      "urlp" : "^/myapp1$",
      "vhost" : "www.mywebserver.com",
      "pinnedconnection" : 0,
      "routingpolicy" : "ROUND_ROBIN"
   },
   "status" : "needed restart"
}

פרמטרי תגובה

התגובה תהיה JSON עם עדכון הפרמטרים המבוקשים מצב שדה עם המצב הנוכחי של החווה. אם יש לנקוט בפעולה מחדש להפעלת שינויים בחווה, הערך יהיה יש צורך מחדש.

הוסף FarmGuardian

הוסף FarmGuardian

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/fg
zcli farm-service-farmguardian add FarmHTTP service1 -name check_tcp-cut_conns

POST /farms/<farmname>/services/<id>/fg

החל FarmGuardian לשירות.

הפרמטר URI הוא המזהה הייחודי לשירות.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור.

דוגמה לתגובה:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the service service1 in the farm FarmHTTP",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the service service1 in the farm FarmHTTP"
}

הסר FarmGuardian

הסר FarmGuardian

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove FarmHTTP service1 check_tcp-cut_conns

DELETE /farms/<farmname>/services/<id>/fg/<name>

הסר את FarmGuardian משירות בחווה.

דוגמה לתגובה:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the service service1 in the farm FarmHTTP",
   "message" : "Sucess, check_tcp-cut_conns was removed from the service service1 in the farm FarmHTTP"
}

העבר שירותים

העבר שירותים

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1/actions
zcli farm-service move FarmHTTP service1 -position 0

POST /farms/<farmname>/services/<id>/actions

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

id הוא המזהה הייחודי לשירות שישתנה.

פרמטרים בקשה

שדה סוּג תיאור דרוש
עמדה מספר מיקום איפה יהיה השירות. למיקום הראשון יש את האינדקס 0. נכון

דוגמה לתגובה:

{
   "description" : "Move service",
   "message" : "service1 was moved successful.",
   "params" : {
      "position" : 0
   }
}

מחיקת שירות

מחיקת שירות

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/services/service1
zcli farm-service remove FarmHTTP service1

DELETE /farms/<farmname>/services/<id>

מחק שירות נתון של פרופיל HTTP. id הוא המזהה הייחודי לשירות שיימחק.

דוגמה לתגובה:

{
  "description" : "Delete service service1 in farm FarmHTTP",
  "message" : "The service service1 in farm FarmHTTP has been deleted.",
  "success" : "true",
  "status": "needed restart"
}

הוסף כלל לשכתוב כותרות מתוך בקשה

הוסף כלל לשכתוב כותרות מתוך בקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/service/<servicename>/replacerequestheader

הוסף כללים כדי לשכתב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header"
}

שנה כלל שכתוב כותרות מ-Request

שנה כלל שכתוב כותרות מ-Request

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

שנה כלל של שכתוב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}
שנה כלל שכתוב כותרות מ-Request

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id
zcli farm-service-replacerequestheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/service/<servicename>/replacerequestheader/<id>

שנה כלל של שכתוב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Modify replaceHeader directive.",
   "message" : "Modified an item from the ReplaceHeader list",
   "success" : "true"
}

מחק כלל לשכתוב כותרות מהבקשה

מחק כלל לשכתוב כותרות מהבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/Index
zcli farm-service-replacerequestheader remove MyHttpFarm MyService Index

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replacerequestheader/<index>

מדד הוא האינדקס של מערך replacerequestheader שיש למחוק.

דוגמה לתגובה:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

הוסף כלל לשכתוב כותרות מהתגובה

הוסף כלל לשכתוב כותרות מהתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/service/<servicename>/replaceresponseheader

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Add a Replace Header.",
   "message" : "Added a new replace header",
   "success" : "true"
}

העבר כותרות שכתוב מכלל בקשה

העבר כותרות שכתוב מכלל בקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replacerequestheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/services/<service>/replacerequestheader/<id>/actions

העבר כותרת ReplaceRequest.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר עמדת כלל חדשה נכון

דוגמה לתגובה:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

שנה כלל שכתוב כותרות מ-Response

שנה כלל שכתוב כותרות מ-Response

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"^Cookie:", "match":"^COOKIESESSION=(.*)", "replace":"COOKIEUSER=$1`"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id
zcli farm-service-replaceresponseheader add farm1 -header "^Cookie:" -match "^COOKIESESSION=(.*)" -replace "COOKIEUSER=$1`"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/service/<servicename>/replaceresponseheader/<id>

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון
להתאים מחרוזת ערך רגקס שיתאים למה שאנו רוצים להחליף נכון
להחליף מחרוזת ערך להחליף גפרורים נכון

דוגמה לתגובה:

{
   "description" : "Modify a replaceHeader directive.",
   "message" : "Modified an item from the replaceHeader list",
   "success" : "true"
}

מחק כלל לשכתב כותרות מהתגובה

מחק כלל לשכתב כותרות מהתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/Index
zcli farm-service-replaceresponseheader remove MyHttpFarm MyService Index

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/service/<servicename>/replaceresponseheader/<index>

מדד הוא האינדקס של מערך replaceresponseheader שיש למחוק.

דוגמה לתגובה:

{
   "description" : "Delete a replace header directive.",
   "message" : "The replace header <index> was deleted successfully"
}

העבר כותרות שכתוב מכלל תגובה

העבר כותרות שכתוב מכלל תגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/replaceresponseheader/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/services/<service>/replaceresponseheader/<id>/actions

העבר כותרת ReplaceRequest.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר עמדת כלל חדשה נכון

דוגמה לתגובה:

{
   "description" : "Move a replace header directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

הוסף כלל כדי להוסיף כותרת לבקשה

הוסף כלל כדי להוסיף כותרת לבקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader
farm-service-addrequestheader add farm1 -header "header: value"

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/addrequestheader

הוסף כללים כדי לשכתב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון

דוגמה לתגובה:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

שנה הוסף כותרת לכלל הבקשה

שנה הוסף כותרת לכלל הבקשה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/id
farm-service-addrequestheader add farm1 -header "header: value"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/addrequestheader/<id>

הוסף כללים כדי לשכתב כותרות מהבקשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון

דוגמה לתגובה:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

מחק כלל כדי להוסיף כותרת לבקשה

מחק כלל כדי להוסיף כותרת לבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addrequestheader/Index
zcli farm-service-addrequestheader remove MyHttpFarm MyService Index

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

מדד הוא האינדקס של מערך replacerequestheader שיש למחוק.

דוגמה לתגובה:

{
   "message": "The add request header <index> has been deleted successfully"
}

הוסף כלל כדי להוסיף כותרת לתגובה

הוסף כלל כדי להוסיף כותרת לתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader
zcli farm-service-addresponseheader add farm1 -header "header: value"

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/addresponseheader

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון

דוגמה לתגובה:

{
   "description" : "Add a AddHeader.",
   "message" : "Added a new add request header",
   "success" : "true"
}

שנה הוסף כותרת לכלל התגובה

שנה הוסף כותרת לכלל התגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"header":"header: value"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/id
zcli farm-service-addresponseheader add farm1 -header "header: value"

שיחה זו זמינה מגרסה 4.0.2

PUT /farms/<farmname>/addresponseheader/<id>

הוסף כללים כדי לשכתב כותרות מהתגובה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כותרת מחרוזת Regex עם שם הכותרת שיש לשכתב נכון

דוגמה לתגובה:

{
   "description" : "Modify an addheader directive.",
   "message" : "Modified an item from the addheader list",
   "success" : "true"
}


מחק כלל כדי להוסיף כותרת לתגובה

מחק כלל כדי להוסיף כותרת לתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/addresponseheader/Index
zcli farm-service-addresponseheader remove MyHttpFarm MyService Index

שיחה זו זמינה מגרסה 4.0.2

DELETE /farms/<farmname>/addrequestheader/<index>

מדד הוא האינדקס של מערך replaceresponseheader שיש למחוק.

דוגמה לתגובה:

{
   "message": "The add response header 0 has been deleted successfully"
}

הוסף כלל להסרת כותרות מהבקשה

הוסף כלל להסרת כותרות מהבקשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removerequestheader

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "message": "Added a new remove request header"
}

שנה כלל להסרת כותרות מהבקשה

שנה כלל להסרת כותרות מהבקשה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/id
zcli farm-service-removerequestheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removerequestheader/<id>

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

מחק כלל להסרת כותרות מהבקשה

מחק כלל להסרת כותרות מהבקשה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removerequestheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removerequestheader/<index>

מדד הוא האינדקס של מערך removerequestheader שיש למחוק.

דוגמה לתגובה:

{
   "message": "The remove request header <index> has been deleted successfully"
}


הוסף כלל להסרת כותרות מהתגובה

הוסף כלל להסרת כותרות מהתגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

POST /farms/<farmname>/service/<servicename>/removeresponseheader

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "message": "Added a new remove response header"
}

שנה הסרת כותרות מכלל התגובה

שנה הסרת כותרות מכלל התגובה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"^client:"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/id
zcli farm-service-removeresponseheader add MyHttpFarm -pattern "^client:""

PUT /farms/<farmname>/service/<servicename>/removeresponseheader/<id>

הסר כותרות מסוימות מהבקשות הנכנסות. כל המופעים של הכותרת שצוינה יוסרו.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
דפוס מחרוזת זה מחרוזת עם regexp לחפש בקשות הלקוח. אם כותרת כלשהי תואמת בתבנית, הכותרת תוסר נכון

דוגמה לתגובה:

{
   "description" : "Modify RemoveResponseHeader directive.",
   "message" : "Modify an item from the removeresponseheader list",
   "success" : "true"
}

מחק כלל להסרת כותרות מהתגובה

מחק כלל להסרת כותרות מהתגובה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/removeresponseheader/Index
zcli farm-remove-request-header remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/removeresponseheader/<index>

מדד הוא האינדקס של מערך removeresponseheader למחיקה.

דוגמה לתגובה:

{
   "message": "The remove request header <index> has been deleted successfully"
}


הוסף כלל לבדיקות ושכתוב תבניות מ-URL

הוסף כלל לבדיקות ושכתוב תבניות מ-URL

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

POST /farms/<farmname>/service/<servicename>/rewriteurl

מגרסה 4.0.2. הוא בודק דפוס כדי לקבל מחרוזות מ-URL ולהחליף אותן.

פרמטרים של בקשה

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

דוגמה לתגובה:

{
   "message": "Added a new rewriteurl"
}

שנה את כלל הבדיקות ושכתוב תבניות מ-URL

שנה את כלל הבדיקות ושכתוב תבניות מ-URL

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"pattern":"/media/(.+)$","replace":"/svc1/$1","last":"true"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id
zcli farm-service-rewriteurl add MyHttpFarm MyService -pattern "/media/(.+)$" -replace "/svc1/$1" -last "true"

PUT /farms/<farmname>/service/<servicename>/rewriteurl/<id>

מגרסה 4.0.2. הוא בודק דפוס כדי לקבל מחרוזות מ-URL ולהחליף אותן.

פרמטרים של בקשה

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

דוגמה לתגובה:

{
   "description" : "Modify a RewriteUrl.",
   "message" : "Modify a new rewrite url",
   "success" : "true"
}

מחק כלל לבדיקה ושכתוב תבניות מ-URL

מחק כלל לבדיקה ושכתוב תבניות מ-URL

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/Index
zcli arm-service-rewriteurl remove MyHttpFarm Service Index

DELETE /farms/<farmname>/service/<service0>/rewriteurl/<index>

מגרסה 4.0.2. מדד הוא האינדקס של מערך ה-rewriteurl שיש למחוק.

דוגמה לתגובה:

{
   "message": "The rewriteurl <index> has been deleted successfully"
}


העבר צ'קים ושכתוב דפוסים מכלל כתובת האתר

העבר צ'קים ושכתוב דפוסים מכלל כתובת האתר

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"position":1}'
https://<zevenet_server>:444/zapi/v4.0/zapi/v4.0/zapi.cgi/farms/MyHttpFarm/services/MyService/rewriteurl/id/actions
farm-replace-response-header add farm1 -header ^Cookie: -match ^COOKIESESSION=(.*) -replace COOKIEUSER=$1`

שיחה זו זמינה מגרסה 4.0.2

POST /farms/<farmname>/services/<service>/rewriteurl/<id>/actions

העבר כותרת ReplaceRequest.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
עמדה מספר עמדת כלל חדשה נכון

דוגמה לתגובה:

{
   "description" : "Move a rewriteurl directive",
   "message" : "Header was moved successfully.",
   "params" : {
      "position" : "1"
   }
}

רשום את ההפעלות

רשום את ההפעלות

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session list farm1 service0

GET /farms/<farmname>/services/<servicename>/sessions

מגרסה 4.0.2. קבלו את רשימת המפגשים בחווה:שירות. נכס זמין רק עבור פרוקסי מהדור החדש zproxy.

דוגמה לתגובה:

{
   "description" : "Get farm sessions",
   "params": [
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": null,
         "type": "static"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "id": "0",
         "session": "10.0.0.2",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

פרמטרי תגובה

בקשה זו מחזירה רשימה של אובייקט הפעלה, כל אובייקט הפעלה מכיל את המפתחות הבאים:

שדה סוּג תיאור
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'IP' מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65;
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם הפגישה אינה מסוג סטטי.

הוסף מושב

הוסף מושב

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions
zcli farm-service-session add farm1 service0 -backend 0 -session 10.0.0.2

POST /farms/<farmname>/services/<servicename>/sessions

מגרסה 4.0.2. זה יוצר הפעלה סטטית עם קצה אחורי בהפעלה. חיבור הקלט המתאים ל- מושב יועבר תמיד לחלק האחורי הזה. נכס זמין רק עבור פרוקסי מהדור החדש zproxy.

פרמטרים של בקשה

שדה סוּג תיאור
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'IP', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65;

דוגמה לתגובה:

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "id" : "0",
      "session" : "10.0.0.1",
      "ttl" : null,
      "type" : "static"
   }
}

פרמטרי תגובה

בקשה זו מחזירה אובייקט הפעלה המכיל את המפתחות הבאים:

שדה סוּג תיאור
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'IP', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם ההפעלה היא מסוג סטטי.
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.

הסר מושב

הסר מושב

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/services/service0/sessions/10.0.0.1
zcli farm-service-session remove farm1 service0 10.0.0.1

DELETE /farms/<farmname>/services/<servicename>/sessions/<session>

זה מוחק מושב סטטי.

דוגמה לתגובה:

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

HTTP - שירותים - Backends

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/service1/backends
zcli farm get httpfarm

GET /farms/<farmname>/services/<id>/backends

קבל את רשימת backends בשירות. id הוא המזהה הייחודי לשירות.

דוגמה לתגובה:

{
   "description" : "List service backends",
   "params" : [
      {
         "alias" : null,
         "id" : 0,
         "ip" : "192.168.0.10",
         "port" : 88,
         "status" : "up",
         "timeout" : 12,
         "weight" : 1,
         "priority" : null,
         "connection_limit" : null
      },
      {
         "alias" : null,
         "id" : 1,
         "ip" : "192.168.102.245",
         "port" : 80,
         "status" : "up",
         "timeout" : 22,
         "weight" : 2,
         "priority" : null,
         "connection_limit": null
      }
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
עדיפות (מ 4.0.1) מספר (רק כאשר הדור החדש של פרוקסי עובד) זהו ערך העדיפות עבור השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוכה יותר יהיה מוכן לקבל חיבורים לפני יותר מאשר אחרים עם עדיפות גבוהה יותר. ערך ברירת המחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ 1 ל 9
connect_limit (מ 4.0.2) מספר (רק כאשר הדור החדש של פרוקסי עובד) המספר המרבי של חיבורים שנוצרו לכל backend. עם ערך 0, לא תהיה הגבלה ב-backend. הלקוח יקבל שגיאת 503 אם אין קצה אחורי זמין.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2,"priority":1,"connection_limit":10}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends
zcli farm-service-backend add httpfarm newsrv -ip 192.168.102.244 -port 80 -timeout 2 -priority 1 -weight 2 -connection_limit 10

POST /farms/<farmname>/services/<id>/backends

צור Backend חדש בפרופיל HTTP נתון. id הוא המזהה הייחודי לשירות.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין. נכון
נמל מספר הנמל של Backend שבו השירות מאזין. נכון
פסק זמן מספר זה הזמן הקצוב ביותר להגיב לבקשה מסוימת.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9.
עדיפות (מ 4.0.1) מספר (רק כאשר הדור החדש של פרוקסי עובד) זהו ערך העדיפות עבור השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוכה יותר יהיה מוכן לקבל חיבורים לפני יותר מאשר אחרים עם עדיפות גבוהה יותר. ערך ברירת המחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ 1 ל 9
connect_limit (מ 4.0.2) מספר (רק כאשר הדור החדש של פרוקסי עובד) המספר המרבי של חיבורים שנוצרו לכל backend. עם ערך 0, לא תהיה הגבלה ב-backend. הלקוח יקבל שגיאת 503 אם אין קצה אחורי זמין.

דוגמה לתגובה:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 0,
      "ip" : "192.168.102.244",
      "port" : 80,
      "timeout" : 2,
      "weight" : 2,
      "priority" : 1,
      "connection_limit" : 10
   },
   "status" : "needed restart"
}

פרמטרי תגובה

התגובה תהיה JSON עם עדכון הפרמטרים המבוקשים מצב שדה עם המצב הנוכחי של החווה. אם יש לנקוט בפעולה מחדש להפעלת שינויים בחווה, הערך יהיה יש צורך מחדש.אם יש

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.0.10","port":88,"timeout":12,"weight":1,"priority":1,"connection_limit":10}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
zcli farm-service-backend set FarmHTTP service1 1 -ip 192.168.0.10 -port 88 -timeout 12 -weight 1 -priority 1 -connection_limit 10

PUT /farms/<farmname>/services/<id>/backends/<id>

שנה את הפרמטרים של שירות HTTP backend.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין.
פסק זמן מספר זה פסק זמן backend להגיב על בקשה מסוימת, בתוך שניות.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. הערכים האפשריים הם מ 1 ל 9.
עדיפות (מ 4.0.1) מספר (רק כאשר הדור החדש של פרוקסי עובד) זהו ערך העדיפות עבור השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוכה יותר יהיה מוכן לקבל חיבורים לפני יותר מאשר אחרים עם עדיפות גבוהה יותר. ערך ברירת המחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ 1 ל 9
connect_limit (מ 4.0.2) מספר (רק כאשר הדור החדש של פרוקסי עובד) המספר המרבי של חיבורים שנוצרו לכל backend. עם ערך 0, לא תהיה הגבלה ב-backend. הלקוח יקבל שגיאת 503 אם אין קצה אחורי זמין.

דוגמה לתגובה:

{
   "description" : "Modify service backend",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.0.10",
      "port" : 88,
      "timeout" : 12,
      "weight" : 1,
      "priority" : 4,
      "connection_limit" : 10
   },
   "status" : "needed restart",
   "warning" : "Backends with high priority value (4) will not be used."
}

פרמטרי תגובה

התגובה תהיה JSON עם עדכון הפרמטרים המבוקשים מצב שדה עם המצב הנוכחי של החווה. אם יש לנקוט בפעולה מחדש להפעלת שינויים בחווה, הערך יהיה יש צורך מחדש. אם פרמטר Priority מתעדכן עם ערך לא עקבי, ה- אזהרה שדה יתאר את זה.

אחורה בתחזוקה

אחורה בתחזוקה

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
zcli farm-service-backend maintenance httpfarm newsrv 0 -mode cut

PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance

הגדר פעולה נתונה במערך אחורי של חוות HTTP, הפעולות הזמינות מתוארות להלן.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת הגדר את הפעולה הרצויה. הפעולות הן: up backend הוא מוכן לקבל בקשות הלקוח, תחזוקה backend אינו מוכן לקבל בקשות לקוח, פעולה זו שימושית לעצירת שרת backend ללא השפעה על הלקוחות.
מצב מחרוזת בחר מצב תחזוקה. האפשרויות הזמינות הן: לנקז, ה- backend אינו מקבל חיבורים חדשים, אך הוא ימשיך לטפל בחיבורים הנוכחיים; אוֹ לחתוך, הקשרים הנוכחיים ייסגרו. אם שדה זה לא צוין, מצב ברירת המחדל יהיה לנקז.

דוגמה לתגובה:

{
   "description" : "Set service backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
zcli farm-service-backend remove newfarmHTTP service1 4

DELETE /farms/<farmname>/services/<id>/backends/<id>

מחק backend נתון משירות HTTP.

ראשון id הוא מזהה השירות הייחודי, הבא id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete service backend",
   "message" : "Backend removed",
   "success" : "true"
}

L4xNAT חוות

חוות הפרופילים L4xNAT מאפשרת ליצור חוות איזון עומסים העובדות בשכבה 4 של מודל OSI, עם ביצועים גבוהים מאוד והרבה יותר חיבורים מקבילים מאשר ליבות איזון עומסים בשכבה 7 כמו פרופילי חוות HTTP. שיפור הביצועים של שכבה 4 נוגד את הטיפול המתקדם בתוכן שיכול פרופילי שכבה 7 לנהל.

בנוסף, חוות L4xNAT יכולות לאגד מגוון של יציאות, ולא רק יציאה וירטואלית אחת כפי שמשמשת עם פרופילי שכבה 7 האחרים. כדי להיות מסוגל לבחור מגוון יציאות וירטואליות או יציאה וירטואלית ספציפית בחוות L4xNAT, חובה לבחור סוג פרוטוקול. במקרה אחר, החווה תאזין לכל היציאות מה- IP הווירטואלי (מסומן בתו '*'). לאחר שנבחר פרוטוקול TCP או UDP, הוא יהיה זמין לציין יציאה, מספר יציאות בין ',', יציאות נעות בין ':' או לכל היציאות עם '*'. שילוב של כולם יהיה תקף גם כן.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm
zcli farm get l4farm

GET /farms/<farmname>

הצג את כל תצורת החווה.

תגובה BODY:

{
   "backends" : [
      {
         "alias" : null,
         "max_conns" : 0,
         "id" : 0,
         "ip" : "192.168.55.40",
         "port" : "88",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      },
      {
         "alias" : "server-1",
         "id" : 1,
         "max_conns" : 500,
         "ip" : "192.168.55.41",
         "port" : "88",
         "priority" : 3,
         "status" : "undefined",
         "weight" : 2
      }
   ],
   "description" : "List farm l4farm",
   "ipds" : {
      "blacklists" : [
            {
              "status" : "down",
              "name" : "blacklist"
            }
      ],
      "dos" : [
         {
             "name" : "newlimitconns",
             "status" : "down"
         }
      ],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "algorithm" : "weight",
      "farmguardian" : "check_tcp-cut_conns",
      "listener" : "l4xnat",
      "logs" : "false",
      "nattype" : "nat",
      "persistence" : "ip",
      "protocol" : "tcp",
      "status" : "down",
      "ttl" : 120,
      "vip" : "192.168.100.241",
      "vport" : "88",
      "sessions": []
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
ipod חפץ רשימת הכללים IPDS החלים על החווה הזו.
params חפץ פרמטרים של תצורה חקלאית.
backends אובייקט [] כל השרתים האמיתיים שנוצרו בחווה זו ואת התצורה שלה.

אובייקט IPDS:

שדה סוּג תיאור
רשימות שחורות אובייקט [] הכללים השחורים החלים על החווה.
דוס אובייקט [] הכללים DoS להחיל את החווה.
Rbl אובייקט [] הכללים RBL להחיל על החווה.

רשימה שחורה, DoS ו- RBL אובייקט:

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

אובייקט פרמטרים עבור חוות L4xNAT:

שדה סוּג תיאור
אַלגוֹרִיתְם מחרוזת סוג תזמון איזון עומסים המשמש להעברת התנועה בין הגב. האפשרויות הן: postier מעביר חיבור תמיד לשרת החיבור הכי פחות; מִשׁקָל שיגור ליניארי חיבור בהתאם למשקל האחורי; רובין העגול האם בחר ברצף בין מאגר ה- backend, כל backend יקבל מספר זהה של בקשות; hash_srcip מאזנת חבילות שתואמות את אותה IP IP לאותו backend; hash_srcip_srcport מאזנת חבילות שתואמות את אותה IP מקור ויציאה לאותו backend; סימשה חבילות איזון שתואמות לאותו מקור IP ולאותו יציאה ו- IP וליציאה של היעד, כך שהוא יכול לחבר חיבור בשני הכיוונים (במהלך נכנס ויוצא).
מאזין מחרוזת מאזין מגדיר כיצד החווה הולכת לשחק עם הבקשות מהלקוחות. שדה מידע, לא ניתן לשנותו.
יומני מחרוזת החנות יומני מידע מנות של שכבת התחבורה, זה לא זמין מידע שכבת היישום. אם לפרמטר זה יש את הערך נכון, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים.
nattype מחרוזת איך שכבת איזון שכבת 4 הליבה הולך לפעול. האפשרויות הן: נת המכונה גם מצב sNAT, ה- backend מגיב למאזן העומסים על מנת לשלוח את התגובה ללקוח; dnat ה- backend יגיב ישירות ללקוח, איזון העומס צריך להיות מוגדר כשער בשרת ה- backend; ב Dsr במצב (Direct Server Return) שהלקוח מתחבר ל- VIP, ואז איזון העומס משנה את כתובת ה- MAC היעד שלו עבור כתובת ה- MAC של backend (השרת חייב להיות באותו מדיה קישור כמו איזון העומס); DNAT חסר מדינה. ב חסר מדינה איזון העומס מחליף את כתובת היעד עבור כתובת ה- backend ומעביר אותה ל- backend כפי ש- DNAT עושה, אך היא אינה מנהלת כל סוג של מידע על חיבור.
התמדה מחרוזת פרמטר זה מעביר את הבקשה הנכנסת לאותו backend בבסיס על מצב ההתמדה שנבחר. האפשרויות הן: "" ערך ריק מבטל את ההתמדה, כל חבילה נכנסת תתאזן בין הגב. ip or srcip, IP המקור, יקצה את אותו backend לכל חיבור נכנס בהתאם לכתובת ה- IP המקורית בלבד; נָמָל, מקור יציאה, יקצה את אותו backend לכל חיבור נכנס בהתאם ליציאת המקור בלבד. srcmac, מקור MAC, עם אפשרות זו, החווה תקצה את אותו backend לכל חיבור נכנס בהתאם לכתובת ה- MAC של שכבת הקישור של החבילה; srcip_srcport, מקור IP ויציאת מקור, יקצו את אותו backend לכל חיבור נכנס בהתאם לשניהם, IP המקור ויציאת המקור; srcip_dstport, מקור ה- IP ויציאת היעד, יקצה את אותו backend לכל חיבור נכנס בהתאם לשניהם, IP המקור ויציאת היעד.
פרוטוקול מחרוזת פרוטוקול להיות מאוזן בשכבה 4. האפשרויות הן: את כל הפרופיל יטען איזון בכל פרוטוקול L4; TCP מאזן העומסים רק יאזן את פרוטוקול TCP L4, גם עבור TCP, ניתן להגדיר פעם אחת מהפרוטוקולים הבאים על מנת לנתח את הכותרות ולהשתמש בה להפצה נכונה: FTP, IRC, PPTP, או שָׁפוּי בְּדַעתוֹ; UDP מאזן העומסים בלבד יאזן את פרוטוקול UDP L4, גם עבור UDP, ניתן להגדיר פעם אחת מהפרוטוקולים הבאים על מנת לנתח את הכותרות ולהשתמש בה להפצה נכונה: לגימה, tftp, אמנדה, netbios-ns, או SNMP; sctpמאזן העומסים בלבד יאזן את פרוטוקול SCTP L4. אם h323 נבחר, החווה תקשיב ל TCP ו UDP מבקש ולנתח את הכותרות שלו כדי לאזן בין הגב.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
Ttl מספר ערך שדה זה מציין את מספר השניות שמוקצה ההתמדה בין מקור הלקוח לבין ה- backend בשניות. התמדה חייב להיות מוגדר.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל החווה, שם השירות הווירטואלי מאזין. ניתן לציין יציאה ייחודית, ניתן להגדיר יציאת טווח באמצעות מפריד : וניתן לציין מספר יציאות באמצעות מפריד ,.
חקלאי מחרוזת זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד.
הפעלות (מגרסה 4.0.2) אובייקט [] רשימה של הפעלות סטטיות ודינמיות שנוצרו עבור החווה הזו.

אובייקט Backend עבור חוות L4xNAT:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר תעודת זהות לזיהוי ה- backend בבריכת backends החווה.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מקשיב. מקבלים ערך ריק והוא ישתמש בתצורה זהה ליציאות הווירטואליות.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
עדיפות מספר זהו ערך העדיפות של השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוך יותר יהיה מוכן לקבל חיבורים לפני יותר מאחרים עם עדיפות גבוהה יותר. ערך ברירת מחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ- 1 ל 9.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9.
max_conns מספר זהו המספר המרבי של החיבור שה- backend יקבל בו זמנית. אם זה מוגדר עם 0 ערך ה- backend לא הגדיר שום מגבלה.

אובייקט הפעלה עבור חוות L4xNAT:

שדה סוּג תיאור
לקוחות מספר זהו מזהה לקוח.
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'מק', מושב צריך להיות MAC, למשל 02: 8e: 69: 38: 12: 8e; אם התמדה הוא 'ip' או 'srcip', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65; אם התמדה הוא 'נמל', מושב צריכה להיות יציאה תקפה, למשל 5445; אם התמדה הוא 'srcip_srcport' או 'srcip_dstport'; מושב צריך להיות מחרוזת עם IP ויציאה שמצטרפת תחת הגנה תחתונה '', למשל 122.36.54.280.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם ההפעלה היא מסוג סטטי.
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm create -farmname newl4farm -vip 192.168.100.241 -vport 88 -profile l4xnat

POST /farms

צור חוות L4xNAT חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה, מזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות L4xNAT הוא l4xnat, הודעת מידע, לא ניתן לשנות ערך זה נכון
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב. נכון
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב. L4xNAT חוות לאפשר multport מופרדים על ידי , או יציאה טווח מופרדים על ידי :. נכון
תעתיק מ (מ 4.0.1) מחרוזת פרמטר זה מצפה לשמה של חווה קיימת. אם פרמטר זה נשלח, החווה מועתקת מהחווה שצוינה בה. ה שם החווה, החברים ו גווניה ערכים יידרסו.

דוגמה לתגובה:

{
   "description" : "Creating farm 'newl4farm'",
   "params" : {
      "farmname" : "newl4farm",
      "interface" : "eth0",
      "profile" : "l4xnat",
      "vip" : "192.168.100.241",
      "vport" : "88"
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"algorithm":"weight","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81","logs":"true"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/newfarml4
zcli farm set newfarml4 -algorithm weight -newfarmname l4farm -protocol tcp -nattype nat -ttl 125 -vip 178.62.126.152 -vport 81 -logs true

PUT /farms/<farmname>

שנה את התצורה של חוות L4xNAT.

פרמטרים של בקשה

שדה סוּג תיאור
newfarmname מחרוזת שם החווה החדשה. יש לעצור את החווה.
יומני מחרוזת החנות יומני מידע מנות של שכבת התחבורה, זה לא זמין מידע שכבת היישום. אם לפרמטר זה יש את הערך נכון, היומנים מופעלים; אם יש לו את הערך שקר, יומנים מושבתים.
Ttl מספר ערך שדה זה מציין את מספר השניות שההקפדה בין מקור הלקוח לבין ה- backend מוקצית, תוך שניות. ההתמדה צריכה להיות מוגדרת.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל החווה, שם השירות הווירטואלי מאזין. ניתן לציין יציאה ייחודית, ניתן להגדיר יציאת טווח באמצעות מפריד : וניתן לציין מספר יציאות באמצעות מפריד ,.
התמדה מחרוזת פרמטר זה מעביר את הבקשה הנכנסת לאותו backend בבסיס על מצב ההתמדה שנבחר. האפשרויות הן: "" ערך ריק מבטל את ההתמדה, כל חבילה נכנסת תתאזן בין הגב. ip or srcip, IP המקור, יקצה את אותו backend לכל חיבור נכנס בהתאם לכתובת ה- IP המקורית בלבד; נָמָל, מקור יציאה, יקצה את אותו backend לכל חיבור נכנס בהתאם ליציאת המקור בלבד. srcmac, מקור MAC, עם אפשרות זו, החווה תקצה את אותו backend לכל חיבור נכנס בהתאם לכתובת ה- MAC של שכבת הקישור של החבילה; srcip_srcport, מקור IP ויציאת מקור, יקצו את אותו backend לכל חיבור נכנס בהתאם לשניהם, IP המקור ויציאת המקור; srcip_dstport, מקור ה- IP ויציאת היעד, יקצה את אותו backend לכל חיבור נכנס בהתאם לשניהם, IP המקור ויציאת היעד.
nattype מחרוזת איך שכבת איזון שכבת 4 הליבה הולך לפעול. האפשרויות הן: נת המכונה גם מצב sNAT, ה- backend מגיב למאזן העומסים על מנת לשלוח את התגובה ללקוח; dnat ה- backend יגיב ישירות ללקוח, איזון העומס צריך להיות מוגדר כשער בשרת ה- backend; ב Dsr במצב (Direct Server Return) שהלקוח מתחבר ל- VIP, ואז איזון העומס משנה את כתובת ה- MAC היעד שלו עבור כתובת ה- MAC של backend (השרת חייב להיות באותו מדיה קישור כמו איזון העומס); DNAT חסר מדינה. ב חסר מדינה איזון העומס מחליף את כתובת היעד עבור כתובת ה- backend ומעביר אותה ל- backend כפי ש- DNAT עושה, אך היא אינה מנהלת כל סוג של מידע על חיבור.
אַלגוֹרִיתְם מחרוזת סוג תזמון איזון עומסים המשמש להעברת התנועה בין הגב. האפשרויות הן: postier מעביר חיבור תמיד לשרת החיבור הכי פחות; מִשׁקָל שיגור ליניארי חיבור בהתאם למשקל האחורי; רובין העגול האם בחר ברצף בין מאגר ה- backend, כל backend יקבל מספר זהה של בקשות; hash_srcip מאזנת חבילות שתואמות את אותה IP IP לאותו backend; hash_srcip_srcport מאזנת חבילות שתואמות את אותה IP מקור ויציאה לאותו backend; סימשה חבילות איזון שתואמות לאותו מקור IP ולאותו יציאה ו- IP וליציאה של היעד, כך שהוא יכול לחבר חיבור בשני הכיוונים (במהלך נכנס ויוצא).
פרוטוקול מחרוזת פרוטוקול להיות מאוזן בשכבה 4. האפשרויות הן: את כל הפרופיל יטען איזון בכל פרוטוקול L4; TCP מאזן העומסים רק יאזן את פרוטוקול TCP L4, גם עבור TCP, ניתן להגדיר פעם אחת מהפרוטוקולים הבאים על מנת לנתח את הכותרות ולהשתמש בה להפצה נכונה: FTP, IRC, PPTP, או שָׁפוּי בְּדַעתוֹ; UDP מאזן העומסים בלבד יאזן את פרוטוקול UDP L4, גם עבור UDP, ניתן להגדיר פעם אחת מהפרוטוקולים הבאים על מנת לנתח את הכותרות ולהשתמש בה להפצה נכונה: לגימה, tftp, אמנדה, netbios-ns, או SNMP; sctpמאזן העומסים בלבד יאזן את פרוטוקול SCTP L4. אם h323 נבחר, החווה תקשיב ל TCP ו UDP מבקש ולנתח את הכותרות שלו כדי לאזן בין הגב.

דוגמה לתגובה:

{
   "description" : "Modify farm l4farm",
   "params" : {
      "algorithm" : "weight",
      "logs" : "true",
      "nattype" : "nat",
      "newfarmname" : "l4farm",
      "persistence" : "",
      "protocol" : "tcp",
      "ttl" : 125,
      "vip" : "178.62.126.152",
      "vport" : "81"
   }
}

פרמטרים של תגובה

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

הוסף FarmGuardian

הוסף FarmGuardian

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg
zcli farm-service-farmguardian add l4Farm default_service -name check_tcp-cut_conns

POST /farms/<farmname>/fg

החל FarmGuardian לחווה.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור.

דוגמה לתגובה:

{
   "description" : "Add the farm guardian check_tcp-cut_conns to the farm fgl4",
   "message" : "Success, The farm guardian check_tcp-cut_conns was added to the farm fgl4"
}

הסר FarmGuardian

הסר FarmGuardian

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/fg/check_tcp-cut_conns
zcli farm-service-farmguardian remove l4Farm default_service check_tcp-cut_conns

DELETE /farms/<farmname>/fg/<name>

הסר את FarmGuardian מן החווה.

דוגמה לתגובה:

{
   "description" : "Remove the farm guardian check_tcp-cut_conns from the farm fgl4",
   "message" : "Sucess, check_tcp-cut_conns was removed from the farm fgl4"
}

להוסיף POST /farms/<farmname>/sessions

להוסיף DELETE /farms/<farmname>/sessions/<session>

רשום את ההפעלות

רשום את ההפעלות

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session list farm1

GET /farms/<farmname>/sessions

קבלו את רשימת ההפעלות בחווה.

דוגמה לתגובה:

{
   "description" : "Get farm sessions",
   "params": [
      {
         "client": 0,
         "id": "0",
         "session": "10.0.0.2_56",
         "ttl": null,
         "type": "static"
      },
      {
         "client": 1,
         "id": "0",
         "session": "10.0.0.2_54936",
         "ttl": "58m28s148ms",
         "type": "dynamic"
      },
      {
         "client": 2,
         "id": "0",
         "session": "10.0.0.2_54968",
         "ttl": "59m56s496ms",
         "type": "dynamic"
      }
   ]
}

פרמטרי תגובה

בקשה זו מחזירה רשימה של אובייקטי הפעלות, כל אובייקט הפעלה מכיל את המפתחות הבאים:

שדה סוּג תיאור
לקוחות מספר זהו מזהה לקוח.
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'מק', מושב צריך להיות MAC, למשל 02: 8e: 69: 38: 12: 8e; אם התמדה הוא 'ip' או 'srcip', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65; אם התמדה הוא 'נמל', מושב צריכה להיות יציאה תקפה, למשל 5445; אם התמדה הוא 'srcip_srcport' או 'srcip_dstport'; מושב צריך להיות מחרוזת עם IP ויציאה שמצטרפת תחת הגנה תחתונה '', למשל 122.36.54.280.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם ההפעלה היא מסוג סטטי.
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.

הוסף מושב

הוסף מושב

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"session":"10.0.0.2_56","id":0}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions
zcli farm-session add farm1 -id 0 -session 10.0.0.2_56

POST /farms/<farmname>/sessions

זה יוצר מושב סטטי עם backend. חיבור הקלט התואם את ה- מושב יועבר תמיד לאותו backend.

פרמטרים של בקשה

שדה סוּג תיאור
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'מק', מושב צריך להיות MAC, למשל 02: 8e: 69: 38: 12: 8e; אם התמדה הוא 'ip' או 'srcip', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65; אם התמדה הוא 'נמל', מושב צריכה להיות יציאה תקפה, למשל 5445; אם התמדה הוא 'srcip_srcport' או 'srcip_dstport'; מושב צריך להיות מחרוזת עם IP ויציאה שמצטרפת תחת הגנה תחתונה '', למשל 122.36.54.280.

דוגמה לתגובה:

{
   "description" : "Adding a static session to the farm1",
   "message" : "Added a session for the farm 'farm1'",
   "params" : {
      "client" : 1,
      "id" : "0",
      "session" : "10.0.0.1_56",
      "ttl" : null,
      "type" : "static"
   }
}

פרמטרי תגובה

בקשה זו מחזירה אובייקט הפעלה המכיל את המפתחות הבאים:

שדה סוּג תיאור
לקוחות מספר זהו מזהה לקוח.
id מספר מזהה backend שיקבל את החיבור.
מושב מחרוזת זהו מזהה ההפעלה או חיבור, ערכו תלוי ב- התמדה פרמטר של החווה. אם התמדה הוא 'מק', מושב צריך להיות MAC, למשל 02: 8e: 69: 38: 12: 8e; אם התמדה הוא 'ip' או 'srcip', מושב צריך להיות IPv4 או IPv6, למשל 192.168.42.65; אם התמדה הוא 'נמל', מושב צריכה להיות יציאה תקפה, למשל 5445; אם התמדה הוא 'srcip_srcport' או 'srcip_dstport'; מושב צריך להיות מחרוזת עם IP ויציאה שמצטרפת תחת הגנה תחתונה '', למשל 122.36.54.280.
Ttl מחרוזת זהו מחרוזת שתוקף זמן ההפעלה יפוג. ה Ttl ערך יהיה ריק אם ההפעלה היא מסוג סטטי.
סוג מחרוזת ישנם שני סוגים של הפעלות: דינמי הוא חיבור שמצמיד איזון עומסים עם backend באמצעות אלגוריתם איזון עומסים בחווה; סטטי הוא חיבור שמנהל איזון העומס מצמיד עם backend. ההפעלות הסטטיות לא יופנו אל backend אחר אם הגיבוי שלו אינו נגיש.

הסר מושב

הסר מושב

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/farm1/sessions/10.0.0.1_56
zcli farm-session remove farm1 10.0.0.1_56

DELETE /farms/<farmname>/sessions/<session>

זה מוחק מושב סטטי.

דוגמה לתגובה:

{
   "description" : "Delete a 'static' session",
   "message" : "The session '10.0.0.1_56' was deleted properly from the farm 'farm1'.",
   "success" : "true"
}

הוסף כלל IPDS

הוסף כלל IPDS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists
zcli farm-blacklist add l4Farm -name china

POST /farms/<farmname>/ipds/<dos|blacklists|rbl>

החל רשימות שחורות, כללי DoS או RBL בחווה.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת שם כלל ה- IPDS המשמש כמזהה ייחודי.

דוגמה לתגובה:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm l4Farm.",
   "success" : "true"
}

הסר כלל IPDS

הסר כלל IPDS

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4Farm/ipds/blacklists/china
zcli farm-blacklist remove l4Farm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>

הסר רשימה שחורה, DoS או RBL של מודול IPDS מחווה נתונה באמצעות המחוון שלה שם.

דוגמה לתגובה:

{
   "description" : "Delete a rule from a farm",
   "message" : "Blacklist rule china was removed successful from the farm l4Farm.",
   "success" : "true"
}

L4xNAT - Backends

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm get l4farm

GET /farms/<farmname>/backends

קבל את רשימת backends בשירות.

דוגמה לתגובה:

{
   "description" : "List backends",
   "params" : [
      {
         "alias" : null,
         "id" : 0,
         "ip" : "192.5.1.1",
         "max_conns" : 400,
         "port" : 787,
         "priority" : 1,
         "status" : "up",
         "weight" : 1
      },
      {
         "alias" : "server-2",
         "id" : 1,
         "ip" : "192.5.1.3",
         "max_conns" : 200,
         "port" : 787,
         "priority" : 2,
         "status" : "up",
         "weight" : 1
      },
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר תעודת זהות לזיהוי ה- backend בבריכת backends החווה.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מקשיב. מקבלים ערך ריק והוא ישתמש בתצורה זהה ליציאות הווירטואליות.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.
max_conns מספר זהו המספר המרבי של חיבורים מקבילים עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות של השרת האמיתי הנוכחי. חיבורים תמיד לעדיפות הגבוהה ביותר שיש 1 בה עדיפות הגבוהה ביותר ו- 9 בעדיפות הנמוכה ביותר.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends
zcli farm-service-backend add l4farm default_service -ip 192.168.5.100 -port 8080 -max_conns 400

POST /farms/<farmname>/backends

צור Backend חדש בחווה L4xNAT.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין. נכון
נמל מספר הנמל של Backend שבו השירות מקשיב. מקבלים ערך ריק והוא ישתמש בתצורה זהה ליציאות הווירטואליות.
max_conns מספר זהו המספר המרבי של חיבורים מקבילים עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות של השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוך יותר יהיה מוכן לקבל חיבורים לפני יותר מאחרים עם עדיפות גבוהה יותר. ערך ברירת מחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ- 1 ל 9.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9.

דוגמה לתגובה:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 5,
      "ip" : "192.168.5.100",
      "port" : 8080,
      "max_conns" : 400,
      "priority" : null,
      "weight" : null
   }
}

פרמטרים של תגובה

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

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.5.40","port":8080,"max_conns":220,"priority":4,"weight":7}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/2
zcli farm-service-backend set l4farm default_service 2 -ip 192.168.5.40 -port 8080 -max_conns 220 -priority 4 -weight 7

PUT /farms/<farmname>/backends/<id>

שנה את הפרמטרים של backend בחווה L4xNAT. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מקשיב. מקבלים ערך ריק והוא ישתמש בתצורה זהה ליציאות הווירטואליות.
max_conns מספר זהו המספר המרבי של חיבורים מקבילים עבור ה- backend. אם לשדה זה יש את הערך 0, ה- backend לא הגדיר מגבלת חיבור כלשהי.
עדיפות מספר זהו ערך העדיפות של השרת האמיתי הנוכחי. Backend עם ערך עדיפות נמוך יותר יהיה מוכן לקבל חיבורים לפני יותר מאחרים עם עדיפות גבוהה יותר. ערך ברירת מחדל null, ערך עדיפות 1 משמש. הערכים האפשריים הם מ- 1 ל 9.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. גיבויים עם משקל רב יותר יקבלו יותר חיבורים. הערכים האפשריים הם מ 1 ל 9.

דוגמה לתגובה:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.5.40",
      "port" : 8080,
      "max_conns" : 220,
      "priority" : 4,
      "weight" : 7
   }
}

פרמטרים של תגובה

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

אחורה בתחזוקה

אחורה בתחזוקה

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"action":"maintenance","mode":"cut"}'
 https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/1/maintenance
zcli farm-service-backend maintenance l4farm default_service 1 -mode cut

PUT /farms/<farmname>/backends/<id>/maintenance

הגדר פעולה נתונה במערך אחורי של חוות L4xNAT. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
פעולה מחרוזת הגדר את הפעולה הרצויה. הפעולות הן: up backend הוא מוכן לקבל בקשות הלקוח, תחזוקה backend אינו מוכן לקבל בקשות לקוח, פעולה זו שימושית לעצירת שרת backend ללא השפעה על הלקוחות.
מצב מחרוזת בחר מצב תחזוקה. האפשרויות הזמינות הן: לנקז, ה- backend אינו מקבל חיבורים חדשים, אך הוא ימשיך לטפל בחיבורים הנוכחיים; אוֹ לחתוך, הקשרים הנוכחיים ייסגרו.

דוגמה לתגובה:

{
   "description" : "Set backend status",
   "params" : {
      "action" : "maintenance",
      "mode" : "cut"
   }
}

פרמטרים של תגובה

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

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/l4farm/backends/4
zcli farm-service-backend remove l4farm default_service 4

DELETE /farms/<farmname>/backends/<id>

מחק backend נתון עבור חוות L4xNAT.

id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete backend",
   "message" : "Backend removed",
   "success" : "true"
}

חוות GSLB

האיזון העומסי לשירותים גלובלי, המכונה בדרך כלל GSLB, מאפשר ליצור שירות לאיזון עומסים המבוסס על הארכיטקטורה ההיררכית של שירות ה- DNS. חווה מסוג זה מספקת DNS סמכותי בלבד עם אלגוריתמי איזון עומסים וזיהוי מצב שירות בשכבת יישום ה- DNS.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm
zcli farm get gslbfarm

GET /farms/<farmname>

הצג את כל תצורת החווה.

דוגמה לתגובה:

{
   "description" : "List farm gslbfarm",
   "ipds" : {
      "blacklists" : [],
      "dos" : [],
      "rbl" : [
         {
            "name" : "protection_ssh",
            "status" : "up"
         }
      ]
   },
   "params" : {
      "status" : "needed restart",
      "vip" : "192.168.100.155",
      "vport" : 60
   },
   "services" : [
      {
         "algorithm" : "roundrobin",
         "backends" : [
            {
               "alias" : "localhost",
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 53,
               "status" : "up"
            },
            {
               "alias" : "dns-server",
               "id" : 2,
               "ip" : "192.168.55.40",
               "port" : 53,
               "status" : "up"
            },
            {
               "alias" : null,
               "id" : 4,
               "ip" : "192.135.10.2",
               "port" : 53,
               "status" : "up"
            }
         ],
         "deftcpport" : 53,
         "farmguardian" : "dns-request",
         "id" : "service1"
      },
      {
         "algorithm" : "prio",
         "backends" : [
            {
               "alias" : "localhost",
               "id" : 1,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            },
            {
               "alias" : "localhost",
               "id" : 2,
               "ip" : "127.0.0.1",
               "port" : 80,
               "status" : "up"
            }
         ],
         "deftcpport" : 80,
         "farmguardian" : null,
         "id" : "prioServ"
      }
   ],
   "zones" : [
      {
         "defnamesv" : "ns3",
         "id" : "global.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns3",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns3",
               "ttl" : null,
               "type" : "A"
            },
            {
               "id" : 3,
               "rdata" : "resource2",
               "rname" : "ns2",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 4,
               "rdata" : "192.168.200.30",
               "rname" : "resource2",
               "ttl" : null,
               "type" : "A"
            }
         ]
      },
      {
         "defnamesv" : "ns1",
         "id" : "DOM.com",
         "resources" : [
            {
               "id" : 0,
               "rdata" : "ns1",
               "rname" : "@",
               "ttl" : null,
               "type" : "NS"
            },
            {
               "id" : 1,
               "rdata" : "192.168.100.155",
               "rname" : "ns1",
               "ttl" : null,
               "type" : "A"
            }
         ]
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
ipod חפץ רשימת הכללים IPDS החלים על החווה הזו.
params חפץ פרמטרים של תצורה חקלאית.
שירותים אובייקט [] מערך עם כל השירותים שנוצרו בחווה זו ואת התצורה שלה.
אזורי אובייקט [] מערך עם כל האזורים שנוצרו בחווה זו ואת התצורה שלה.

אובייקט IPDS:

שדה סוּג תיאור
רשימות שחורות אובייקט [] רשימות שחורות פנו לחווה.
דוס אובייקט [] הכללים DoS להחיל את החווה.
Rbl אובייקט [] הכללים RBL להחיל על החווה.

רשימה שחורה, DoS ו- RBL אובייקט:

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

אובייקט פרמטר עבור חוות GSLB:

שדה סוּג תיאור
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא מעלה את כל backends הם בלתי מושגת; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.

אובייקט שירות עבור חוות GSLB:

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
חקלאי מחרוזת זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד. יומני חקלאי אינם זמינים עבור חוות GSLB
id מחרוזת שם השירות המשמש כמזהה ייחודי.
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, שיאזן בין הקשרים בין כל הגיבויים העליונים, או פריו אשר ישלח את כל החיבורים אל ה- backend הזמין הראשון.
deftcpport מספר בדיקת תקינות ברירת מחדל של יציאת TCP. זהו יציאת ה- TCP לבדיקת הבריאות שהשירות עומד לבדוק כדי לקבוע ששירות ה- backend חי. ערך ריק מושבת.

אובייקט Backend עבור חוות GSLB:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת.
ip מחרוזת ה- IP של Backend שבו השירות האמיתי מאזין.
נמל מספר הנמל של Backend שבו השירות מאזין.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.

אובייקט Zone:

שדה סוּג תיאור
id מספר שם האזור משמש כמגדיר ייחודי.
defnamesv מחרוזת זה יהיה שרת השמות של נקודת הכניסה שיהיה זמין כרשומת DNS של רשות ההתחלה (SOA).
משאבים אובייקט [] מידע נוסף המוגדר באזור.

אובייקט משאב:

שדה סוּג תיאור
id מספר מזהה ייחודי עבור המשאב באזור.
rname מחרוזת שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata.
Ttl מספר הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון.
סוג מחרוזת סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף.
rdata מחרוזת זה הנתונים האמיתיים הדרושים לפי סוג הרשומה, ערך הקלט תלוי בסוג שם המשאב, rname ואת סוג המשאב, סוג.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"gslbfarm","profile":"gslb","vip":"192.168.100.241","vport":53}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm create -farmname gslbfarm -vip 192.168.100.241 -vport 53 -profile gslb

POST /farms

צור חוות GSLB חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה משמש כמזהה הייחודי לחוות. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. עבור חוות GSLB הוא גסלב. נכון
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב. נכון
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב. נכון
תעתיק מ (מ 4.0.1) מחרוזת פרמטר זה מצפה לשמה של חווה קיימת. אם פרמטר זה נשלח, החווה מועתקת מהחווה שצוינה בה. ה שם החווה, החברים ו גווניה ערכים יידרסו.

דוגמה לתגובה:

{
   "description" : "Creating farm 'gslbfarm'",
   "params" : {
      "farmname" : "gslbfarm",
      "interface" : "eth0",
      "profile" : "gslb",
      "vip" : "192.168.100.241",
      "vport" : 53
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"gslbnewname","vip":"192.168.100.155","vport":60}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm
zcli farm set gslbfarm -newfarmname gslbnewname -vip 192.168.100.155 -vport 60

PUT /farms/<farmname>

שינוי התצורה של חוות GSLB.

פרמטרים של בקשה

שדה סוּג תיאור
newfarmname מחרוזת שם החווה החדשה. יש לעצור את החווה בכדי לבצע את השינוי הזה.
גווניה מספר נמל של החווה, שבו השירות וירטואלי מקשיב.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.

דוגמה לתגובה:

{
   "description" : "Modify farm gslbnewname",
   "params" : {
      "newfarmname" : "gslbnewname",
      "vip" : "192.168.100.155",
      "vport" : 60
   }
}

פרמטרים של תגובה

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

הוסף כלל IPDS

הוסף כלל IPDS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists
zcli farm farm-blacklist add gslbFarm -name china

POST /farms/<farmname>/ipds/<dos|blacklists|rbl>

החלת רשימה שחורה, DoS או RBL הכלל לחווה.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת שם כלל ה- IPDS המשמש כמזהה ייחודי.

דוגמה לתגובה:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm gslbFarm.",
   "success" : "true"
}

הסר כלל IPDS

הסר כלל IPDS

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbFarm/ipds/blacklists/china
zcli farm-blacklist remove gslbFarm china

DELETE /farms/<farmname>/ipds/<dos|blacklists|rbl>/<name>

הסר כלל רשימה שחורה, DoS או RBL מחווה נתונה באמצעות המזהה שלה שם.

דוגמה לתגובה:

{
   "description" : "Delete a rule form a farm",
   "message" : "Blacklist rule china was removed successful from the farm gslbFarm.",
   "success" : "true"
}

GSLB - שירותים

שירות GSLB מייצג קבוצה של שרתים אמיתיים ואלגוריתם משויך שישמש עבורם. כדי ליצור שירות חדש, עליך להגדיר שם זיהוי תקף ואת האלגוריתם הרצוי לשימוש.

השירותים הזמינים הם:

סבב רובין: שיתוף שווה. מאזן תנועה שווה לכל השרתים האמיתיים הפעילים. לכל חיבור נכנס, האיזון מקצה את השרת האמיתי הבא של רובין כדי לספק את הבקשה.

עדיפות: חיבורים תמיד לעדיפות הגבוהה ביותר שיש. מאזנים את כל החיבורים לאותו שרת בעדיפות הגבוהה ביותר. אם שרת זה מושבת, החיבורים עוברים לשרת הבא הגבוה ביותר. בעזרת אלגוריתם זה תוכלו לבנות שירות אשכול פעיל-פסיבי עם מספר שרתים אמיתיים.

שירותים אובייקטים עבור חוות GSLB

שדה סוּג תיאור
backends אובייקט [] Backends שהוגדרו בשירות.
חקלאי מחרוזת זהו שם FarmGuardian כי הוא בודק את מצב backend. FarmGuardian יהיה פועל בעוד החווה נמצאת במעמד.
id מחרוזת שם השירות המשמש כמזהה הייחודי.
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, שיאזן בין הקשרים בין כל הגיבויים העליונים, או פריו אשר ישלח את כל החיבורים אל ה- backend הזמין הראשון.
deftcpport מחרוזת בדיקת תקינות ברירת מחדל של יציאת TCP. זהו יציאת ה- TCP לבדיקת הבריאות שהשירות עומד לבדוק כדי לקבוע ששירות ה- backend חי. ערך ריק מושבת.

צור שירות חדש

צור שירות חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"service1","algorithm":"roundrobin"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services
zcli farm-service add gslbfarm -id service1 -algorithm roundrobin

POST /farms/<farmname>/services

יצירת שירות בחוות GSLB נתון. יש להפעיל מחדש את החווה כדי להחיל את השינוי.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
id מחרוזת שם השירות המשמש כמזהה הייחודי. נכון
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש את השירות. האפשרויות הן: רובין העגול, אשר יתאזן חיבורים amoung כל backends, או פריו אשר ישלח את כל החיבורים אל ה- backend הזמין הראשון. נכון

דוגמה לתגובה:

{
   "description" : "New service service1",
   "params" : {
      "algorithm" : "roundrobin",
      "id" : "service1"
   },
   "status" : "needed restart"
}

פרמטרים של תגובה

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

שינוי שירות

שינוי שירות

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
 -d '{"deftcpport":53}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service set  gslbfarm service1 -deftcpport 53

PUT /farms/<farmname>/services/<id>

שנה את הפרמטרים של שירות GSLB. id הוא המזהה הייחודי לשירות שישתנה.

פרמטרים של בקשה

שדה סוּג תיאור
deftcpport מספר זהו יציאת ה- TCP לבדיקת הבריאות שהשירות עומד לבדוק כדי לקבוע ששירות ה- backend חי.

דוגמה לתגובה:

{
   "description" : "Modify service service1 in farm gslbfarm",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "params" : {
      "deftcpport" : 53
   },
   "status" : "needed restart"
}

פרמטרים של תגובה

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

הוסף FarmGuardian

הוסף FarmGuardian

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"dns-request"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg
zcli farm-service-farmguardian add gslbfarm service1 -name dns-request

POST /farms/<farmname>/services/<id>/fg

החל FarmGuardian לשירות.

הפרמטר URI הוא המזהה הייחודי לשירות.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת מזהה ייחודי של FarmGuardian. FarmGuardians נוצרים ושונה בסעיף ניטור. יומני FarmGuardian אינם זמינים עבור חוות gslb.

דוגמה לתגובה:

{
   "description" : "Add the farm guardian dns-request to the service service1 in the farm gslbfarm",
   "message" : "Success, The farm guardian dns-request was added to the service service1 in the farm gslbfarm"
}

הסר FarmGuardian

הסר FarmGuardian

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/service/service1/fg/dns-request
zcli farm-service-farmguardian remove gslbfarm service1 dns-request

DELETE /farms/<farmname>/fg/<name>

הסר את FarmGuardian משירות GSLB.

דוגמה לתגובה:

{
   "description" : "Remove the farm guardian dns-request from the service service1 in the farm gslbfarm",
   "message" : "Sucess, dns-request was removed from the service service1 in the farm gslbfarm"
}

מחיקת שירות

מחיקת שירות

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1
zcli farm-service remove gslbfarm service1

DELETE /farms/<farmname>/services/<id>

מחק שירות מסוים של חוות GSLB. id הוא המזהה הייחודי לשירות שיימחק.

דוגמה לתגובה:

{
  "description" : "Delete service service1 in farm gslbfarm",
  "message" : "The service service1 in farm gslbfarm has been deleted.",
  "success" : "true",
  "status": "needed restart"
}

GSLB - שירותים - Backends

סעיף זה ינהל את רשימת השירותים האמיתית המשויכת לשירות.

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm get gslbfarm

GET /farms/<farmname>/services/<id>/backends

קבל את רשימת backends בשירות. id הוא המזהה הייחודי לשירות.

דוגמה לתגובה:

{
   "description" : "List service backends",
   "params" : [
      {
         "alias" : "localhost",
         "id" : 1,
         "ip" : "127.0.0.1",
         "port":53,
         "status":"up"
      },
      {
         "alias" : "dns-server",
         "id" : 2,
         "ip" : "192.168.55.40",
         "port":53,
         "status":"up"
      }
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה ייחודי עבור backend בשירות. מזהה זה נוצר על ידי המערכת.
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
נמל מספר הנמל של Backend שבו השירות מאזין.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.135.10.2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends
zcli farm-service-backend add gslbfarm service1 -ip 192.135.10.2

POST /farms/<farmname>/services/<id>/backends

צור Backend חדש בשירות נתון בחוות GSLB. id הוא מזהה השירות הייחודי שבו יתווסף backend.

שירותי העדיפות יש 2 backends כמו maxun, המארח הפעיל המארח פסיבי.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב. נכון

דוגמה לתגובה:

{
   "description" : "New service backend",
   "message" : "Added backend to service succesfully",
   "params" : {
      "id" : 4,
      "ip" : "192.135.10.2"
   },
   "status" : "needed restart"
}

פרמטרים של תגובה

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

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.2.30"}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/1
zcli farm-service-backend set gslbfarm service1 1 -ip 192.168.2.30

PUT /farms/<farmname>/services/<id>/backends/<id>

שנה את הפרמטרים של backend לשירות GSLB.

הערה ב PUT מעל זה הראשון id הוא מזהה השירות הייחודי הבא id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.

דוגמה לתגובה:

{
   "description" : "Modify service backend",
   "info" : "There're changes that need to be applied, stop and start farm to apply them!",
   "message" : "Backend modified",
   "params" : {
      "ip" : "192.168.2.30"
   },
   "status" : "needed restart"
}

פרמטרים של תגובה

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

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/services/service1/backends/3
zcli farm-service-backend remove gslbfarm service1 3

DELETE /farms/<farmname>/services/<servicename>/backends/<id>

מחק backend נתון בשירות GSLB.

דוגמה לתגובה:

{
   "description" : "Delete service backend",
   "message" : "Backend removed",
   "success" : "true"
}

GSLB - אזורים

החלק של אזור ה- GSLB יתאר את שם תחום ה- DNS, תת-הדומיינים, כינויים וכו ', שיידרש ליצירת אזור DNS שלם עם רשומות איזון עומס נוספות באמצעות השירותים המוגדרים.

צור אזור

צור אזור

דוגמה לבקשה:

curl  -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"global.com"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones
zcli farm-zone add gslbfarm -id global.com

POST /farms/<farmname>/zones

צור אזור DNS.

פרמטרים בקשה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור דרוש
id מספר שם האזור המשמש כמייחד הייחודי. נכון

דוגמה לתגובה:

{
   "description" : "New zone global.com",
   "params" : {
      "id" : "global.com"
   }
}

פרמטרים של תגובה

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

שינוי אזור

שינוי אזור

דוגמה לבקשה:

curl  -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"defnamesv":"ns3"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com
zcli farm-zone set gslbfarm global.com -defnamesv ns3

PUT /farms/<farmname>/zones/<id>

שינוי הפרמטרים של אזור. id הוא המזהה הייחודי לאזור אשר ישונה.

פרמטרים בקשה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
defnamesv מחרוזת זה יהיה שרת השמות של נקודת הכניסה שיהיה זמין כרשומת DNS של רשות ההתחלה (SOA).

דוגמה לתגובה:

{
   "description" : "Modify zone global.com in farm gslbfarm",
   "params" : {
      "defnamesv" : "ns3"
   }
}

פרמטרים של תגובה

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

מחיקת אזור

מחיקת אזור

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/dom.com
zcli farm-zone remove gslbfarm dom.com

DELETE /farms/<farmname>/zones/<id>

מחק אזור נתון של חוות GSLB.

דוגמה לתגובה:

{
   "description" : "Delete zone dom.com in farm gslbfarm.",
   "message" : "The zone dom.com in farm gslbfarm has been deleted.",
   "success" : "true"
}

GSLB - אזורי - משאבים

משאבים המוגדרים כשירות ה- DNS פותר בקשות. משאבי ה- DNS האפשריים במאזן העומס של Zevenet הם:

  1. NS. שם הרשומה סוג שרת, הוא נציג אזור DNS כדי להשתמש בשרתי שם נתון סמכותי.
  2. A. כתובת סוג רשומה, הוא מחזיר כתובת IPv4 של המארח.
  3. CNAME. שם הקלטת שם קנוני, הוא מייצג כינוי של שם נתון.
  4. DYNA. רשומה מסוג כתובת דינמית, היא מחזירה כתובת דינמית שצוין על ידי שירות GSLB שכבר נוצר בתוך תצורת החווה בהתאם לאלגוריתם שנבחר עבור שירות כזה.
  5. אאאא. כתובת סוג רשומה, הוא מחזיר כתובת IPv6 של המארח.
  6. MX. סוג החלפת דואר דואר, מפות שם תחום לרשימה של סוכני העברת הודעות עבור תחום זה.
  7. SRV. רשומת סוג לאיתור שירות, רשומת מיקום שירות כללית, המשמשת לפרוטוקולים חדשים יותר במקום ליצור רשומות ספציפיות לפרוטוקול כגון MX.
  8. TXT. להקליד סוג טקסט, הוא משמש לאחסון כל מידע מבוסס טקסט שניתן לתפוס בעת הצורך. בדרך כלל אנו רואים רשומות TXT המשמשות לאחזקת נתוני SPF ולאמת בעלות על תחום.
  9. PTR. רשומת מצביע, מצביע לשם קנוני. שלא כמו CNAME, עיבוד ה- DNS מפסיק ורק השם מוחזר. השימוש הנפוץ ביותר הוא ליישום חיפושי DNS הפוכים.
  10. NAPTR. מתן שמות של רשם רשות, מאפשר כתיבה מחדש המבוססת על ביטוי רגולרי של שמות דומיינים, אשר לאחר מכן ניתן להשתמש בהם כ- URI, שמות דומיין נוספים לחיפושים וכו '.

רשום את המשאבים

רשום את המשאבים

דוגמה לבקשה:

curl  -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource list gslbfarm global.com

GET /farms/<farmname>/zones/<id>/resources

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

דוגמה לתגובה:

{
   "description" : "List zone resources",
   "params" : [
      {
         "id" : 0,
         "rdata" : "ns3",
         "rname" : "@",
         "ttl" : null,
         "type" : "NS"
      },
      {
         "id" : 1,
         "rdata" : "192.168.100.155",
         "rname" : "ns3",
         "ttl" : null,
         "type" : "A"
      },
      {
         "id" : 2,
         "rdata" : "192.168.0.9",
         "rname" : "resource2",
         "ttl" : 10,
         "type" : "A"
      },
      {
         "id" : 3,
         "rdata" : "resource2",
         "rname" : "ns2",
         "ttl" : null,
         "type" : "NS"
      }
   ]
}

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט משאבים עם הפרמטרים השוררים.

שדה סוּג תיאור
id מספר מזהה ייחודי עבור המשאב באזור.
rname מחרוזת שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata.
Ttl מספר הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון.
סוג מחרוזת סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף.
rdata מחרוזת זה הנתונים האמיתיים הדרושים לפי סוג הרשומה, ערך הקלט תלוי בסוג שם המשאב, rname ואת סוג המשאב, סוג.

צור משאב חדש

צור משאב חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"rname":"resource2", "rdata":"192.168.0.9", "ttl":10, "type":"A" }'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources
zcli farm-zone-resource add gslbfarm global.com -rname resource2 -rdata 192.168.0.9 -ttl 10 -type A

POST /farms/<farmname>/zones/<id>/resources

צור משאב חדש באזור נתון בחוות GSLB. id הוא המזהה הייחודי לאזור אשר ישתנה במקום בו יתווסף המשאב.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
rname מחרוזת שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata. נכון
Ttl מספר ערך הזמן לחיות עבור הרשומה הנוכחית. זהו המספר המרבי של התקני הנתב שהבקשה יכולה לעבור עד למותם. זה שימושי הוא שהחבילה לא נקלטת בלולאה נטו.
סוג מחרוזת סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף. נכון
rdata מחרוזת זה הנתונים האמיתיים הדרושים לפי סוג הרשומה, ערך הקלט תלוי בסוג שם המשאב, rname ואת סוג המשאב, סוג. אם DYNA נבחר ב סוג אז הערך rdata צריך להיות אחד מוגדר שירותים באזור זה. נכון

דוגמה לתגובה:

{
   "description" : "New zone resource",
   "message" : "Resource added",
   "params" : {
      "rdata" : "192.168.0.9",
      "rname" : "resource2",
      "ttl" : 10,
      "type" : "A",
      "zone" : "global.com"
   }
}

פרמטרים של תגובה

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

שנה משאב

שנה משאב

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"rname":"resource2", "rdata":"192.168.200.30","ttl":null, "type":"A" }'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/1
zcli farm-zone-resource set gslbfarm global.com 1 -rname resource2 -rdata 192.168.200.30 -type A

PUT /farms/<farmname>/zones/<id>/resources/<id>

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

ראשון id הוא מזהה אזור ייחודי, הבא id הוא מזהה ייחודי של משאב.

פרמטרים של בקשה

שדה סוּג תיאור
rname מחרוזת שם המשאב הוא הכינוי ששירות ה- DNS יתרגם לנתונים האמיתיים הנדרשים בשדה rdata.
Ttl מספר הערך 'זמן לחיות' (אופציונלי) עבור הרשומה הנוכחית שבה היא נדרשת כדי לקבוע את משך הזמן שבו השם הנוכחי יישמר במטמון.
סוג מחרוזת סוג רשומה DNS. האפשרויות הן: NS, A, אאאא, CNAME, DYNA, MX, SRV, TXT, PTR or NAPTR). לקבלת מידע נוסף, עיין ב- GSLB - אזורי - משאבים סָעִיף.
rdata מחרוזת זה הנתונים האמיתיים הדרושים לפי סוג הרשומה, ערך הקלט תלוי בסוג שם המשאב, rname ואת סוג המשאב, סוג. אם סוג טעון עם ערך DYNA אז rdata צריך לטעון עם זמין שרות שם

דוגמה לתגובה:

{
   "description" : "Modify zone resource",
   "message" : "Resource modified",
   "params" : {
      "rdata" : "192.168.200.30",
      "rname" : "resource2",
      "ttl" : null,
      "type" : "A"
   },
   "success" : "true"
}

פרמטרים של תגובה

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

מחק משאב

מחק משאב

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/gslbfarm/zones/global.com/resources/3
zcli farm-zone-resource remove gslbfarm global.com 3

DELETE /farms/<farmname>/zones/<id>/resources/<id>

מחק resouce נתון באזור של חוות GSLB

שים לב כי ב DELETE URI מעל הראשון id הוא מזהה אזור ייחודי הבא id הוא מזהה ייחודי של משאב.

דוגמה לתגובה:

{
   "description" : "Delete zone resource",
   "message" : "Resource removed",
   "success" : "true"
}

Datalink חוות

פרופיל חוות datalink או DSLB (Datalink Service Load Balancing) מאפשר ליצור חווה מבוססת מסלולים שבה הקצה האחורי הוא נתב או שער שערים. סוג זה של פרופיל חווה מוכן לשיתוף מספר גישות נתב WAN uplink באמצעות איזון העומס כמולטיפלטור ערוץ uplink (קלט אחד וכמה יציאות קו נתב). לכן, חוות קישורי הנתונים יכולה לשמש כקישורי תקשורת זמינים גבוהים ובנוסף לשמש כגידול רוחב הפס המצטרף לכמות רוחב הפס בין קישורי גב הנתבים.

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

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

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm get dlink

GET /farms/<farmname>

הצג את כל תצורת החווה.

דוגמה לתגובה:

{
   "backends" : [
      {
         "alias" : "main-gateway",
         "id" : 0,
         "interface" : "eth0",
         "ip" : "192.168.100.10",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 2
      },
      {
         "alias" : "secondary-gateway",
         "id" : 1,
         "interface" : "eth0",
         "ip" : "192.168.100.11",
         "priority" : 2,
         "status" : "undefined",
         "weight" : 1
      }
   ],
   "description" : "List farm dlink",
   "ipds" : {
      "blacklists" : []
   },
   "params" : {
      "algorithm" : "weight",
      "status" : "down",
      "vip" : "192.168.100.199"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפורמט שלהלן.

אובייקט משק חקלאי:

שדה סוּג תיאור
ipod חפץ רשימת הכללים IPDS החלים על החווה הזו.
params חפץ פרמטרים של תצורה חקלאית.
backends אובייקט [] שרתים אמיתיים שנוצרו בחווה זו ובתצורה שלה.

אובייקט IPDS:

שדה סוּג תיאור
רשימות שחורות מחרוזת [] רשימות שחורות פנו לחווה.

אובייקט פרמטרים עבור חוות datalink:

שדה סוּג תיאור
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: מִשׁקָל, האיזון מפיץ בין כל התומכים הזמינים בהינתן יותר גבינות טעינה עם מאפיין משקל גבוה יותר או פריו, אשר שולח את כל החיבורים אל backend עם ערך קטין של עדיפות.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא מעלה את כל backends הם בלתי מושגת; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.

אובייקט backend עבור חוות datalink:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה ייחודי לחלק האחורי של החווה.
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הוא ישמש כאשר אַלגוֹרִיתְם שדה מוגדר כעדיפות ולעדיפות נמוכה יותר תהיה עדיפות
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.
מִשׁקָל מספר זהו ערך המשקל עבור השרת האמיתי הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה מוגדר כמשקל.

יצירת חוות חדשה

יצירת חוות חדשה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms
zcli farm create -profile datalink -farmname dlink -vip 192.168.100.241

POST /farms

צור חוות datalink חדשה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם החווה מחרוזת שם החווה, מזהה ייחודי. נכון
פרופיל מחרוזת הפרופיל של החווה שנוצרה. ליצירת חווה מסוג קישור נתונים, המפתח הוא DataLink נכון
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב. נכון
תעתיק מ (מ 4.0.1) מחרוזת פרמטר זה מצפה לשמה של חווה קיימת. אם פרמטר זה נשלח, החווה מועתקת מהחווה שצוינה בה. ה שם החווה ו החברים ערכים יידרסו.

דוגמה לתגובה:

{
   "description" : "Creating farm 'dlink'",
   "params" : {
      "farmname" : "dlink",
      "interface" : "eth0",
      "profile" : "datalink",
      "vip" : "192.168.100.241"
   }
}

פרמטרים של תגובה

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

שינוי משק חקלאי

שינוי משק חקלאי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink
zcli farm set dlink -newfarmname dlink2 -vip 192.168.100.199 -algorithm weight

PUT /farms/<farmname>

שינוי התצורה של חוות datalink.

פרמטרים של בקשה

שדה סוּג תיאור
newfarmname מחרוזת שם החווה החדש. יש לעצור את החווה כדי לשנות שדה זה.
אַלגוֹרִיתְם מחרוזת סוג של אלגוריתם איזון עומס המשמש בחווה. האפשרויות הן: מִשׁקָל, האיזון מפיץ בין כל התומכים הזמינים בהינתן יותר גבינות טעינה עם מאפיין משקל גבוה יותר או פריו, אשר שולח את כל החיבורים אל backend עם ערך קטין של עדיפות.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.

דוגמה לתגובה:

{
   "description" : "Modify farm dlink",
   "params" : {
      "algorithm" : "weight",
      "vip" : "192.168.100.199",
      "newfarmname" : "dlink2"
   }
}

פרמטרים של תגובה

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

הוסף כלל IPDS

הוסף כלל IPDS

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"china"}' https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists
zcli farm-blacklist add dlink2 -name china

POST /farms/<farmname>/ipds/<blacklists>

החלת כלל רשימה שחורה על החווה. פרופיל datalink מקבל רק כללים של רשימה שחורה.

פרמטרים של בקשה

שדה סוּג תיאור
שם מחרוזת שם כלל ה- IPDS המשמש כמזהה ייחודי.

דוגמה לתגובה:

{
   "description" : "Apply a rule to a farm",
   "message" : "Blacklist rule china was applied successful to the farm dlink2.",
   "success" : "true"
}

הסר כלל IPDS

הסר כלל IPDS

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink2/ipds/blacklists/china
zcli farm-blacklist remove dlink -name china

DELETE /farms/<farmname>/ipds/<blacklists>/<name>

הסר כלל ברשימה השחורה של מודול ה- IPDS מחווה נתונה באמצעות המחוון שלה שם.

דוגמה לתגובה:

{
   "description" : "Delete a rule from a farm",
   "message" : "Blacklist rule china was removed successful from the farm dlink2.",
   "success" : "true"
}

Datalink - Backends

אחורי גב בחוות קישורי נתונים הם השערים באמצעות ניתוב השירות. השירות יכפל בין שערים אלה וחלקם אינם זמינים, השירות משתמש בשני האחרים.

רשימת backends

רשימת backends

דוגמה לבקשה:

curl  -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm get dlink

GET /farms/<farmname>/backends

קבל את רשימת backends בשירות.

דוגמה לתגובה:

[
   {
      "alias" : "main-gateway",
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 2
   },
   {
      "alias" : "secondary-gateway",
      "id" : 7,
      "interface" : "eth0",
      "ip" : "192.168.100.11",
      "priority" : 2,
      "status" : "undefined",
      "weight" : 1
   }
]

פרמטרי תגובה

שיחה זו מחזירה מערך אובייקט backend עם הפרמטרים השוררים.

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את backend. כינוי
id מספר מזהה ייחודי עבור backend בחווה. מזהה זה נוצר על ידי המערכת.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
עדיפות מספר זהו ערך העדיפות עבור ה- backend הנוכחי. הוא ישמש כאשר אַלגוֹרִיתְם שדה מוגדר כעדיפות ולעדיפות נמוכה יותר תהיה עדיפות.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה מוגדר כמשקל.

צור Backend חדש

צור Backend חדש

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends
zcli farm-service-backend add dlink default_service -ip 192.168.100.10 -interface eth0 -priority 2 -weight 2

POST /farms/<farmname>/backends

יצירת backend חדש בחוות datalink נתון.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב. נכון
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר. נכון
עדיפות מספר זהו ערך העדיפות עבור השרת האמיתי הנוכחי. הוא ישמש כאשר אַלגוֹרִיתְם שדה מוגדר כעדיפות ולעדיפות נמוכה יותר תהיה עדיפות. ערך ברירת המחדל הוא 1.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי. זה ישמש מתי אַלגוֹרִיתְם שדה מוגדר כמשקל. ערך ברירת המחדל הוא 1.

דוגמה לתגובה:

{
   "description" : "New farm backend",
   "message" : "Backend added",
   "params" : {
      "id" : 6,
      "interface" : "eth0",
      "ip" : "192.168.100.10",
      "priority" : 2,
      "weight" : 2
   }
}

פרמטרים של תגובה

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

שינוי Backend

שינוי Backend

דוגמה לבקשה:

 curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
  -d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"priority":1}'
  https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/datalink/backends/2
zcli farm-service-backend set datalink default_service 2 -ip 192.168.102.50 -interface eth0 -weight 1 -priority 1

PUT /farms/<farmname>/backends/<id>

שינוי הפרמטרים של backend בשירות של חוות datalink. id הוא מזהה ייחודי backend.

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של backend, שבו השירות האמיתי הוא מקשיב.
ממשק מחרוזת זהו ממשק הרשת המקומית שבו backend מחובר.
עדיפות מספר זוהי העדיפות של backend להגיב לבקשה מסוימת.
מִשׁקָל מספר זה ערך המשקל עבור ה- backend הנוכחי.

דוגמה לתגובה:

{
   "description" : "Modify backend",
   "message" : "Backend modified",
   "params" : {
      "interface" : "eth0",
      "ip" : "192.168.102.50",
      "priority" : 1,
      "weight" : 1
   }
}

פרמטרים של תגובה

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

מחק backend

מחק backend

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/farms/dlink/backends/4
zcli farm-service-backend remove dlink default_service 4

DELETE /farms/<farmname>/backends/<id>

מחק backend נתון מחוות קישורי נתונים. id הוא מזהה ייחודי backend.

דוגמה לתגובה:

{
   "description" : "Delete backend",
   "message" : "Backend removed",
   "success" : "true"
}

רשת

Zevenet יכול לעבוד עם סוגים שונים של ממשקי רשת.

בחלק זה תוכלו לרשום, ליצור, להגדיר, למחוק ולהגדיר פעולה בממשקי NIC, VLAN, וירטואליים ומליטה.

nic: או כרטיס ממשק רשת, זהו רכיב חומרת מחשב. שאר הממשקים מבוססים על רשתות רשת.

vlan: או כרטיס LAN וירטואלי הוא מעין ממשק רשת המספק שירותי פילוח רשת. ניתן ליצור יותר מ- VLAN אחד באמצעות ממשק nic.

קשר: נקרא גם על ידי ספקים אחרים כממשקי תא מטען, ניתן ליצור סוג זה עם יותר מממשק nic אחד. Zevenet תומך בשבעה סוגים שונים של ממשקי מליטה.

וירטואלי: ניתן ליצור ממשק מסוג זה בכל סוג של ממשק שתואר לעיל והם משתמשים בטבלאות הניתוב של ממשק האם שלו, כך שהוא צריך להיות מוגדר באותו פלח רשת מאשר האב שלו. יש להשתמש בממשק מסוג זה עבור חוות.

רשימת כל הממשקים

רשימת כל הממשקים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network list

GET /interfaces

קבל רשימה של ממשקים במערכת עם התצורה שלהם.

דוגמה לתגובה:

{
   "description" : "List interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "bond2",
         "netmask" : "",
         "status" : "down",
         "dhcp" : "false",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "bondiface",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "bond"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "status" : "down",
         "dhcp" : "false",
         "type" : "vlan"
      },
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "type" : "virtual"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "false"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "name" : "eth2",
         "netmask" : "",
         "status" : "up",
         "dhcp" : "false",
         "type" : "nic",
         "is_slave" : "true"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "status" : "up",
         "type" : "nic",
         "dhcp" : "false",
         "is_slave" : "true"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק.

אובייקט ממשק:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שממשק האב שלו בממשק וירטואלי.
has_vlan מחרוזת נכון, הממשק שהוא ההורה של ממשק VLAN; אוֹ שקר, הממשק לא קיבל שום ממשק VLAN המלווה אותו. שדה זה מיועד רק עבור ממשקי NIC.
מסכת רשת מחרוזת מסכת רשת של הממשק. לא ניתן היה לשנות ערך זה בממשקים וירטואליים, הוא עובר בירושה ממשק האב.
שער כניסה מחרוזת שער הממשק. לא ניתן היה לשנות ערך זה בממשקים וירטואליים, הוא עובר בירושה ממשק האב.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מעבד ה- NIC הראשון בממשקי מליטה. בממשקים וירטואליים ו- VLAN הוא עובר בירושה ממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק לא יכול לקבל מנות.
סוג מחרוזת הממשקים השונים הם: nic, vlan, וירטואלי or קשר.
is_slave מחרוזת זמין רק בממשקי NIC, נכון, הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

אחזר שער ברירת מחדל

אחזר שער ברירת מחדל

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 get

GET /interfaces/gateway/<ip_version>

שער ברירת המחדל הוא הצומת שבה נשלח כל תעבורת היעד שאינה ניתנת להשגה מקומית מכל ממשק בממשק העומס.

קבל את הפרמטרים של ממשק שער ברירת המחדל.

המערכת הגדירה שני שערים, פעם לנתב IPv4 ואחד לנתב IPv6. ה- URI מצפה לגרסת IP ipv4 or ipv6.

דוגמה לתגובה:

{
   "description" : "Default gateway",
   "params" : {
      "address" : "192.168.100.5",
      "interface" : "eth0"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כתובת מחרוזת זהו ה- IP של השער.
ממשק מחרוזת שם הממשק עבור השער.

שנה את שער ברירת המחדל

שינוי שער ברירת המחדל

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth0","address":"192.168.100.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 set -interface eth0 -address 192.168.100.5

PUT /interfaces/gateway/<ip_version>

שינוי התצורה של ממשק השער.

URI מצפה לגרסת ה- IP המשמשת בשדה הכתובת. הערכים האפשריים הם ipv4 ו ipv6.

דוגמה לתגובה:

{
   "description" : "Modify default gateway",
   "message" : "The default gateway has been changed successfully",
   "success" : "true"
}

פרמטרים של בקשה

שדה סוּג תיאור
כתובת מחרוזת זהו ה- IP של השער.
ממשק מחרוזת שם הממשק עבור השער.

מחק את תצורת השער

DELETE /interfaces/gateway/<ip_version>

מחק את התצורה של תצורת ברירת המחדל של שער השער.

ה- URI מצפה לגירסת IP אחת של שער ברירת המחדל למחיקה. הערכים האפשריים הם ipv4 ו ipv6.

אזהרה: אם השער לא מוגדר, לא ניתן יהיה להגיע ל Zevenet מגזרת רשת חיצונית.

מחק את תצורת השער

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/gateway/ipv4
zcli network-default-gateway-ipv4 delete

הודעת תגובה

אם השער לא מוגדר מאותו פלח רשת, הודעה זו תופיע, אחרת החיבור יאבד.

דוגמה לתגובה:

{
   "description" : "Remove default gateway",
   "message" : "The default gateway has been deleted successfully",
   "params" : {
      "address" : null,
      "interface" : null
   }
}

רשת - ממשקי NIC

ממשקי NIC הם הממשקים הפיזיים המחוברים לאיזון העומס שלך ב- Zevenet.

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

באמצעות ממשקי NIC כהורים ניתן ליצור סוגים אחרים של ממשקים בעלי מאפיינים שונים. ממשקים זמינים הם VLAN, וירטואלי ו קשר.

רשימת ממשקי NIC

GET /interfaces/nic

קבל את כל הפרמטרים של ממשקי NIC.

רשימת ממשקי NIC

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic
zcli network-nic list

דוגמה לתגובה:

{
   "description" : "List NIC interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "has_vlan" : "true",
         "ip" : "192.168.100.241",
         "is_slave" : "false",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : "gestion",
         "gateway" : "192.168.100.5",
         "has_vlan" : "false",
         "ip" : "192.168.100.102",
         "is_slave" : "false",
         "mac" : "62:30:43:36:29:ac",
         "name" : "eth1",
         "netmask" : "255.255.255.0",
         "dhcp" : "false",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "",
         "has_vlan" : "false",
         "ip" : "",
         "is_slave" : "false",
         "mac" : "a2:6d:80:29:87:c6",
         "name" : "eth3",
         "netmask" : "",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך של אובייקטי ממשק NIC.

אובייקט ממשק NIC:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק.
has_vlan מחרוזת נכון, הממשק שהוא ההורה של ממשק VLAN; אוֹ שקר, הממשק לא קיבל שום ממשק VLAN המלווה אותו.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות לפלח רשת אחר.
מק מחרוזת מזהה ייחודי של שכבת קישור. זה לא ניתן לשינוי.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק לא יכול לקבל מנות.
is_slave מחרוזת נכון הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

אחזור ממשק NIC

אחזור ממשק NIC

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic get eth1

GET /interfaces/nic/<name>

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

דוגמה לתגובה:

{
   "description" : "Show NIC interface",
   "interface" : {
      "alias" : "gestion",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "62:30:43:36:29:ac",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "dhcp" : "false",
      "status" : "up"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות לפלח רשת אחר.
מק מחרוזת מזהה ייחודי של שכבת קישור. זה לא ניתן לשינוי.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק לא יכול לקבל מנות.
סוג מחרוזת סוג הממשקים השונה הוא: nic, vlan, וירטואלי or קשר. כל אחד מהם מוגדר בתפריט המשנה שלו ברשת.
is_slave מחרוזת נכון הממשק הוא חלק ממשק מליטה, שקר הממשק אינו חלק ממשק מליטה.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

שינוי ממשק NIC

שינוי ממשק NIC

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.102","netmask":"255.255.255.0","gateway":"192.168.100.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1
zcli network-nic set eth0 -ip 192.168.100.102 -netmask 255.255.255.0 -gateway 192.168.100.5

PUT /interfaces/nic/<name>

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

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
כּוֹחַ מחרוזת אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נכון, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

דוגמה לתגובה:

{
   "description" : "Configure NIC interface",
   "params" : {
      "alias" : null,
      "dhcp" : "false",
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.102",
      "is_slave" : "false",
      "mac" : "4a:4f:3c:d7:dd:70",
      "name" : "eth1",
      "netmask" : "255.255.255.0",
      "status" : "down"
}

פרמטרים של תגובה

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

מחיקת תצורת NIC

מחיקת תצורת NIC

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth3
zcli network-nic unset eth3

DELETE /interfaces/nic/<name>

מחק את התצורה עבור ממשק NIC. לאחר פעולה זו, הממשק יהיה חסר תועלת, ומוכן להיות מוגדר שוב. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete nic interface",
   "message" : "The configuration for the network interface eth3 has been deleted.",
   "success" : "true"
}

הגדר פעולה ממשק NIC

הגדר פעולה ממשק NIC

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/nic/eth1/actions
zcli network-nic stop eth1

POST /interfaces/nic/<name>/actions

החל פעולה על ממשק NIC. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on nic interface",
   "params" : {
      "action" : "up"
   }
}

פרמטרים של תגובה

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

רשת - ממשקי VLAN

ממשק VLAN מאפשר לממשק NIC או מליטה לעבוד ברשת אחרת, כך שתצורת הרשת (IP, שער כניסה, ו מסכת רשת) צריך להיות בגזרת רשת אחרת. ממשק VLAN יורש את כתובת ה- MAC מממשק האם.

השדה ממשקי VLAN שם יופיע עם תו נקודה. "" שישמש ליצירת תג מזהה עבור ממשק VLAN.

רשימת ממשקי VLAN

רשימת ממשקי VLAN

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan list 

GET /interfaces/vlan

קבל את כל הפרמטרים של ממשקי VLAN.

דוגמה לתגובה:

{
   "description" : "List VLAN interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "192.168.120.1",
         "ip" : "192.168.120.120",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0.1",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "dhcp" : "false",
         "status" : "down"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק VLAN.

הפרמטרים של VLAN הם:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק. זה יכול להיות שונה מממשק ה- IP של האב.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת המעוצבת על ידי שם ממשק אב, תו נקודה "." ומספר עבור ממשק רשת VLAN או תג VLAN.
הורה מחרוזת זהו ממשק המשמש ליצירת זה.
מצב מחרוזת הערכים יכולים להיות up הממשק יכול לקבל מנות, מטה הממשק אינו יכול לקבל מנות.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

לאחזר ממשק VLAN

לאחזר ממשק VLAN

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan get eth0.1

GET /interfaces/vlan/<name>

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

דוגמה לתגובה:

{
   "description" : "Show VLAN interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0.1",
      "netmask" : "255.255.255.0",
      "dhcp" : "false",
      "status" : "up"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת MAC של הממשק. ערך זה עובר בירושה מממשק האב.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת המעוצבת על ידי שם ממשק אב, תו נקודה "." ומספר לממשק רשת VLAN.
מצב מחרוזת הערכים יכולים להיות up הממשק יכול לקבל מנות, מטה הממשק אינו יכול לקבל מנות.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

צור ממשק VLAN

צור ממשק VLAN

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1","name":"eth0.1","mac":"52:98:19:6a:c9:18","dhcp":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan
zcli network-vlan create -name eth0.1 -ip 192.168.120.120 -netmask 255.255.255.0 -gateway 192.168.120.1 -mac 52:98:19:61:c9:18 -dhcp false

POST /interfaces/vlan

יצירת ממשק VLAN מ NIC או ממשק מליטה. ממשק VLAN החדש יחלק MAC, אם כי הפרמטרים הבאים של הרשת חייבים להיות שונים: ip, והפעולות הבאות עשויות להשתנות: שער כניסה, מסכת רשת.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של הממשק. זה חייב להיות שונה מ- IP ממשק האב. נכון
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק. נכון
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר. נכון
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת המעוצבת על ידי שם ממשק אב, תו נקודה "." ומספר לממשק רשת VLAN. נכון
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.
מק מחרוזת משכתב את ה- MAC של הממשק.

דוגמה לתגובה:

{
   "description" : "Add a vlan interface",
   "params" : {
      "gateway" : "192.168.120.1",
      "ip" : "192.168.120.120",
      "mac" : "52:98:19:6a:c9:18",
      "name" : "eth0.1",
      "dhcp" : "false",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

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

שינוי ממשק VLAN

שינוי ממשק VLAN

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1","mac":"96:23:25:8b:d4:af"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan set eth0.1 -ip 192.168.131.151 -netmask 255.255.255.0 -gateway 192.168.131.1 -mac 96:23:25:8b:d4:af

PUT /interfaces/vlan/<name>

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

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק. זה יכול להיות שונה מממשק ה- IP של האב.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.
מק מחרוזת משכתב את ה- MAC של הממשק.
כּוֹחַ מחרוזת אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נכון, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש.

דוגמה לתגובה:

{
   "description" : "Modify VLAN interface",
   "params" : {
      "gateway" : "192.168.131.1",
      "ip" : "192.168.131.155",
      "netmask" : "255.255.255.0",
      "mac" : "96:23:25:8b:d4:af",
      "dhcp" : "false",
      "force" : "true"
   }
}

פרמטרים של תגובה

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

מחק ממשק VLAN

מחק ממשק VLAN

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1
zcli network-vlan delete eth0.1

DELETE /interfaces/vlan/<name>

מחק ממשק VLAN. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete VLAN interface",
   "message" : "The VLAN interface eth0.1 has been deleted.",
   "success" : "true"
}

הגדרת פעולה ממשק VLAN

הגדרת פעולה ממשק VLAN

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/vlan/eth0.1/actions
zcli network-vlan stop eth0.1

POST /interfaces/vlan/<name>/actions

החל פעולה על ממשק VLAN. שיחה זו מאפשרת להפעיל או להשבית ממשק רשת.

שם הוא שם ייחודי מזהה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on vlan interface",
   "params" : {
      "action" : "down"
   }
}

פרמטרים של תגובה

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

רשת - ממשקים וירטואליים

ממשקי רשת מאפשרים למשתמשים להגדיר ממשק רשת אחר באותו פלח רשת מאשר הוריהם, ולכן ממשקים וירטואליים יורשים תמיד את תצורת הרשת מההורה שלה. הפרמטר השונה יהיה ה- ip. ניתן ליצור את הממשק הווירטואלי מ- NIC, bonding או VLAN. יצירת ממשק וירטואלי חדש יופיע שדה עם תו נקודה ":" שישמש להקמת זהות עבור הממשק הווירטואלי.

רשימת ממשקים וירטואליים

רשימת ממשקים וירטואליים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual list

GET /interfaces/virtual

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

דוגמה לתגובה:

{
   "description" : "List virtual interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "192.168.100.155",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virt",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "up"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.5",
         "ip" : "192.168.100.41",
         "mac" : "c2:56:f6:54:ff:a0",
         "name" : "eth0:virtiface",
         "netmask" : "255.255.255.0",
         "parent" : "eth0",
         "status" : "down"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שבו ממשק האב.
מסכת רשת מחרוזת הגדר את פלח הרשת שבו הממשק עובד. זה יורש מממשק ההורה.
שער כניסה מחרוזת IP המשמש לשליחת מנות של פלח רשת אחר. זה יורש מממשק ההורה.
מק מחרוזת MAC של הממשק. זה יורש מממשק ההורה.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שעוצבה על ידי ממשק אב, תו נקודתיים ":" והשם עבור ממשק הרשת הווירטואלית, תווים אלפאנומריים מותרים.
הורה מחרוזת זהו ממשק המשמש ליצירת זה.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק לא יכול לקבל מנות.

לאחזר ממשק וירטואלי

לאחזר ממשק וירטואלי

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual get eth0:vip1

GET /interfaces/virtual/<name>

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

דוגמה לתגובה:

{
   "description" : "Show virtual interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0",
      "status" : "down"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שבו ממשק האב.
מסכת רשת מחרוזת הגדר את פלח הרשת שבו הממשק עובד. זה יורש מממשק ההורה.
שער כניסה מחרוזת IP המשמש לשליחת מנות של פלח רשת אחר. זה יורש מממשק ההורה.
מק מחרוזת MAC של הממשק. זה יורש מממשק ההורה.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שעוצבה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-נומרית עבור ממשק הרשת הווירטואלית.
הורה מחרוזת זהו ממשק המשמש ליצירת זה.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק לא יכול לקבל מנות.

צור ממשק וירטואלי

יצירת ממשק וירטואלי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.41", "name":"eth0:virtiface"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual
zcli network-virtual create -name eth0:virtiface -ip 192.168.100.41

POST /interfaces/virtual

יצירת ממשק וירטואלי.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שבו ממשק האב. נכון
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שעוצבה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-נומרית עבור ממשק הרשת הווירטואלית. נכון

דוגמה לתגובה:

{
   "description" : "Add a virtual interface",
   "params" : {
      "gateway" : "192.168.100.5",
      "ip" : "192.168.100.41",
      "mac" : "c2:56:f6:54:ff:a0",
      "name" : "eth0:virtiface",
      "netmask" : "255.255.255.0"
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם תצורת הממשק. ראה דוגמה לתגובה למידע נוסף.

שדה סוּג תיאור
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שבו ממשק האב.
מסכת רשת מחרוזת הגדר את פלח הרשת שבו הממשק עובד. זה יורש מממשק ההורה.
שער כניסה מחרוזת IP המשמש לשליחת מנות לפלח רשת אחר. זה יורש מממשק ההורה.
מק מחרוזת MAC של הממשק. זה יורש מממשק ההורה.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי. שם זה הוא שרשרת שעוצבה על ידי ממשק אב, תו נקודתיים ":" ומחרוזת אלפא-נומרית עבור ממשק הרשת הווירטואלית.

שינוי ממשק וירטואלי

שינוי ממשק וירטואלי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual set eth0:virtiface -ip 192.168.131.155

PUT /interfaces/virtual/<name>

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

פרמטרים של בקשה

שדה סוּג תיאור נדרש
ip מחרוזת IP של הממשק. ה- IP חייב להיות באותו קטע רשת שבו ממשק האב. נכון
כּוֹחַ מחרוזת אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נכון, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש.

דוגמה לתגובה:

{
   "description" : "Modify virtual interface",
   "params" : {
      "ip" : "192.168.100.10",
      "force" : "true"
   }
}

פרמטרים של תגובה

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

מחיקת ממשק וירטואלי

מחיקת ממשק וירטואלי

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface
zcli network-virtual delete eth0:virtiface

DELETE /interfaces/virtual/<name>

מחק ממשקים וירטואליים. שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete virtual interface",
   "message" : "The virtual interface eth0:virtiface has been deleted.",
   "success" : "true"
}

הגדרת פעולה ממשק וירטואלי

הגדרת פעולה ממשק וירטואלי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
zcli network-virtual stop eth0:virtiface

POST /interfaces/virtual/<name>/actions

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

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up, לאפשר לממשק ולהכין אותו לשימוש; מטה, להשבית את הממשק כדי לא לקבל או לא לשלוח מנות. נכון

דוגמה לתגובה:

{
   "description" : "Action on virtual interface",
   "params" : {
      "action" : "down"
   }
}

פרמטרים של תגובה

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

רשת - ממשקי מליטה

ממשק הקישור של לינוקס או שנקרא גם על ידי ספקים אחרים כ- Trunk מספק שיטה לצבירת ממשקי רשת מרובים לממשק "מלוכד" לוגי יחיד. ההתנהגות של הממשקים המחוברים תלויה במצב, Zevenet Load Balancer תומך בשיטות הבאות:

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

מדיניות גיבוי פעיל: רק עבד אחד בקשר פעיל. עבד אחר הופך להיות פעיל אם, ורק אם העבד הפעיל נכשל. כתובת ה- MAC של האג"ח נראית חיצונית רק ביציאה אחת (מתאם רשת) כדי למנוע בלבול בין המתג. מצב זה מספק סובלנות לתקלות. האפשרות העיקרית משפיעה על התנהגותה.

XOR מדיניות: לשדר מבוסס על המקור כתובת MAC XOR'd עם כתובת MAC היעד. זה בוחר את אותו עבד עבור כל כתובת MAC היעד. מצב זה מספק איזון עומסים ועמידות בפני תקלות.

מדיניות שידור: מעביר הכל על כל ממשקי העבדים. מצב זה מספק עמידות בפני תקלות.

IEEE 802.3ad LACP: יצירת קבוצות צבירה המשותפות לאותה מהירות ולהגדרות דו-צדדיות. מנצל את כל העבדים בצובר הפעיל בהתאם למפרט 802.3ad.

מקדים:

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

  2. מתג התומך ב- IEEE 802.3ad של צבירת קישורים דינמיים. רוב המתגים ידרוש איזה סוג של תצורה כדי לאפשר מצב 802.3ad.

איזון עומס מסתגל: מליטה ערוץ זה אינו דורש שום תמיכה מתג מיוחד. התנועה היוצאת מופצת בהתאם לעומס הנוכחי (מחושב ביחס למהירות) על כל עבדים. התנועה הנכנסת מתקבלת על ידי העבד הנוכחי. אם העבד המקבל נכשל, עבד אחר משתלט על כתובת ה- MAC של העבד המקבל.

מקדים:

בסיס תמיכה הנהג לאחזור המהירות של כל עבד.

איזון עומס מסתגל: כולל איזון מסתגל של עומס שידור וקבלת איזון עומסים עבור תעבורת IPV4, ואינו דורש תמיכה מיוחדת במתג. האיזון עומס לקבל מושגת על ידי משא ומתן ARP. הנהג מליטה מיירט את התגובות ARP שנשלחו על ידי המערכת המקומית בדרכם החוצה מחליף את כתובת החומרה המקור עם כתובת החומרה הייחודית של אחד העבדים ב מליטה כך עמיתים שונים להשתמש בכתובות חומרה שונות עבור השרת.

רשימת הממשקים מליטה

רשימת הממשקים מליטה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding list

GET /interfaces/bonding

קבל תצורה על כל ממשקי מליטה במערכת.

דוגמה לתגובה:

{
   "description" : "List bonding interfaces",
   "interfaces" : [
      {
         "alias" : null,
         "gateway" : "",
         "ip" : "",
         "mac" : "66:eb:31:0e:07:71",
         "mode" : "broadcast",
         "name" : "bond2",
         "netmask" : "",
         "dhcp" : "false",
         "slaves" : [
            {
               "name" : "eth2"
            }
         ],
         "status" : "down"
      },
      {
         "alias" : null,
         "gateway" : "192.168.100.1",
         "ip" : "192.168.100.121",
         "mac" : "a2:6d:80:29:87:c6",
         "mode" : "balance-rr",
         "name" : "bondiface",
         "dhcp" : "false",
         "netmask" : "255.255.255.0",
         "slaves" : [
            {
               "name" : "eth3"
            },
            {
               "name" : "eth4"
            }
         ],
         "status" : "up"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק מליטה.

פרמטרים מליטה הם:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת מזהה ייחודי של שכבת קישור. זה מק של העבד ממשק NIC הראשון.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.
עבדים אובייקט [] חברים בממשק NIC בממשק המליטה.
מצב מחרוזת זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים בסעיף רשת - ממשקי מליטה.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

חפצי עבדים:

שדה סוּג תיאור
שם מחרוזת שם הוא מזהה ייחודי של ממשק של העבד NIC.

לאחזר ממשק מליטה

לאחזר ממשק מליטה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding get bondiface

GET /interfaces/bonding/<name>

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

דוגמה לתגובה:

{
   "description" : "Show bonding interface",
   "interface" : {
      "alias" : null,
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "netmask" : "255.255.255.0",
      "dhcp" : "false",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "up"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם אובייקט ממשק מליטה.

פרמטרים מליטה הם:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
מק מחרוזת מזהה ייחודי של שכבת קישור. זה מק של העבד ממשק NIC הראשון.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.
עבדים אובייקט [] חברים בממשק NIC בממשק המליטה.
מצב מחרוזת זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.

עבד אובייקט:

שדה סוּג תיאור
שם מחרוזת שם הוא מזהה ייחודי של ממשק של העבד NIC.

יצירת ממשק מליטה

יצירת ממשק מליטה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"slaves":["eth3","eth2"],"name":"bondiface","mode":"balance-rr"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding
zcli network-bonding create -slave eth3,eth2 -name bondiface -mode balance-rr

POST /interfaces/bonding

יצירת ממשק מליטה שהצטרף ממשקי NIC.

כתובת מליטה MAC יילקח ממשק NIC הראשון שלה. מצב Bonding לא ניתן לשנות ברגע ממשק מליטה נוצר, אבל ממשקי חבר ניתן להוסיף או למחוק ממשק מליטה לפי הצורך. ממשק NIC יהיה נעול אם הוא חלק ממשק מליטה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק. נכון
עבדים מחרוזת [] כל הממשקים NIC לבנות את מליטה. זה נדרש פרמטר NIC שם. נכון
מצב מחרוזת זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה. נכון

דוגמה לתגובה:

{
   "description" : "Add a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         }
      ],
      "status" : "down"
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם הפרמטרים configurated מליטה.

שדה סוּג תיאור
מק מחרוזת מזהה ייחודי של שכבת קישור. זה מק של העבד ממשק NIC הראשון.
שם מחרוזת שם הממשק. הוא משמש כמזהה ייחודי לממשק.
מצב מחרוזת הערכים יכולים להיות up, הממשק יכול לקבל מנות; מטה, הממשק אינו יכול לקבל מנות.
עבדים אובייקט [] ממשקי NIC הבונים את ממשק המליטה.
מצב מחרוזת זהו מצב עבודה עבור ממשק מליטה. האפשרויות הן: איזון rr, מדיניות סיבוב רובין; גיבוי פעיל, מדיניות גיבוי פעיל; מאזן- xor, מדיניות XOR; מִשׁדָר, מדיניות שידור; 802.3ad, IEEE 802.3ad LACP; איזון- tlb, איזון מסתגלת להעברת עומסים; מאזן, איזון עומסים מסתגלת. ערכים אלה מוגדרים ב רשת> ממשקי מליטה.

עבד אובייקט:

שדה סוּג תיאור
שם מחרוזת שם הוא מזהה ייחודי של ממשק של העבד NIC.

שינוי ממשק מליטה

שינוי ממשק מליטה

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.121","netmask":"255.255.255.0","gateway":"192.168.100.1","mac":"86:2f:0e:9a:30:14"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding set bondiface -ip 192.168.100.121 -netmask 255.255.255.0 -gateway 192.168.100.1 -mac 86:2f:0e:9a:30:14 

PUT /interfaces/bonding/<name>

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

פרמטרים של בקשה

שדה סוּג תיאור
ip מחרוזת IP של הממשק.
מסכת רשת מחרוזת הגדר את קטע הרשת שבו פועל הממשק.
שער כניסה מחרוזת IP שימש לשלוח מנות של פלח רשת אחר.
כּוֹחַ מחרוזת אם חווה משתמשת בממשק, לא ניתן יהיה לשנות את הממשק. לאחר מכן, אם פרמטר זה נשלח עם הערך נכון, הממשק ייאלץ לקחת את התצורה החדשה וכל חוות משתמש ממשק יופעל מחדש.
dhcp מחרוזת מאפשר לשירות DHCP לקבל את תצורת הרשת עבור הממשק משרת DHCP. פרמטר זה מקבל: נכון, כדי להפעיל את השירות, תצורת הממשק תיחסם בזמן שמופעל שירות DHCP; שקר כדי להפסיק את השירות, הממשק יאבד את כל תצורת הרשת שלו.
מק מחרוזת משכתב את ה- MAC של הממשק.

דוגמה לתגובה:

{
   "description" : "Modify bond address",
   "params" : {
      "gateway" : "192.168.100.1",
      "ip" : "192.168.100.121",
      "netmask" : "255.255.255.0",
      "mac" : "86:2f:0e:9a:30:14",
      "dhcp" : "false",
      "force" : "true"
   }
}

פרמטרים של תגובה

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

מחק את תצורת האיגום

מחק את תצורת האיגום

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface
zcli network-bonding delete bondiface

DELETE /interfaces/bonding/<name>

מחק את תצורת הממשק מליטה. הפרמטרים של התצורה הם: שער כניסה, ip ו מסכת רשת.

שם הוא מזהה ייחודי של ממשק.

דוגמה לתגובה:

{
   "description" : "Delete bonding network configuration",
   "message" : "The configuration for the bonding interface bondiface has been deleted.",
   "success" : "true"
}

הגדר פעולת ממשק מליטה

הגדר פעולת ממשק מליטה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"up"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/actions
zcli network-bond start bondiface

POST /interfaces/bonding/<name>/actions

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

יש צורך למחוק את ממשק מליטה באמצעות להרוס פעולה אם ברצונך לפתוח את ממשקי ה- NIC המשומשים במליטה. לאחר מכן מנהל התקן המליטה ישחזר את כתובות ה- MAC שהיו לממשקי החברים לפני שנוספו לממשק המליטה.

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת פעולה כדי להחיל על הממשק. הערכים הזמינים הם: up לאפשר את ממשק ולהכין אותו לשימוש, מטה להשבית את הממשק כדי לא לקבל או לא לשלוח מנות, להרוס למחוק את מליטה לשחזר את הממשקים עבדים NIC. נכון

דוגמה לתגובה:

{
   "description" : "Action on bond interface",
   "params" : {
      "action" : "up"
   }
}

פרמטרים של תגובה

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

הוסף ממשק עבדים מליטה

הוסף ממשק עבדים מליטה

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"eth4"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves
zcli network-bonding-slave add bondiface -name eth4

POST /interfaces/bonding/<name>/slaves

הוסף ממשק NIC כעבד לממשק מליטה קיים.

שם הוא מזהה ייחודי של ממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
שם מחרוזת ממשקי NIC שם כדי להוסיף לממשק המליטה. נכון

דוגמה לתגובה:

{
   "description" : "Add a slave to a bond interface",
   "params" : {
      "mac" : "a2:6d:80:29:87:c6",
      "mode" : "balance-rr",
      "name" : "bondiface",
      "slaves" : [
         {
            "name" : "eth3"
         },
         {
            "name" : "eth2"
         },
         {
            "name" : "eth4"
         }
      ],
      "status" : "up"
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם ערכים מוגדרים מעודכנים. ראה דוגמה לתגובה למידע נוסף.

הסר ממשק עבדים מליטה

הסר ממשק עבדים מליטה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/bonding/bondiface/slaves/eth2
zcli network-bonding-slave remove bondiface eth2

DELETE /interfaces/bonding/<name>/slaves/<name>

מחק ממשק עבדים NIC מממשק מליטה. ממשק המליטה חייב לכלול כמעט ממשק עבדים אחד של NIC.

ראשית, שם האם ה DELETE השיחה היא שם החיבור המזהה הייחודי, הבא שם ב DELETE השיחה היא שם הממשק מזהה ייחודי של NIC.

דוגמה לתגובה:

{
   "description" : "Remove bonding slave interface",
   "message" : "The bonding slave interface eth2 has been removed.",
   "success" : "true"
}

רשת - ממשקים צפים

סוג זה של ממשק משתמש בממשק וירטואלי מוגדר ומסווה את התנועה היוצאת של a nic, קשר or VLAN ממשק עם ילד וירטואלי מִמְשָׁק. ממשק זה משמש להתנהגות כושלת ממלכתית בפרופילי l4xnat אם מוגדר אשכול.

רשימת ממשקים צפים

רשימת ממשקים צפים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating
zcli network-floating list

GET /interfaces/floating

הראה את כל הממשקים הזמינים או שהוגדרו בהם נוצר IP צף.

דוגמה לתגובה:

{
   "description" : "List floating interfaces",
   "params" : [
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "bondiface",
         "interface_virtual" : null
      },
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : "192.168.100.41",
         "interface" : "eth0",
         "interface_virtual" : "eth0:virtiface"
      },
      {
         "alias" : null,
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "eth0.1",
         "interface_virtual" : null
      },
      {
         "alias" : "gestion",
         "floating_alias" : null,
         "floating_ip" : null,
         "interface" : "eth1",
         "interface_virtual" : null
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מערך אובייקט ממשק צף:

צף אובייקט:

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
floating_alias מחרוזת זהו הכינוי של הממשק הווירטואלי.
צף מחרוזת צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק.
ממשק מחרוזת ממשק רעול על ידי ה- IP הצף.
ממשק מחרוזת זהו שם הממשק הווירטואלי של ה- IP הצף המשמש להסרת הממשק.

אחזור ממשק צף

אחזור ממשק צף

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating get eth0

GET /interfaces/floating/<name>

מראה אם ​​לממשק יש כתובת IP צפה מוגדרת. אם התצורה מוגדרת, היא תוצג כאן.

שם הוא המזהה הייחודי לממשק שיכול להיות מסוג nic, bonding או VLAN.

דוגמה לתגובה:

{
   "description" : "Show floating interface",
   "params" : {
      "alias" : null,
      "floating_alias" : null,
      "floating_ip" : "192.168.100.41",
      "interface" : "eth0",
      "interface_virtual" : "eth0:virtiface"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
כינוי מחרוזת זה ניק לעזור לזהות את הממשק. כינוי
floating_alias מחרוזת זהו הכינוי של הממשק הווירטואלי.
צף מחרוזת צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק.
ממשק מחרוזת ממשק רעול על ידי ה- IP הצף.
ממשק מחרוזת זהו שם הממשק הווירטואלי של ה- IP הצף המשמש להסרת הממשק.

שינוי ממשק צף

שינוי ממשק צף

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"floating_ip":"192.168.100.199"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating set eth0 -floating_ip 192.168.100.199

PUT /interfaces/floating/<name>

הגדר IP צף עבור ממשק NIC, מליטה או VLAN.

שם הוא המזהה הייחודי לממשק שיכול להיות מסוג nic, bonding או VLAN.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
צף מחרוזת צף IP בשימוש ממשק. צף חייב להתקיים כילד ממשק וירטואלי של ממשק. נכון

דוגמה לתגובה:

{
   "description" : "Modify floating interface",
   "message" : "Floating interface modification done",
   "success" : "true"
}

מחק תצורה צפה

מחק תצורה צפה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/interfaces/floating/eth0
zcli network-floating delete eth0

DELETE /interfaces/floating/<name>

הסר את תצורת ה- IP הצפה בממשק.

שם הוא המזהה הייחודי לממשק שיכול להיות מסוג nic, bonding או VLAN.

דוגמה לתגובה:

{
   "description" : "Remove floating interface",
   "message" : "The floating interface has been removed.",
   "success" : "true"
}

רשת - כינויים

שים כינוי לממשק או ל- backend כדי לזהות אותו במהירות.

קיימים שני סוגים של כינויים, ניתן ליישם את כינויי הממשק בכל סוגי הממשקים: NIC, bonding, VLAN או וירטואלי. זוהי דרך קלה להתייחס לשם ממשק עם שם ידידותי יותר.

הסוג השני של הכינוי הוא עבור backends. זה מתייחס IP backend עם כינוי.

הכינויים הם מידע חזותי בלבד, הוא אינו מחליף את ה- IP של הגב האחורי או את שם הממשק בבקשת ZAPI.

רשימת כינויים

רשימת כינויים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/backends
zcli network-alias-backend list

GET /aliases/<backends|interfaces>

רשימת הכינויים במערכת עבור ממשקים או backends.

דוגמה לתגובה:

{
   "description" : "List the aliases",
   "params" : [
      {
         "id" : "192.168.11.13",
         "alias" : "http-backend"
      },
      {
         "id" : "127.0.0.1",
         "alias" : "localhost"
      }
   ]
}

פרמטרים של תגובה

ה- ZAPI מחזיר hash כאשר המפתח הוא ה- IP האחורי או שם הממשק והערך הוא הכינוי שלו.

צור כינוי

צור כינוי

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"eth0","alias":"management"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces
zcli network-alias-interface set eth0 -alias management

POST /aliases/<backends|interfaces>

סוג האובייקט האחורי או הממשקים שיקבל את הכינוי.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כינוי מחרוזת זהו ניק עבור האלמנט id נשלח ב- URI. נכון
id מחרוזת זה ה-IP האחורי או שם הממשק. נכון

דוגמה לתגובה:

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

פרמטרים של תגובה

ה- ZAPI מחזיר הודעת הצלחה אם התהליך היה נכון.

שנה כינוי

שנה כינוי

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"alias":"gateway"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zcli network-alias-interface set eth0 -alias gateway

PUT /aliases/<backends|interfaces>/<id>

אם לאובייקט יש כינוי, הוא יוחלף, אחרת ייקרא כינוי עבור האובייקט.

אל האני id הפרמטר URI הוא ה- IP של ה- backend או שם הממשק.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
כינוי מחרוזת זהו ניק עבור האלמנט id נשלח ב- URI. נכון

דוגמה לתגובה:

{
   "description" : "Set an alias",
   "message" : "Alias for eth0 has been updated successfully",
   "success" : "true"
}

פרמטרים של תגובה

ה- ZAPI מחזיר הודעת הצלחה אם התהליך היה נכון.

מחק כינוי

מחק כינוי

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/aliases/interfaces/eth0
zli network-alias-interface delete eth0

DELETE /aliases/<backends|interfaces>/<id>

זה מוחק את הכינוי של ממשק או backend.

אל האני id הפרמטר URI הוא ה- IP של ה- backend או שם הממשק.

דוגמה לתגובה:

{
   "description" : "Delete an alias",
   "message" : "The alias has been deleted.",
   "success" : "true"
}

פרמטרים של תגובה

ה- ZAPI מחזיר הודעת הצלחה אם התהליך היה נכון.

רשת - ניתוב

מודול זה זמין מגרסת zapi 4.0.1.

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

הצעד הראשון הוא לחפש לשלוט כאשר מקור החבילה תואם, ברגע שנמצא הכלל, ממשק החבילה היוצא מחפש ב- שולחן זֶה לשלוט מוּגדָר. הממשק הוא סימן למסלול התואם את יעד החבילה.

רשימת כללי ניתוב

רשימת כללי ניתוב

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule list

GET /routing/rules

ציין את כללי הניתוב של איזון העומס. כללי ניתוב משמשים כדי לקבל את טבלת הממשק תלויה ב- IP של חבילת המקור

דוגמה לתגובה:

{
    "description" : "List routing rules",
    "params" : [
        {
            "id" : 1024,
            "not" : "true",
            "from" : "10.10.10.0/24",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "local",
            "type" : "system",
            "id" : 0,
            "priority" : 0,
            "from" : "all"
        },
        {
            "id" : 0,
            "priority" : 31000,
            "from" : "10.3.0.0/24",
            "table" : "205",
            "type" : "system"
        },
        {
            "type" : "system",
            "table" : "table_eth1",
            "priority" : 31000,
            "from" : "4.4.4.0/24",
            "id" : 0
        },
        {
            "type" : "system",
            "table" : "main",
            "priority" : 32766,
            "from" : "all",
            "id" : 0
        }
    ]
}

פרמטרים של תגובה

התגובה תהיה רשימת JSON עם כל כללי הניתוב במערכת. כל כלל הוא אובייקט עם הפרמטרים הבאים:

שדה סוּג תיאור
id מספר זהו המזהה הייחודי המשמש לכללי ניתוב.
לֹא מחרוזת נעשה שימוש בשדה זה בשילוב עם הפרמטר החל מ- לשלול את תוצאת המשחק. פרמטר זה הוא מחרוזת בוליאנית עם הערך נכון כדי לאפשר אותו או עם הערך שקר אם תוצאת המשחק לא תשלול.
החל מ- מחרוזת זהו ה- IP המקורי או קטע הרשת המשמש להתאמה עם ה- IP המקורי של החבילה.
עדיפות מספר זה עדיפות הכלל, ערך מינורי של עדיפות הוא עדיפות גבוהה.
שולחן מחרוזת זהו טבלת הממשק המשמשת לניתוב אם ה- IP של מקור החבילה תואם לפרמטר החל מ-.
סוג מחרוזת זהו סוג הכלל, לשדה זה יכול להיות הערכים: משק הוא מסלול המשמש לניתוב תנועה של חוות l4xnat, המשתמש הוא כלל שנוצר על ידי מנהל איזון העומסים או מערכת הוא כלל שנוצר באופן אוטומטי עבור המערכת.

צור כלל ניתוב

צור כלל ניתוב

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","not":"true","priority":"30000","from":"192.168.0.0/16"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules
zcli network-routing-rule -table table_eth1 -not true -priority 30000 -from 192.168.0.0/16

POST /routing/rules

צור כלל ניתוב.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
לֹא מחרוזת נעשה שימוש בשדה זה בשילוב עם הפרמטר החל מ- לשלול את תוצאת המשחק. פרמטר זה הוא מחרוזת בוליאנית עם הערך נכון כדי לאפשר אותו או עם הערך שקר אם תוצאת המשחק לא תשלול.
החל מ- מחרוזת זהו ה- IP המקורי או קטע הרשת המשמש להתאמה עם ה- IP המקורי של החבילה. נכון
עדיפות מספר זה עדיפות הכלל, ערך מינורי של עדיפות הוא עדיפות גבוהה. לכללים שנוצרו חייב להיות ערך בין 29000 ו 30999
שולחן מחרוזת זהו טבלת הממשק המשמשת לניתוב אם ה- IP של מקור החבילה תואם לפרמטר החל מ-. נכון

דוגמה לתגובה:

{
    "description" : "Create a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "from" : "192.168.0.0/16",
            "priority" : 30000,
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "table" : "table_eth0",
            "type" : "system",
            "id" : 0,
            "priority" : 32765,
            "from" : "192.168.100.0/24"
        },
        {
            "from" : "all",
            "priority" : 32766,
            "id" : 0,
            "type" : "system",
            "table" : "main"
        },
        {
            "id" : 0,
            "priority" : 32767,
            "from" : "all",
            "table" : "default",
            "type" : "system"
        }
    ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם כל כללי המסלולים של המערכת. כל מסלול הוא אובייקט עם הפרמטרים:

שדה סוּג תיאור
id מספר זהו המזהה הייחודי המשמש לכללי ניתוב.
לֹא מחרוזת נעשה שימוש בשדה זה בשילוב עם הפרמטר החל מ- לשלול את תוצאת המשחק. פרמטר זה הוא מחרוזת בוליאנית עם הערך נכון כדי לאפשר אותו או עם הערך שקר אם תוצאת המשחק לא תשלול.
החל מ- מחרוזת זהו ה- IP המקורי או קטע הרשת המשמש להתאמה עם ה- IP המקורי של החבילה.
עדיפות מספר זה עדיפות הכלל, ערך מינורי של עדיפות הוא עדיפות גבוהה.
שולחן מחרוזת זהו טבלת הממשק המשמשת לניתוב אם ה- IP של מקור החבילה תואם לפרמטר החל מ-.
סוג מחרוזת זהו סוג הכלל, לשדה זה יכול להיות הערכים: משק הוא מסלול המשמש לניתוב תנועה של חוות l4xnat, המשתמש הוא כלל שנוצר על ידי מנהל איזון העומסים או מערכת הוא כלל שנוצר באופן אוטומטי עבור המערכת.

שנה את כלל הניתוב

שנה את כלל הניתוב

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"table":"table_eth1","from":"10.10.10.0/24","priority":"30000","not":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule set 1024 -table table_eth1 -from 10.10.10.0/24 -priority 30000 -not false

PUT /routing/rules/<id>

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

אל האני id פרמטר URI הוא המזהה הייחודי לכלל.

הכללים של סוג המשתמש הם הייחודיים שניתן לשנות

פרמטרים של בקשה

שדה סוּג תיאור דרוש
לֹא מחרוזת נעשה שימוש בשדה זה בשילוב עם הפרמטר החל מ- לשלול את תוצאת המשחק.
החל מ- מחרוזת זהו ה- IP המקורי או קטע הרשת המשמש להתאמה עם ה- IP המקורי של החבילה. פרמטר זה הוא מחרוזת בוליאנית עם הערך נכון כדי לאפשר אותו או עם הערך שקר אם תוצאת המשחק לא תשלול. נכון
עדיפות מספר זה עדיפות הכלל, ערך מינורי של עדיפות הוא עדיפות גבוהה. לכללים שנוצרו חייב להיות ערך בין 29000 ו 30999
שולחן מחרוזת זהו טבלת הממשק המשמשת לניתוב אם ה- IP של מקור החבילה תואם לפרמטר החל מ-. נכון

דוגמה לתגובה:

{
    "description" : "Modify a routing rule",
    "params" : [
        {
            "not" : "true",
            "id" : 1024,
            "priority" : 30000,
            "from" : "10.10.10.0/24",
            "table" : "table_eth1",
            "type" : "user"
        },
        {
            "id" : 0,
            "from" : "4.4.4.0/24",
            "priority" : 31000,
            "table" : "table_eth1",
            "type" : "system"
        },
        {
            "table" : "table_eth2",
            "type" : "system",
            "id" : 0,
            "from" : "5.5.5.0/24",
            "priority" : 31000
        },
        {
            "type" : "system",
            "table" : "table_eth0",
            "from" : "192.168.100.0/24",
            "priority" : 32765,
            "id" : 0
        },
    ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם כל כללי המסלולים של המערכת. כל מסלול הוא אובייקט עם הפרמטרים:

שדה סוּג תיאור
id מספר זהו המזהה הייחודי המשמש לכללי ניתוב.
לֹא מחרוזת נעשה שימוש בשדה זה בשילוב עם הפרמטר החל מ- לשלול את תוצאת המשחק. פרמטר זה הוא מחרוזת בוליאנית עם הערך נכון כדי לאפשר אותו או עם הערך שקר אם תוצאת המשחק לא תשלול.
החל מ- מחרוזת זהו ה- IP המקורי או קטע הרשת המשמש להתאמה עם ה- IP המקורי של החבילה.
עדיפות מספר זה עדיפות הכלל, ערך מינורי של עדיפות הוא עדיפות גבוהה.
שולחן מחרוזת זהו טבלת הממשק המשמשת לניתוב אם ה- IP של מקור החבילה תואם לפרמטר החל מ-.
סוג מחרוזת זהו סוג הכלל, לשדה זה יכול להיות הערכים: משק הוא מסלול המשמש לניתוב תנועה של חוות l4xnat, המשתמש הוא כלל שנוצר על ידי מנהל איזון העומסים או מערכת הוא כלל שנוצר באופן אוטומטי עבור המערכת.

מחק כלל ניתוב

מחק כלל ניתוב

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/rules/1024
zcli network-routing-rule remove 1024

DELETE /routing/rules/<id>

מחק כלל ניתוב.

אל האני id פרמטר URI הוא המזהה הייחודי לכלל.

דוגמה לתגובה:

{
    "message" : "The routing rule '1024' has been deleted successfully.",
    "description" : "Delete the routing rule '1024'"
}

רשימת טבלאות ניתוב

רשימת טבלאות ניתוב

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables
zcli network-routing-table list

GET /routing/tables

ציין את טבלאות הניתוב שמנהל איזון העומס.

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

דוגמה לתגובה:

{
  "description" : "List routing tables",
  "params" : [
                "main",
                "table_eth0",
                "table_eth1",
                "table_eth2",
                "table_eth3"
              ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם ה- params מפתח המכיל רשימה עם הטבלאות הקיימות במערכת.

רשימת מסלולים של טבלה

רשימת כללי ניתוב

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2
zcli network-routing-table get table_eth2

GET /routing/tables/<table>

ציין את ערכי המסלולים שטבלת ממשקים מנהלת. רשומות אלה משמשות להתאמה ל- IP של יעד החבילה. הממשק הקרוב לחבילה יהיה הממשק הראשון שיתאים לערך של הטבלה.

דוגמה לתגובה:

{
    "description" : "Get the routing table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "priority" : 10,
          "raw" : "5.5.5.0/24 dev eth2 scope link src 5.5.5.5 initcwnd 10 initrwnd 10  table table_eth2",
          "interface" : "eth2",
          "source" : "5.5.5.5",
          "type" : "system",
          "to" : "5.5.5.0/24",
          "via" : ""
        },
        {
          "via" : "",
          "to" : "192.168.100.0/24",
          "interface" : "eth0",
          "type" : "system",
          "source" : "192.168.100.241",
          "raw" : "192.168.100.0/24 dev eth0 scope link src 192.168.100.241 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10
        }
    ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ורשימת המסלולים המכילה את הטבלה.

שדה סוּג תיאור
חי מחרוזת זהו ערך הניתוב עם ה- מסלול IP פורמט.
עדיפות מספר זוהי העדיפות בה ייבחן המסלול. ערך נמוך יותר הוא עדיפות רבה יותר. שדה זה צריך להיות בעל ערך בין 1 ו 10.
ממשק מחרוזת זהו הממשק העתידי המשמש אם המסלול תואם.
מָקוֹר מחרוזת זה ה- IP המשמש למסכת החבילה. מקור זה צריך להתקיים במאזן העומסים כממשק וירטואלי.
סוג מחרוזת זה סוג המסלול. המסלולים יכולים להיות מסוגים מערכת שנוצרו ומנוהלים אוטומטית על ידי המערכת, או המשתמש כאשר המסלול נוצר על ידי משתמש מאזן עומסים. בודק את לא לנהל תכונה להסרת א מערכת המסלול.
ל מחרוזת זה מצב התאמה. אם ה- IP של יעד החבילה תואם את זה המסלול מוצלח.
באמצעות מחרוזת זה הקפיצה הבאה של החבילה. הוא משמש כשער. יש להגיע ל- IP זה מקטע ממשקי הרשת.
id מספר זהו המזהה הייחודי של המסלול. פרמטר זה משמש לשינוי או למחיקה של המסלול והוא זמין רק במסלולים מהסוג המשתמש.

צור כניסה לניתוב

צור כניסה לניתוב

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"source":"4.4.4.4","via":"4.4.4.45","interface":"eth1","priority":2,"to":"84.1.21.5"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes
zcli network-routing-table add table_eth2 -source 4.4.4.4 -via 4.4.4.45 -interface eth1 -priority 2 -to 84.1.21.5

POST /routing/tables/<table>/routes

צור מסלול לממשק.

אל האני שולחן פרמטר URI הוא טבלת הממשק שבה יתווסף המסלול.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
חי מחרוזת זהו ערך הניתוב עם ה- מסלול IP פוּרמָט. אם משתמשים בפרמטר זה, האחרים יימנעו.
ל מחרוזת זה מצב התאמה. אם ה- IP של יעד החבילה תואם את זה המסלול מוצלח. זה נדרש כאשר חי לא נשלח
עדיפות מספר זוהי העדיפות בה ייבחן המסלול. ערך נמוך יותר הוא עדיפות רבה יותר. שדה זה צריך להיות בעל ערך בין 1 ו 10.
ממשק מחרוזת זהו הממשק העתידי המשמש אם המסלול תואם.
מָקוֹר מחרוזת זה ה- IP המשמש למסכת החבילה. מקור זה צריך להתקיים במאזן העומסים כממשק וירטואלי.
באמצעות מחרוזת זה הקפיצה הבאה של החבילה. הוא משמש כשער. יש להגיע ל- IP זה מקטע ממשקי הרשת.

דוגמה לתגובה:

{
    "description" : "Create a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "84.1.21.5",
          "via" : "4.4.4.45",
          "priority" : 2,
          "raw" : "84.1.21.5 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "id" : 1024,
          "source" : "4.4.4.4",
          "type" : "user",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "source" : "",
          "type" : "system",
          "interface" : "eth2",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2",
          "source" : "4.4.4.4",
          "type" : "system",
          "interface" : "eth1",
          "to" : "4.4.4.0/24",
          "via" : ""
        },
    ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ורשימת המסלולים המכילה את הטבלה.

שדה סוּג תיאור
עדיפות מספר זוהי העדיפות בה ייבחן המסלול. ערך נמוך יותר הוא עדיפות רבה יותר. שדה זה צריך להיות בעל ערך בין 1 ו 10.
חי מחרוזת זהו ערך הניתוב עם ה- מסלול IP פורמט.
ממשק מחרוזת זהו הממשק העתידי המשמש אם המסלול תואם.
מָקוֹר מחרוזת זה ה- IP המשמש למסכת החבילה. מקור זה צריך להתקיים במאזן העומסים כממשק וירטואלי.
סוג מחרוזת זה סוג המסלול. המסלולים יכולים להיות מסוגים מערכת שנוצרו ומנוהלים אוטומטית על ידי המערכת, או המשתמש כאשר המסלול נוצר על ידי משתמש מאזן עומסים. בודק את לא לנהל תכונה להסרת א מערכת המסלול.
ל מחרוזת זה מצב התאמה. אם ה- IP של יעד החבילה תואם את זה המסלול מוצלח.
באמצעות מחרוזת זה הקפיצה הבאה של החבילה. הוא משמש כשער. יש להגיע ל- IP זה מקטע ממשקי הרשת.
id מספר זהו המזהה הייחודי של המסלול. פרמטר זה משמש לשינוי או למחיקה של המסלול והוא זמין רק במסלולים מהסוג המשתמש.

שנה כניסה למסלול

שנה כניסה למסלול

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"priority":2,"source":"4.4.4.4","interface":"eth1","to":"71.71.71.0/24","via":"4.4.4.45"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table -id 1024 -priority 2 -source 4.4.4.4 -interface eth1 -to 71.71.71.0/24 -via 4.4.4.45

PUT /routing/tables/<table>/routes/<id>

שנה את הפרמטרים של ערך נתיב.

אל האני שולחן פרמטר URI הוא טבלת הממשק של המסלול שישונה. ה id פרמטר URI הוא המזהה הייחודי למסלול של המסלול שישונה.

פרמטרים של בקשה

שדה סוּג תיאור
חי מחרוזת זהו ערך הניתוב עם ה- מסלול IP פוּרמָט. אם משתמשים בפרמטר זה, האחרים יימנעו.
עדיפות מספר זוהי העדיפות בה ייבחן המסלול. ערך נמוך יותר הוא עדיפות רבה יותר. שדה זה צריך להיות בעל ערך בין 1 ו 10.
ממשק מחרוזת זהו הממשק העתידי המשמש אם המסלול תואם.
מָקוֹר מחרוזת זה ה- IP המשמש למסכת החבילה. מקור זה צריך להתקיים במאזן העומסים כממשק וירטואלי.
ל מחרוזת זה מצב התאמה. אם ה- IP של יעד החבילה תואם את זה המסלול מוצלח.
באמצעות מחרוזת זה הקפיצה הבאה של החבילה. הוא משמש כשער. יש להגיע ל- IP זה מקטע ממשקי הרשת.

דוגמה לתגובה:

{
    "description" : "Modify a routing entry in the table 'table_eth2'",
    "params" : [
        {
          "to" : "71.71.71.0/24",
          "via" : "4.4.4.45",
          "raw" : "71.71.71.0/24 dev eth1 src 4.4.4.4 via 4.4.4.45 metric 2 table table_eth2",
          "priority" : 2,
          "id" : 1024,
          "type" : "user",
          "source" : "4.4.4.4",
          "interface" : "eth1"
        },
        {
          "raw" : "default via 5.5.5.1 dev eth2 initcwnd 10 initrwnd 10  table table_eth2",
          "priority" : 10,
          "interface" : "eth2",
          "source" : "",
          "type" : "system",
          "to" : "default",
          "via" : "5.5.5.1"
        },
        {
          "via" : "",
          "to" : "4.4.4.0/24",
          "interface" : "eth1",
          "source" : "4.4.4.4",
          "type" : "system",
          "priority" : 10,
          "raw" : "4.4.4.0/24 dev eth1 scope link src 4.4.4.4 initcwnd 10 initrwnd 10  table table_eth2"
        },
    ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ורשימת המסלולים המכילה את הטבלה.

שדה סוּג תיאור
עדיפות מספר זוהי העדיפות בה ייבחן המסלול. ערך נמוך יותר הוא עדיפות רבה יותר. שדה זה צריך להיות בעל ערך בין 1 ו 10.
חי מחרוזת זהו ערך הניתוב עם ה- מסלול IP פורמט.
ממשק מחרוזת זהו הממשק העתידי המשמש אם המסלול תואם.
מָקוֹר מחרוזת זה ה- IP המשמש למסכת החבילה. מקור זה צריך להתקיים במאזן העומסים כממשק וירטואלי.
סוג מחרוזת זה סוג המסלול. המסלולים יכולים להיות מסוגים מערכת שנוצרו ומנוהלים אוטומטית על ידי המערכת, או המשתמש כאשר המסלול נוצר על ידי משתמש מאזן עומסים. בודק את לא לנהל תכונה להסרת א מערכת המסלול.
ל מחרוזת זה מצב התאמה. אם ה- IP של יעד החבילה תואם את זה המסלול מוצלח.
באמצעות מחרוזת זה הקפיצה הבאה של החבילה. הוא משמש כשער. יש להגיע ל- IP זה מקטע ממשקי הרשת.
id מספר זהו המזהה הייחודי של המסלול. פרמטר זה משמש לשינוי או למחיקה של המסלול והוא זמין רק במסלולים מהסוג המשתמש.

מחק ערך כניסה

מחק ערך כניסה

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth2/routes/1024
zcli network-routing-table remove table_eth2 1024

DELETE /routing/tables/<table>/routes/<id>

מחק מסלול של טבלת ממשקים.

אל האני שולחן פרמטר URI הוא טבלת הממשק שממנה יימחק המסלול. ה id פרמטר URI הוא המזהה הייחודי של המסלול של המסלול שיימחק.

דוגמה לתגובה:

{
    "description" : "Delete the routing entry '1024' from the table 'table_eth2'",
    "message" : "The routing rule '1024' has been deleted successfully."
}

רשימת ממשקים שלא מנוהלים בטבלה

רשימת ממשקים שלא מנוגנים בטבלה

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged get table_eth1

GET /routing/tables/<table>/unmanaged

תכונה זו משמשת כדי למנוע תנועה מממשק שיכול לצאת למצב אחר.

שולחן הוא טבלת הניתוב של הממשק הנכנס.

ציין את הממשקים ואם ניתן להשתמש בהם בכדי להגיע לתנועה.

דוגמה לתגובה:

{
    "params" : [
      {
         "unmanaged" : "false",
         "interface" : "eth3"
      },
      {
         "unmanaged" : "false",
         "interface" : "eth0"
      }
    ],
    "description" : "Get the list of interfaces that cannot manage traffic when traffic incoming through the table 'table_eth1'"
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params המכילה רשימה של אובייקטים עם הפרמטרים הבאים.

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

הוסף ממשק לרשימת הלא מנוהלים

בטל ניהול ממשק

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth2"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged
zcli network-routing-table-unmanaged add table_eth1 interface eth0

POST /routing/tables/<table>/unmanaged

השבת ממשק לתנועה קרובה.

אל האני שולחן פרמטר URI הוא שם טבלת הניתוב שממנה לא ניתן יהיה להגיע. אם שולחן יש את הערך “*"(כוכבית), ה ממשק לא יהיה נגיש מאף טבלה.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
ממשק מחרוזת זה הממשק שלא יוכל לנתב מה- שולחן. נכון

דוגמה לתגובה:

{
    "description" : "Do not route traffic through an interface for the table 'table_eth1'",
    "message" : "The interface 'eth2' is not accesible from the table 'table_eth1'"
}

הסר ממשק מרשימת הלא מנוהלים

נהל טבלת ניתוב

דוגמה לבקשה:

curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/routing/tables/table_eth1/unmanaged/eth2
zcli network-routing-table-unmanaged remove table_eth1 eth2

DELETE /routing/tables/<table>/unmanaged/<interface>

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

אל האני שולחן פרמטר URI הוא טבלת הממשק שעוברת שינוי. אם שולחן יש את הערך “*"(כוכבית), ה ממשק ינוהל מכל הטבלאות. ה ממשק פרמטר URI הוא הממשק המותר עבור ה- שולחן השולחן.

דוגמה לתגובה:

{
    "description" : "Enable an interface as possible route path from the table 'table_eth1'",
    "message" : "The interface 'eth2' is now accesible from the table 'table_eth1'"
}

ניטור - FarmGuardian

FarmGuardian משמש למצב ניטור מתקדם של backends. כאשר בעיה מזוהה על ידי FarmGuardian משבית באופן אוטומטי את השרת האמיתי יהיה מסומן כמו ברשימה השחורה.

רשימת FarmGuardians

רשימת FarmGuardians

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian list

GET /monitoring/fg

רשום את FarmGuardians. תבניות ו FarmGuardians מותאמים אישית מופיעים ברשימה.

דוגמה לתגובה:

{
   "description" : "List farm guardian checks and templates",
   "params" : [
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp-cut_conns",
         "template" : "true",
         "backend_alias" : "false"
      },
      {
         "command" : "check_tcp -p 80 -H HOST",
         "cut_conns" : "false",
         "description" : "TCP check to the port 80",
         "farms" : [
                     "web_service",
                     "my_welcome_web"
         ],
         "interval" : 7,
         "log" : "true",
         "name" : "custom-tcp",
         "template" : "false",
         "backend_alias" : "true"
      },
      {
         "command" : "check_tcp -p PORT -H HOST",
         "cut_conns" : "false",
         "description" : "It does a TCP connection to test if the backend is alive",
         "farms" : [],
         "interval" : 5,
         "log" : "false",
         "name" : "check_tcp",
         "template" : "true",
         "backend_alias" : "false"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור
הפקודה מחרוזת פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec.
cut_conns מחרוזת הערכים האפשריים הם: נכון, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
תיאור מחרוזת תיאור קצר של הצ'ק.
חוות מחרוזת [] חוות שבהן החווה FarmGuardian מוחל.
הפסקה מספר זמן בין המחאות.
היכנס מחרוזת הערכים האפשריים הם: נכון, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
שם מחרוזת מזהה ייחודי.
תבנית מחרוזת אם FarmGuardian היא תבנית, היא לא תחול על אף חווה. התבניות שימושיות ליצירת FarmGuardian חדש.
backend_alias (מ 4.0.1) מחרוזת אם לפרמטר זה יש את הערך שקר, מארח ה- backend יהיה ה- IP של ה- backend. הכינוי של ה- backend ישמש כמארח אם לפרמטר זה יש את הערך נכון, יש להגדיר את הכינוי ואיזון העומס אמור להיות מסוגל לפתור אותו.

אחזר FarmGuardian

אחזר FarmGuardian

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/check_tcp
zcli farmguardian get check_tcp

GET /monitoring/fg/<name>

הצג את התצורה של FarmGuardian.

פרמטר URI שם הוא מזהה ייחודי FarmGuardian.

דוגמה לתגובה:

{
   "description" : "Retrive the farm guardian check_tcp",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 10,
      "log" : "false",
      "name" : "check_tcp",
      "template" : "true",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור
הפקודה מחרוזת פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec.
cut_conns מחרוזת הערכים האפשריים הם: נכון, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
תיאור מחרוזת תיאור קצר של הצ'ק.
חוות מחרוזת [] חוות שבהן החווה FarmGuardian מוחל.
הפסקה מספר זמן בין צ'קים. זהו הזמן מרגע בדיקת ה-backend האחרון ברשימה ועד שה-backend הראשון נבדק שוב.
היכנס מחרוזת הערכים האפשריים הם: נכון, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
שם מחרוזת מזהה ייחודי.
תבנית מחרוזת אם FarmGuardian היא תבנית, היא לא תשתנה. התבניות שימושיות ליצירת FarmGuardian חדש או להחיל ישירות על חוות.
backend_alias (מ 4.0.1) מחרוזת אם לפרמטר זה יש את הערך שקר, מארח ה- backend יהיה ה- IP של ה- backend. הכינוי של ה- backend ישמש כמארח אם לפרמטר זה יש את הערך נכון, יש להגדיר את הכינוי ואיזון העומס אמור להיות מסוגל לפתור אותו.
פסק זמן (מ 4.0.2) מספר פסק זמן לכל קצה אחורי. לאחר זמן זה במהלך מבחן הקצה האחורי, הוא ייחשב כירידה. כברירת מחדל, הזמן הקצוב שווה למרווח.

יצירת FarmGuardian

יצירת FarmGuardian

דוגמה לבקשה:

curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"check_tcp-cut_conns", "copy_from":"check_tcp"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg
zcli farmguardian create -name check_tcp-cut_conns -copy_from check_tcp

POST /monitoring/fg

צור FarmGuardian חדש.

פרמטרים של בקשה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור דרוש
שם מחרוזת מזהה ייחודי. נכון
תעתיק מ מחרוזת זהו FarmGuardian המשמש כתבנית ליצירת FarmGuardian החדש. אם שדה זה לא נשלח, FarmGuardian החדש נוצר ללא תצורה.

דוגמה לתגובה:

{
   "description" : "Create a farm guardian check_tcp-cut_conns",
   "message" : "The farm guardian check_tcp-cut_conns has been created successfully",
   "params" : {
      "command" : "check_tcp -p PORT -H HOST",
      "cut_conns" : "false",
      "description" : "It does a TCP connection to test if the backend is alive",
      "farms" : [],
      "interval" : 5,
      "log" : "false",
      "name" : "check_tcp-cut_conns",
      "template" : "true",
      "backend_alias" : "false",
      "timeout" : 5
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור
הפקודה מחרוזת פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec.
cut_conns מחרוזת הערכים האפשריים הם: נכון, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
תיאור מחרוזת תיאור קצר של הצ'ק.
חוות מחרוזת [] חוות שבהן החווה FarmGuardian מוחל.
הפסקה מספר זמן בין צ'קים. זהו הזמן מרגע בדיקת ה-backend האחרון ברשימה ועד שה-backend הראשון נבדק שוב.
היכנס מחרוזת הערכים האפשריים הם: נכון, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
שם מחרוזת מזהה ייחודי.
תבנית מחרוזת אם FarmGuardian היא תבנית, היא לא תשתנה. התבניות שימושיות ליצירת FarmGuardian חדש או להחיל ישירות על חוות.
backend_alias (מ 4.0.1) מחרוזת אם לפרמטר זה יש את הערך שקר, מארח ה- backend יהיה ה- IP של ה- backend. הכינוי של ה- backend ישמש כמארח אם לפרמטר זה יש את הערך נכון, יש להגדיר את הכינוי ואיזון העומס אמור להיות מסוגל לפתור אותו.
פסק זמן (מ 4.0.2) מספר פסק זמן לכל קצה אחורי. לאחר זמן זה במהלך מבחן הקצה האחורי, הוא ייחשב כירידה. כברירת מחדל, הזמן הקצוב שווה למרווח.

שינוי FarmGuardian

שינוי FarmGuardian

דוגמה לבקשה:

curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interval":7,"log":"true","description":"TCP check to the port 80","command":"check_tcp -p 80 -H HOST","cut_conns":"false"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian set custom-tcp -interval 7 -log true -description 'TCP check to the port 80' -command 'check_tcp -p 80 -H HOST' -cut_conns false

PUT /monitoring/fg/<name>

שינוי FarmGuardian.

פרמטר URI שם הוא מזהה ייחודי FarmGuardian.

פרמטרים של בקשה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור דרוש
הפקודה מחרוזת פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec.
cut_conns מחרוזת הערכים האפשריים הם: נכון, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
תיאור מחרוזת תיאור קצר של הצ'ק.
הפסקה מספר זמן בין צ'קים. זהו הזמן מרגע בדיקת ה-backend האחרון ברשימה ועד שה-backend הראשון נבדק שוב.
היכנס מחרוזת הערכים האפשריים הם: נכון, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
כּוֹחַ מחרוזת אם משק פועל משתמש ב- FarmGuardian, לא ניתן יהיה לשנות את FarmGuardian. לאחר מכן, אם פרמטר זה נשלח עם הערך נכון, FarmGuardian ייאלץ לקחת את התצורה החדשה.
backend_alias (מ 4.0.1) מחרוזת אם לפרמטר זה יש את הערך שקר, מארח ה- backend יהיה ה- IP של ה- backend. הכינוי של ה- backend ישמש כמארח אם לפרמטר זה יש את הערך נכון, יש להגדיר את הכינוי ואיזון העומס אמור להיות מסוגל לפתור אותו.
פסק זמן (מ 4.0.2) מספר פסק זמן לכל קצה אחורי. לאחר זמן זה במהלך מבחן הקצה האחורי, הוא ייחשב כירידה. כברירת מחדל, הזמן הקצוב שווה למרווח.

דוגמה לתגובה:

{
   "description" : "Modify farm guardian custom-tcp",
   "message" : "Success, some parameters have been changed in farm guardian custom-tcp.",
   "params" : {
      "command" : "check_tcp -p 80 -H HOST",
      "cut_conns" : "false",
      "description" : "TCP check to the port 80",
      "farms" : [],
      "interval" : 7,
      "log" : "true",
      "name" : "custom-tcp",
      "template" : "false",
      "backend_alias" : "false",
      "timeout" : 7
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם המפתח params ואת הפורמט להלן:

שדה סוּג תיאור
הפקודה מחרוזת פקודה כדי לבדוק את מצב השירות ב- backend. פקודות זמינות אלה נמצאות בנתיב libexec.
cut_conns מחרוזת הערכים האפשריים הם: נכון, FarmGuardian חותך את הקשרים הנוכחי כאשר backend אינו זמין; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
תיאור מחרוזת תיאור קצר של הצ'ק.
חוות מחרוזת [] חוות שבהן החווה FarmGuardian מוחל.
הפסקה מספר זמן בין צ'קים. זהו הזמן מרגע בדיקת ה-backend האחרון ברשימה ועד שה-backend הראשון נבדק שוב.
היכנס מחרוזת הערכים האפשריים הם: נכון, FarmGuardian יכנס כל המחאה; או שקר, אם backend זה לא זמין, זה יהיה מושבת אבל המפגשים בחיים ממשיכים.
שם מחרוזת מזהה ייחודי.
תבנית מחרוזת אם FarmGuardian היא תבנית, היא לא תחול על אף חווה. התבניות שימושיות ליצירת FarmGuardian חדש.
backend_alias (מ 4.0.1) מחרוזת אם לפרמטר זה יש את הערך שקר, מארח ה- backend יהיה ה- IP של ה- backend. הכינוי של ה- backend ישמש כמארח אם לפרמטר זה יש את הערך נכון, יש להגדיר את הכינוי ואיזון העומס אמור להיות מסוגל לפתור אותו.
פסק זמן (מ 4.0.2) מספר פסק זמן לכל קצה אחורי. לאחר זמן זה במהלך מבחן הקצה האחורי, הוא ייחשב כירידה. כברירת מחדל, הזמן הקצוב שווה למרווח.

מחק FarmGuardian

מחק FarmGuardian

דוגמה לבקשה:

curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/monitoring/fg/custom-tcp
zcli farmguardian delete custom-tcp

DELETE /monitoring/fg/<name>

מחק מחווה.

פרמטר URI שם הוא מזהה ייחודי FarmGuardian.

דוגמה לתגובה:

{
   "description" : "Delete the farm guardian custom-tcp",
   "message" : "custom-tcp has been deleted successful.",
   "success" : "true"
}

ניטור - סטטיסטיקה

הראה מידע אודות המערכת והחוות. מידע זה יהיה שימושי לניטור מצב איזון העומס של Zevenet.

הצג נתונים סטטיסטיים של המערכת

הצג נתונים סטטיסטיים של המערכת

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats
zcli statistics-system get

GET /stats

קבל נתונים סטטיסטיים גלובליים של המערכת.

דוגמה לתגובה:

{
   "description" : "System stats",
   "params" : {
      "cpu" : {
         "cores" : 2,
         "idle" : 94.42,
         "iowait" : 0,
         "irq" : 0,
         "nice" : 0,
         "softirq" : 0,
         "sys" : 2.54,
         "usage" : 5.58,
         "user" : 3.05
      },
      "date" : "Fri Jan 27 11:40:32 2017",
      "hostname" : "api3",
      "load" : {
         "Last_1" : 1.17,
         "Last_15" : 0.36,
         "Last_5" : 0.6
      },
      "memory" : {
         "Buffers" : 21.68,
         "Cached" : 147.95,
         "MemFree" : 348.06,
         "MemTotal" : 2005.01,
         "MemUsed" : 1656.95,
         "SwapCached" : 2.67,
         "SwapFree" : 614.38,
         "SwapTotal" : 672,
         "SwapUsed" : 57.62
      },
      "network" : {
         "bond0 in in" : 234.72,
         "bond0 out out" : 0,
         "bond0.10 in in" : 0,
         "bond0.10 out out" : 0,
         "bond1 in in" : 234.72,
         "bond1 out out" : 0,
         "bond3 in in" : 815.69,
         "bond3 out out" : 4300.38,
         "eth0 in in" : 2702.29,
         "eth0 out out" : 50701.95,
         "eth0.2 in in" : 0,
         "eth0.2 out out" : 0,
         "eth1 in in" : 234.72,
         "eth1 out out" : 0,
         "eth2 in in" : 234.72,
         "eth2 out out" : 0,
         "eth3 in in" : 0,
         "eth3 out out" : 0,
         "eth4 in in" : 436.89,
         "eth4 out out" : 4300.38,
         "eth4.6 in in" : 0,
         "eth4.6 out out" : 0,
         "eth5 in in" : 301.39,
         "eth5 out out" : 0,
         "eth5.5 in in" : 0,
         "eth5.5 out out" : 0,
         "eth6 in in" : 77.42,
         "eth6 out out" : 0
      }
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
מעבד חפץ נתונים סטטיסטיים של המעבד.
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.
לִטעוֹן חפץ נתונים סטטיסטיים של עומס הליבה.
זיכרון חפץ נתונים סטטיסטיים של זיכרון משומש.
רשת חפץ נתונים סטטיסטיים של תעבורת הרשת.

אובייקט CPU:

שדה סוּג תיאור
ליבות מספר מספר הליבות במעבד.
להתבטל מספר מעבד אינו משתמש בשום תוכנית.
כן מספר מעבד המשמש בתהליך קלט או פלט.
Irq מספר מעבד המשמש להפרעות חומרה.
נחמד מספר עדיפות תזמון CPU.
רך מספר מעבד המשמש להפרעות תוכנה.
sys מספר CPU המשמש את המערכת.
שימוש מספר סה"כ מעבד משומש.
המשתמש מספר CPU המשמש את המשתמש.

טען אובייקט:

שדה סוּג תיאור
Last_1 מספר טען אחוזי מערכת ברגע האחרון.
Last_5 מספר אחוז טעינה של מערכת לפני חמש דקות.
Last_15 מספר אחוז טעינה של מערכת לפני חמש עשרה דקות.

אובייקט זיכרון.

שדה סוּג תיאור
חוצצים מספר זהו הזיכרון המשמש את המאגרים. סכום זה מצוין ב- Mb.
שמור במטמון מספר זה הזיכרון הכולל במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
ממפיס מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
MemTotal מספר זה ה- RAM הכולל במערכת. סכום זה מצוין ב- Mb.
נמחק מספר זה הזיכרון המשמש את המערכת. סכום זה מצוין ב- Mb.
SwapCached מספר זה זיכרון המטמון הכולל שמור.
SwapFree מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
SwapTotal מספר זה סה"כ זיכרון החלפה שמור.
הוחלף מספר זה להחליף את הזיכרון בשימוש על ידי המערכת, על מערכות אופטימלי צריך להיות 0.

אובייקט רשת:

שדה סוּג תיאור
בתוך בתוך מספר הזן תנועה עבור זה ממשק.
לצאת החוצה מספר תנועה פלט עבור זה ממשק.

הצג נתונים סטטיסטיים ברשת

הצג נתונים סטטיסטיים ברשת

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network
zcli statistic-network get

GET /stats/system/network

קבל סיכום של סך קלט ותשומת פלט דרך ממשק רשת.

דוגמה לתגובה:

{
   "description" : "Network interfaces usage",
   "params" : {
      "date" : "Fri Jan 27 11:58:05 2017",
      "hostname" : "api3",
      "interfaces" : [
         {
            "in" : "234.72",
            "interface" : "bond1",
            "out" : "0.00"
         },
         {
            "in" : "77.42",
            "interface" : "eth6",
            "out" : "0.00"
         },
         {
            "in" : "2703.88",
            "interface" : "eth0",
            "out" : "50917.65"
         },
         {
            "in" : "815.69",
            "interface" : "bond2",
            "out" : "4300.38"
        }
      ]
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט עם המקשים הבאים:

שדה סוּג תיאור
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.
ממשקים אובייקט [] נתונים סטטיסטיים של תעבורת הרשת.

ממשקי אובייקט

שדה סוּג תיאור
in מחרוזת סה"כ תעבורת קלט ב- MB.
ממשק מחרוזת שם הממשק.
הַחוּצָה מחרוזת סה"כ תעבורת פלט ב- MB.

הצג נתונים סטטיסטיים של ממשקים

הצג נתונים סטטיסטיים של ממשקים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/network/interfaces
zcli statistics-network get

GET /stats/system/network/interfaces

קבל סיכום של כל ממשק רשת.

דוגמה לתגובה:

{
   "description" : "Interfaces info",
   "params" : {
      "bond" : [
         {
            "in" : "234.72",
            "interface" : "bond1",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "slaves" : [
               "eth2"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "815.70",
            "interface" : "bond3",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "slaves" : [
               "eth4",
               "eth5",
               "eth6"
            ],
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "bond0",
            "ip" : "",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "slaves" : [
               "eth1"
            ],
            "status" : "down",
            "virtual" : [],
            "vlan" : [
               "bond0.10"
            ]
         }
      ],
      "nic" : [
         {
            "in" : "77.42",
            "interface" : "eth6",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "2704.81",
            "interface" : "eth0",
            "ip" : "192.168.101.46",
            "mac" : "9e:2e:3e:a5:2e:6a",
            "out" : "51039.13",
            "status" : "up",
            "virtual" : [
               "eth0:1",
               "eth0:2",
               "eth0.2:6"
            ],
            "vlan" : [
               "eth0.2"
            ]
         },
         {
            "in" : "234.72",
            "interface" : "eth1",
            "ip" : "192.168.101.58",
            "mac" : "c2:d0:d7:64:df:68",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "234.72",
            "interface" : "eth2",
            "ip" : "",
            "mac" : "3a:3a:a7:e3:33:73",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : []
         },
         {
            "in" : "0.00",
            "interface" : "eth3",
            "ip" : "192.168.101.72",
            "mac" : "16:97:ab:43:87:02",
            "out" : "0.00",
            "status" : "down",
            "virtual" : [
               "eth3:1",
               "eth3:8",
               "eth3:6"
            ],
            "vlan" : []
         },
         {
            "in" : "436.89",
            "interface" : "eth4",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "4300.38",
            "status" : "up",
            "virtual" : [
               "eth4.6:5"
            ],
            "vlan" : [
               "eth4.6"
            ]
         },
         {
            "in" : "301.39",
            "interface" : "eth5",
            "ip" : "",
            "mac" : "ea:00:7d:88:1d:bd",
            "out" : "0.00",
            "status" : "up",
            "virtual" : [],
            "vlan" : [
               "eth5.5"
            ]
         }
      ]
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט עם המקשים קשר ו nic.

שדה סוּג תיאור
קשר אובייקט [] סטטיסטיקות ממשק.
nic אובייקט [] נתונים סטטיסטיים ממשק.

אובייקט בונד:

שדה סוּג תיאור
in מחרוזת סה"כ תעבורת קלט ב- MB.
ממשק מחרוזת שם ממשק המשמש כמזהה ייחודי.
ip מחרוזת ה- IP של הממשק.
מק מחרוזת ממשק ה- MAC.
הַחוּצָה מחרוזת סה"כ תעבורת פלט ב- MB.
עבדים מחרוזת [] רשימת עבדים הבונים את ממשק האג"ח.
מצב מחרוזת מצב ממשק. הערך יכול להיות מטה, הממשק מושבת; up, הממשק מאופשר.
וירטואלי מחרוזת [] ממשקים וירטואליים שירשו מממשק זה.
vlan מחרוזת [] ממשקי VLAN היורשים מממשק זה.

אובייקט Nic:

שדה סוּג תיאור
in מחרוזת סה"כ תעבורת קלט ב- MB.
ממשק מחרוזת שם ממשק המשמש כמזהה ייחודי.
ip מחרוזת ה- IP של הממשק.
מק מחרוזת ממשק ה- MAC.
הַחוּצָה מחרוזת סה"כ תעבורת פלט ב- MB.
מצב מחרוזת מצב ממשק. הערך יכול להיות מטה, הממשק מושבת; up, הממשק מאופשר.
וירטואלי מחרוזת [] ממשקים וירטואליים שירשו מממשק זה.
vlan מחרוזת [] ממשקי VLAN היורשים מממשק זה.

הצג נתונים סטטיסטיים של זיכרון

הצג נתונים סטטיסטיים של זיכרון

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/memory
zcli statistics-system get -filter memory

GET /stats/system/memory

קבל סיכום של זיכרון המערכת.

דוגמה לתגובה:

{
   "description" : "Memory usage",
   "params" : {
      "Buffers" : 1.01,
      "Cached" : 42.47,
      "MemFree" : 880.11,
      "MemTotal" : 2005.01,
      "MemUsed" : 1124.91,
      "SwapCached" : 8.27,
      "SwapFree" : 565.15,
      "SwapTotal" : 672,
      "SwapUsed" : 106.84,
      "date" : "Fri Jan 27 12:27:11 2017",
      "hostname" : "api3"
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם מפתח params שערכו הוא אובייקט זיכרון.

זכרון אובייקט.

שדה סוּג תיאור
חוצצים מספר זהו הזיכרון המשמש את המאגרים. סכום זה מצוין ב- Mb.
שמור במטמון מספר זה הזיכרון הכולל במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
ממפיס מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
MemTotal מספר זה ה- RAM הכולל במערכת. סכום זה מצוין ב- Mb.
נמחק מספר זה הזיכרון המשמש את המערכת. סכום זה מצוין ב- Mb.
SwapCached מספר זה זיכרון המטמון הכולל שמור.
SwapFree מספר זה הזיכרון הפנוי הכולל שלא שמור במטמון על ידי המערכת. סכום זה מצוין ב- Mb.
SwapTotal מספר זה סה"כ זיכרון החלפה שמור.
הוחלף מספר זה להחליף את הזיכרון בשימוש על ידי המערכת, על מערכות אופטימלי צריך להיות 0.
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.

הצג נתונים סטטיסטיים של עומס

הצג נתונים סטטיסטיים של עומס

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/load
zcli statistics-system get -filter load

GET /stats/system/load

קבל סיכום של עומס מערכת ה- CPU.

דוגמה לתגובה:

{
   "description" : "System load",
   "params" : {
      "Last_1" : 0.66,
      "Last_15" : 0.39,
      "Last_5" : 0.49,
      "date" : "Fri Jan 27 13:15:01 2017",
      "hostname" : "api3"
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
Last_1 מספר טען את השימוש במערכת בפעם האחרונה.
Last_5 מספר טען את השימוש במערכת בחמש הדקות האחרונות.
Last_15 מספר טען את השימוש במערכת בחמש עשרה הדקות האחרונות.
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.

הצג נתונים סטטיסטיים של CPU

הצג נתונים סטטיסטיים של CPU

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/cpu
zcli statistics-system get -filter cpu

GET /stats/system/cpu

דוגמה לתגובה:

{
   "description" : "System CPU usage",
   "params" : {
      "cores" : 2,
      "date" : "Fri Jan 27 13:30:52 2017",
      "hostname" : "api3",
      "idle" : 94.9,
      "iowait" : 0,
      "irq" : 0,
      "nice" : 0,
      "softirq" : 0,
      "sys" : 3.06,
      "usage" : 5.1,
      "user" : 2.04
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
ליבות מספר מספר הליבות במעבד.
להתבטל מספר מעבד אינו משתמש בשום תוכנית.
כן מספר מעבד המשמש בתהליך קלט או פלט.
Irq מספר מעבד המשמש להפרעות חומרה.
נחמד מספר עדיפות תזמון CPU.
רך מספר מעבד המשמש להפרעות תוכנה.
sys מספר CPU המשמש את המערכת.
שימוש מספר סה"כ מעבד משומש.
המשתמש מספר CPU המשמש את המשתמש.
נתונים מחרוזת תאריך מערכת.
המארח מחרוזת שם המארח.

הצג נתונים סטטיסטיים של חיבורים

הצג נתונים סטטיסטיים של חיבורים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/system/connections
zcli statistics-network-connections get

GET /stats/system/connections

קבל את סך החיבורים הנוכחיים במערכת. הדלפק מסכם כל סוג של חיבורים במעקב: ASSURED, ESTABLISHED, SYN_SENT, TIME_WAIT, LISTEN ...

דוגמה לתגובה:

{
   "description" : "System connections",
   "params" : {
      "connections" : 324
   }
}

פרמטרים של תגובה

שדה סוּג תיאור
חיבורים מספר סה"כ חיבורי מעקב.

הצג מספר חוות

הצג מספר חוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/total

GET /stats/farms/total

הצג את סך החוות שנוצרו במערכת.

דוגמה לתגובה:

{
   "description" : "Number of farms.",
   "number" : 8
}

פרמטרים של תגובה

שדה סוּג תיאור
מספר מספר זהו מספר החוות הקיימות במערכת.

הצג נתונים סטטיסטיים של חוות

הצג נתונים סטטיסטיים של חוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms
statistics-farm list

GET /stats/farms

קבל סיכום של חיבורים ותצורה עבור כל החוות במערכת.

דוגמה לתגובה:

{
   "description" : "List all farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "testHttps",
         "pending" : 0,
         "profile" : "https",
         "status" : "up",
         "vip" : "192.168.101.20",
         "vport" : "120"
      },
      {
         "established" : 0,
         "farmname" : "httpFarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "8080"
      },
      {
         "established" : 0,
         "farmname" : "testDL",
         "pending" : 0,
         "profile" : "datalink",
         "status" : "up",
         "vip" : "192.168.102.72",
         "vport" : "eth1"
      },
      {
         "established" : 0,
         "farmname" : "testL4",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "30"
      },
      {
         "established" : 0,
         "farmname" : "testGSLB",
         "pending" : 0,
         "profile" : "gslb",
         "status" : "up",
         "vip" : "192.168.10.31",
         "vport" : "53"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
נוסד מספר המספר הכולל של החיבורים שהוקמו כעת.
שם החווה מחרוזת שם החווה, מזהה ייחודי.
תלוי ועומד מספר מספר החיבורים הממתינים.
פרופיל מחרוזת סוג החווה. הערכים האפשריים הם: DataLink, l4xnat, http, https or גסלב. כל פרופיל מוגדר בקטע שלו.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב.

הראה סטטיסטיקה של חוות

הראה סטטיסטיקה של חוות

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/farmname
zcli statistic-farm list

GET /stats/farms/<farmname>

מציג את מצב החווה הנוכחי, סטטוס ה- backend והקשרים שלהם. כל משק יגיב עם אובייקט אחר, תלוי בפרופיל.

דוגמת תגובה עבור חוות HTTP:

{
   "backends" : [
      {
         "established" : 0,
         "id" : 0,
         "ip" : "192.168.0.168",
         "pending" : 0,
         "port" : 80,
         "service" : "srv1",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
         "client" : "0",
         "id" : "0"
         "backend_ip" : "192.168.0.168"
         "backend_port" : 80
         "service" : "srv1",
         "session" : "192.168.0.186",
         "ttl" : "1m28s0ms"
      }
   ],
   "total_sessions" : 1
}

פרמטרי תגובה בחוות HTTP

שדה סוּג תיאור
backends אובייקט [] הצג מידע על backends.
הפעלות אובייקט [] הצג מידע על פעילויות באתר.
total_sessions מספר מגרסה 4.0.2. מציג את המספר הכולל של הפעלות רשומות.

אובייקט Backend

שדה סוּג תיאור
נוסד מספר המספר הכולל של חיבורים מבוססים.
id מספר מזהה ייחודי של Backend.
ip מחרוזת IP שבו השירות האמיתי מקשיב.
תלוי ועומד מספר מספר החיבורים הממתינים.
נמל מספר נמל שבו השירות האמיתי מקשיב.
שרות מחרוזת שם השירות המשמש כמזהה ייחודי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.

אובייקט מושב

שדה סוּג תיאור
לקוחות מחרוזת מזהה ייחודי של לקוח.
id מחרוזת מזהה ייחודי של Backend שהוקצה ללקוח.
שרות מחרוזת מזהה ייחודי של שירות שהוקצה ללקוח.
מושב מחרוזת מזהה ייחודי של מושב. ערך זה תלוי בסוג ההתמדה.
Ttl מחרוזת מגרסה 4.0.2. הזמן שנותר עד לסיום הפגישה
backend_ip מחרוזת מגרסה 4.0.2. Backend IP שהוקצה ללקוח.
backend_port מחרוזת מגרסה 4.0.2. יציאת אחורי שהוקצתה ללקוח.

דוגמת תגובה לחוות GSLB:

{
   "backends" : [
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "192.168.55.40",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 4,
         "ip" : "192.135.10.2",
         "port" : 53,
         "service" : "service1",
         "status" : "down"
      },
      {
         "id" : 1,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      },
      {
         "id" : 2,
         "ip" : "127.0.0.1",
         "port" : 80,
         "service" : "prioServ",
         "status" : "down"
      }
   ],
   "client" : {
      "edns_big" : 0,
      "edns_tc" : 0,
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0,
      "tc" : 0
   },
   "description" : "List farm stats",
   "extended" : {
      "badvers" : 0,
      "dropped" : 0,
      "edns" : 0,
      "edns_clientsub" : 0,
      "formerr" : 0,
      "noerror" : 0,
      "notimp" : 0,
      "nxdomain" : 0,
      "refused" : 0,
      "v6" : 0
   },
   "server" : {
      "recvfail" : 0,
      "reqs" : 0,
      "sendfail" : 0
   }
}

פרמטרי תגובה בחוות GSLB

שדה סוּג תיאור
backends אובייקט [] הצג מידע על backenders.
לקוחות חפץ סטטיסטיקה הקשורים ללקוח.
מוּרחָב חפץ מידע מורחב על השירות.
שרת חפץ סטטיסטיקה הקשורה לשרת.

אובייקט Backend

שדה סוּג תיאור
id מספר מזהה ייחודי של Backend.
ip מחרוזת IP שבו השירות האמיתי מקשיב.
נמל מספר נמל שבו השירות האמיתי מקשיב.
שרות מחרוזת שם השירות המשמש כמזהה ייחודי.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; לא מוגדר, מצב backend לא נבדק.

אובייקט לקוח

שדה סוּג תיאור
edns_big מספר תגובות שהיו גדולות מ 512 בתים.
edns_tc מספר גודל מאגר ה- DNS המורחב שצוין של הלקוח היה קטן מדי לנתונים המבוקשים.
recvfail מספר מספר שגיאות UDP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת קבלתן.
reqs מספר המספר הכולל של בקשות UDP המטופלות על ידי השרת.
לשלוח מספר מספר שגיאות UDP, שבהן מערכת ההפעלה הצביעה על כך שמשהו רע קרה בעת השליחה.
tc מספר תגובות שנקטעו עם bit סיביות להגדיר.

אובייקט מורחב

שדה סוּג תיאור
רע מספר בקשה עם EDNS OPT-RR עם גרסה לא נתמכת.
ירד מספר בקשות שהושלכו לפורמט לא תקין.
אדנס מספר הבקשה הכילה EDNS OPT-RR.
edns_clientsub מספר Subset of edns מבקש לציין את האפשרות edns_client_subnet.
צורה מספר הבקשה בוצעה בצורה גרועה אך הייתה שפויה מספיק כדי ששלחנו תגובה עם ה- rcode FORMERR.
טרור מספר בקשות מוצלחות.
לא מספר שירות המבוקש לא מיושם על ידי daemon זה, כגון בקשות להעביר אזור.
nxdomain מספר בקשה לשם דומיין שאינו קיים.
סירב מספר הבקשה נדחתה על ידי השרת משום שהשרת אינו סמכותי עבור שם השאילתה.
v6 מספר בקשה מלקוח IPv6.

אובייקט שרת

שדה סוּג תיאור
recvfail מספר מספר שגיאות TCP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת קבלתן.
reqs מספר המספר הכולל של בקשות TCP המטופלות על ידי השרת.
לשלוח מספר מספר שגיאות TCP, שבהן מערכת ההפעלה ציינה שמשהו רע קרה בעת שליחתן.

דוגמת תגובה עבור חוות L4xNAT:

{
   "backends" : [
      {
         "established" : 5,
         "id" : 1,
         "ip" : "192.168.5.40",
         "pending" : 0,
         "port" : "8080",
         "status" : "maintenance"
      },
      {
         "established" : null,
         "id" : 3,
         "ip" : "192.5.1.1",
         "pending" : 0,
         "port" : "787",
         "status" : "down"
      },
      {
         "established" : 1,
         "id" : 5,
         "ip" : "192.168.5.100",
         "pending" : 0,
         "port" : "8080",
         "status" : "up"
      }
   ],
   "description" : "List farm stats",
   "sessions" : [
      {
     "client": 0,
         "id" : 5,
         "backend_ip" : "192.168.5.100",
         "backend_port" : "8080",
         "session" : "192.168.5.100",
         "ttl" : "1m51s564ms",
         "type" : "dynamic"
      }
   ],
   "total_sessions" : 1

}

פרמטרי תגובה בחוות L4xNAT

התגובה תהיה JSON עם אובייקט backends ו הפעלות:

אובייקט Backend:

שדה סוּג תיאור
נוסד מספר המספר הכולל של החיבורים שהוקמו כרגע.
id מספר מזהה ייחודי של Backend.
ip מחרוזת IP שבו השירות האמיתי מקשיב.
תלוי ועומד מספר מספר החיבורים הממתינים.
נמל מספר נמל שבו השירות האמיתי מקשיב.
מצב מחרוזת מצב אחורה. הערכים האפשריים הם: up, החווה פועלת ואת backend הוא מוכן לקבל חיבורים; מטה, החווה פועלת והשירות זיהה כי backend לא עובד; תחזוקה, backend מסומן כלא מוכן לקבלת חיבורים על ידי מנהל המערכת, אפשרות זו שימושית למשימות התחזוקה של backend; לא מוגדר, מצב backend לא נבדק.

אובייקט מושב:

שדה סוּג תיאור
לקוחות מספר מזהה רצף של הפעלה.
id מספר אחורה מזהה ייחודי שבו הלקוח מוקצה.
מושב מחרוזת מזהה ייחודי של פעילות באתר. זהו ה- IP של הלקוח.
סוג מחרוזת הערכים הם: סטטי או דינמי. סטטי אם הפגישה נעשתה באופן ידני ודינמית אם הפגישה נעשתה באופן אוטומטי.
Ttl מחרוזת מגרסה 4.0.2. הזמן שנותר עד לסיום הפגישה
backend_ip מחרוזת מגרסה 4.0.2. ip backend שהוקצה ללקוח.
backend_port מספר מגרסה 4.0.2. יציאת אחורי שהוקצתה ללקוח.

הנתונים הסטטיסטיים של Datalink אינם זמינים בפועל.

הצגת מצב מודול

הצגת מצב מודול

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/modules

GET /stats/farms/modules

קבל סיכום של מודולים סטטיסטיים. שיחה זו מציגה כל מצב של המודול, מספר התצורות המוגדרות, מספר החוות שהושבתו ומעלה.

הגדרת המודולים נמצאת ב חוות סָעִיף.

דוגמה לתגובה:

{
   "description" : "Module status",
   "params" : {
      "dslb" : {
         "critical" : 0,
         "down" : 1,
         "problem" : 0,
         "total" : 2,
         "up" : 1
      },
      "gslb" : {
         "critical" : 0,
         "down" : 0,
         "problem" : 0,
         "total" : 1,
         "up" : 1
      },
      "lslb" : {
         "critical" : 0,
         "down" : 2,
         "problem" : 0,
         "total" : 4,
         "up" : 2
      }
   }
}

פרמטרים של תגובה

התגובה תהיה JSON עם שלושה מפתחות: dslb, גסלב ו לסלב.

שדה סוּג תיאור
קריטי מספר מספר חוות במצב קריטי. החווה היא קריטית כאשר היא מעלה את כל backends הם בלתי מושגת (למטה או תחזוקה).
מטה מספר מספר חוות שנעצרו. החוות נעצרות על ידי מנהל המערכת.
בְּעָיָה מספר מספר חוות בבעיה. החווה היא בעיה כאשר היא למעלה וכמעט backend נמצא במצב למטה.
סה"כ מספר מספר החוות.
up מספר מספר חוות הפועלות. הנה מוצג תחזוקה וצריך להפעיל מחדש את מצב החווה.

הצג נתונים סטטיסטיים של מודול

הצג נתונים סטטיסטיים של מודול

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/stats/farms/modules/lslb

GET /stats/farms/modules/<module>

הראה סטטיסטיקות חווה של מודול שצוין.

הערכים הזמינים עבור מודול הפרמטר הם: לסלב, גסלב or dslb.

דוגמה לתגובה:

{
   "description" : "List lslb farms stats",
   "farms" : [
      {
         "established" : 0,
         "farmname" : "newfarm",
         "pending" : 0,
         "profile" : "http",
         "status" : "up",
         "vip" : "192.168.100.199",
         "vport" : "40"
      },
      {
         "established" : 0,
         "farmname" : "nwl4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "down",
         "vip" : "192.168.100.241",
         "vport" : "88"
      },
      {
         "established" : 0,
         "farmname" : "l4farm",
         "pending" : 0,
         "profile" : "l4xnat",
         "status" : "up",
         "vip" : "192.168.100.102",
         "vport" : "70"
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מידע על חוות במודול.

שדה סוּג תיאור
נוסד מספר המספר הכולל של החיבורים שהוקמו כרגע.
שם החווה מחרוזת שם החווה, מזהה ייחודי לחוות.
תלוי ועומד מספר מספר החיבורים הממתינים.
פרופיל מחרוזת סוג החווה. הערכים האפשריים הם: DataLink, l4xnat, http, https or גסלב. כל פרופיל מוגדר כשלעצמו.
מצב מחרוזת מצב משק. ערכי הסטטוס הזמינים הם: מטה, החווה אינה פועלת; יש צורך מחדש, החווה היא למעלה אבל זה תלוי ועומד על הפעלה מחדש; קריטי, החווה היא למעלה כל backends הם בלתי מושגת או תחזוקה; בְּעָיָה, החווה היא מעלה ויש כמה backend בלתי מושגת, אבל כמעט backend הוא במעמד; תחזוקה, החווה היא מעלה ויש backends במעמד למעלה, אבל כמעט backend נמצא במצב תחזוקה; up, החווה היא מעלה את כל backends הם עובדים בהצלחה.
החברים מחרוזת IP של החווה, שבו השירות וירטואלי מקשיב.
גווניה מחרוזת נמל של החווה, שבו השירות וירטואלי מקשיב.

ניטור - גרפים

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

כמו כן, תוכל לגשת להיסטוריה השבועית, החודשית והשנתית.

גרפים עם מידע מגיבים בפורמט base64.

רשימת תרשימים זמינים

רשימת תרשימים זמינים

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs

GET /graphs

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

דוגמה לתגובה:

{
   "description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
   "farms" : [
      "l4farm",
      "newfarm",
      "gslbfarm",
      "nwl4farm",
      "httpweb"
   ],
   "interfaces" : [
      "eth0.1",
      "eth2",
      "eth1",
      "eth3",
      "bondiface",
      "eth0"
   ],
   "system" : [
      "cpu",
      "load",
      "ram",
      "swap",
      {
         "disk" : [
            "root/",
            "root/boot",
            "root/usr/local/zenloadbalancer/config",
            "root/var/log"
         ]
      }
   ]
}

פרמטרים של תגובה

התגובה תהיה JSON שלושה סוגים של גרפים, חוות, ממשקים ו מערכת.

שדה סוּג תיאור
חוות מחרוזת [] רשימת גרפים חקלאיים זמינים.
ממשקים מחרוזת [] רשימת גרפי ממשק זמינים.
מערכת אובייקט [] רשימת גרפי המערכת הזמינים. למערך יש אובייקט עם מערך המציין נקודות הרכבה לדיסק.

אובייקט מערכת:

אובייקט המערכת מכיל רשימת מערכים הקשורה למערכת ואובייקטים דיסק עם הפורמט הבא.

שדה סוּג תיאור
דיסק מחרוזת [] הערכים של מערך זה הם כולם קיימים נקודות במערכת, לכל אחד יש גרפים זמינים.

הצג תרשימים

הצג תרשימים

בקש דוגמה לחווה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb

בקש דוגמה עבור ממשק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3

בקש דוגמה לדיסק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/system/disk/root/boot

GET /graphs/<graph>

הערכים הזמינים עבור גרף הם:

ערך תיאור
farms/<farmname> שם החווה, מזהה ייחודי לחווה.
interfaces/<interface> ממשק, מזהה ייחודי של ממשק.
system/<system> מערכת, גרפים אפשריים של המערכת הם: מעבד, לִטעוֹן, RAM or להחליף.
system/disk/<mount point> נקודת הר, הוא ערך של דיסק אובייקט, הוחזר בשיחת 'GET / graphs'.

דוגמה לתגובה:

{
   "description" : "Get cpu graphs",
   "graphs" : [
      {
         "frequency" : "daily",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "weekly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "monthly",
         "graph" : "PNG IN BASE 64"
      },
      {
         "frequency" : "yearly",
         "graph" : "PNG IN BASE 64"
      }
   ]
}

פרמטרים של תגובה

שדה סוּג תיאור
תדר מחרוזת תקופה המשמשת להפקת הגרף. הערכים האפשריים הם: יומי, שבועי, אחת לחודש or שְׁנָתִי.
גרפים מחרוזת גרף בפורמט base64.

הצג תרשים תדירות

הצג תרשים תדירות

בקש דוגמה לחווה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/farms/httpweb/daily

בקש דוגמה עבור ממשק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/interfaces/eth3/monthly

בקש דוגמה לדיסק:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/graphs/system/disk/root/boot/yearly

GET /graphs/<graph>/<frequency>

הערכים הזמינים עבור גרף הם:

ערך תיאור
farms/<farmname> שם החווה, מזהה ייחודי לחווה.
interfaces/<interface> ממשק, מזהה ייחודי של ממשק.
system/<system> מערכת, גרפים אפשריים של המערכת הם: מעבד, לִטעוֹן, RAM or להחליף.
system/disk/<mount point> נקודת הר, הוא ערך של דיסק אובייקט, הוחזר בשיחת 'GET / graphs'.

הערכים הזמינים עבור תדר הם:

שדה סוּג תיאור
תדר מחרוזת תקופה המשמשת להפקת הגרף. הערכים האפשריים הם: יומי, שבועי, אחת לחודש or שְׁנָתִי.

דוגמה לתגובה:

{
    "description" : "Get farm graphs",
    "graph" : "PNG IN BASE 64"
}

פרמטרים של תגובה

שדה סוּג תיאור
גרפים מחרוזת גרף בפורמט base64.

IPDS

מודול זה הוא יישום של שב"ס (מערכת מניעת חדירת) ו IDS (מערכת איתור חדירה) מערכת המציעה למשתמש שכבת אבטחה. מודול ה- IPDS בודק את התנועה רק לפני הגעה למודולים של איזון עומס LSLB or GSLB, אם התנועה מזוהה כזדונית, היא תידחה.

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

הכללים הזמינים החלים על זאבנט יכולים להיות רשימות שחורות, DoS, RBL or WAF.

אחזר חבילת IPDS

אחזר חבילת IPDS

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package
zcli ipds-package get

GET /ipds/package

אחזר את פרטי החבילה של zevenet-ipds. חבילה זו מכילה כללים מעודכנים עבור כל מודול IPDS.

דוגמה לתגובה:

{
   "description" : "zevenet-ipds package status info",
   "params" : {
      "frequency" : 0,
      "mode" : "disabled",
      "ruleset_date" : "05-06-2019",
      "scheduled" : "none",
      "status" : "Updates available",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מקש מוגדר params, הערך שלה יהיה המידע על חבילת ה- IPDS.

שדה סוּג תיאור
מצב מחרוזת מציג את פרטי סטטוס העדכון לגבי חבילת ה- IPDS. אם החבילה מותקנת, אם היא מעודכנת ואם יש עדכונים ממתינים.
הגדרת חוקים_תאריך מחרוזת זהו התאריך בו נבנתה החבילה. זה לא התאריך המותקן.
מתוכנן מחרוזת הודעה תיאורית מסבירה את תצורת לוח הזמנים.
מצב מחרוזת זה מציין באיזו תדירות העדכון יתרחש או להשבית את לוח הזמנים. הערכים הזמינים הם: יומי קבעו את העדכון שייעשה בכל יום, הוא מאפשר לשדה התדירות לציין כמה שעות יחזור על העדכון, מהזמן שנקבע; שבועי, קבע את העדכון שייעשה פעם בשבוע, זה מאפשר את תדר בתור יום השבוע כדי לציין באיזה יום בשבוע יתעדכן העדכון (מיום שני עד ראשון); אחת לחודש, קבעו את העדכון שייעשה פעם בחודש.
תדר מספר If מצב הוא יומי, התדירות היא מספר השעות שבין עדכון החבילה מ- זמן; אם מצב הוא שבועי, הערך הצפוי הוא מספר יום השבוע (מיום שני, 1, עד יום ראשון, 7); אם מצב הוא חודשי, הערך הצפוי הוא מספר החודש (החל מ- 1 ל 31).
זמן חפץ מאפשר לקבוע באיזו שעה יתרחש העדכון או מאיזו שעה תתעדכן החבילה אם המצב מוגדר כ- Daily ותדירות גדולה מ- 0.

אובייקט זמן:

אובייקט זה, שעה: דקה, הוא השעה בה תעדכן החבילה.

שדה סוּג תיאור
שעה מספר האם השעה היא בפורמט 0 ל 23.
דקה מספר הם הפרוטוקולים בצורת פורמט 0 ל 59.

החל פעולה על חבילת IPDS

החל פעולה על חבילת IPDS

דוגמה לבקשה לעדכון כללי ה- IPDS:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"action":"upgrade"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions
zcli ipds-package upgrade

דוגמה לתגובה:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "ruleset_date" : "07-06-2019",
      "status" : "Installed and updated"
   }
}

דוגמה לבקשה לתזמון עדכונים:

curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"mode":"daily","frequency":1,"time":{"hour":0,"minute":0},"action":"schedule"}'
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds/package/actions

דוגמה לתגובה:

{
   "desc" : "Execute an action over the zevenet-ipds package",
   "params" : {
      "frequency" : 1,
      "mode" : "daily",
      "scheduled" : "daily from 0:00 to 23:00 each 1 hours",
      "status" : "Installed and updated",
      "time" : {
         "hour" : 0,
         "minute" : 0
      }
   }
}

POST /ipds/package

החל פעולה לגבי חבילת zevenet-ipds.

פרמטרים של בקשה

שדה סוּג תיאור דרוש
פעולה מחרוזת זו הפעולה להחיל לגבי חבילת כללי ה- IPDS. האפשרויות הן: שדרוג לאלץ שדרוג של החבילה. לוח זמנים כדי להגדיר את המערכת משדרגת החבילה במחזוריות.
מצב מחרוזת זה מציין באיזו תדירות העדכון יתרחש או להשבית את לוח הזמנים. הערכים הזמינים הם: יומי קבעו את העדכון שייעשה בכל יום, הוא מאפשר לשדה התדירות לציין כמה שעות יחזור על העדכון, מהזמן שנקבע; שבועי, קבע את העדכון שייעשה פעם בשבוע, זה מאפשר את תדר בתור יום השבוע כדי לציין באיזה יום בשבוע יתעדכן העדכון (מיום שני עד ראשון); אחת לחודש, קבעו את העדכון שייעשה פעם בחודש.
תדר מספר If מצב הוא יומי, התדירות היא מספר השעות בין טופס עדכון החבילה זמן; אם מצב הוא שבועי, הערך הצפוי הוא מספר יום השבוע (מיום שני, 1, עד יום ראשון, 7); אם מצב הוא חודשי, הערך הצפוי הוא מספר החודש (החל מ- 1 ל 31).
זמן חפץ מאפשר לקבוע באיזו שעה יתרחש העדכון או מאיזו שעה תתעדכן החבילה אם המצב מוגדר כ- Daily ותדירות גדולה מ- 0.

אובייקט זמן:

אובייקט זה, שעה: דקה, הוא השעה בה תעדכן החבילה.

שדה סוּג תיאור
שעה מספר האם השעה היא בפורמט 0 ל 23.
דקה מספר הם הפרוטוקולים בצורת פורמט 0 ל 59.

פרמטרים של תגובה

התגובה תהיה אובייקט JSON עם מקש מוגדר params. הערך של זה יהיה המידע על חבילת ה- IPDS.

שדה סוּג תיאור
מצב מחרוזת מציג את פרטי סטטוס העדכון לגבי חבילת ה- IPDS. אם החבילה מותקנת, אם היא מעודכנת ואם יש עדכונים ממתינים.
הגדרת חוקים_תאריך מחרוזת זהו התאריך בו נבנתה החבילה. זה לא התאריך המותקן.
מתוכנן מחרוזת הודעה תיאורית מסבירה את תצורת לוח הזמנים.
מצב מחרוזת זה מציין באיזו תדירות העדכון יתרחש או להשבית את לוח הזמנים. הערכים הזמינים הם: יומי קבעו את העדכון שייעשה בכל יום, הוא מאפשר לשדה התדירות לציין כמה שעות יחזור על העדכון, מהזמן שנקבע; שבועי, קבע את העדכון שייעשה פעם בשבוע, זה מאפשר את תדר בתור יום השבוע כדי לציין באיזה יום בשבוע יתעדכן העדכון (מיום שני עד ראשון); אחת לחודש, קבעו את העדכון שייעשה פעם בחודש.
תדר מספר If מצב הוא יומי, התדירות היא מספר השעות שבין עדכון החבילה מ- זמן; אם מצב הוא שבועי, הערך הצפוי הוא מספר יום השבוע (מיום שני, 1, עד יום ראשון, 7); אם מצב הוא חודשי, הערך הצפוי הוא מספר החודש (החל מ- 1 ל 31).
זמן חפץ מאפשר לקבוע באיזו שעה יתרחש העדכון או מאיזו שעה תתעדכן החבילה אם המצב מוגדר כ- Daily ותדירות גדולה מ- 0.

אובייקט זמן:

אובייקט זה, שעה: דקה, הוא השעה בה תעדכן החבילה.

שדה סוּג תיאור
שעה מספר האם השעה היא בפורמט 0 ל 23.
דקה מספר הם הפרוטוקולים בצורת פורמט 0 ל 59.

ציין את כל כללי ה- IPDS

רשימת כללים ipds

דוגמה לבקשה:

curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v4.0/zapi.cgi/ipds
zcli ipds list

GET /ipds

ציין את כל כללי ה- IPDS הקיימים במערכת.

דוגמה לתגובה:

{
   "description" : "List the available IPDS rules.",
   "params" : [
      {