Skip to main content

Get-UnifiController

Description

Returns a unifiController object containing all site data.

Requirements

  • PowerShell v5
  • Unifi module

Usage

  1. Imports the Unifi module.
  2. Connects to the Unifi API.
  3. Creates and returns a Unifi controller object.
.\Get-UnifiController.ps1 -TargetName 'localhost' -Port 8443 -Credential $credential

Parameters

ParameterAliasRequiredDefaultTypeDescription
TargetNameTrueStringThe host name or the IP address of the target Unifi controller.
PortFalse8443IntThe port designated for the Unifi controller.
CredentialTruePSCredentialA credential object to access the Unifi controller.

Output

Location of output for log, result, and error files.

System.Object