Disconnect-UnifiClient
SYNOPSIS
Blocks a client from accessing the network
SYNTAX
Disconnect-UnifiClient [-Url] <String> [-WebSession] <WebRequestSession> [-SiteName] <String>
[-MacAddress] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Blocks a client from accessing the network
EXAMPLES
EXAMPLE 1
$Credential = $(Get-SecureCredential -Name 'Unifi' -VaultName 'MyVault')
PS>$Url = "https://unifi.domain.com:8443"
PS>$session = Get-UnifiSession -Url $Url -Credential $Credential
PS>$MySite = Get-UnifiSite -Url $Url -WebSession $session -SiteName 'MySite'
PS>$Device = Get-UnifiConnectedClient -Url $Url -WebSession $session -SiteName $MySite.name | where-object {$_.hostname -ieq 'MyDvice'}
PS>Disconnect-UnifiClient -Url $Url -WebSession $session -SiteName $MySite.name -MacAddress $Device.mac
PS>Remove-UnifiSession -Url $Url -WebSession $session -Confirm:$false
PARAMETERS
-Url
Target UniFi Url
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WebSession
UniFi web session
Type: WebRequestSession
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SiteName
Target site ID. Use the 'name' property of the target site.
Type: String
Parameter Sets: (All)
Aliases: name
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MacAddress
Target device mac address
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.