Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
cbe89d913c | ||
|
|
4fe1780e1d | ||
|
|
61bd2eda0d | ||
|
|
746fb0933c | ||
|
|
aefbbdc5e1 | ||
|
|
fbfd6a8246 | ||
|
|
310abc43b5 | ||
|
|
01eafb516a | ||
|
|
c3c44d61e4 | ||
|
|
2e7b556d8e | ||
|
|
e7e1540df4 | ||
|
|
adb98a3c8e |
49
README.md
49
README.md
@@ -2,9 +2,9 @@
|
||||
|
||||
A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API.
|
||||
|
||||
UniFi Network Controller software versions 4.X.X, 5.X.X and 6.X.X are supported
|
||||
(version 6.4.54 has been confirmed to work) as well as UniFi OS-based controllers .
|
||||
This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
|
||||
UniFi Network Controller software versions 4.X.X, 5.X.X, 6.X.X, and 7.X.X (version 7.0.23 has been confirmed to work)
|
||||
are supported as well as UniFi OS-based controllers. This class is used by our API browser tool which can be found
|
||||
[here](https://github.com/Art-of-WiFi/UniFi-API-browser).
|
||||
|
||||
The package can be installed manually or by using
|
||||
composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for
|
||||
@@ -13,24 +13,26 @@ easy inclusion in your projects.
|
||||
## Requirements
|
||||
|
||||
- a server with:
|
||||
- PHP version 5.5.0 or higher
|
||||
- PHP 5.5.0 or higher
|
||||
- PHP json and PHP cURL modules
|
||||
- tested on Apache 2.4 with PHP Version 5.6.1 and cURL 7.42.1 and with PHP 7.2.24 and cURL 7.58.0
|
||||
- direct network connectivity between this server and the host and port (normally TCP
|
||||
port 8443 or port 443 for
|
||||
- tested on Apache 2.4 with PHP 5.6.1 and cURL 7.42.1 and with PHP 7.4.9 and cURL 7.68.0
|
||||
- direct network connectivity between this server and the host and port (usually TCP port 8443 or port 443 for
|
||||
UniFi OS) where the UniFi Controller is running
|
||||
- you must use **accounts with local access**, not pure UniFi Cloud accounts,
|
||||
to access the UniFi Controller API through this class
|
||||
- you must use **accounts with local access**, not UniFi Cloud accounts, to access the UniFi Controller API
|
||||
through this class
|
||||
|
||||
## UniFi OS Support
|
||||
|
||||
Support for UniFi OS-based controllers (UniFi Dream Machine, UniFi Dream Machine Pro
|
||||
or Cloud Key Gen2/Cloud Key Gen2 Plus with firmware version 2.0.24 or higher) has
|
||||
been added as of version 1.1.47. The class automatically detects UniFi OS devices and
|
||||
adjusts URLs and several functions/methods accordingly. If your own code implements strict
|
||||
validation of the URL that is passed to the constructor, please adapt your logic to
|
||||
allow URLs without a port suffix or with port 443 when dealing with a UniFi OS-based
|
||||
controller.
|
||||
Support for UniFi OS-based controllers has been added as of version 1.1.47:
|
||||
- UniFi Dream Router (UDR)
|
||||
- UniFi Dream Machine (UDM)
|
||||
- UniFi Dream Machine Pro (UDM PRO)
|
||||
- Cloud Key Gen2 (UCK G2), firmware version 2.0.24 or higher
|
||||
- Cloud Key Gen2 Plus (UCK G2 Plus), firmware version 2.0.24 or higher
|
||||
|
||||
The class automatically detects UniFi OS-based controllers and adjusts URLs and several functions/methods accordingly.
|
||||
If your own code implements strict validation of the URL that is passed to the constructor, please adapt your
|
||||
logic to allow URLs without a port suffix or with port 443 when working with a UniFi OS-based controller.
|
||||
|
||||
Please test all methods you plan on using thoroughly before using the API Client with
|
||||
UniFi OS devices in a production environment.
|
||||
@@ -86,7 +88,7 @@ require_once 'path/to/src/Client.php';
|
||||
### Download the Release
|
||||
|
||||
If you prefer not to use composer or git,
|
||||
simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), uncompress the zip
|
||||
simply [download the package](https://github.com/Art-of-WiFi/UniFi-API-client/archive/master.zip), unpack the zip
|
||||
file, then include the file containing the class in your code like so:
|
||||
|
||||
```php
|
||||
@@ -107,7 +109,7 @@ require_once 'vendor/autoload.php';
|
||||
* initialize the UniFi API connection class, log in to the controller and request the alarms collection
|
||||
* (this example assumes you have already assigned the correct values to the variables used)
|
||||
*/
|
||||
$unifi_connection = new UniFi_API\Client($controller_user, $controller_password $controller_url, $site_id, $controller_version, true);
|
||||
$unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true);
|
||||
$login = $unifi_connection->login();
|
||||
$results = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects
|
||||
```
|
||||
@@ -129,11 +131,17 @@ own PHP code.
|
||||
this feature in production environments where you have a valid SSL cert installed on the UniFi Controller that is
|
||||
associated with the FQDN in the `controller_url` parameter. This option was added with API client version 1.1.16.
|
||||
|
||||
3. Using an administrator account (`$controller_user` in the above example) with **read-only** permissions can limit
|
||||
visibility on certain collection/object properties. See this
|
||||
[issue](https://github.com/Art-of-WiFi/UniFi-API-client/issues/129) and this
|
||||
[issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues/94) for an example where the WPA2 password isn't
|
||||
visible for **read-only** administrator accounts.
|
||||
|
||||
## Functions/methods supported
|
||||
|
||||
The class currently supports the following functions/methods to GET/POST/PUT/DELETE data
|
||||
through the UniFi Controller API. Please refer to the comments in the source code for
|
||||
more details on the functions/methods and their respective parameters.
|
||||
more details on each of the functions/methods and their respective parameters.
|
||||
|
||||
- login()
|
||||
- logout()
|
||||
@@ -170,6 +178,7 @@ more details on the functions/methods and their respective parameters.
|
||||
- disable_ap()
|
||||
- edit_apgroup() (supported with controller versions 6.0.X and higher)
|
||||
- edit_client_fixedip()
|
||||
- edit_client_name()
|
||||
- edit_firewallgroup()
|
||||
- edit_usergroup()
|
||||
- extend_guest_validity()
|
||||
@@ -343,7 +352,7 @@ This class is based on the initial work by the following developers:
|
||||
|
||||
and the API as published by Ubiquiti:
|
||||
|
||||
- https://dl.ui.com/unifi/6.2.26/unifi_sh_api
|
||||
- https://dl.ui.com/unifi/7.0.23/unifi_sh_api
|
||||
|
||||
## Important Disclaimer
|
||||
|
||||
|
||||
@@ -29,24 +29,25 @@ $ch = curl_init();
|
||||
if (is_resource($ch) || is_object($ch)) {
|
||||
/**
|
||||
* If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options
|
||||
*/
|
||||
curl_setopt($ch, CURLOPT_URL, $controllerurl);
|
||||
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
|
||||
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
|
||||
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
|
||||
|
||||
/**
|
||||
* This cURL option can have a value of 0-6
|
||||
*
|
||||
* NOTES:
|
||||
* The cURL option CURLOPT_SSLVERSION can have a value of 0-6
|
||||
* see this URL for more details:
|
||||
* http://php.net/manual/en/function.curl-setopt.php
|
||||
* 0 is the default value and is used by the PHP API client class
|
||||
*/
|
||||
curl_setopt($ch, CURLOPT_SSLVERSION, 0);
|
||||
$curl_options = [
|
||||
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
|
||||
CURLOPT_URL => $controllerurl,
|
||||
CURLOPT_CUSTOMREQUEST => 'GET',
|
||||
CURLOPT_SSL_VERIFYPEER => false,
|
||||
CURLOPT_SSL_VERIFYHOST => false,
|
||||
CURLOPT_VERBOSE => true,
|
||||
CURLOPT_SSLVERSION => 0,
|
||||
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
|
||||
];
|
||||
|
||||
/**
|
||||
* Be more verbose
|
||||
*/
|
||||
curl_setopt($ch, CURLOPT_VERBOSE, true);
|
||||
curl_setopt_array($ch, $curl_options);
|
||||
|
||||
/**
|
||||
* $results contains the output as returned by the cURL request,
|
||||
|
||||
298
src/Client.php
298
src/Client.php
@@ -13,7 +13,7 @@ namespace UniFi_API;
|
||||
*
|
||||
* @package UniFi_Controller_API_Client_Class
|
||||
* @author Art of WiFi <info@artofwifi.net>
|
||||
* @version Release: 1.1.71
|
||||
* @version Release: 1.1.79
|
||||
* @license This class is subject to the MIT license that is bundled with this package in the file LICENSE.md
|
||||
* @example This directory in the package repository contains a collection of examples:
|
||||
* https://github.com/Art-of-WiFi/UniFi-API-client/tree/master/examples
|
||||
@@ -24,24 +24,24 @@ class Client
|
||||
* private and protected properties
|
||||
*
|
||||
* NOTE:
|
||||
* do not modify the values here, instead user the constructor or the getter and setter functions/methods
|
||||
* do not modify the values here, instead use the constructor or the getter and setter functions/methods
|
||||
*/
|
||||
const CLASS_VERSION = '1.1.72';
|
||||
const CLASS_VERSION = '1.1.79';
|
||||
protected $baseurl = 'https://127.0.0.1:8443';
|
||||
protected $user = '';
|
||||
protected $password = '';
|
||||
protected $site = 'default';
|
||||
protected $version = '6.2.26';
|
||||
protected $debug = false;
|
||||
protected $is_loggedin = false;
|
||||
protected $is_logged_in = false;
|
||||
protected $is_unifi_os = false;
|
||||
protected $exec_retries = 0;
|
||||
protected $cookies = '';
|
||||
protected $last_results_raw = null;
|
||||
protected $last_error_message = null;
|
||||
protected $last_error_message = '';
|
||||
protected $curl_ssl_verify_peer = false;
|
||||
protected $curl_ssl_verify_host = false;
|
||||
protected $curl_http_version = CURL_HTTP_VERSION_1_1;
|
||||
protected $curl_http_version = CURL_HTTP_VERSION_NONE;
|
||||
protected $curl_headers = [];
|
||||
protected $curl_method = 'GET';
|
||||
protected $curl_methods_allowed = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
|
||||
@@ -60,7 +60,7 @@ class Client
|
||||
* @param string $version optional, the version number of the controller
|
||||
* @param bool $ssl_verify optional, whether to validate the controller's SSL certificate or not, a value of true
|
||||
* is recommended for production environments to prevent potential MitM attacks, default
|
||||
* value (false) disables validation of the controller certificate
|
||||
* value (false) disables validation of the controller's SSL certificate
|
||||
*/
|
||||
public function __construct($user, $password, $baseurl = '', $site = '', $version = '', $ssl_verify = false)
|
||||
{
|
||||
@@ -85,7 +85,7 @@ class Client
|
||||
$this->version = trim($version);
|
||||
}
|
||||
|
||||
if ((boolean)$ssl_verify === true) {
|
||||
if ((bool) $ssl_verify === true) {
|
||||
$this->curl_ssl_verify_peer = true;
|
||||
$this->curl_ssl_verify_host = 2;
|
||||
}
|
||||
@@ -100,16 +100,16 @@ class Client
|
||||
public function __destruct()
|
||||
{
|
||||
/**
|
||||
* if $_SESSION['unificookie'] is set, do not logout here
|
||||
* if $_SESSION['unificookie'] is set, do not log out here
|
||||
*/
|
||||
if (isset($_SESSION['unificookie'])) {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* logout, if needed
|
||||
* log out, if needed
|
||||
*/
|
||||
if ($this->is_loggedin) {
|
||||
if ($this->is_logged_in) {
|
||||
$this->logout();
|
||||
}
|
||||
}
|
||||
@@ -124,12 +124,11 @@ class Client
|
||||
/**
|
||||
* skip the login process if already logged in
|
||||
*/
|
||||
if ($this->is_loggedin === true) {
|
||||
return true;
|
||||
if ($this->update_unificookie()) {
|
||||
$this->is_logged_in = true;
|
||||
}
|
||||
|
||||
if ($this->update_unificookie()) {
|
||||
$this->is_loggedin = true;
|
||||
if ($this->is_logged_in === true) {
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -141,9 +140,6 @@ class Client
|
||||
}
|
||||
|
||||
$curl_options = [
|
||||
CURLOPT_HEADER => true,
|
||||
CURLOPT_POST => true,
|
||||
CURLOPT_NOBODY => true,
|
||||
CURLOPT_URL => $this->baseurl . '/',
|
||||
];
|
||||
|
||||
@@ -163,7 +159,7 @@ class Client
|
||||
* prepare the actual login
|
||||
*/
|
||||
$curl_options = [
|
||||
CURLOPT_NOBODY => false,
|
||||
CURLOPT_POST => true,
|
||||
CURLOPT_POSTFIELDS => json_encode(['username' => $this->user, 'password' => $this->password]),
|
||||
CURLOPT_HTTPHEADER => [
|
||||
'content-type: application/json',
|
||||
@@ -218,8 +214,8 @@ class Client
|
||||
* check the HTTP response code
|
||||
*/
|
||||
if ($http_code >= 200 && $http_code < 400) {
|
||||
$this->is_loggedin = true;
|
||||
return $this->is_loggedin;
|
||||
$this->is_logged_in = true;
|
||||
return $this->is_logged_in;
|
||||
}
|
||||
|
||||
return false;
|
||||
@@ -248,7 +244,6 @@ class Client
|
||||
* construct the HTTP request headers as required
|
||||
*/
|
||||
$this->curl_headers = [
|
||||
'content-length: 0',
|
||||
'Expect:',
|
||||
];
|
||||
|
||||
@@ -277,8 +272,8 @@ class Client
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
$this->is_loggedin = false;
|
||||
$this->cookies = '';
|
||||
$this->is_logged_in = false;
|
||||
$this->cookies = '';
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -433,7 +428,7 @@ class Client
|
||||
* the existing note for the client-device is removed and "noted" attribute set to false
|
||||
* @return bool returns true upon success
|
||||
*/
|
||||
public function set_sta_note($user_id, $note = null)
|
||||
public function set_sta_note($user_id, $note = '')
|
||||
{
|
||||
$payload = ['note' => $note];
|
||||
return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($user_id), $payload);
|
||||
@@ -447,7 +442,7 @@ class Client
|
||||
* the existing name for the client device is removed
|
||||
* @return bool returns true upon success
|
||||
*/
|
||||
public function set_sta_name($user_id, $name = null)
|
||||
public function set_sta_name($user_id, $name = '')
|
||||
{
|
||||
$payload = ['name' => $name];
|
||||
return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($user_id), $payload);
|
||||
@@ -487,6 +482,9 @@ class Client
|
||||
/**
|
||||
* Fetch hourly site stats
|
||||
*
|
||||
* TODO: add support for optional attrib parameter
|
||||
* airtime_avg
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 7*24 hours
|
||||
* - "bytes" are no longer returned with controller version 4.9.1 and later
|
||||
@@ -602,6 +600,26 @@ class Client
|
||||
/**
|
||||
* Fetch hourly stats for a single access point or all access points
|
||||
*
|
||||
* TODO: optionally add ["top_filter_by" => "tx_retries"] to payload
|
||||
* add optional parameter for attribs to support:
|
||||
* wifi_tx_attempts
|
||||
* tx_retries
|
||||
* wifi_tx_dropped
|
||||
* sta_assoc_failures
|
||||
* sta_wpa_auth_failures
|
||||
* mac_filter_rejections
|
||||
* sta_dhcp_failures
|
||||
* sta_assoc_min
|
||||
* sta_assoc_max
|
||||
* sta_connect_time_min
|
||||
* sta_connect_time_max
|
||||
* sta_connect_time_total
|
||||
* user-wlan-num_sta_connected
|
||||
* user-wlan-num_sta_disconnected
|
||||
* user-wlan-sta_assoc_samples
|
||||
* user-wlan-sta_track_samples
|
||||
* wlan-num_sta
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 7*24 hours
|
||||
* - make sure that the retention policy for hourly stats is set to the correct value in
|
||||
@@ -683,6 +701,7 @@ class Client
|
||||
/**
|
||||
* Fetch 5 minutes stats for a single user/client device
|
||||
*
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 12 hours
|
||||
* - only supported with UniFi controller versions 5.8.X and higher
|
||||
@@ -696,7 +715,8 @@ class Client
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
* @param array $attribs array containing attributes (strings) to be returned, valid values are:
|
||||
* rx_bytes, tx_bytes, signal, rx_rate, tx_rate, rx_retries, tx_retries, rx_packets,
|
||||
* tx_packets default is ['rx_bytes', 'tx_bytes']
|
||||
* tx_packets, satisfaction, wifi_tx_attempts
|
||||
* default value is ['rx_bytes', 'tx_bytes']
|
||||
* @return array returns an array of 5-minute stats objects
|
||||
*/
|
||||
public function stat_5minutes_user($mac, $start = null, $end = null, $attribs = null)
|
||||
@@ -724,7 +744,8 @@ class Client
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
* @param array $attribs array containing attributes (strings) to be returned, valid values are:
|
||||
* rx_bytes, tx_bytes, signal, rx_rate, tx_rate, rx_retries, tx_retries, rx_packets,
|
||||
* tx_packets default is ['rx_bytes', 'tx_bytes']
|
||||
* tx_packets, satisfaction, wifi_tx_attempts
|
||||
* default value is ['rx_bytes', 'tx_bytes']
|
||||
* @return array returns an array of hourly stats objects
|
||||
*/
|
||||
public function stat_hourly_user($mac, $start = null, $end = null, array $attribs = null)
|
||||
@@ -752,7 +773,8 @@ class Client
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
* @param array $attribs array containing attributes (strings) to be returned, valid values are:
|
||||
* rx_bytes, tx_bytes, signal, rx_rate, tx_rate, rx_retries, tx_retries, rx_packets,
|
||||
* tx_packets default is ['rx_bytes', 'tx_bytes']
|
||||
* tx_packets, satisfaction, wifi_tx_attempts
|
||||
* default value is ['rx_bytes', 'tx_bytes']
|
||||
* @return array returns an array of daily stats objects
|
||||
*/
|
||||
public function stat_daily_user($mac, $start = null, $end = null, $attribs = null)
|
||||
@@ -780,7 +802,8 @@ class Client
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
* @param array $attribs array containing attributes (strings) to be returned, valid values are:
|
||||
* rx_bytes, tx_bytes, signal, rx_rate, tx_rate, rx_retries, tx_retries, rx_packets,
|
||||
* tx_packets default is ['rx_bytes', 'tx_bytes']
|
||||
* tx_packets, satisfaction, wifi_tx_attempts
|
||||
* default value is ['rx_bytes', 'tx_bytes']
|
||||
* @return array returns an array of monthly stats objects
|
||||
*/
|
||||
public function stat_monthly_user($mac, $start = null, $end = null, $attribs = null)
|
||||
@@ -800,7 +823,7 @@ class Client
|
||||
* - this function/method is only supported on controller versions 5.5.* and later
|
||||
* - make sure that the retention policy for 5 minutes stats is set to the correct value in
|
||||
* the controller settings
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
@@ -824,7 +847,7 @@ class Client
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 7*24 hours
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
@@ -848,7 +871,7 @@ class Client
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 52 weeks (52*7*24 hours)
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
@@ -872,7 +895,7 @@ class Client
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 52 weeks (52*7*24 hours)
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
@@ -896,7 +919,7 @@ class Client
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 24 hours
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
* @param int $end optional, Unix timestamp in milliseconds
|
||||
@@ -910,13 +933,12 @@ class Client
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/stat/report/archive.speedtest', $payload);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Fetch IPS/IDS events
|
||||
*
|
||||
* NOTES:
|
||||
* - defaults to the past 24 hours
|
||||
* - requires a USG
|
||||
* - requires a UniFi gateway
|
||||
* - supported in UniFi controller versions 5.9.X and higher
|
||||
*
|
||||
* @param int $start optional, Unix timestamp in milliseconds
|
||||
@@ -1035,18 +1057,22 @@ class Client
|
||||
*
|
||||
* @param string $client_mac optional, the MAC address of a single online client device for which the call must be
|
||||
* made
|
||||
* @return array returns an array of online client device objects, or in case of a single device request, returns a
|
||||
* single client device object
|
||||
* @return array|false returns an array of online client device objects, or in case of a single device request, returns a
|
||||
* single client device object, false upon error
|
||||
*/
|
||||
public function list_clients($client_mac = null)
|
||||
{
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/stat/sta/' . strtolower(trim($client_mac)));
|
||||
if (is_string($client_mac)) {
|
||||
$client_mac = strtolower(trim($client_mac));
|
||||
}
|
||||
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/stat/sta/' . $client_mac);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch details for a single client device
|
||||
*
|
||||
* @param string $client_mac optional, client device MAC address
|
||||
* @param string $client_mac client device MAC address
|
||||
* @return array returns an object with the client device information
|
||||
*/
|
||||
public function stat_client($client_mac)
|
||||
@@ -1057,23 +1083,23 @@ class Client
|
||||
/**
|
||||
* Assign client device to another group
|
||||
*
|
||||
* @param string $user_id id of the user device to be modified
|
||||
* @param string $group_id id of the user group to assign user to
|
||||
* @param string $client_id _id value of the client device to be modified
|
||||
* @param string $group_id _id value of the user group to assign client device to
|
||||
* @return bool returns true upon success
|
||||
*/
|
||||
public function set_usergroup($user_id, $group_id)
|
||||
public function set_usergroup($client_id, $group_id)
|
||||
{
|
||||
$payload = ['usergroup_id' => $group_id];
|
||||
return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($user_id), $payload);
|
||||
return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($client_id), $payload);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update client fixedip (using REST)
|
||||
* Update client device fixed IP address (using REST)
|
||||
*
|
||||
* @param string $client_id _id value for the client
|
||||
* @param bool $use_fixedip determines whether use_fixedip is true or false
|
||||
* @param string $client_id _id value for the client device
|
||||
* @param bool $use_fixedip determines whether to enable the fixed IP address or not
|
||||
* @param string $network_id optional, _id value for the network where the ip belongs to
|
||||
* @param string $fixed_ip optional, IP address, value of client's fixed_ip field
|
||||
* @param string $fixed_ip optional, IP address, value of client device's fixed_ip field
|
||||
* @return array|false returns an array containing a single object with attributes of the updated client on success
|
||||
*/
|
||||
public function edit_client_fixedip($client_id, $use_fixedip, $network_id = null, $fixed_ip = null)
|
||||
@@ -1101,6 +1127,28 @@ class Client
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/rest/user/' . trim($client_id), $payload);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update client device name (using REST)
|
||||
*
|
||||
* @param string $client_id _id value for the client device
|
||||
* @param string $name name of the client
|
||||
* @return array|false returns an array containing a single object with attributes of the updated client on success
|
||||
*/
|
||||
public function edit_client_name($client_id, $name)
|
||||
{
|
||||
if (empty($name)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->curl_method = 'PUT';
|
||||
$payload = [
|
||||
'_id' => $client_id,
|
||||
'name' => $name,
|
||||
];
|
||||
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/rest/user/' . trim($client_id), $payload);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch user groups
|
||||
*
|
||||
@@ -1353,11 +1401,16 @@ class Client
|
||||
* Fetch UniFi devices
|
||||
*
|
||||
* @param string $device_mac optional, the MAC address of a single UniFi device for which the call must be made
|
||||
* @return array containing known UniFi device objects (or a single device when using the <device_mac> parameter)
|
||||
* @return array|false an array containing known UniFi device objects (or a single device when using the <device_mac>
|
||||
* parameter), false upon error
|
||||
*/
|
||||
public function list_devices($device_mac = null)
|
||||
{
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/stat/device/' . strtolower(trim($device_mac)));
|
||||
if (is_string($device_mac)) {
|
||||
$device_mac = strtolower(trim($device_mac));
|
||||
}
|
||||
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/stat/device/' . $device_mac);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1400,7 +1453,7 @@ class Client
|
||||
* NOTES:
|
||||
* this is an experimental function, please do not use unless you know exactly what you're doing
|
||||
*
|
||||
* @return bool|array|string URL from where the backup file can be downloaded once generated, false upon failure
|
||||
* @return array|bool URL from where the backup file can be downloaded once generated, false upon failure
|
||||
*/
|
||||
public function generate_backup()
|
||||
{
|
||||
@@ -1504,7 +1557,7 @@ class Client
|
||||
* @param string $locale_id _id value of the locale section
|
||||
* @param object|array $payload stdClass object or associative array containing the configuration to apply to the
|
||||
* site, must be a (partial) object/array structured in the same manner as is
|
||||
* returned by list_settings() for section with the the "locale" key. Valid
|
||||
* returned by list_settings() for section with the "locale" key. Valid
|
||||
* timezones can be obtained in Javascript as explained here:
|
||||
* https://stackoverflow.com/questions/38399465/how-to-get-list-of-all-timezones-in-javascript
|
||||
* or in PHP using timezone_identifiers_list(). Do not include the _id property, it
|
||||
@@ -1653,7 +1706,8 @@ class Client
|
||||
$device_adopt = false,
|
||||
$device_restart = false
|
||||
) {
|
||||
$email_valid = filter_var(trim($email), FILTER_VALIDATE_EMAIL);
|
||||
$email = trim($email);
|
||||
$email_valid = filter_var($email, FILTER_VALIDATE_EMAIL);
|
||||
if (!$email_valid) {
|
||||
trigger_error('The email address provided is invalid!');
|
||||
return false;
|
||||
@@ -1661,7 +1715,7 @@ class Client
|
||||
|
||||
$payload = [
|
||||
'name' => trim($name),
|
||||
'email' => trim($email),
|
||||
'email' => $email,
|
||||
'for_sso' => $enable_sso,
|
||||
'cmd' => 'invite-admin',
|
||||
'role' => 'admin',
|
||||
@@ -1688,13 +1742,13 @@ class Client
|
||||
*
|
||||
* @param string $admin_id _id value of the admin user to assign, can be obtained using the
|
||||
* list_all_admins() method/function
|
||||
* @param bool $readonly optional, whether or not the new admin has readonly
|
||||
* @param bool $readonly optional, whether the new admin has readonly
|
||||
* permissions, default value is false which gives the new admin
|
||||
* Administrator permissions
|
||||
* @param bool $device_adopt optional, whether or not the new admin has permissions to
|
||||
* @param bool $device_adopt optional, whether the new admin has permissions to
|
||||
* adopt devices, default value is false. With versions < 5.9.X this only applies
|
||||
* when readonly is true.
|
||||
* @param bool $device_restart optional, whether or not the new admin has permissions to
|
||||
* @param bool $device_restart optional, whether the new admin has permissions to
|
||||
* restart devices, default value is false. With versions < 5.9.X this only applies
|
||||
* when readonly is true.
|
||||
* @return bool true on success
|
||||
@@ -1740,7 +1794,7 @@ class Client
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch wlan_groups
|
||||
* Fetch WLAN groups
|
||||
*
|
||||
* @return array containing known wlan_groups
|
||||
*/
|
||||
@@ -1803,7 +1857,7 @@ class Client
|
||||
/**
|
||||
* Fetch self
|
||||
*
|
||||
* @return array containing information about the logged in user
|
||||
* @return array containing information about the logged-in user
|
||||
*/
|
||||
public function list_self()
|
||||
{
|
||||
@@ -1842,10 +1896,10 @@ class Client
|
||||
* @param string $note optional, note to attach to the hotspot operator
|
||||
* @return bool true upon success
|
||||
*/
|
||||
public function create_hotspotop($name, $x_password, $note = null)
|
||||
public function create_hotspotop($name, $x_password, $note = '')
|
||||
{
|
||||
$payload = ['name' => $name, 'x_password' => $x_password];
|
||||
if (!isset($note)) {
|
||||
if (!empty($note)) {
|
||||
$payload['note'] = trim($note);
|
||||
}
|
||||
|
||||
@@ -1881,7 +1935,7 @@ class Client
|
||||
$minutes,
|
||||
$count = 1,
|
||||
$quota = 0,
|
||||
$note = null,
|
||||
$note = '',
|
||||
$up = null,
|
||||
$down = null,
|
||||
$megabytes = null
|
||||
@@ -1893,7 +1947,7 @@ class Client
|
||||
'quota' => intval($quota),
|
||||
];
|
||||
|
||||
if (!is_null($note)) {
|
||||
if (!empty($note)) {
|
||||
$payload['note'] = trim($note);
|
||||
}
|
||||
|
||||
@@ -1973,7 +2027,7 @@ class Client
|
||||
|
||||
$payload = ['type' => $type];
|
||||
|
||||
if (is_array($cat_filter) && $type == 'by_app') {
|
||||
if (is_array($cat_filter) && $type === 'by_app') {
|
||||
$payload['cats'] = $cat_filter;
|
||||
}
|
||||
|
||||
@@ -2522,13 +2576,13 @@ class Client
|
||||
* @return array containing wireless networks and their settings, or an array containing a single wireless network
|
||||
* when using the <wlan_id> parameter
|
||||
*/
|
||||
public function list_wlanconf($wlan_id = null)
|
||||
public function list_wlanconf($wlan_id = '')
|
||||
{
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/rest/wlanconf/' . trim($wlan_id));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a wlan
|
||||
* Create a WLAN
|
||||
*
|
||||
* @param string $name SSID
|
||||
* @param string $x_passphrase new pre-shared key, minimal length is 8 characters, maximum length is 63,
|
||||
@@ -2541,8 +2595,9 @@ class Client
|
||||
* @param string $security optional, security type (open, wep, wpapsk, wpaeap)
|
||||
* @param string $wpa_mode optional, wpa mode (wpa, wpa2, ..)
|
||||
* @param string $wpa_enc optional, encryption (auto, ccmp)
|
||||
* @param boolean $vlan_enabled optional, enable/disable vlan for this wlan
|
||||
* @param int $vlan optional, vlan id
|
||||
* @param boolean $vlan_enabled optional, enable/disable VLAN for this wlan (is ignored as of 1.1.73)
|
||||
* @param string $vlan_id optional, "_id" value of the VLAN to assign to this WLAN, can be found using
|
||||
* list_networkconf()
|
||||
* @param boolean $uapsd_enabled optional, enable/disable Unscheduled Automatic Power Save Delivery
|
||||
* @param boolean $schedule_enabled optional, enable/disable wlan schedule
|
||||
* @param array $schedule optional, schedule rules
|
||||
@@ -2561,35 +2616,34 @@ class Client
|
||||
$security = 'open',
|
||||
$wpa_mode = 'wpa2',
|
||||
$wpa_enc = 'ccmp',
|
||||
$vlan_enabled = false,
|
||||
$vlan = null,
|
||||
$vlan_enabled = null,
|
||||
$vlan_id = null,
|
||||
$uapsd_enabled = false,
|
||||
$schedule_enabled = false,
|
||||
$schedule = [],
|
||||
$ap_group_ids = null
|
||||
) {
|
||||
$payload = [
|
||||
'name' => $name,
|
||||
'usergroup_id' => $usergroup_id,
|
||||
'wlangroup_id' => $wlangroup_id,
|
||||
'name' => trim($name),
|
||||
'usergroup_id' => trim($usergroup_id),
|
||||
'wlangroup_id' => trim($wlangroup_id),
|
||||
'enabled' => $enabled,
|
||||
'hide_ssid' => $hide_ssid,
|
||||
'is_guest' => $is_guest,
|
||||
'security' => $security,
|
||||
'wpa_mode' => $wpa_mode,
|
||||
'wpa_enc' => $wpa_enc,
|
||||
'vlan_enabled' => $vlan_enabled,
|
||||
'security' => trim($security),
|
||||
'wpa_mode' => trim($wpa_mode),
|
||||
'wpa_enc' => trim($wpa_enc),
|
||||
'uapsd_enabled' => $uapsd_enabled,
|
||||
'schedule_enabled' => $schedule_enabled,
|
||||
'schedule' => $schedule,
|
||||
];
|
||||
|
||||
if (!empty($vlan) && $vlan_enabled) {
|
||||
$payload['vlan'] = $vlan;
|
||||
if (!empty($vlan_id)) {
|
||||
$payload['networkconf_id'] = $vlan_id;
|
||||
}
|
||||
|
||||
if (!empty($x_passphrase) && $security !== 'open') {
|
||||
$payload['x_passphrase'] = $x_passphrase;
|
||||
$payload['x_passphrase'] = trim($x_passphrase);
|
||||
}
|
||||
|
||||
if (!empty($ap_group_ids) && is_array($ap_group_ids)) {
|
||||
@@ -2604,9 +2658,8 @@ class Client
|
||||
*
|
||||
* @param string $wlan_id the "_id" value for the WLAN which can be found with the list_wlanconf() function
|
||||
* @param object|array $payload stdClass object or associative array containing the configuration to apply to the
|
||||
* wlan, must be a
|
||||
* (partial) object/array structured in the same manner as is returned by
|
||||
* list_wlanconf() for the wlan.
|
||||
* wlan, must be a (partial) object/array structured in the same manner as is returned
|
||||
* by list_wlanconf() for the wlan.
|
||||
* @return bool true on success
|
||||
*/
|
||||
public function set_wlansettings_base($wlan_id, $payload)
|
||||
@@ -2624,7 +2677,7 @@ class Client
|
||||
* @param string $name optional, SSID
|
||||
* @return bool true on success
|
||||
*/
|
||||
public function set_wlansettings($wlan_id, $x_passphrase, $name = null)
|
||||
public function set_wlansettings($wlan_id, $x_passphrase, $name = '')
|
||||
{
|
||||
$payload = [];
|
||||
$payload['x_passphrase'] = trim($x_passphrase);
|
||||
@@ -2690,7 +2743,7 @@ class Client
|
||||
|
||||
$macs = array_map('strtolower', $macs);
|
||||
$payload = [
|
||||
'mac_filter_enabled' => (bool)$mac_filter_enabled,
|
||||
'mac_filter_enabled' => (bool) $mac_filter_enabled,
|
||||
'mac_filter_policy' => $mac_filter_policy,
|
||||
'mac_filter_list' => $macs,
|
||||
];
|
||||
@@ -2752,7 +2805,7 @@ class Client
|
||||
* by default all alarms are archived
|
||||
* @return bool true on success
|
||||
*/
|
||||
public function archive_alarm($alarm_id = null)
|
||||
public function archive_alarm($alarm_id = '')
|
||||
{
|
||||
$payload = ['cmd' => 'archive-all-alarms'];
|
||||
if (!empty($alarm_id)) {
|
||||
@@ -2991,9 +3044,9 @@ class Client
|
||||
*/
|
||||
public function create_radius_account($name, $x_password, $tunnel_type = null, $tunnel_medium_type = null, $vlan = null)
|
||||
{
|
||||
$tunnel_types = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
|
||||
$tunnel_medium_types = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
|
||||
if ((!is_null($tunnel_type) && !in_array($tunnel_type, $tunnel_types)) || (!is_null($tunnel_medium_type) && !in_array($tunnel_medium_type, $tunnel_medium_types)) || ($tunnel_type ^ $tunnel_medium_type)) {
|
||||
$tunnel_type_values = [null, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
|
||||
$tunnel_medium_type_values = [null, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
|
||||
if (!in_array($tunnel_type, $tunnel_type_values) || !in_array($tunnel_medium_type, $tunnel_medium_type_values) || ($tunnel_type xor $tunnel_medium_type)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -3003,15 +3056,15 @@ class Client
|
||||
];
|
||||
|
||||
if (!is_null($tunnel_type)) {
|
||||
$payload['tunnel_type'] = (int)$tunnel_type;
|
||||
$payload['tunnel_type'] = (int) $tunnel_type;
|
||||
}
|
||||
|
||||
if (!is_null($tunnel_medium_type)) {
|
||||
$payload['tunnel_medium_type'] = (int)$tunnel_medium_type;
|
||||
$payload['tunnel_medium_type'] = (int) $tunnel_medium_type;
|
||||
}
|
||||
|
||||
if (!is_null($vlan)) {
|
||||
$payload['vlan'] = (int)$vlan;
|
||||
$payload['vlan'] = (string) $vlan;
|
||||
}
|
||||
|
||||
return $this->fetch_results('/api/s/' . $this->site . '/rest/account', $payload);
|
||||
@@ -3152,10 +3205,10 @@ class Client
|
||||
****************************************************************/
|
||||
|
||||
/**
|
||||
* Fetch access points and other devices under management of the controller (USW and/or USG devices)
|
||||
* Fetch access points and other devices under management of the controller (USW, USG, and/or UnIfi OS consoles)
|
||||
*
|
||||
* NOTE:
|
||||
* changed function/method name to fit it's purpose
|
||||
* changed function/method name to fit its purpose
|
||||
*
|
||||
* @param string $device_mac optional, the MAC address of a single device for which the call must be made
|
||||
* @return array containing known device objects (or a single device when using the <device_mac> parameter)
|
||||
@@ -3312,7 +3365,7 @@ class Client
|
||||
*
|
||||
* @param boolean $return_json true returns the results in "pretty printed" json format,
|
||||
* false returns PHP stdClass Object format (default)
|
||||
* @return object|string the raw results as returned by the controller API
|
||||
* @return false|string|object|null the raw results as returned by the controller API
|
||||
*/
|
||||
public function get_last_results_raw($return_json = false)
|
||||
{
|
||||
@@ -3330,16 +3383,12 @@ class Client
|
||||
/**
|
||||
* Get last error message
|
||||
*
|
||||
* @return object|bool the error message of the last method called in PHP stdClass Object format, returns false if
|
||||
* unavailable
|
||||
* @return string the error message of the last method called in PHP stdClass Object format, an empty string when
|
||||
* none available
|
||||
*/
|
||||
public function get_last_error_message()
|
||||
{
|
||||
if (!is_null($this->last_error_message)) {
|
||||
return $this->last_error_message;
|
||||
}
|
||||
|
||||
return false;
|
||||
return $this->last_error_message;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -3545,12 +3594,12 @@ class Client
|
||||
* Set value for the private property $curl_http_version
|
||||
*
|
||||
* NOTES:
|
||||
* - as of cURL version 7.62.0 the default value is CURL_HTTP_VERSION_2TLS which may cause issues
|
||||
* - the default value used in this class is CURL_HTTP_VERSION_1_1
|
||||
* - https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html
|
||||
* - as of cURL version 7.62.0 the default value is CURL_HTTP_VERSION_2TLS which may cause issues,
|
||||
* this method allows to set the value to CURL_HTTP_VERSION_1_1 when needed
|
||||
*
|
||||
* @param int $http_version new value for $curl_http_version, can be CURL_HTTP_VERSION_1_1 int(2)
|
||||
* or CURL_HTTP_VERSION_2TLS int(4)
|
||||
* @param int $http_version new value for $curl_http_version, CURL_HTTP_VERSION_1_1 int(2) or
|
||||
* CURL_HTTP_VERSION_2TLS int(4) are recommended
|
||||
* @see https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html
|
||||
*/
|
||||
public function set_curl_http_version($http_version)
|
||||
{
|
||||
@@ -3562,6 +3611,7 @@ class Client
|
||||
*
|
||||
* @return int current value of $request_timeout, can be CURL_HTTP_VERSION_1_1 int(2) or
|
||||
* CURL_HTTP_VERSION_2TLS int(4)
|
||||
* @see https://curl.se/libcurl/c/CURLOPT_HTTP_VERSION.html
|
||||
*/
|
||||
public function get_curl_http_version()
|
||||
{
|
||||
@@ -3590,7 +3640,7 @@ class Client
|
||||
/**
|
||||
* guard clause to check if logged in when needed
|
||||
*/
|
||||
if ($login_required && !$this->is_loggedin) {
|
||||
if ($login_required && !$this->is_logged_in) {
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -3602,7 +3652,7 @@ class Client
|
||||
|
||||
if (isset($response->meta->rc)) {
|
||||
if ($response->meta->rc === 'ok') {
|
||||
$this->last_error_message = null;
|
||||
$this->last_error_message = '';
|
||||
if (is_array($response->data) && !$boolean) {
|
||||
return $response->data;
|
||||
}
|
||||
@@ -3817,17 +3867,17 @@ class Client
|
||||
$cookie_crumbs = explode(';', $cookie);
|
||||
foreach ($cookie_crumbs as $cookie_crumb) {
|
||||
if (strpos($cookie_crumb, 'unifises') !== false) {
|
||||
$this->cookies = $cookie_crumb;
|
||||
$this->is_loggedin = true;
|
||||
$this->is_unifi_os = false;
|
||||
$this->cookies = $cookie_crumb;
|
||||
$this->is_logged_in = true;
|
||||
$this->is_unifi_os = false;
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
if (strpos($cookie_crumb, 'TOKEN') !== false) {
|
||||
$this->cookies = $cookie_crumb;
|
||||
$this->is_loggedin = true;
|
||||
$this->is_unifi_os = true;
|
||||
$this->cookies = $cookie_crumb;
|
||||
$this->is_logged_in = true;
|
||||
$this->is_unifi_os = true;
|
||||
|
||||
break;
|
||||
}
|
||||
@@ -3843,7 +3893,7 @@ class Client
|
||||
*
|
||||
* @param string $path path for the request
|
||||
* @param object|array $payload optional, payload to pass with the request
|
||||
* @return bool|array|string response returned by the controller API, false upon error
|
||||
* @return bool|string response returned by the controller API, false upon error
|
||||
*/
|
||||
protected function exec_curl($path, $payload = null)
|
||||
{
|
||||
@@ -3927,7 +3977,7 @@ class Client
|
||||
}
|
||||
|
||||
/**
|
||||
* fetch the HTTP response code
|
||||
* get the HTTP response code
|
||||
*/
|
||||
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
|
||||
|
||||
@@ -3935,12 +3985,12 @@ class Client
|
||||
* an HTTP response code 401 (Unauthorized) indicates the Cookie/Token has expired in which case
|
||||
* re-login is required
|
||||
*/
|
||||
if ($http_code == 401) {
|
||||
if ($http_code === 401) {
|
||||
if ($this->debug) {
|
||||
error_log(__FUNCTION__ . ': needed to reconnect to UniFi controller');
|
||||
}
|
||||
|
||||
if ($this->exec_retries == 0) {
|
||||
if ($this->exec_retries === 0) {
|
||||
/**
|
||||
* explicitly clear the expired Cookie/Token, update other properties and log out before logging in again
|
||||
*/
|
||||
@@ -3948,8 +3998,8 @@ class Client
|
||||
$_SESSION['unificookie'] = '';
|
||||
}
|
||||
|
||||
$this->is_loggedin = false;
|
||||
$this->cookies = '';
|
||||
$this->is_logged_in = false;
|
||||
$this->cookies = '';
|
||||
$this->exec_retries++;
|
||||
curl_close($ch);
|
||||
|
||||
@@ -3961,7 +4011,7 @@ class Client
|
||||
/**
|
||||
* when re-login was successful, simply execute the same cURL request again
|
||||
*/
|
||||
if ($this->is_loggedin) {
|
||||
if ($this->is_logged_in) {
|
||||
if ($this->debug) {
|
||||
error_log(__FUNCTION__ . ': re-logged in, calling exec_curl again');
|
||||
}
|
||||
@@ -4006,7 +4056,7 @@ class Client
|
||||
/**
|
||||
* Create and return a new cURL handle
|
||||
*
|
||||
* @return object|bool|resource cURL handle (object or resource) upon success, false upon failure
|
||||
* @return object|resource|bool cURL handle (object or resource) upon success, false upon failure
|
||||
*/
|
||||
protected function get_curl_handle()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user