Skip to content

Ubiquiti UniFi Controller Module 1.0.11

I published a new version, Release 1.0.11, of the Ubiquiti UniFi Controller API Management and automation module.

Even if I marked this as a minor release, this one contains a lot of new functionality.
Release Notes:

Added

  • Get-UnifiHourlySiteStats – Get horly statistics for a complete UniFi Site
  • Get-UnifiDailySiteStats – Get daily statistics for a complete UniFi Site
  • Get-Unifi5minutesSiteStats – Get statistics in 5 minute segments for a complete UniFi Site
  • Get-Unifi5minutesGatewayStats – Get statistics in 5 minute segments for the USG (UniFi Secure Gateway)
  • Get-UnifiHourlyGatewayStats – Get hourly statistics for the USG (UniFi Secure Gateway)
  • Get-UnifiDailyGatewayStats – Get daily statistics for the USG (UniFi Secure Gateway)
  • Get-UnifiDailyClientStats – Get daily user/client statistics for a given user/client
  • Get-UnifiHourlyClientStats – Get hourly user/client statistics for a given user/client
  • Get-Unifi5minutesClientStats – Get user/client statistics in 5 minute segments for a given client
  • Get-UnifiDailyApStats – Get daily stats for all or just one access points in a given UniFi site
  • Get-UnifiHourlyApStats – Get hourly stats for all or just one access points in a given UniFi site
  • Get-Unifi5minutesApStats – Get the stats in 5 minute segments for all or just one access points in a given UniFi site
  • ConvertTo-UniFiValidMacAddress – Helper to check and make sure we have the right format (private function)
  • Get-CallerPreference – Add private meta function
  • CODEOWNERS – Add GitHub code owners feature file
  • Set-UnifiClientDeviceNote – Add/modify/remove a client-device note
  • Set-UnifiClientDeviceName – Add/modify/remove a client device name
  • New-UnifiClientDevice – Create a new user/client-device (unfinished beta)

Changed

  • New-UnifiClientDevice now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiUnblockClient now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiUnauthorizeGuest now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiReconnectClient now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiForgetClient now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiBlockClient now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Invoke-UnifiAuthorizeGuest now use ConvertTo-UniFiValidMacAddress to check and make sure we have the right format
  • Get-CallerPreference – Implemented private meta function usage to all (public/private) functions

Removed

  • Get-HostsFile should never be a part of this module. I just use them for some internal tests.
  • Add-HostsEntry should never be a part of this module. I just use them for some internal tests.
  • Get-HostsFile should never be a part of this module. I just use them for some internal tests.

Fixed

  • Fixed the Get-CallerPreference usage

Feel free to install it from the PowerShell Gallery.

# Install the module for the Current User with PowerShellGet directly from the Powershell Gallery, Preferred method
# Run in a regular or administrative PowerShell prompt (Elevated).
Install-Module -Name 'UniFiTooling' -Scope CurrentUser

# Install the module for the All Users with PowerShellGet directly from the Powershell Gallery, Preferred method.
# Run this in an administrative PowerShell prompt (Elevated).
Install-Module -Name 'UniFiTooling' -Scope AllUsers

Powershell Gallery

You will find the latest version in the release page of the GitHub repository for this module.

GitHub release

Published inNewsPowerShell

4 Comments

  1. Reinhard Reinhard

    Hallo Joerg, kann das Unifi Modul auch zB eine Liste von WLAN Clients ausgeben? Falls ja, wie kann ich mir diese Clients ausgeben lassen?
    lg aus Oberösterreich
    Reinhard

    • Joerg Hochwald Joerg Hochwald

      Hallo Reinhard,

      du wirst lachen: Aktuell noch nicht 🙁
      Das liegt daran, dass ich die einfachen Tasks erstmal nach hinten geschoben habe.

      Aber: Im nächsten Release sind genau solche Dinge drin.

  2. marco marco

    Hi Joerg,

    Any plans to expand the command set to more devices from the controller?
    currently looking to programatically get all devices from all sites.

    Kind regards,
    Marco

    • Joerg Hochwald Joerg Hochwald

      Hi Marco,

      there are plans to extend the module. But I dropped the usage of all USG’s and most of the UniFi Switches. Mostly because of the issues that we had and the lag of interest from the vendor! They still not fixed the issues with IPv6 or the PPOE issue is posted an article about, several months ago.

      Anyway: We still use the UniFi AccessPoints! I might find the time to work on the module in August or September. The drop of UniFi equipment dramatically changed my priorities.

      Automation is still my top goal, but now more the automation of the equipment that I really use and need. And that are opnSense firewalls and Cisco Switches, cause that is the backbone of our network.

      Cheers
      Josh

Comments are closed.