fredbradley / aruba-central
A PHP wrapper for the Aruba Central API
Installs: 5
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:package
Requires
- php: ^8.3
- league/flysystem: ^3.15
- saloonphp/cache-plugin: ^3.0
- saloonphp/pagination-plugin: ^2.0
- saloonphp/saloon: ^3.0
Requires (Dev)
- laravel/pint: ^1.10
- mockery/mockery: ^1.6
- nunomaduro/phpinsights: ^2.12
- orchestra/testbench: v10.2.0
- pestphp/pest: ^3.8.1
- pestphp/pest-plugin-laravel: ^3.1
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^11.0.0
README
For Laravel Applications
Installation & Requirements
This package requires PHP 8.3 and above.
You can install the package via composer:
composer require fredbradley/aruba-central
Usage
You will need to add the following to your .env file:
ARUBA_CLIENT_ID="" ARUBA_CLIENT_SECRET="" ARUBA_BASE_URL="" #EG: https://apigw-eucentral2.central.arubanetworks.com/ ARUBA_ACCESS_TOKEN="" ARUBA_CREDENTIAL_ID="" ARUBA_REFRESH_TOKEN=""
The config file is publishable, but you shouldn't need to change anything.
Usage
use FredBradley\ArubaCentral\ArubaCentral; ArubaCentral::accessPoints()->all(); // Gets all access points ArubaCentral::accessPoints()->findByMacAddress($mac); // Gets a specific access point by MAC address ArubaCentral::wirelessClients()->all(); // Gets all wireless clients ArubaCentral::wirelessClients()->findUser($username); // Gets all wireless client by username
This package uses the Saloon API package to make the HTTP requests. You can read more about that package here.
Testing
Not written yet
composer pest
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please either report here or if you don't have a Github account, email code@fredbradley.co.uk instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.