romain-dartigues
/
cdist
forked from ungleich-public/cdist
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
cdist/cdist/conf/type/__pf_ruleset/man.rst

52 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
cdist-type__pf_ruleset(7)
fix manpages of __pf_ruleset and __pf_apply Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
2012-10-26 16:38:14 +00:00
=========================
Better sphinx manpage ext. Add custom dotman Makefile target for custom .cdist directory.
2016-06-23 14:08:59 +00:00
NAME
----
cdist-type__pf_ruleset - Copy a pf(4) ruleset to $__target_host
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
Jake Guffey <jake.guffey--@--eprotex.com>
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
DESCRIPTION
-----------
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
This type is used on \*BSD systems to manage the pf firewall's ruleset.
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
REQUIRED PARAMETERS
-------------------
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
state
Make state parameter optional for all types, fixes #131
2014-02-08 20:48:51 +00:00
Either "absent" (no ruleset at all) or "present", defaults to "present".
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
OPTIONAL PARAMETERS
-------------------
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
source
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
If supplied, use to define the ruleset to load onto the $__target_host for pf(4).
Note that this type is almost useless without a ruleset defined, but it's technically not
needed, e.g. for the case of disabling the firewall temporarily.
documentation cleanups Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
2012-11-07 18:22:02 +00:00
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
EXAMPLES
--------
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
.. code-block:: sh
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
# Remove the current ruleset in place
__pf_ruleset --state absent
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
# Enable the firewall with the ruleset defined in $__manifest/files/pf.conf
__pf_ruleset --state present --source $__manifest/files/pf.conf
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
SEE ALSO
--------
Write sphinx rst docs.
2016-05-20 06:50:56 +00:00
- `cdist-type(7) <cdist-type.html>`_
Initial commit Broke old __pf type into __pf_* Initial commit of __pf_ruleset type with basic logic
2012-09-19 18:50:28 +00:00
- pf(4)
COPYING
-------
Copyright \(C) 2012 Jake Guffey. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).