Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI是用來要求 Aruba 交換器 (ArubaOS) 的 PHP 函式庫。該庫可以檢索、建立、更新和刪除交換器上的配置。它可以用於：

• 從 PHP 設計的 Web 介面設定交換器。
• 使用 PHP 腳本備份交換器配置。
• 還有更多，就看你了！

警告：此庫不完整，主要面向 POE、VLAN、連接埠和 LED 定位器。歡迎貢獻！

您可以在 Aruba 網站上找到所有支援的方法，選擇您的裝置並下載 API 文件。

目錄

• 入門
• 文件
  • 配置類別
  • 開關API類
    • 用法
    • 可用方法

入門

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 物件實例化 SwitchAPI 物件$switch = new ArubaSwitchAPI($configSwitch); 。
6. 開始使用函式庫$runningConf = $switch->getRunningConfig(); 。

文件

您可以在此處找到完整的文檔。

配置類別

此 Config 類別用於準備實例化和使用 SwitchAPI 類別所需的強製配置資訊。在建構函式中，您必須傳遞：

1. 交換器的主機名稱 (FQDN) 或 IP 位址
2. 有效用戶的用戶名
3. 有效的用戶密碼

可選參數：

• 超時：5000 毫秒。使用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 ());
}

開關API類

用法

此類別使用 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 ());
}

可用方法

您可以在此處瀏覽所有可用的方法。