نوصي بشدة بمراجعة سياسة الدعم لواجهة برمجة التطبيقات من Cato قبل البدء في استخدامها.
نظرة عامة على updateSocketInterface
استخدم واجهة برمجة التطبيقات updateSocketInterface mutation لتحديث إعدادات واجهة المقبس التالية في قسم المقبس لموقع في تطبيق إدارة Cato (الشبكة > المواقع > {اسم الموقع} > تكوين الموقع > المقبس)
الوجهة للواجهة
الاسم
إعدادات واجهة الشبكة المحلية (LAN)
عرض النطاق الترددي للموقع
إعدادات واجهة الشبكة الواسعة (WAN)
خارج السحابة (لوجهة Cato)
إعدادات واجهة الشبكة الواسعة البديلة (Alt WAN)
عضو في LAG (تجميع الروابط)
نوع VRRP
تحديد موقع معرف الموقع لموقع
لا يظهر معرف الموقع في تطبيق إدارة Cato، يمكنك تحديد معرف الموقع:
باستخدام استعلام واجهة برمجة التطبيقات entityLookup (راجع واجهة برمجة التطبيقات Cato - EntityLookup)، استخدم
النوعبالقيمة الموقعيمكنك أيضًا استخدام معامل
searchبالقيمة كاسم الموقع، ويعيد الاستعلام معرف الموقعالرقم في عنوان URL لتطبيق إدارة Cato، عند اختيارك لموقع (الشبكة > المواقع > {اسم الموقع}). على سبيل المثال، معرف الموقع هو ١٢٣٤٥ لعنوان URL التالي: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics
فهم القيم socketInterfaceId للمقبس
ال socketInterfaceId هو تعداد يحتوي على قيم لمقابس Cato. تظهر أسماء الواجهات في شاشة المقابس لموقع (الشبكة > المواقع > {اسم الموقع} > تكوين الموقع > المقبس) كما يلي:
مقبس X1500 - تلقائي، LAN1، LAN2، WAN1، WAN2، WAN3، USB1، USB2
مقبس X1600 - 1-8، USB1، USB2
مقبس X1700 - INT_1 - INT_12
تفاصيل المدخلات updateSocketInterfaceInput
هذه هي المعاملات لتحديث إعدادات واجهة المقبس التالية لموقع باستخدام واجهة برمجة التطبيقات لتكوين Cato. المعامل destType هو المعامل الإجباري الوحيد، وإلا قم بتضمين المعاملات لإعدادات واجهة المقبس التي تقوم بتحديثها.
نوع الوجهة - الوجهة للواجهة
الاسم - اسم الموقع
الشبكة المحلية - إعدادات واجهة الشبكة المحلية (LAN)
عرض النطاق الترددي - عرض النطاق الترددي للموقع للتيار الصاعد والتيار النازل
الشبكة الواسعة - إعدادات واجهة الشبكة الواسعة (WAN)
خارج السحابة - إعدادات خارج السحابة للواجهات ذات الوجهة Cato
الشبكة الواسعة البديلة - إعدادات الواجهات مع الوجهة الشبكة الواسعة البديلة أو الشبكة الواسعة البديلة (الطبقة-2)
تجميع الروابط - للوجهة LAN LAG الرئيسي، الحد الأدنى لعدد الروابط (بما في ذلك الرابط الأساسي والفرعي) لهذا التجميع الروابط (LAG)
نوع VRRP - لتكوين التوافر العالي (HA) للمقبس، نوع اتصال VRRP بين المقابس
واجهة برمجة التطبيقات updateSocketInterfaceInput نوع الوجهة
المعامل destType هو معامل تعداد، يحدد الوجهة للواجهة.
هذه هي الخيارات:
CATO - حركة مرور الشبكة الواسعة للسحابة Cato
الشبكة المحلية - الشبكة المحلية الداخلية خلف المقبس
VRRP_AND_LAN - للتوافر العالي للمقبس، تُستخدم الواجهة لحركة مرور الشبكة المحلية و VRRP
الواجهة غير مفعلة - الواجهة معطلة وليست تمرير حركة المرور
البديل - حركة مرور الشبكة الواسعة ليست عبر السحابة Cato، مثل MPLS
الشبكة الواسعة الطبقة-2 - خيار الشبكة الواسعة البديلة (الطبقة-2) لشبكة MPLS مع مواقع المقبس على نفس الشبكة الفرعية
VRRP - للتوافر العالي للمقبس، تُستخدم الواجهة فقط لحركة مرور VRRP
LAN_LAG_MASTER_AND_VRRP - للتوافر العالي للمقبس وتكوين LAN LAG، تكون الواجهة هي LAN LAG الرئيسي وتُستخدم لحركة مرور VRRP
LAN_LAG_MASTER - لتكوين LAN LAG، تكون الواجهة هي LAN LAG الرئيسي
LAN_LAG_MEMBER - لتكوين LAN LAG، تكون الواجهة عضو في LAN LAG
LAN_AND_HA - للتوافر العالي لـ vSocket في Azure و AWS، الواجهة لحركة مرور الشبكة المحلية والتوافر العالي
واجهة برمجة التطبيقات updateSocketInterfaceInput الاسم
المعامل name هو لاسم واجهة المقبس.
واجهة برمجة التطبيقات updateSocketInterfaceInput الشبكة المحلية
المعاملات lan هي لإعدادات واجهة الشبكة المحلية (LAN) للمقبس.
هذه هي الخيارات:
الشبكة الفرعية - النطاق الأصلي لواجهة الشبكة المحلية بتنسيق CIDR
عنوان IP المحلي - عنوان IP المحلي لنطاق شبكة LAN
واجهة برمجة التطبيقات updateSocketInterfaceInput عرض النطاق الترددي
بالنسبة للواجهات المستخدمة لحركة مرور الشبكة الواسعة (WAN)، تحدد المعاملات bandwidth عرض النطاق الترددي للتيار الصاعد والتيار النازل للواجهة.
هذه هي الخيارات:
upstreamBandwidth - أقصى عرض نطاق للتيار الصاعد لهذه الواجهة
downstreamBandwidth - أقصى عرض نطاق للتيار الهابط لهذه الواجهة
updateSocketInterfaceInput wan
الوسيطات wan لإعدادات واجهة WAN لمقبس. بشكل عام، تُستخدم أدوار WAN لتحديد حركة المرور في قواعد الشبكة. يُستخدم التسلسل لمفاضلة الفشل في مقبس ذو واجهات نشطة وخاملة
هذه هي الخيارات:
role - تحديد الدور لواجهة WAN: none, automatic, wan_1, wan_2, wan_3
precedence - تحديد أولوية الفشل للواجهة: ACTIVE, PASSIVE, LAST_RESORT
LAST_RESORT هي الواجهة ذات الأولوية الأدنى
updateSocketInterfaceInput offCloud
الوسيطات offCloud لمواقع المقبس التي تستخدم ميزة Off-Cloud لتوجيه حركة المرور عبر الإنترنت العامة بدلاً من سحابة Cato.
هذه هي الخيارات:
enabled - القيمة المنطقية، عند
trueيتم تمكين حركة المرور خارج السحابة للموقعpublicIP (اختياري) - يحدد عنوان IP عام ثابت لبدء الاتصال بالإنترنت
publicStaticPort (اختياري) - يحدد رقم منفذ ثابت لحركة المرور خارج السحابة
updateSocketInterfaceInput altWan
الوسيطات altWan لمواقع المقبس التي تتصل بشبكة WAN بديلة، مثل MPLS. بشكل عام، تُستخدم IPs خاصة وواجهات للاتصال المباشر بمزود خدمة MPLS.
هذه هي الخيارات:
privateInterfaceIp - عنوان IP خاص لواجهة المقبس لحركة المرور
privateNetwork - نطاق IP خاص (مع CIDR) للـ LAN
privateGatewayIp - عنوان IP خاص للبوابة WAN البديلة (مثل جدار حماية MPLS أو الموجه)
privateVlanTag (اختياري) - علامة VLAN للواجهة (عنوان IP خاص)
publicInterfaceIP (اختياري) - عنوان IP عام لواجهة المقبس لحركة المرور
publicNetwork (اختياري) - نطاق IP عام (مع CIDR) للـ LAN
publicGatewayIp (اختياري) - عنوان IP عام لبوابة WAN البديلة (مثل جدار حماية MPLS أو الموجه)
publicVlantag (اختياري) - علامة VLAN للواجهة (عنوان IP عام)
updateSocketInterfaceInput lag
الوسيط lag لواجهة LAG LAN الرئيسية ويحدد الحد الأدنى من عدد الواجهات (بما في ذلك الرئيسية والأعضاء) لـ LAG لهذا الموقع.
هذا هو الخيار:
minLinks - الحد الأدنى لعدد الواجهات (الروابط) في LAG
updateSocketInterfaceInput vrrp
الوسيط vrrp لتكوينات HA لمقبس ويحدد نوع اتصال VRRP بين المقابس لرسائل keepalive.
هذه هي الخيارات:
VIA_SWITCH - اتصال VRRP موجه عبر مفتاح بين المقابس
DIRECT_LINK - اتصال VRRP موجه مباشرة بين المقابس
نموذج سكريبت Postman
نموذج البرنامج - تحديث النطاق الأصلي والاسم
هذا مثال لاستخدام واجهة برمجة التطبيقات لتغيير اسم واجهة LAN1 إلى LAN-01، وتحديث الشبكة الفرعية و localIP للنطاق الأصلي للمقبس.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}متغيرات GraphQL
{
"accountId": "26",
"siteId": 26,
"socketInterfaceId": "LAN1",
"input": {
"name": "LAN-01",
"destType": "LAN",
"lan": {
"subnet": "10.0.0.0/24",
"localIp": "10.0.0.1"
}
}
}نموذج البرنامج - تغيير عرض النطاق الترددي والاسم
هذا مثال على استخدام واجهة برمجة التطبيقات لتغيير عرض النطاق الترددي والاسم لواجهة WAN.
mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
site(accountId: $accountId) {
updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
siteId
socketInterfaceId
}
}
}متغيرات GraphQL
{
"accountId": "26",
"siteId": 126,
"socketInterfaceId": "WAN1",
"input": {
"name": "WAN Demo",
"destType": "CATO",
"bandwidth": {
"upstreamBandwidth": 100,
"downstreamBandwidth": 100
}
}
}