Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI เป็นไลบรารี PHP สำหรับการร้องขอสวิตช์ Aruba (ArubaOS) ไลบรารีนี้สามารถดึงข้อมูล สร้าง อัปเดต และลบการกำหนดค่าบนสวิตช์ได้ มันถูกใช้เพื่อ:

• กำหนดค่าสวิตช์จากเว็บอินเตอร์เฟสที่ออกแบบโดย PHP
• การกำหนดค่าสวิตช์สำรองด้วยสคริปต์ PHP
• อีกมากมายก็ขึ้นอยู่กับคุณ!

คำเตือน : ไลบรารีนี้ไม่สมบูรณ์และมุ่งเน้นไปที่ POE, VLAN, พอร์ตและตัวระบุตำแหน่ง LED เป็นหลัก ยินดีบริจาค!

คุณสามารถค้นหาวิธีการที่รองรับทั้งหมดได้จากเว็บไซต์ของ Aruba เลือกอุปกรณ์ของคุณ และดาวน์โหลดเอกสาร API

สารบัญ

• เริ่มต้นใช้งาน
• เอกสารประกอบ
  • กำหนดค่าคลาส
  • คลาส SwitchAPI
    • การใช้งาน
    • วิธีการที่มีอยู่

เริ่มต้นใช้งาน

1. รับผู้แต่ง.
2. ติดตั้งไลบรารี่โดยใช้ composer composer require benclerc/aruba-switchapi
3. เพิ่มสิ่งต่อไปนี้ลงในไฟล์ PHP หลักของแอปพลิเคชันของคุณ require 'vendor/autoload.php'; -
4. สร้างคลาส Config ด้วยชื่อโฮสต์ ชื่อผู้ใช้ และรหัสผ่านของสวิตช์ $configSwitch = new ArubaConfig('123.123.123.123', 'admin', 'password'); -
5. ใช้ Config object ที่สร้างไว้ก่อนหน้านี้เพื่อสร้างอินสแตนซ์ SwitchAPI object $switch = new ArubaSwitchAPI($configSwitch); -
6. เริ่มใช้ไลบรารี $runningConf = $switch->getRunningConfig(); -

เอกสารประกอบ

คุณสามารถค้นหาเอกสารฉบับเต็มได้ที่นี่

กำหนดค่าคลาส

คลาส Config นี้ใช้เพื่อเตรียมข้อมูลการกำหนดค่าที่จำเป็นเพื่อเริ่มต้นและใช้คลาส SwitchAPI ใน Constructor คุณต้องผ่าน :

1. ชื่อโฮสต์ของสวิตช์ (FQDN) หรือที่อยู่ IP
2. ชื่อผู้ใช้ที่ถูกต้อง
3. รหัสผ่านของผู้ใช้ที่ถูกต้อง

พารามิเตอร์เสริม:

• หมดเวลา: 5,000ms ใช้ setTimeout() เพื่อเปลี่ยนแปลง
• SSL ตรวจสอบตัวเลือกเพียร์: TRUE ใช้ setSSLVerifyPeer() เพื่อเปลี่ยนแปลง
• ตัวเลือก SSL ตรวจสอบโฮสต์ : 2. ใช้ setSSLVerifyHost() เพื่อเปลี่ยนแปลง
• เวอร์ชัน API: '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

การใช้งาน

คลาสนี้ใช้ Exception เพื่อจัดการกับข้อผิดพลาด สำหรับการดำเนินการเล็กน้อย คุณควรสร้างอินสแตนซ์และร้องขอวิธีการภายในคำสั่ง try/catch

ตัวอย่าง :

 // 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 ());
}

วิธีการที่มีอยู่

คุณสามารถเรียกดูวิธีการทั้งหมดที่มีอยู่ได้ที่นี่