node-unifiapi
Version:
Provides API to manage Ubiquiti Unifi Controller, ver 4 and 5
1,217 lines (1,144 loc) • 69.4 kB
JavaScript
let debug = require('debug')('UnifiAPI');
let merge = require('merge');
let UnifiRequest = require('./lib/unifi-request');
let SSHSession = require('./lib/ssh-session');
let defaultOptions = {
'username': 'unifi',
'password': 'unifi',
'baseUrl': 'https://127.0.0.1:8443',
'debug': false,
'debugNet': false,
'gzip': true,
'site': 'default'
};
/**
* The main class and the initialization of the Unifi Access
* @param {object} options the options during initialization
* @param {string} options.baseUrl the URL where the Unifi controller is. Default https://127.0.0.1:8443
* @param {string} options.username default username
* @param {string} options.password default password
* @param {string} options.site default site. Default is "default"
* @param {boolean} options.debug if the debug log is enabled
* @param {boolean} options.debugNet if the debug of the request module is enabled
* @returns this
* @example let UnifiAPI = require('node-unifiapi');
* let unifi = UnifiAPI({
* baseUrl: 'https://127.0.0.1:8443', // The URL of the Unifi Controller
* username: 'ubnt',
* password: 'ubnt',
* // debug: true, // More debug of the API (uses the debug module)
* // debugNet: true // Debug of the network requests (uses request module)
* });
*/
function UnifiAPI(options) {
if (!(this instanceof UnifiAPI)) return new UnifiAPI(options);
merge(this, defaultOptions, options);
this.debugging(this.debug);
if (typeof this.net === 'undefined') {
this.net = new UnifiRequest(merge(true, defaultOptions, options));
}
debug('UnifiAPI Initialized with options %o', options);
}
/**
* Enable or disable the debug of the module
* @param {boolean} enable Enable or disable the debugging
* @returns {undefined}
*/
UnifiAPI.prototype.debugging = function(enabled) {
this.debug = enabled;
debug.enabled = this.debug ? true : false;
debug('Debug is', this.debug ? 'enabled' : 'disabled');
};
/**
* Generic network operation, executing Ubiquiti command under /api/s/{site}/... rest api
* @param {string} url The right part of the URL (/api/s/{site}/ is automatically added)
* @param {object} jsonParams optional. Default undefined. If it is defined and it is object, those will be the JSON POST attributes sent to the URL and the the default method is changed from GET to POST
* @param {object} headers optional. Default {}. HTTP headers that we require to be sent in the request
* @param {object} method optional. Default undefined. The HTTP request method. If undefined, then it is automatic. If no jsonParams specified, it will be GET. If jsonParams are specified it will be POST
* @param {string} site optional. The {site} atribute of the request. If not specified, it is taken from the UnifiAPI init options, where if it is not specified, it is "default"
* @return {Promise}
* @example unifi.netsite('/cmd/stamgr', { cmd: 'authorize-guest', mac: '00:01:02:03:04:05', minutes: 60 }, {}, 'POST', 'default')
* .then(data => console.log('Success', data))
* .catch(error => console.log('Error', error));
*/
UnifiAPI.prototype.netsite = function(url = '', jsonParams = undefined, headers = {}, method = undefined, site = undefined) {
site = site || this.site;
if (typeof method === 'undefined') {
if (typeof jsonParams === 'undefined') method = 'GET';
else method = 'POST';
}
return this.net.req('/api/s/' + site + url, jsonParams, headers, method)
};
/**
* @description Explicit login to the controller. It is not necessary, as every other method calls implicid login (with the default username and password) before execution
* @param {string} username The username
* @param {string} password The password
* @return {Promise} success or failure
* @example unifi.login(username, password)
* .then(data => console.log('success', data))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.login = function(username, password) {
return this.net.login(username, password);
};
/**
* Logout of the controller
* @example unifi.logout()
* .then(() => console.log('Success'))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.logout = function() {
return this.net.logout();
};
/**
* Authorize guest by a MAC address
* @param {string} mac mac address of the guest - mandatory
* @param {string} minutes minutes for the authorization - optional, default 60 min
* @param {string} up upstream bandwidth in Kbps. Default no limit
* @param {string} down downstream bandwidth in Kbps. Default no _limit
* @param {string} mbytes download limit in Mbytes. Default no limit
* @param {string} apmac to which mac address the authorization belongs. Default any
* @param {string} site to which site (Ubiquiti) the command will be applied if it is different than the default
* @return {Promise} Promise
* @example unifi.authorize_guest('01:02:aa:bb:cc')
* .then(data => console.log('Successful authorization'))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.authorize_guest = function(mac = '', minutes = 60, up = undefined, down = undefined, mbytes = undefined, apmac = undefined, site = undefined) {
return this.netsite('/cmd/stamgr', {
cmd: 'authorize-guest',
mac: mac.toLowerCase(),
minutes: minutes,
up: up,
down: down,
bytes: mbytes,
ap_mac: apmac && apmac.toLowerCase()
}, {}, undefined, site);
};
/**
* De-authorize guest by a MAC address
* @param {string} mac the mac address
* @param {site} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.unauthorize_guest('00:01:02:03:aa:bb')
* .then(done => console.log('Success', done))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.unauthorize_guest = function(mac = '', site = undefined) {
return this.netsite('/cmd/stamgr', {
cmd: 'uauthorize-guest',
mac: mac.toLowerCase()
}, {}, undefined, site);
};
/**
* Kick a client (station) of the network. This will disconnect a wireless user if it is connected
* @param {string} mac Mac address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.kick_sta('00:00:11:22:33:44')
* .then(done => console.log('Success', done))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.kick_sta = function(mac = '', site = undefined) {
return this.netsite('/cmd/stamgr', {
cmd: 'kick-sta',
mac: mac.toLowerCase()
}, {}, undefined, site);
};
/**
* Terminate access of a Guest (logged in via Guest Authorization). It kicks it out of the wireless and authroization
* @param {string} id the ID of the guest that have to be kicked out
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.terminate_guest('aa01af0133d334d77d')
* .this(done => console.log('Success', done))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.terminate_guest = function(id = '', site = undefined) {
return this.netsite('/cmd/hotspot', {
_id: id,
cmd: 'terminate'
}, {}, undefined, site);
};
/**
* Block station of the network
* @param {string} mac Mac address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.block_sta('00:01:02:03:04:05')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.block_sta = function(mac = '', site = undefined) {
return this.netsite('/cmd/stamgr', {
cmd: 'block-sta',
mac: mac.toLowerCase()
}, {}, undefined, site);
};
/**
* Unblock station of the network
* @param {string} mac Mac address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.block_sta('00:01:02:03:04:05')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error', err))
*/
UnifiAPI.prototype.unblock_sta = function(mac = '', site = undefined) {
return this.netsite('/cmd/stamgr', {
cmd: 'unblock-sta',
mac: mac.toLowerCase()
}, {}, undefined, site);
};
/**
* Set or remove Note to a station
* @param {string} user User ID
* @param {string} note Note
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_sta_note('aabbaa0102aa03aa3322','Test note')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
* @example unifi.set_sta_note('aabbaa0102aa03aa3322','') // remove note
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_sta_note = function(user = '', note = '', site = undefined) {
return this.netsite('/upd/user/' + user, {
note: note,
noted: note ? true : false
}, {}, undefined, site);
};
/**
* Set or remove Name to a station
* @param {string} user User ID
* @param {string} name Name
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_sta_name('aabbaa0102aa03aa3322','Central Access Point')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
* @example unifi.set_sta_name('aabbaa0102aa03aa3322','') // remove name
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_sta_name = function(user = '', name = '', site = undefined) {
return this.netsite('/upd/user/' + user, {
name: name
}, {}, undefined, site);
};
/**
* List client sessions
* @param {number} start Start time in Unix Timestamp - Optional. Default 7 days ago
* @param {number} end End time in Unix timestamp - Optional. Default - now
* @param {string} type Sessions type. Optional. Default all
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_sessions()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_sessions = function(start = undefined, end = undefined, type = 'all', site = undefined) {
return this.netsite('/stat/sessions', {
type: type,
start: start || (new Date()).getTime() / 1000 - 7 * 24 * 3600 * 1000,
end: end || (new Date()).getTime()
}, {}, undefined, site);
};
/**
* List daily site statistics
* @param {number} start Start time in Unix Timestamp - Optional. Default 7 days ago
* @param {number} end End time in Unix timestamp - Optional. Default - now
* @param {array} attrs What attributes we are quering for. Optional. Default [ 'bytes', 'wan-tx_bytes', 'wan-rx_bytes', 'wlan_bytes', 'num_sta', 'lan-num_sta', 'wlan-num_sta', 'time' ]
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_daily_site()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_daily_site = function(start = undefined, end = undefined, attrs = ['bytes', 'wan-tx_bytes', 'wan-rx_bytes', 'wlan_bytes', 'num_sta', 'lan-num_sta', 'wlan-num_sta', 'time'], site = undefined) {
return this.netsite('/stat/report/daily.site', {
start: start ? start : (new Date()).getTime() - 52 * 7 * 24 * 3600 * 1000,
end: end ? end : (new Date()).getTime(),
attrs: attrs
}, {}, undefined, site);
};
/**
* List hourly site statistics
* @param {number} start Start time in Unix Timestamp - Optional. Default 7 days ago
* @param {number} end End time in Unix timestamp - Optional. Default - now
* @param {array} attrs What attributes we are quering for. Optional. Default [ 'bytes', 'wan-tx_bytes', 'wan-rx_bytes', 'wlan_bytes', 'num_sta', 'lan-num_sta', 'wlan-num_sta', 'time' ]
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_hourly_site()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_hourly_site = function(start = undefined, end = undefined, attrs = ['bytes', 'wan-tx_bytes', 'wan-rx_bytes', 'wlan_bytes', 'num_sta', 'lan-num_sta', 'wlan-num_sta', 'time'], site = undefined) {
return this.netsite('/stat/report/hourly.site', {
start: start ? start : (new Date()).getTime() - 7 * 24 * 3600 * 1000,
end: end ? end : (new Date()).getTime(),
attrs: attrs
}, {}, undefined, site);
};
/**
* List hourly site statistics for ap
* @param {number} start Start time in Unix Timestamp - Optional. Default 7 days ago
* @param {number} end End time in Unix timestamp - Optional. Default - now
* @param {array} attrs What attributes we are quering for. Optional. Default [ 'bytes', 'num_sta', 'time' ]
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_hourly_ap()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_hourly_ap = function(start = undefined, end = undefined, attrs = ['bytes', 'num_sta', 'time'], site = undefined) {
return this.netsite('/stat/report/hourly.ap', {
start: start ? start : (new Date()).getTime() - 7 * 24 * 3600 * 1000,
end: end ? end : (new Date()).getTime(),
attrs: attrs
}, {}, undefined, site);
};
/**
* Last station sessions
* @param {string} mac Mac address
* @param {number} limit How many sessions. Optional. Default 5
* @param {string} sort Sorting. Optional. Default Ascending (asc)
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_sta_sessions_latest('00:01:02:03:04:05', 10)
* .then(done => console.log('Success', done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_sta_sessions_latest = function(mac = '', limit = 5, sort = '-asoc-time', site = undefined) {
return this.netsite('/stat/sessions', {
mac: mac.toLowerCase(),
'_limit': limit,
'_sort': sort
}, {}, undefined, site);
};
/**
* List authorizations
* @param {number} start Start time in Unix Timestamp - Optional. Default 7 days ago
* @param {number} end End time in Unix timestamp - Optional. Default - now
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_auths()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_auths = function(start = undefined, end = undefined, site = undefined) {
return this.netsite('/stat/authorization', {
end: end || (new Date()).getTime(),
start: start || (new Date()).getTime() - 7 * 24 * 3600000
}, {}, undefined, site);
};
/**
* List all users
* @param {number} historyhours How many hours back to query. Optional. Default 8670
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_allusers()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_allusers = function(historyhours = 8670, type = 'all', conn = 'all', site = undefined) {
return this.netsite('/stat/alluser', {
type: type,
conn: conn,
within: historyhours
}, {}, undefined, site);
};
/**
* List of guests (authorized via the guest portal)
* @param {number} historyhours How many hours back to query. Optional. Default 8670
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_guests()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_guests = function(historyhours = 8670, site = undefined) {
return this.netsite('/stat/guest', {
within: historyhours
}, {}, undefined, site);
};
/**
* List of guests (authorized via the guest portal) but with modern internal api
* @param {number} historyhours How many hours back to query. Optional. Default 8670
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_guests2()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_guests2 = function(historyhours = 8670, site = undefined) {
return this.netsite('/stat/guest?within=' + historyhours, undefined, {}, undefined, site);
};
/**
* List of (all) clients per station
* @param {string} mac Mac address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_clients()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_clients = function(mac = '', site = undefined) {
return this.netsite('/stat/sta/' + mac, undefined, {}, undefined, site);
};
/**
* List of group of clients per station
* @param {string} macs String mac or array of mac addresses as strings, to get information about them
* @param {string} ap Station man address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_some_clients()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_some_clients = function(macs = undefined, ap = '', site = undefined) {
var clients = undefined;
if (macs) {
if (typeof macs == 'string') clients = { macs: [ macs ] }
else if (macs instanceof Array) clients = { macs: macs };
}
return this.netsite('/stat/sta/' + ap, clients, {}, undefined, site);
};
/**
* Statistics of (all) clients per station
* @param {string} mac Mac address
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_client()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_client = function(mac = '', site = undefined) {
return this.netsite('/stat/user/' + mac, undefined, {}, undefined, site);
};
/**
* List of the usergroups
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_usergroup()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_usergroup = function(site = undefined) {
return this.netsite('/list/usergroup', undefined, {}, undefined, site);
};
/**
* Add user to a group
* @param {string} userid ID of the user
* @param {string} groupid ID of the group
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_usergroup('11aa22bb33cc44dd55ee66ff', '112233445566778899aabb')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_usergroup = function(userid = '', groupid = '', site = undefined) {
return this.netsite('/upd/user/' + userid, {
usergroup_id: groupid
}, {}, undefined, site);
};
/**
* List health
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_health()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_health = function(site = undefined) {
return this.netsite('/stat/health', undefined, {}, undefined, site);
};
/**
* List dashboard
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_dashboard()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_dashboard = function(site = undefined) {
return this.netsite('/stat/dashboard', undefined, {}, undefined, site)
};
/**
* List users
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_users()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_users = function(site = undefined) {
return this.netsite('/list/user', undefined, {}, undefined, site);
};
/**
* List APs
* @param {string} mac AP mac/id, Optional
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_aps()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_aps = function(mac = '', site = undefined) { // TODO: not working with mac different than none
return this.netsite('/stat/device/' + mac, undefined, {}, undefined, site)
};
/**
* List Rogue APs
* @param {number} within For how many hours back. Optional. Default 24h
* @param {string} site Ubiquiti site, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_rogueaps()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_rogueaps = function(within = 24, site = undefined) {
return this.netsite('/stat/rogueap', {
within: within
}, {}, undefined, site);
};
/**
* List sites
* @return {Promise} Promise
* @example unifi.list_sites()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_sites = function() {
return this.net.req('/api/self/sites');
};
/**
* Sites stats
* @return {Promise} Promise
* @example unifi.stat_sites()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_sites = function() {
return this.net.req('/api/stat/sites');
};
/**
* Add new site
* @param {string} name name
* @param {string} description description - optional
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.add_site('mysite','Experimental site')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.add_site = function(name = 'default', description = '', site = undefined) {
return this.netsite('/cmd/sitemgr', site = site, {
cmd: 'add-site',
name: name,
desc: description
}, {}, undefined, site);
};
/**
* Remove site
* @param {string} name name
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.remove_site('mysite')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.remove_site = function(name = 'none', site = undefined) { // TODO: test it
return this.netsite('/cmd/sitemgr', site = site, {
cmd: 'remove-site',
name: name
}, {}, undefined, site);
};
/**
* List WLANGroups
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_wlan_groups()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_wlan_groups = function(site = undefined) {
return this.netsite('/list/wlangroup', undefined, {}, undefined, site);
};
/**
* Stat Sysinfo
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_sysinfo()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_sysinfo = function(site = undefined) {
return this.netsite('/stat/sysinfo', undefined, {}, undefined, site);
};
/**
* Get information aboult self (username, etc)
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_self()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_self = function(site = undefined) { // TODO: test
return this.netsite('/self', undefined, {}, undefined, site);
};
/**
* Get information aboult the network configuration
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_networkconf()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_networkconf = function(site = undefined) {
return this.netsite('/list/networkconf', undefined, {}, undefined, site);
};
/**
* Get accounting / status of the vouchers
* @param {number} createtime Unixtimestamp since when we return information about the vouchers. Optional. Default any
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_voucher()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_voucher = function(createtime = undefined, site = undefined) {
return this.netsite('/stat/voucher', {
create_time: createtime
}, {}, undefined, site);
};
/**
* Get accounting / status of the payments
* @param {number} within how many hours back we query. Optional. Default any
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.stat_payment()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.stat_payment = function(within = undefined, site = undefined) {
return this.netsite('/stat/payment', { // TODO: test it, is it payment or voucher
within: within
}, {}, undefined, site);
};
/**
* Create HotSpot (version 1)
* @todo Check if the URL of the rest service is correct
* @todo Test that it is working
* @param {string} name name
* @param {string} password password
* @param {string} note Note (optional)
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.create_hotspot('myhotspot', 'password', 'note')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.create_hotspot = function(name = '', password = '', note = '', site = undefined) {
return this.netsite('/stat/voucher', {
name: name,
note: note,
x_password: password
}, {}, undefined, site);
};
/**
* List all of the hotspots (v1)
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_hotspot()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_hotspot = function(site = undefined) {
return this.netsite('/list/hotspotop', undefined, {}, undefined, site);
};
/**
* Create vouchers. Generate a set of vouchers
* @param {number} count how many vouchers to generate. Optional. default is 1
* @param {number} minutes how long the voucher may be active after activation in minutes. Optional. default is 60 minutes
* @param {number} quota how many times a user may reuse (login with) this voucher. Default 0 = unlimited. 1 means only once. 2 means two times and so on
* @param {string} note the note of the voucher. Optional
* @param {number} up Upstream bandwidth rate limit in Kbits. Optional. Default - no limit
* @param {number} down Downstream bandwidth rate limit in Kbits. Optional. Default - no limit
* @param {number} mbytes Limit of the maximum download traffic in Mbytes. Optional. Default - no limit
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.create_voucher(10, 2880, 1, 'Test vouchers', 1000, 2000, 250)
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.create_voucher = function(count = 1, minutes = 60, quota = 0, note = undefined, up = undefined, down = undefined, mbytes = undefined, site = undefined) {
return this.netsite('/cmd/hotspot', {
note: note,
up: up,
down: down,
bytes: mbytes,
cmd: 'create-voucher',
expire: minutes,
n: count,
quota: quota
}, {}, undefined, site);
};
/**
* Revoke Voucher. Voucher revoking is the same as deleting the voucher. In most of the cases the authorized user is kicked out of the network too
* @param {string} voucher_id description
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.revoke_voucher('9912982aaff182728a0f03')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.revoke_voucher = function(voucher_id, site = undefined) {
return this.netsite('/cmd/hotspot', {
cmd: 'delete-voucher',
_id: voucher_id
}, {}, undefined, site);
};
/**
* List port forwarding configuration
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_portforwarding()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_portforwarding = function(site = undefined) {
return this.netsite('/list/portforward', undefined, {}, undefined, site);
};
/**
* List dynamic dns configuration
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_dynamicdns()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_dynamicdns = function(site = undefined) {
return this.netsite('/list/dynamicdns', undefined, {}, undefined, site);
};
/**
* List network port configuration
* @todo Test it
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_portconf()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_portconf = function(site = undefined) {
return this.netsite('/list/portconf', undefined, {}, undefined, site);
};
/**
* List extensions
* @todo Learn more what exactly is this
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_extension()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_extension = function(site = undefined) {
return this.netsite('/list/extension', undefined, {}, undefined, site);
};
/**
* Get array with all the settings refered by settings key
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.list_settings()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_settings = function(site = undefined) {
return this.netsite('/get/setting', undefined, {}, undefined, site)
};
/**
* Restart Wireless Access Point
* @param {string} mac mac address of the AP
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.restart_ap('00:01:02:03:aa:04')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.restart_ap = function(mac = '', site = undefined) {
return this.netsite('/cmd/devmgr', {
cmd: 'restart',
mac: mac.toLowerCase()
}, {}, undefined, site);
};
/**
* Disable Wireless Access Point
* @param {string} ap_id The internal ID of the AP
* @param {boolean} disable Shall we disable it. Optional. Default true. If false, the AP is enabled
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.disable_ap('001fa98a00a22328123')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.disable_ap = function(ap_id = '', disable = true, site = undefined) {
return this.netsite('/rest/device/' + ap_id, {
disabled: disable
}, {}, undefined, site);
};
/**
* Enable Wireless Access Point
* @param {string} ap_id The internal ID of the AP
* @param {boolean} disable Shall we disable it. Optional. Default true. If false, the AP is enabled
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.enable_ap('001fa98a00a22328123')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.enable_ap = function(ap_id = '', disable = false, site = undefined) {
return this.disable_ap(ap_id, disable, site);
};
/**
* Locate Wireless Access Point. The Access Point will start blinking
* @param {string} mac mac of the AP
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_locate_ap('00:01:aa:03:04:05')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_locate_ap = function(mac = '', site = undefined) {
return this.netsite('/cmd/devmgr', {
mac: mac.toLowerCase(),
cmd: 'set-locate'
}, {}, undefined, site);
};
/**
* Turn off Locate Wireless Access Point. The Access Point will stop blinking
* @param {string} mac mac of the AP
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.unset_locate_ap('00:01:aa:03:04:05')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.unset_locate_ap = function(mac = '', site = undefined) {
return this.netsite('/cmd/devmgr', {
mac: mac.toLowerCase(),
cmd: 'unset-locate'
}, {}, undefined, site);
};
/**
* All devices in the site group will start blinking
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.site_ledson()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.site_ledson = function(site = undefined) {
return this.netsite('/set/setting/mgmt', {
led_enabled: true
}, {}, undefined, site);
};
/**
* All devices in the site group will stop blinking
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.site_ledsoff()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.site_ledsoff = function(site = undefined) {
return this.netsite('/set/setting/mgmt', {
led_enabled: false
}, {}, undefined, site);
};
/**
* Change AP wireless settings
* @param {string} ap_id internal id of the AP
* @param {string} radio The radio type. Supports ng or ac. Default ng. Optional
* @param {number} channel Wireless channel. Optional. Default 1. Could be string 'auto'
* @param {number} ht HT width in MHz. 20, 40, 80, 160. Optional. Default 20
* @param {number} tx_power_mode TX Power Mode. Optional. Default 0
* @param {number} tx_power TX Power. Optional. Default 0
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_ap_radiosettings('aa0101023faabbaacc0c0', 'ng', 3, 20)
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_ap_radiosettings = function(ap_id = '', radio = 'ng', channel = 1, ht = '20', tx_power_mode = 0, tx_power = 0) {
return this.netsite('/upd/device/' + ap_id, {
radio: radio,
channel: channel,
ht: ht,
tx_power_mode: tx_power_mode,
tx_power: tx_power
}, {}, undefined, site);
};
/**
* Alias to list_settings. Retrieve array with settings defined by setting key.
* @alias list_settings
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.get_settings()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.get_settings = function(site = undefined) {
return this.netsite('/get/setting', undefined, {}, undefined, site);
};
/**
* Retrieve settings by a specific settings key. Only elements with this settings key will be returned in the array. Usually 1 or 0
* Typical keys are mgmt, snmp, porta, locale, rsyslogd, auto_speedtest, country, connectivity
* @param {string} key key
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.get_settings_by_key('mgmt')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.get_settings_by_key = function(key, site = undefined) {
return new Promise((resolve, reject) => {
this.get_settings(site)
.then((data) => {
data.data = data.data.filter(n => n.key == key);
resolve(data);
})
.catch(reject);
});
};
/**
* Set settings by key modifies properties of the settings, defined by key
* @param {string} key key
* @param {object} obj object of properties that overwrite the original values
* @param {string} site Ubiquiti site to query, if different from default - optional
* @return {Promise} Promise
* @example unifi.set_settings_by_key('mgmt', { auto_upgrade: true })
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_settings = function(key, obj, site = undefined) {
return new Promise((resolve, reject) => {
this.get_settings_by_key(key, site)
.then((data) => {
if (data.data.length < 1) return reject({ msg: 'No such key', meta: { rc: 'error' } });
let o = merge(true, data.data[0], obj);
return this.netsite('/set/setting/' + o.key + '/' + o._id, o, {}, undefined, site);
})
.then(resolve)
.catch(reject);
});
};
/**
* Set Guest Settings and Guest Access Portal are created with this method
* @param {object} obj Object of properties that modify the original values
* @param {string} obj.auth Optional. Type of authentication. hotspot, radius, none, .... Default hotspot
* @param {string} obj.expire Optional. How long the authentication is valid in minutes. Default 480 (8h)
* @param {boolean} obj.facebook_enabled Optional. Allow authentication with facebook. Default false
* @param {boolean} obj.google_enabled Optional. Allow authentication with google+. Default false
* @param {boolean} obj.payment Optional. Allow payments for authentication. Default false
* @param {boolean} obj.portal_customized Optional. Customize the auth portal. Default false
* @param {boolean} obj.portal_enabled Optional. Enable the portal. Default true
* @param {boolean} obj.redirect_enabled Optional. Redirect after authentication. Default false
* @param {string} obj.redirect_url Optional. Redirect URL after successful authentication. Default empty
* @param {boolean} obj.voucher_enabled Optional. If voucher authentication is enabled. Default false
* @param {string} guest_id From the get_settings, the ID of the guest settings
* @param {string} site_id The ID of the current site
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.set_guest_access({ auth: 'hotspot', payment_enabled: true }, 'aabbaa01010203','ccffee0102030303')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_guest_access = function(obj, guest_id, site_id, site = undefined) {
let o = merge({}, {
_id: guest_id || obj._id,
site_id: site_id || obj.site_id,
'auth': 'hotspot',
'expire': '480',
'facebook_enabled': false,
'google_enabled': false,
'key': 'guest_access',
'payment_enabled': false,
'payment_fields_address_enabled': true,
'payment_fields_address_required': true,
'payment_fields_city_enabled': true,
'payment_fields_city_required': true,
'payment_fields_country_default': '',
'payment_fields_country_enabled': true,
'payment_fields_country_required': true,
'payment_fields_first_name_enabled': true,
'payment_fields_first_name_required': true,
'payment_fields_last_name_enabled': true,
'payment_fields_last_name_required': true,
'payment_fields_state_enabled': true,
'payment_fields_state_required': true,
'payment_fields_zip_enabled': true,
'payment_fields_zip_required': true,
'portal_customized': false,
'portal_customized_bg_color': '#cccccc',
'portal_customized_bg_image_enabled': false,
'portal_customized_bg_image_tile': true,
'portal_customized_box_color': '#ffffff',
'portal_customized_box_link_color': '#1379b7',
'portal_customized_box_opacity': 90,
'portal_customized_box_text_color': '#000000',
'portal_customized_button_color': '#1379b7',
'portal_customized_button_text_color': '#ffffff',
'portal_customized_languages': ['en'],
'portal_customized_link_color': '#1379b7',
'portal_customized_logo_enabled': false,
'portal_customized_text_color': '#000000',
'portal_customized_title': 'Hotspot portal',
'portal_customized_tos': 'Terms of Use\n\nBy accessing the wireless network, you acknowledge that you\'re of legal age, you have read and understood and agree to be bound by this agreement.\n\nThe wireless network service is provided by the property owners and is completely at their discretion. Your access to the network may be blocked, suspended, or terminated at any time for any reason.\n\nYou agree not to use the wireless network for any purpose that is unlawful and take full responsibility of your acts.\n\nThe wireless network is provided "as is" without warranties of any kind, either expressed or implied.',
'portal_customized_tos_enabled': true,
'portal_customized_welcome_text_enabled': true,
'portal_customized_welcome_text_position': 'under_logo',
'portal_enabled': true,
'redirect_enabled': false,
'redirect_https': false,
'redirect_to_https': false,
'redirect_url': '',
'restricted_subnet_1': '192.168.0.0/16',
'restricted_subnet_2': '172.16.0.0/12',
'restricted_subnet_3': '10.0.0.0/8',
'template_engine': 'angular',
'voucher_customized': false,
'voucher_enabled': true,
'x_facebook_app_secret': 'UBNT',
'x_google_client_secret': 'UBNT',
'x_password': 'UBNT'
}, obj);
return this.netsite('/set/setting/guest_access/' + o._id, o, {}, undefined, site);
};
/**
* Set Guest Login Settings (simplified version)
* @param {boolean} portal_enabled If the portal is enabled. Optional. Default true
* @param {boolean} portal_customized If the portal is customized. Optional. Default true
* @param {boolean} redirect_enabled If the redirection is enabled. Optional. Default false
* @param {string} redirect_url The url for redirection. Optional. Default ''
* @param {string} x_password Password for the portal. Optional. Default ''
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.set_guestlogin_settings(true, true, true, 'http://news.com')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_guestlogin_settings = function(portal_enabled = true, portal_customized = true, redirect_enabled = false, redirect_url = '', x_password = '', expire_number = undefined, expire_unit = undefined, site_id = undefined, site = undefined) {
return this.netsite('/set/setting/guest_access', {
portal_enabled: portal_enabled,
portal_customized: portal_customized,
redirect_enabled: redirect_enabled,
redirect_url: redirect_url,
x_password: x_password,
expire_number: expire_number,
expire_unit: expire_unit,
site_id: site_id
}, {}, undefined, site);
};
/**
* Rename Access Point
* @param {string} ap_id Id of the AP
* @param {string} ap_name New name of the AP
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.rename_ap('ccffee0102030303','My Access Point')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.rename_ap = function(ap_id = '', ap_name = '', site = undefined) {
return this.netsite('/upd/device/' + ap_id, {
name: ap_name
}, {}, undefined, site);
};
/**
* Set WLAN Settings
* @param {strings} wlan_id ID of the Wlan
* @param {string} x_password Password of the WLAN
* @param {string} name Name of the WLAN
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.set_wlansettings('ccffee0102030303', 'guest', 'GuestWLAN')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_wlansettings = function(wlan_id = '', x_password = undefined, name = undefined, site = undefined) { // TODO: test it
return this.netsite('/upd/wlanconf/' + wlan_id, {
x_passphrase: x_password,
name: name
}, {}, undefined, site);
};
/**
* List the Events
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.list_events()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_events = function(site = undefined) {
return this.netsite('/stat/event', undefined, {}, undefined, site);
};
/**
* Get WLAN Config. Respond with Array of Wlan configurations
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.list_wlanconf()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_wlanconf = function(site = undefined) {
return this.netsite('/list/wlanconf', undefined, {}, undefined, site);
};
/**
* Get WLAN Config. Second REST option. Respond with Array of Wlan configurations
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.get_wlanconf()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.get_wlanconf = function(site = undefined) {
return this.netsite('/rest/wlanconf', undefined, {}, undefined, site);
};
/**
* List the Alarms
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.list_alarms()
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.list_alarms = function(site = undefined) {
return this.netsite('/list/alarm', undefined, {}, undefined, site);
};
/**
* Set the access point LED
* @param {string} ap_id AP ID
* @param {string} led_override Do we follow the standard LED config. Options default and overwrite
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.set_ap_led('12312312312','default')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_ap_led = function(ap_id = '', led_override = 'default', site = undefined) {
return this.netsite('/rest/device/' + ap_id, {
led_override: led_override
}, {}, undefined, site);
};
/**
* Change the name of an Access Point
* @param {string} ap_id the ID of the AP
* @param {string} name the new name
* @param {string} site Ubiquiti site to query, if different from default - optonal
* @return {Promise} Promise
* @example unifi.set_ap_name('12312312312','new ap')
* .then(done => console.log('Success',done))
* .catch(err => console.log('Error',err))
*/
UnifiAPI.prototype.set_ap_name = function(ap_id, name = '', site = undefined) {
return this.