Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI Aruba スイッチ (ArubaOS) をリクエストするための PHP ライブラリです。このライブラリは、スイッチ上の構成を取得、作成、更新、削除できます。用途:

• PHP で設計された Web インターフェイスからスイッチを設定します。
• PHP スクリプトを使用してスイッチ構成をバックアップします。
• それ以上はあなた次第です！

警告: このライブラリは不完全であり、主に POE、VLAN、ポート、LED ロケーターを対象としています。貢献は大歓迎です!

Aruba の Web サイトでサポートされているすべてのメソッドを検索し、機器を選択して API ドキュメントをダウンロードできます。

目次

• はじめる
• ドキュメント
  • 構成クラス
  • SwitchAPI クラス
    • 使用法
    • 利用可能な方法

はじめる

1. コンポーザーを入手します。
2. 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. 有効なユーザーのパスワード

オプションのパラメータ:

• タイムアウト: 5000ms。変更するには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 クラス

使用法

このクラスは例外を使用してエラーを処理します。通常の実行では、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 ());
}

利用可能な方法

ここで利用可能なすべてのメソッドを参照できます。