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

可用方法

您可以在此处浏览所有可用的方法。