المقدمة
يوضح هذا المستند كيفية تحويل vEdge من وضع vManage إلى وضع واجهة سطر الأوامر (CLI) بواسطة واجهة برمجة التطبيقات (API) vManage.
المتطلبات الأساسية
المتطلبات
توصي Cisco بأن تكون لديك معرفة بالمواضيع التالية:
- شبكة المنطقة الواسعة المعرفة من برنامج Cisco (SD-WAN)
- ساعي البريد
المكونات المستخدمة
تستند المعلومات الواردة في هذا المستند إلى إصدارات البرامج والمكونات المادية التالية:
- Cisco vManager، الإصدار 20.9.4
- Cisco vEdge، الإصدار 20.9.4
- Postman، الإصدار 11.63.0
تم إنشاء المعلومات الواردة في هذا المستند من الأجهزة الموجودة في بيئة معملية خاصة. بدأت جميع الأجهزة المُستخدمة في هذا المستند بتكوين ممسوح (افتراضي). إذا كانت شبكتك قيد التشغيل، فتأكد من فهمك للتأثير المحتمل لأي أمر.
معلومات أساسية
- Cisco SD-WAN vManage API هي واجهة REST API للتحكم في أجهزة Cisco في شبكة فرعية وتكوينها ومراقبتها.
- تستخدم بنية REST بروتوكول إتصالات غير محدد الحالة، وخادم عميل، واتصالات قابلة للاستعمال.
- نقل حالة إعادة التقديم (REST) هو نمط بنية لتصميم تطبيقات خدمات الويب.
- يمكن تجربة مكالمات API للاختبار من واجهة مستخدم Swagger.
- في بعض الأحيان، من المستحيل تعديل وضع إدارة vEdge من خلال واجهة المستخدم الرسومية (GUI). وفي مثل هذه الحالات، يعد إختيار تعديل أسلوب الإدارة من خلال واجهة برمجة التطبيقات نهجا مجديا آخر.
- يمكن الوصول إلى وثائق واجهة برمجة التطبيقات vManage عبر https://<vmanage_ip>:<port>/apiDocs للحصول على مرجع حول مكالمات واجهة برمجة التطبيقات (API) المتوفرة.
مكونات بنية URL
https://<vmanage_ip>:<port>/apidocs/#/configuration٪20-٪20Template٪20Configuration/updateDeviceToCLIMode
خصائص الأمر
|
صياغة الأمر
|
الوصف
|
البروتوكول
|
http:// أو https://
|
البروتوكول الذي يتم إرسال البيانات عليه بين العميل والخادم
|
الخادم أو المضيف
|
<vmanage-ip:port>
|
يتم الحل إلى IP والمنفذ الذي سيتم الاتصال به
|
مورد
|
/apidocs/#/configuration٪20-٪20Template٪20Configuration/updateDeviceToCLIMode
|
موقع البيانات أو الشيء محل الاهتمام
|
الوصول إلى وثائق واجهة برمجة التطبيقات (API) المدمجة
توجد وثائق VManage الخاصة بواجهة برمجة التطبيقات على عنوان URL https://<vmanage_ip>:<port:>/apidocs. تعرض هذه الوثائق واجهات برمجة التطبيقات المتاحة على إصدار البرنامج الحالي.
وهذا يتطلب تسجيل الدخول باستخدام بيانات اعتماد vManage صالحة. بينما يمكن لمستويات الامتيازات المتعددة عرض الوثائق، يمكن فقط لمستخدم netadmin تنفيذها كلها.
ملاحظة: تتوفر صفحة وثائق واجهة برمجة التطبيقات للمستأجرين في بيئة متعددة المستأجرين، ومع ذلك، يتم تقييد بعض الأوامر إلى الموفر فقط.
ثم يعرض vManage قائمة بفئات واجهات برمجة التطبيقات (API) المتاحة. انقر الفئة المرغوبة، متبوعة باستدعاء API نفسه، والذي يعرض هذه الحقول:
الوصف/ملاحظات التنفيذ
|
وصف العملية التي تم تنفيذها.
|
محددات
|
المعلمات المطلوبة التي سيتم تحديدها لاستدعاء API.
|
نص الطلب (POST/PUT/DELETE)
|
تنسيق نص الطلب.
|
الاستجابات
|
الردود المحتملة التي يرسلها vManage إلى واجهة برمجة التطبيقات. ويتضمن ذلك رمز حالة HTTP، والسبب، ونص الاستجابة المحتملة.
|
الامتدادات
|
ملحقات صالحة للاستدعاء.
|
ملاحظة: ومن الإصدار 20.6، يقدم النظام حدود المعدل التالية: واجهة برمجة التطبيقات (API) المجمعة: 48 طلب/دقيقة جميع واجهات API الأخرى: 100 طلب/ثانية.
تحذير: تعد واجهات برمجة التطبيقات (API) الخاصة بالرصد في الوقت الفعلي مكثفة لوحدة المعالجة المركزية ويجب إستخدامها فقط لاستكشاف الأخطاء وإصلاحها، وليس المراقبة المستمرة.
إختبار واجهات برمجة التطبيقات من أداة التوثيق
الخطوة 1:تسجيل الدخول إلى واجهة المستخدم الرسومية (GUI) vManage للتحقق من أن وضع إدارة vEdge هو vManage

الخطوة 2:تعديل عنوان URL لتسجيل الدخول واجهة برمجة تطبيقات Cisco SD-WAN vManage
تسجيل الدخول https://10.124.x.x/apidocs/

الخطوة 3: انتقل إلى التكوين - تكوين القالب في واجهة برمجة تطبيقات Cisco SD-WAN vManage

الخطوة 4:انقر فوق الزر تجربة ذلك

الخطوة 5:تغيير معرف الجهاز وDeviceIP
- deviceId == uuid
- deviceIP == local-system-ip

الخطوة 6:انقر فوق زر تنفيذ
الخطوة 7:تحقق من وضع vEdge في واجهة المستخدم الرسومية vManage
تم تبديل وضع إدارة vEdge من حالة vManage إلى حالة واجهة سطر الأوامر.

إختبار واجهات برمجة التطبيقات من أداة البريد
الخطوة 1: تسجيل الدخول إلى vManage والحصول على ملف تعريف إرتباط جلسة العمل
أسلوب الطلب: الاختبار الذاتي لبدء التشغيل (POST)
URL: https://<vmanage-ip>/j_security_check
تكوين ساعي البريد
العنوان الرئيسي: نوع المحتوى:تطبيق/x-www-form-urlencoded
نوع النص الأساسي: x-ww-form-urlencoded
محتوى النص الأساسي:
- j_username=admin
- j_password=xxx


بعد تسجيل دخول ناجح، يقوم vManage بإرجاع ملف تعريف الارتباط ل JSESSIONID؛ ويتم حفظ ملفات تعريف الارتباط تلقائيا.
الخطوة 2: الحصول على رمز CSRF المميز
أسلوب الطلب: إحضار
URL: https://<vmanage-ip>/dataService/client/token
تكوين ساعي البريد
العنوان الرئيسي: نوع المحتوى:تطبيق/x-www-form-urlencoded
نوع النص الأساسي: x-ww-form-urlencoded
محتوى النص الأساسي:
- j_username=admin
- j_password=xxx

الخطوة 3:الحصول على معرف المستخدم الخاص بالجهاز و IP
أسلوب الطلب: إحضار
URL: https://<vmanage-ip>/dataService/template/config/device/mode/vmanage؟type=vedge
تكوين ساعي البريد
العنوان الرئيسي:
- المحتوى - النوع:التطبيق/json
- X-XSRF-Token: E9C81862C46DA9F8C9A650272E8D577C41599496A990B771EEFB8F05C37DBEFA7759A20816ACC2DCF75F a912C9ECD23A68A
نوع النص الأساسي: x-ww-form-urlencoded
محتوى النص الأساسي:
- j_username=admin
- j_password=xxx


الخطوة 4: إلغاء ربط قالب تكوين vEdge
أسلوب الطلب: الاختبار الذاتي لبدء التشغيل (POST)
URL: https://<vmanage-ip>/dataService/template/config/device/mode/cli
تكوين ساعي البريد
العنوان الرئيسي:
- قبول:تطبيق/json
- المحتوى - النوع:التطبيق/json
- X-XSRF-token: E9C81862C46DA9F8C9A650272E8D577C41599496A990b771EEFB8F05C37DBEFA7759A20816ACC2DCF795A912C9ECD9ECD 23 أمبير 68 أمبير
نوع النص الأساسي: خام (JSON)
محتوى النص الأساسي:
{"deviceType":"vedge"،"الأجهزة":[{"deviceId":"cfca8af1-8f4d-faba-xxx"،"deviceIP":"xxx"}]
معلومات ذات صلة