jeroen/unifi-php-api
1
0
Fork 0
mirror of https://github.com/Art-of-WiFi/UniFi-API-client.git synced 2024-11-21 09:40:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

added a new example demonstrating the change of site settings

Browse Source
This commit is contained in:
malle-pietje 2024-08-04 15:35:26 +02:00
parent fdea77fce0
commit 54ec631d4b
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
examples/toggle_auto_update_settings.php Executable file
View File

@ -0,0 +1,69 @@
<?php
/**
* PHP API usage example
*
* contributed by: Art of WiFi
* description: example to toggle the site-wide auto upgrade setting on a UniFi controller
*/
/**
* using the composer autoloader
*/
require_once('vendor/autoload.php');
/**
* include the config file (place your credentials etc. there if not already present)
* see the config.template.php file for an example
*
* @var string $controlleruser the user name for access to the UniFi Controller
* @var string $controllerpassword the password for access to the UniFi Controller
* @var string $controllerurl full url to the UniFi Controller, eg. 'https://
* @var string $controllerversion the version of the Controller software, eg. '4.6.6' (must be at least 4.0.0)
* @var bool $debug set to true (without quotes) to enable debug output to the browser and the PHP error log
*/
require_once('config.php');
/**
* site id for the site where settings are to be updated
*/
$site_id = 'zzzzz';
/**
* initialize the UniFi API connection class and log in to the controller to do our thing
*/
$unifi_connection = new UniFi_API\Client(
$controlleruser,
$controllerpassword,
$controllerurl,
$site_id,
$controllerversion
);
$login_results = $unifi_connection->login();
if ($login_results) {
/**
* we get the current site mgmt settings
*/
$current_site_settings = $unifi_connection->list_settings();
$mgmt_settings = [];
foreach ($current_site_settings as $section) {
if ($section->key == 'mgmt') {
$mgmt_settings = $section;
}
}
/**
* toggle the auto upgrade setting and set the auto upgrade hour to 3
*/
$mgmt_settings->auto_upgrade = !$mgmt_settings->auto_upgrade;
$mgmt_settings->auto_upgrade_hour = 3;
$mgmt_id = $mgmt_settings->_id;
$set_result = $unifi_connection->set_site_mgmt($mgmt_id, $mgmt_settings);
echo 'done' . PHP_EOL;
exit();
}
echo 'login failed' . PHP_EOL;