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

Invoke UnifiReconnectClient

Joerg Hochwald edited this page Feb 2, 2019 · 5 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-UnifiReconnectClient.md schema: 2.0.0

Invoke-UnifiReconnectClient

SYNOPSIS

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

SYNTAX

Invoke-UnifiReconnectClient [[-UnifiSite] <String>] [-Mac] <String> [<CommonParameters>]

DESCRIPTION

It reconnects a given user/client via Ubiquiti (UBNT) UniFi RESTful API request on the UniFi SDN Controller.

EXAMPLES

EXAMPLE 1

Invoke-UnifiReconnectClient -Mac '84:3a:4b:cd:88:2D'

Reconnect a client device via the API of the UniFi Controller

EXAMPLE 2

Invoke-UnifiReconnectClient -Mac '84:3a:4b:cd:88:2D' -UnifiSite 'Contoso'

Reconnect a client device on Site 'Contoso' via the API of the UniFi Controller

PARAMETERS

-UnifiSite

UniFi Site as configured. The default is: default

Type: String
Parameter Sets: (All)
Aliases: Site

Required: False
Position: 1
Default value: Default
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Mac

Client MAC address

Type: String
Parameter Sets: (All)
Aliases: UniFiMac, MacAddress

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

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

System.Boolean

NOTES

Initial version of the Ubiquiti UniFi Controller automation function

RELATED LINKS

Get-UniFiConfig

Set-UniFiDefaultRequestHeader

Invoke-UniFiApiLogin

Invoke-RestMethod

Clone this wiki locally