UniFiTooling

---

Module Name: UniFiTooling Module Guid: 7fff91a0-02eb-4df2-84d5-c7d3cd7f7a5d Download Help Link: https://github.com/Enatec/UniFiTooling/raw/master/docs/README.md Help Version: 1.1.0 Locale: en-US

UniFiTooling Module

Description

Ubiquiti UniFi Security Gateway automation via the API of the Ubiquiti UniFi Controller

UniFiTooling Cmdlets

Get-Unifi5minutesApStats

Get statistics in five-minute segments for all or a given access point via API on the UniFi SDN Controller.

Get-Unifi5minutesClientStats

Get statistics in five-minute segments for a given user/client via API on the UniFi SDN Controller.

Get-Unifi5minutesGatewayStats

Get statistics in five-minute segments for a USG via API on the UniFi SDN Controller.

Get-Unifi5minutesSiteStats

Get statistics in five-minute segments for a complete Site via API on the UniFi SDN Controller.

Get-UnifiDailyApStats

Get daily statistics for all or a given access point via API on the UniFi SDN Controller.

Get-UnifiDailyClientStats

Get daily statistics for a given user/client via API on the UniFi SDN Controller.

Get-UnifiDailyGatewayStats

Get daily statistics for a USG via API on the UniFi SDN Controller.

Get-UnifiDailySiteStats

Get daily statistics for a complete Site via API on the UniFi SDN Controller.

Get-UnifiFirewallGroupDetails

Get details about one given USG firewall groups via API on the UniFi SDN Controller.

Get-UnifiFirewallGroups

Get a list of configured USG firewall groups via API on the UniFi SDN Controller.

Get-UnifiHourlyApStats

Get hourly statistics for all or a given access point via API on the UniFi SDN Controller.

Get-UnifiHourlyClientStats

Get hourly statistics for a given user/client via API on the UniFi SDN Controller.

Get-UnifiHourlyGatewayStats

Get hourly statistics for a USG via API on the UniFi SDN Controller.

Get-UnifiHourlySiteStats

Get hourly statistics for a complete UniFi Site via API on the UniFi SDN Controller.

Get-UnifiNetworkDetails

Get the details about a given network via API on the UniFi SDN Controller.

Get-UnifiNetworkList

Get a list of configured networks via API on the UniFi SDN Controller.

Get-UnifiSpeedTestResult

Get USG speed test results via API on the UniFi SDN Controller.

Invoke-UniFiApiLogin

It sends a login request via API on the UniFi SDN Controller.

Invoke-UniFiApiLogout

It sends a logout request via API on the UniFi SDN Controller.

Invoke-UnifiAuthorizeGuest

It authorizes a given user/client via API on the UniFi SDN Controller.

Invoke-UnifiBlockClient

It blocks a given user/client via API on the UniFi SDN Controller.

Invoke-UnifiForgetClient

It forgets one or more given users/clients via API on the UniFi SDN Controller.

Invoke-UnifiReconnectClient

It reconnects a given user/client via API on the UniFi SDN Controller.

Invoke-UnifiUnauthorizeGuest

It uauthorizes a user/client via API on the UniFi SDN Controller.

Invoke-UnifiUnblockClient

It unblocks a given user/client via API on the UniFi SDN Controller.

New-UnifiClientDevice

It creates a new user/client via API on the UniFi SDN Controller.

New-UniFiConfig

It creates the JSON configuration file for the UniFiTooling Module.

Set-UnifiFirewallGroup

Get information about a given Firewall Group via API of the UniFi SDN Controller.

Set-UnifiNetworkDetails

It modifies a given network via the API of the UniFi Controller.