Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI ist eine PHP-Bibliothek zum Anfordern von Aruba-Switches (ArubaOS). Diese Bibliothek kann die Konfiguration auf dem Switch abrufen, erstellen, aktualisieren und löschen. Es kann verwendet werden für:

• Konfigurieren Sie den Switch über eine von PHP entworfene Weboberfläche.
• Backup-Switch-Konfiguration mit einem PHP-Skript.
• So viel mehr, es liegt an Ihnen!

Warnung : Diese Bibliothek ist unvollständig und hauptsächlich auf POE, VLAN, Port und LED-Locator ausgerichtet. Beiträge sind willkommen!

Sie können alle unterstützten Methoden auf der Website von Aruba finden, Ihre Ausrüstung auswählen und die API-Dokumentation herunterladen.

Inhaltsverzeichnis

• Erste Schritte
• Dokumentation
  • Konfigurationsklasse
  • SwitchAPI-Klasse
    • Verwendung
    • Verfügbare Methoden

Erste Schritte

1. Holen Sie sich Composer.
2. Installieren Sie die Bibliothek mit Composer composer require benclerc/aruba-switchapi .
3. Fügen Sie der Haupt-PHP-Datei Ihrer Anwendung Folgendes hinzu require 'vendor/autoload.php'; .
4. Instanziieren Sie die Config-Klasse mit dem Hostnamen, Benutzernamen und Passwort des Switches $configSwitch = new ArubaConfig('123.123.123.123', 'admin', 'password'); .
5. Verwenden Sie das zuvor erstellte Config-Objekt, um das SwitchAPI-Objekt zu instanziieren $switch = new ArubaSwitchAPI($configSwitch); .
6. Beginnen Sie mit der Verwendung der Bibliothek $runningConf = $switch->getRunningConfig(); .

Dokumentation

Eine vollständige Dokumentation finden Sie hier.

Konfigurationsklasse

Diese Config-Klasse wird verwendet, um die obligatorischen Konfigurationsinformationen für die Instanziierung und Verwendung der SwitchAPI-Klasse vorzubereiten. Im Konstruktor müssen Sie Folgendes übergeben:

1. Der Hostname (FQDN) oder die IP-Adresse des Switches
2. Der Benutzername eines gültigen Benutzers
3. Das Passwort des gültigen Benutzers

Optionale Parameter:

• Zeitüberschreitung: 5000 ms. Verwenden Sie setTimeout() zum Ändern.
• SSL-Überprüfungs-Peer-Option: TRUE. Verwenden Sie zum Ändern setSSLVerifyPeer() .
• SSL-Host-Überprüfungsoption: 2. Verwenden Sie setSSLVerifyHost() zum Ändern.
• API-Version: „v7“. Verwenden Sie setAPIVersion() zum Ändern (nur >= v7 wird unterstützt).

Beispiel :

 // 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-Klasse

Verwendung

Diese Klasse verwendet Exception, um Fehler zu behandeln. Für die nominale Ausführung sollten Sie Methoden innerhalb von Try/Catch-Anweisungen instanziieren und anfordern.

Beispiele:

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

Verfügbare Methoden

Hier können Sie alle verfügbaren Methoden durchsuchen.