Skip to content

Instantly share code, notes, and snippets.

@adamhancock
Created September 30, 2019 17:05
Show Gist options
  • Save adamhancock/8d753779b2889cdfdbcf833127e70501 to your computer and use it in GitHub Desktop.
Save adamhancock/8d753779b2889cdfdbcf833127e70501 to your computer and use it in GitHub Desktop.
#!/bin/sh
# https://dl.ubnt.com/unifi/5.11.46/unifi_sh_api
#username=ubnt
#password=ubnt
#baseurl=https://unifi:8443
#site=default
#[ -f ./unifi_sh_env ] && . ./unifi_sh_env
cookie=$(mktemp)
curl_cmd="curl --tlsv1 --silent --cookie ${cookie} --cookie-jar ${cookie} --insecure "
named_args_to_payload() {
payload=""
for a in "$@" ; do
if [ "${a##*=*}" = "" ] ; then
k=`echo $a | cut -d = -f 1`
v=`echo $a | cut -d = -f 2`
payload="${payload}, \"$k\":\"$v\""
fi
done
echo ${payload}
}
unifi_requires() {
if [ -z "$username" -o -z "$password" -o -z "$baseurl" -o -z "$site" ] ; then
echo "Error! please define required env vars before including unifi_sh. E.g. "
echo ""
echo "export username=ubnt"
echo "export password=ubnt"
echo "export baseurl=https://localhost:8443"
echo "export site=default"
echo ""
return
fi
}
unifi_login() {
# authenticate against unifi controller
${curl_cmd} --data "{\"username\":\"$username\", \"password\":\"$password\"}" $baseurl/api/login
}
unifi_logout() {
# logout
${curl_cmd} $baseurl/logout
}
unifi_api() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <uri> [json]"
echo " uri example /stat/sta "
return
fi
uri=$1
shift
[ "${uri:0:1}" != "/" ] && uri="/$uri"
json="$@"
[ "$json" = "" ] && json="{}"
${curl_cmd} --data "$json" $baseurl/api/s/$site$uri
}
# cmd/stamgr
# authorize-guest(mac, minutes, [up=kbps, down=kbps, bytes=MB])
unifi_authorize_guest() {
if [ $# -lt 2 ] ; then
echo "Usage: $0 <mac> <minutes> [up=kbps] [down=kbps] [bytes=MB] [ap_mac=mac]"
return
fi
mac=$1
minutes=$2
other_payload=`named_args_to_payload "$@"`
${curl_cmd} --data "{\"cmd\":\"authorize-guest\", \"mac\":\"${mac}\", \"minutes\":${minutes}${other_payload}}" $baseurl/api/s/$site/cmd/stamgr
}
# cmd/stamgr
# unauthorize-guest(mac)
unifi_unauthorize_guest() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <mac>"
return
fi
mac=$1
${curl_cmd} --data "{\"cmd\":\"unauthorize-guest\", \"mac\":\"${mac}\"}" $baseurl/api/s/$site/cmd/stamgr
}
# cmd/stamgr
# kick-sta(mac)
unifi_reconnect_sta() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <mac>"
return
fi
mac=$1
${curl_cmd} --data "{\"cmd\":\"kick-sta\", \"mac\":\"${mac}\"}" $baseurl/api/s/$site/cmd/stamgr
}
# cmd/stamgr
# block-sta(mac)
unifi_block_sta() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <mac>"
return
fi
mac=$1
${curl_cmd} --data "{\"cmd\":\"block-sta\", \"mac\":\"${mac}\"}" $baseurl/api/s/$site/cmd/stamgr
}
unifi_backup() {
if [ "$1" = "" ]; then
output=unifi-backup.unf # or `date +%Y%m%d`.unf
else
output=$1
fi
# ask controller to do a backup, response contains the path to the backup file
path=`$curl_cmd --data "{\"cmd\":\"backup\"}" $baseurl/api/s/$site/cmd/backup | sed -n 's/.*\(\/dl.*unf\).*/\1/p'`
# download the backup to the destinated output file
$curl_cmd $baseurl$path -o $output
}
# cmd/hotspot
# create-voucher(expires, n, [note=notes, up=kbps, down=kbps, bytes=MB])
# @returns create_time
unifi_create_voucher() {
if [ $# -lt 2 ] ; then
echo "Usage: $0 <minutes> <n> [note=notes] [up=kbps] [down=kbps] [bytes=MB]"
return
fi
minutes=$1
n=$2
other_payload=`named_args_to_payload "$@"`
token=`${curl_cmd} --data "{\"cmd\":\"create-voucher\",\"expire\":${minutes},\"n\":$n ${other_payload}}" $baseurl/api/s/$site/cmd/hotspot \
| sed -e 's/.*"create_time"\s*:\s*\([0-9]\+\).*/\1/'`
echo "token=$token"
if [ "$token" != "" ] ; then
${curl_cmd} --data "{\"create_time\":${token}}" $baseurl/api/s/$site/stat/voucher
fi
}
# stat/voucher
# query(create_time)
unifi_get_vouchers() {
set -x
if [ $# -lt 0 ] ; then
echo "Usage: $0 [token]"
return
fi
token=$1
[ "$token" != "" ] && other_payload="\"create_time\":${token}"
${curl_cmd} --data "{${other_payload}}" $baseurl/api/s/$site/stat/voucher
echo ${curl_cmd} --data "{${other_payload}}" $baseurl/api/s/$site/stat/voucher
}
# delete-voucher(id)
unifi_delete_voucher() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <id>"
return
fi
id=$1
${curl_cmd} --data "{\"cmd\":\"delete-voucher\",\"_id\":\"${id}\"}" $baseurl/api/s/$site/cmd/hotspot
}
# stat/sta
unifi_list_sta() {
${curl_cmd} --data "{}" $baseurl/api/s/$site/stat/sta
}
# upgrade device to the given firmware
unifi_upgrade_external() {
if [ $# -lt 2 ] ; then
echo "Usage: $0 <mac> <firmware_url>"
return
fi
mac=$1
firmware_url=$2
${curl_cmd} --data "{\"url\":\"${firmware_url}\", \"mac\":\"${mac}\"}" $baseurl/api/s/$site/cmd/devmgr/upgrade-external
}
# press upgrade button
unifi_upgrade() {
if [ $# -lt 1 ] ; then
echo "Usage: $0 <mac>"
return
fi
mac=$1
${curl_cmd} --data "{\"mac\":\"${mac}\"}" $baseurl/api/s/$site/cmd/devmgr/upgrade
}
unifi_list_devices() {
${curl_cmd} --data "{}" $baseurl/api/s/$site/stat/device
}
unifi_requires
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment