/unifi-ps

PowerShell module to query the Unifi Controller REST API.

Primary LanguagePowerShellMIT LicenseMIT

PowerShell Gallery Version Documentation Status License: MIT

Unifi-PS

PowerShell Unifi REST API Wrapper Module

What is the Unifi REST API?

Unifi Controllers, used for managing Ubiquiti Unifi devices have an unpublished REST API that can be used to query data and modify settings.

What is Unifi-PS?

Unifi-PS is a Unifi REST API Wrapper Module for PowerShell used to query data from the Unifi Controller. This module does not contain functionality to make settings changes as this REST API is unpublished.

Using Unifi-PS

Unifi-PS is available on the PowerShell Gallery.

Installation

Install-Module -Name Unifi-PS

Documentation and Help

The online documentation for this module is available at https://unifi-ps.readthedocs.io.

The console documentation can be accessed with Get-Help.

Quickstart

Set-UnifiAPIConfig -BaseUri "unifi.contoso.com"
Connect-UnifiController
$Sites = Get-UnifiSites
Disconnect-UnifiController
Remove-UnifiAPIConfig

Licensing

Unifi-PS is licensed under the MIT license.