Command Reference

Admin Tools CLI offers a relatively large number of commands which allow you to do almost everything you can do through the graphical user interface. For simplicity's sake we have grouped them under different categories, depending on what is the target of the command.

Blocked Request Management

These commands allow you to manage blocked requests, automatically banned IP addresses and the automatic IP address ban history. Their main purpose is to determine if and why an IP address has been blocked from accessing your site (banned) and why, as well as unblocking a banned IP address.

admintools:autoban:list

What it does: Lists Admin Tools WAF Automatically Blocked IPs.

Syntax: admintools:autoban:list [--format=FORMAT]

Arguments

This command takes no arguments.

Options

--format=FORMAT

Optional. The output format, as described above.

Possible values: table, json, yaml, csv, count

admintools:autoban:remove

What it does: Removes an entry from Admin Tools Automatically Blocked IP list.

Syntax: admintools:autoban:remove [<id>]

Arguments

<id>

The numeric ID of the row you want to remove, as reported by admintools:autoban:list

[Tip]Tip

If you want to remove a record by IP address use admintools:unblock instead.

Options

This command takes no options.

admintools:autobanhistory:list

What it does: Lists Admin Tools Automatic IP Blocking History.

Syntax: admintools:autobanhistory:list [--format=FORMAT]

Arguments

This command takes no arguments.

Options

--format=FORMAT

Optional. The output format, as described above.

Possible values: table, json, yaml, csv, count

admintools:autobanhistory:remove

What it does: Removes an entry from Admin Tools Automatic IP Blocking History.

Syntax: admintools:autobanhistory:remove [<id>]

Arguments

<id>

The numeric ID of the row you want to remove, as reported by admintools:autobanhistory:list

[Tip]Tip

If you want to remove a record by IP address use admintools:unblock instead.

Options

This command takes no options.

admintools:log:list

What it does: Lists Admin Tools WAF blocked requests.

Syntax: admintools:log:list [--format=FORMAT]

Arguments

This command takes no arguments.

Options

--format=FORMAT

Optional. The output format, as described above.

Possible values: table, json, yaml, csv, count

admintools:log:remove

What it does: Removes an entry from Admin Tools WAF blocked requests.

Syntax: admintools:log:remove [<id>]

Arguments

<id>

The numeric ID of the row you want to remove, as reported by admintools:log:list

[Tip]Tip

If you want to remove a record by IP address use admintools:unblock instead.

Options

This command takes no options.

admintools:unblock

What it does: Unblocks an IP address removing all entries with that IP address from the Blocked Requests Log, the Automatically Blocked IP Addresses and the Automatic IP Blocking History.

Syntax: admintools:unblock --ip=IP

Arguments

This command takes no arguments.

Options

--ip=IP

Mandatory. The IP address to unblock, e.g. --ip=10.3.14.15