reconnect_client
reconnect_client
Section titled “reconnect_client”Force a client to reconnect (kick-sta).
Side effects:
- Issues a deauthentication frame for
macon its current AP. The client immediately disconnects and most clients re-associate automatically within seconds. - The block-list is not modified; this is a transient nudge.
- Mutates controller state. Use dry_run=True to preview the change without applying.
Example
Section titled “Example”reconnect_client(mac="aa:bb:cc:00:00:01")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mac |
string |
yes | — | Client MAC address (e.g. "aa:bb:cc:00:00:01"). |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |
dry_run |
boolean |
no | false | Preview the change without applying it. Returns the predicted change set. |