Aruba SwitchAPI

Aruba SwitchAPI (ArubaOS)

Aruba SwitchAPI est une bibliothèque PHP permettant de demander des commutateurs Aruba (ArubaOS). Cette bibliothèque peut récupérer, créer, mettre à jour et supprimer la configuration sur le commutateur. Il servira à :

• Configurez le commutateur à partir d’une interface Web conçue par PHP.
• Sauvegarde de la configuration du switch avec un script PHP.
• Bien plus encore, c'est à vous de décider !

Attention : Cette bibliothèque est incomplète et principalement orientée vers les localisateurs POE, VLAN, ports et LED. Les contributions sont les bienvenues !

Vous pouvez trouver toutes les méthodes prises en charge sur le site Web d'Aruba, choisir votre équipement et télécharger la documentation de l'API.

Table des matières

• Commencer
• Documentation
  • Classe de configuration
  • Classe SwitchAPI
    • Usage
    • Méthodes disponibles

Commencer

1. Obtenez Compositeur.
2. Installez la bibliothèque à l'aide de composer composer require benclerc/aruba-switchapi .
3. Ajoutez ce qui suit au fichier PHP principal de votre application require 'vendor/autoload.php'; .
4. Instanciez la classe Config avec le nom d'hôte, le nom d'utilisateur et le mot de passe du commutateur $configSwitch = new ArubaConfig('123.123.123.123', 'admin', 'password'); .
5. Utilisez l'objet Config créé précédemment pour instancier l'objet SwitchAPI $switch = new ArubaSwitchAPI($configSwitch); .
6. Commencez à utiliser la bibliothèque $runningConf = $switch->getRunningConfig(); .

Documentation

Vous pouvez trouver une documentation complète ici.

Classe de configuration

Cette classe Config est utilisée pour préparer les informations de configuration obligatoires pour instancier et utiliser la classe SwitchAPI. Dans le constructeur vous devez passer :

1. Le nom d'hôte (FQDN) ou l'adresse IP du commutateur
2. Le nom d'utilisateur d'un utilisateur valide
3. Le mot de passe de l'utilisateur valide

Paramètres optionnels :

• Délai d'attente : 5000ms. Utilisez setTimeout() pour changer.
• Option de vérification SSL : TRUE. Utilisez setSSLVerifyPeer() pour modifier.
• Option d'hôte de vérification SSL : 2. Utilisez setSSLVerifyHost() pour modifier.
• Version API : 'v7'. Utilisez setAPIVersion() pour modifier (seuls >= v7 sont pris en charge).

Exemple :

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

Classe SwitchAPI

Usage

Cette classe utilise Exception pour gérer les erreurs. Pour une exécution nominale, vous devez instancier et demander des méthodes dans les instructions try/catch.

Exemples :

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

Méthodes disponibles

Vous pouvez parcourir toutes les méthodes disponibles ici.