Getting all alarms of all Unifi sites with PowerShell

For reporting purposes I sometimes like collecting our all alert logs for my Ubiquity Unifi sites. Of course I want this in a nice readable format so I create a HTML file with all output from the unifi API.

First we start with connecting to the Unifi controller and creating a websession. This websession is used to authenticate us to the Unifi Controller.

param(
[string]$URL = 'yourcontroller.controller.tld',
[string]$port = '8443',
[string]$User = 'APIUSER',
[string]$Pass = 'SomeReallyLongPassword'
)
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}
[string]$controller = "https://$($URL):$($port)"
[string]$credential = "`{`"username`":`"$User`",`"password`":`"$Pass`"`}"
try {
$null = Invoke-Restmethod -Uri "$controller/api/login" -method post -body $credential -ContentType "application/json; charset=utf-8"  -SessionVariable myWebSession
}catch{
$APIerror = "Api Connection Error: $($_.Exception.Message)"
}

Now that we’re connecting, we can start making API calls, our first call is to collect all sites so we will be able to loop trough the sites, when doing this we will be using the data from our previous websession in $myWebSession

try {
    $SiteList = Invoke-Restmethod -Uri "$controller/api/s" -WebSession $myWebSession
    }catch{
    $APIerror = "Query Failed: $($_.Exception.Message)"
    }

$SiteList.data is now filled with the list of all sites on the controller. The next step will be to process this and gather all the alerts from these sites.

foreach($Site in $SiteList.data) {
$SiteID = $($Site.Name)
$AlertsForSite = Invoke-Restmethod -Uri "$controller/api/s/$($siteID)/stat/alarm" -WebSession $myWebSession 
$AlarmsArray += $AlertsForSite.data | convertto-html -Title "Alarm Report Unifi" -PreContent "<h1>$($site.desc)</h1>" -PostContent "<h5><i>$(get-date)</i></h5>" 
}

Now all we have to do is export the $Alarmsarray to a html file which gives us the report in a decent-looking/editable HTML format:

$AlarmsArray | Out-File "C:\temp\AlarmOutput.html"

The complete script is included for reference below, or just for easy copy and pasting 😉

<code>param(
[string]$URL = 'yourcontroller.controller.tld',
[string]$port = '8443',
[string]$User = 'APIUSER',
[string]$Pass = 'APIUSERPASS'
)
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}
[string]$controller = "https://$($URL):$($port)"
[string]$credential = "`{`"username`":`"$User`",`"password`":`"$Pass`"`}"
try {
$null = Invoke-Restmethod -Uri "$controller/api/login" -method post -body $credential -ContentType "application/json; charset=utf-8"  -SessionVariable myWebSession
}catch{
$APIerror = "Api Connection Error: $($_.Exception.Message)"
}

try {
    $SiteList = Invoke-Restmethod -Uri "$controller/api/self/sites" -WebSession $myWebSession
    }catch{
    $APIerror = "Query Failed: $($_.Exception.Message)"
    }

foreach($Site in $SiteList.data) {
$SiteID = $($Site.Name)
$AlertsForSite = Invoke-Restmethod -Uri "$controller/api/s/$($siteID)/stat/alarm" -WebSession $myWebSession 
$AlarmsArray += $AlertsForSite.data | convertto-html -Title "Alarm Report Unifi" -PreContent "&lt;H1>$($site.desc)&lt;/H1>" -PostContent "&lt;H5>&lt;i>$(get-date)&lt;/i>&lt;/H5>" 
}

$AlarmsArray | Out-File "C:\temp\AlarmOutput.html"</code>

and tada! thats it. As always, Be carefull and Happy PowerShelling!

2 thoughts on “Getting all alarms of all Unifi sites with PowerShell

  1. Rob Eberhardt

    This is great, thanks for sharing!

    Heads-up that I had to fix it to make it work — the uri in your 2nd code block is incomplete.
    (Fortunately, you included the whole thing at the bottom, but unfortunately that one is unformatted.)

    Reply
    1. Kelvin Tegelaar Post author

      Hi Rob, Thanks for the heads up! It seems wordpress does not like the bit of HTML code in the PowerShell script. I fixed it so you should be able to copy the entire code. 🙂

      Reply

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.