Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI هي مكتبة PHP لطلب محولات Aruba (ArubaOS). يمكن لهذه المكتبة استرداد التكوين وإنشاءه وتحديثه وحذفه على المحول. يمكن استخدامه من أجل:

• تكوين التبديل من واجهة ويب مصممة PHP.
• تكوين تبديل النسخ الاحتياطي باستخدام برنامج PHP النصي.
• أكثر من ذلك بكثير، والأمر متروك لكم!

تحذير : هذه المكتبة غير مكتملة وموجهة بشكل أساسي نحو POE وVLAN والمنفذ ومحدد موقع LED. المساهمات هي موضع ترحيب!

يمكنك العثور على جميع الطرق المدعومة على موقع Aruba الإلكتروني، واختيار المعدات الخاصة بك وتنزيل وثائق API.

جدول المحتويات

• ابدء
• التوثيق
  • فئة التكوين
  • فئة SwitchAPI
    • الاستخدام
    • الطرق المتاحة

ابدء

1. احصل على الملحن.
2. قم بتثبيت المكتبة باستخدام composer require benclerc/aruba-switchapi .
3. أضف ما يلي إلى ملف PHP الرئيسي لتطبيقك require 'vendor/autoload.php'; .
4. قم بإنشاء فئة التكوين باستخدام اسم مضيف المحول واسم المستخدم وكلمة المرور $configSwitch = new ArubaConfig('123.123.123.123', 'admin', 'password'); .
5. استخدم كائن التكوين الذي تم إنشاؤه مسبقًا لإنشاء كائن SwitchAPI $switch = new ArubaSwitchAPI($configSwitch); .
6. ابدأ في استخدام المكتبة $runningConf = $switch->getRunningConfig(); .

التوثيق

يمكنك العثور على وثائق كاملة هنا.

فئة التكوين

يتم استخدام فئة التكوين هذه لإعداد معلومات التكوين الإلزامية لإنشاء فئة SwitchAPI واستخدامها. في المنشئ يجب عليك تمرير:

1. اسم مضيف المحول (FQDN) أو عنوان IP
2. اسم مستخدم صالح للمستخدم
3. كلمة مرور المستخدم الصالحة

المعلمات الاختيارية:

• المهلة: 5000 مللي ثانية. استخدم setTimeout() للتغيير.
• خيار التحقق من صحة طبقة المقابس الآمنة (SSL) للنظير: TRUE. استخدم setSSLVerifyPeer() للتغيير.
• خيار التحقق من مضيف SSL: 2. استخدم setSSLVerifyHost() للتغيير.
• إصدار واجهة برمجة التطبيقات: "v7". استخدم setAPIVersion() للتغيير (يتم دعم >= v7 فقط).

مثال :

 // Basic configuration
$ configSwitch = new  Aruba  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );

// Configuration for very slow switchs/long requests
$ configSwitch = new  Aruba  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configSwitch -> setTimeout ( 20000 );

// Unsecure configuration
$ configSwitch = new  Aruba  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configSwitch -> setSSLVerifyPeer ( FALSE )-> setSSLVerifyHost ( FALSE );

// Special API version
$ configSwitch = new  Aruba  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configSwitch -> setAPIVersion ( ' v8 ' );

// The class logins to the switch when being instanciated hence the try/catch statement. 
try {
	$ switch = new  Aruba  SwitchAPI ( $ configSwitch );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

فئة SwitchAPI

الاستخدام

تستخدم هذه الفئة الاستثناء لمعالجة الأخطاء، وبالنسبة للتنفيذ الاسمي، يجب عليك إنشاء مثيل وطلب الأساليب داخل عبارات المحاولة/التقاط.

أمثلة :

 // Blink for 1 min LED locator
try {
	$ res = $ switch -> blinkLedLocator ( 2 , 1 );
	if ( $ res ) {
		echo ( ' Blink succeeded ' );
	} else {
		echo ( ' Blink failed ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

// Create a VLAN
try {
	$ res = $ switch -> createVlan ( 666 , ' HELL ' );
	if ( $ res ) {
		echo ( ' The VLAN has been created. ' );
	} else {
		echo ( ' Error : the VLAN was not created. ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

// Get status of all ports
try {
	$ res = $ switch -> getPortsStatus ();
	if ( $ res != FALSE ) {
		foreach ( $ res as $ key => $ value ) {
			$ status = ( $ value -> is_port_enabled ) ? ' up ' : ' down ' ;
			echo ( ' Port ' . $ value -> id . ' is ' . $ status . ' <br> ' );
		}
	} else {
		echo ( ' Error : status could not be retrieved. ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

// Set untagged VLAN 666 on port 42
try {
	$ res = $ switch -> setUVlanPort ( 666 , ' 42 ' );
	if ( $ res ) {
		echo ( ' The VLAN 666 has been affected to the port 42. ' );
	} else {
		echo ( ' Error : the VLAN was not affected. ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

الطرق المتاحة

يمكنك تصفح جميع الطرق المتاحة هنا.