واجهة برمجة التطبيقات لتكوين - إضافة، تحديث، وإزالة نطاق الشبكة

توضح هذه المقالة كيفية استخدام واجهة برمجة تطبيقات Cato لإدارة نطاقات الشبكة لموقع باستخدام هذه الأوامر:

addNetworkRange
updateNetworkRange
removeNetworkRange

نظرة عامة على networkRange

استخدم واجهات برمجة التطبيقات لتحويل الشبكة لإضافة وتحديث وإزالة نطاقات الشبكة لموقع Socket في حسابك وتحديد الإعدادات التالية للموقع:

معرف نطاق الشبكة (يتم إنشاؤه تلقائيًا لـ addNetworkRange)
معرف واجهة LAN Socket
الإعدادات لنطاق الشبكة بما في ذلك: الشبكة الفرعية، IP المحلي أو IP البوابة، و VLAN
لعناوين Azure vSocket HA، عنوان IP العائم
إعدادات DHCP لنطاق الشبكة

لحسابات المُوزعين، يمكنك إنشاء مفاتيح API منفصلة داخل كل حساب عميل تقوم بتكوين الإعدادات معه باستخدام واجهة برمجة تطبيقات Cato.

تحديد accountId لحسابك

يظهر معرّف الحساب في صفحة الإدارة> معلومات عامة.

أدخل هذا المعرّف في الحجة accountId لواجهة برمجة التطبيقات لإنشاء الموقع، على سبيل المثال:

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

تفاصيل الحجج لـ addNetworkRange و updateNetworkRange

يتم استخدام نفس الحجج لإنشاء أو تحديث نطاق شبكة لموقع Socket باستخدام واجهة برمجة التطبيقات لتكوين Cato. بالنسبة إلى addNetworkRange، تكون الحجج إلزامية ما لم تُحدد كاختيارية. بالنسبة إلى updateNetworkRange، قم بتضمين الحجج لإعدادات واجهة Socket التي تقوم بتحديثها.

معرّف networkRange - معرّف نطاق الشبكة (لـ updateNetworkRange)
معرّف lanSocketInterface - معرّف واجهة الشبكة التي يرتبط بها نطاق الشبكة (لـ addNetworkRange)
الاسم - اسم نطاق الشبكة
نوع النطاق - نوع نطاق الشبكة (مسار، مباشر، وغيرها)
الشبكة الفرعية - النطاق الأصلي لواجهة LAN في صيغة CIDR
localIP - عنوان IP المحلي لنطاق شبكة LAN
البوابة - للمسارات الموجهة، عنوان IP للقفزة التالية لجهاز التوجيه المجاور
vlan - معرف VLAN لنطاق الشبكة
azureFloutingIP - لتكوينات Azure HA، عنوان IP للقفزة التالية لجدول مسار LAN
dhcpSettings - يحدد ما إذا كان هذا النطاق الشبكي يستخدم إعدادات DHCP للحساب الافتراضي أو إعدادات مخصصة

networkRangeId (لـ updateNetworkRange)

يمكن الحصول على معرف networkRangeId باستخدام واجهة برمجة التطبيقات للبحث عن الكيانات entityLookup، استخدم type بالقيمة siteRange

يمكنك أيضًا استخدام معامل search بالقيمة كاسم الموقع، وسيتم تصفية الاستعلام لإزالة النطاقات من مواقع أخرى.

lanSocketInterfaceId (لـ addNetworkRange)

استخدم استعلام API للبحث عن الكيانات لاسترداد القيم للحجج lanSocketInterfaceId، كالتالي. لمزيد من المعلومات، راجع واجهة برمجة التطبيقات لـ Cato - EntityLookup.

استخدم type مع القيمة networkInterface، والقيم من هذه الحقول parent:

معرّف - <معرّف الموقع>
الاسم - <اسم الواجهة>

انظر sample script لمعرفة lanSocketInterfaceId أدناه، Sample Postman Script.

networkRange name

الحجة name هي لاسم نطاق الشبكة.

نوع النطاق networkRange

الحجة rangeType هي حجة enum تحدد نوع نطاق الشبكة.

