Ban MQTT Client
emqx_banBlock unwanted clients from connecting by banning a client ID, username, or IP address. Bans persist until they expire or are explicitly removed.
Instructions
[DESTRUCTIVE] Block a client id, username or IP from connecting.
Unlike emqx_kick_client this persists — the target stays out until the ban expires or is lifted with emqx_unban.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"subject_type": "<subject_type>",
"who": "<who>"
},
"name": "emqx_ban"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| who | Yes | The exact value to ban. | |
| until | No | Unix seconds when the ban lifts. Omit for permanent. | |
| reason | No | Free-text note kept with the ban entry. | |
| subject_type | Yes | What to match on: client id, username or peer IP. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||