Skip to content
This repository has been archived by the owner on Apr 3, 2020. It is now read-only.

Invoke UniFiApiLogin

Joerg Hochwald edited this page Feb 2, 2019 · 23 revisions

external help file: UniFiTooling-help.xml HelpVersion: 1.1.0 Locale: en-US Module Guid: 7fff91a0-02eb-4df2-84d5-c7d3cd7f7a5d Module Name: UniFiTooling online version: https://github.com/Enatec/UniFiTooling/raw/master/docs/Invoke-UniFiApiLogin.md schema: 2.0.0

Invoke-UniFiApiLogin

SYNOPSIS

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

SYNTAX

Invoke-UniFiApiLogin [<CommonParameters>]

DESCRIPTION

It sends a login request via Ubiquiti (UBNT) UniFi RESTful API request on the UniFi SDN Controller.

EXAMPLES

EXAMPLE 1

Invoke-UniFiApiLogin

Login to API of the Ubiquiti UniFi Controller

PARAMETERS

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Initial version of the Ubiquiti UniFi Controller automation function

RELATED LINKS

Get-UniFiConfig

Get-UniFiCredentials

Set-UniFiDefaultRequestHeader

Invoke-UniFiApiLogout