هذه هي الخيارات:

مسار - نطاق الشبكة الذي يتصل بـ Socket عبر مسار
مباشر - نطاق الشبكة يتصل مباشرة بـ Socket أو جدار الحماية (ليس عبر جهاز توجيه)، ولكن نطاق IP يختلف عن النطاق الأصلي للموقع.
VLAN - VLANs التي تتصل بـ Cato تشبه منفذ الجذع
أصلي - نطاق IP المحدد لكل واجهة LAN
Native ثانوي - لتكوينات Socket HA، النطاق الأصلي لـ Socket الثانوي

الشبكة الفرعية networkRange

حدد نطاق IP لنطاق الشبكة للموقع في الحجة subnet في صيغة IPSubnet CIDR. /31 و /32 كتل CIDR غير مدعومة.

localIP لنطاق الشبكة

(إلزامي لهذه النطاقات: أصلي، Native ثانوي، مباشر، VLAN) حدد عنوان IP المحلي لنطاق LAN في الحجة localIP.

gateway لنطاق الشبكة

(إجباري للمسارات الموجهة) حدد عنوان IP للبوابة لنطاق شبكة LAN في الحجة gateway.

vlan لنطاق الشبكة

(إجباري لنطاقات VLAN) حدد معرف VLAN لنطاق شبكة LAN في الحجة vlan.

azureFloatingIp لنطاق الشبكة

(إجباري لتكوينات Azure HA Socket) حدد عنوان IP العائم لنطاق شبكة LAN في الحجة azureFloatingIp.

dhcpSettings لنطاق الشبكة (اختياري)

الحجة dhcpSettings هي حجة enum تحدد إعدادات DHCP لنطاق الشبكة.

هذه هي الخيارات:

نوع dhcp - قم بتكوين أحد أنواع DHCP التالية لنطاق الشبكة:
- DHCP_RELAY - تستخدم الشبكة نطاق DHCP relay مُكوَّنًا للحساب (مُعرَّفة في الحجة relayGroupId)
- DHCP_RANGE - يستخدم النطاق الشبكي خادم DHCP الخاص بـ Cato لـ DHCP، وفقًا للنطاق المعرّف في الحجة ipRange
- ACCOUNT_DEFAULT - يستخدم النطاق الشبكي relay DHCP الافتراضي المُعرَّف للحساب
- DHCP_DISABLED - تم تعطيل DHCP لهذا النطاق الشبكي
ipRange - للخيار DHCP_Range أعلاه، حدد نطاق IP الذي يمكن لخادم DHCP الخاص بـ Cato تعيينه إلى الأجهزة
relayGroupId - أدخل معرف مجموعة relay DHCP التي يستخدمها هذا النطاق الشبكي

للـ entityLookup، استخدم type بالقيمة dhcpRelayGroup

removeNetworkRange

استخدم واجهة برمجة التطبيقات removeNetworkRange لحذف نطاق شبكة من موقع. تحتاج فقط لاستخدام networkRangeId مع هذه الواجهة.

نموذج Postman Script

نموذج entityLookup لمعرفة lanSocketInterfaceID

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        items {
            entity {
                id
                name
                type
            }
            description
        }
    }
}

متغيرات GraphQL لـ entityLookup لـ lanSocketInterfaceID

{    
"accountID": "26",    
"type": "networkInterface",    
"parent": {
        "id": 26,
        "type": "site"
    }
}

نموذج Postman Script لإنشاء نطاق VLAN جديد

mutation addNetworkRange ($accountId: ID!, $lanSocketInterfaceId: ID!, $input: AddNetworkRangeInput!) {
    site(accountId: $accountId) {
        addNetworkRange (lanSocketInterfaceId: $lanSocketInterfaceId, input: $input) {
            networkRangeId
        }
    }
}

متغير GraphQL لنطاق VLAN جديد

{
    "accountId": "26",
    "lanSocketInterfaceId": 26,
    "input": {
        "name": "Guest WIFI",
        "rangeType": "VLAN",
        "subnet": "10.1.0.0/24",
        "localIp": "10.1.0.0.1",
        "vlan": 100
    }
}