Project

General

Profile

Actions

Todo #13020

closed

Improve ``easyrule`` command documentation

Added by Ronald Antony about 2 years ago. Updated about 1 year ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Firewall Rules
Target version:
-
Start date:
Due date:
% Done:

100%

Estimated time:

Description

At https://docs.netgate.com/pfsense/en/latest/firewall/easyrule.html#easyrule-in-the-shell the documentation is typically terse. But documentation should not be for those who already know things, but for those who know nothing.

The entire page there does not make one mention of what wildcards are permissible.

With trial and error (because I had the specific need) I ended up figuring out that

easyrule pass wan any any any any

works, but would

easyrule pass any any any any any

also work? Don't know, wasn't in a position to risk my setup playing aroud with it. And frankly, nobody should be having to do trial and error, one should be able to read the documentation, and know what, if any, wildcards are applicable for each parameter to the command.

Actions #1

Updated by Jim Pingle about 2 years ago

  • Assignee set to Jim Pingle
Actions #2

Updated by Jim Pingle almost 2 years ago

  • Subject changed from easyrule command documentation should document permissible wildcards to Improve ``easyrule`` command documentation

This could use some expansion in general. As it is, it's just a copy of the CLI usage output.

There are some other useful things missing as well, like the unblock and showblock actions.

Actions #3

Updated by Jim Pingle over 1 year ago

  • Status changed from New to In Progress
Actions #5

Updated by Jim Pingle about 1 year ago

  • Status changed from Feedback to Resolved
Actions

Also available in: Atom PDF