mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
[PR #9338/2005125a backport][stable-9] u[a-s]*: normalize docs (#9360)
u[a-s]*: normalize docs (#9338)
* u[a-s]*: normalize docs
* Update plugins/modules/udm_dns_record.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/udm_dns_record.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/udm_dns_record.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/udm_dns_zone.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/ufw.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 2005125af4)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
961ba0ddcc
commit
8031011497
9 changed files with 846 additions and 888 deletions
|
|
@ -11,26 +11,24 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: ufw
|
||||
short_description: Manage firewall with UFW
|
||||
description:
|
||||
- Manage firewall with UFW.
|
||||
- Manage firewall with UFW.
|
||||
author:
|
||||
- Aleksey Ovcharenko (@ovcharenko)
|
||||
- Jarno Keskikangas (@pyykkis)
|
||||
- Ahti Kitsik (@ahtik)
|
||||
- Aleksey Ovcharenko (@ovcharenko)
|
||||
- Jarno Keskikangas (@pyykkis)
|
||||
- Ahti Kitsik (@ahtik)
|
||||
notes:
|
||||
- See C(man ufw) for more examples.
|
||||
- >
|
||||
B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency,
|
||||
as firewall rules are meant to be ordered and parallel executions do not guarantee order.
|
||||
B(Do not use concurrency:) The results are unpredictable and the module may fail silently if you do.
|
||||
- See C(man ufw) for more examples.
|
||||
- "B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency, as firewall rules are meant
|
||||
to be ordered and parallel executions do not guarantee order. B(Do not use concurrency:) The results are unpredictable and the module may
|
||||
fail silently if you do."
|
||||
requirements:
|
||||
- C(ufw) package
|
||||
- C(ufw) package
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
|
|
@ -44,59 +42,52 @@ options:
|
|||
- V(reloaded) reloads firewall.
|
||||
- V(reset) disables and resets firewall to installation defaults.
|
||||
type: str
|
||||
choices: [ disabled, enabled, reloaded, reset ]
|
||||
choices: [disabled, enabled, reloaded, reset]
|
||||
default:
|
||||
description:
|
||||
- Change the default policy for incoming or outgoing traffic.
|
||||
type: str
|
||||
choices: [ allow, deny, reject ]
|
||||
aliases: [ policy ]
|
||||
choices: [allow, deny, reject]
|
||||
aliases: [policy]
|
||||
direction:
|
||||
description:
|
||||
- Select direction for a rule or default policy command. Mutually
|
||||
exclusive with O(interface_in) and O(interface_out).
|
||||
- Select direction for a rule or default policy command. Mutually exclusive with O(interface_in) and O(interface_out).
|
||||
type: str
|
||||
choices: [ in, incoming, out, outgoing, routed ]
|
||||
choices: [in, incoming, out, outgoing, routed]
|
||||
logging:
|
||||
description:
|
||||
- Toggles logging. Logged packets use the LOG_KERN syslog facility.
|
||||
type: str
|
||||
choices: [ 'on', 'off', low, medium, high, full ]
|
||||
choices: ['on', 'off', low, medium, high, full]
|
||||
insert:
|
||||
description:
|
||||
- Insert the corresponding rule as rule number NUM.
|
||||
- Note that ufw numbers rules starting with 1.
|
||||
- If O(delete=true) and a value is provided for O(insert),
|
||||
then O(insert) is ignored.
|
||||
- If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored.
|
||||
type: int
|
||||
insert_relative_to:
|
||||
description:
|
||||
- Allows to interpret the index in O(insert) relative to a position.
|
||||
- V(zero) interprets the rule number as an absolute index (i.e. 1 is
|
||||
the first rule).
|
||||
- V(first-ipv4) interprets the rule number relative to the index of the
|
||||
first IPv4 rule, or relative to the position where the first IPv4 rule
|
||||
- V(zero) interprets the rule number as an absolute index (that is, 1 is the first rule).
|
||||
- V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position where the first IPv4
|
||||
rule would be if there is currently none.
|
||||
- V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where the last IPv4 rule
|
||||
would be if there is currently none.
|
||||
- V(last-ipv4) interprets the rule number relative to the index of the
|
||||
last IPv4 rule, or relative to the position where the last IPv4 rule
|
||||
would be if there is currently none.
|
||||
- V(first-ipv6) interprets the rule number relative to the index of the
|
||||
first IPv6 rule, or relative to the position where the first IPv6 rule
|
||||
would be if there is currently none.
|
||||
- V(last-ipv6) interprets the rule number relative to the index of the
|
||||
last IPv6 rule, or relative to the position where the last IPv6 rule
|
||||
- V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position where the first IPv6
|
||||
rule would be if there is currently none.
|
||||
- V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where the last IPv6 rule
|
||||
would be if there is currently none.
|
||||
type: str
|
||||
choices: [ first-ipv4, first-ipv6, last-ipv4, last-ipv6, zero ]
|
||||
choices: [first-ipv4, first-ipv6, last-ipv4, last-ipv6, zero]
|
||||
default: zero
|
||||
rule:
|
||||
description:
|
||||
- Add firewall rule
|
||||
- Add firewall rule.
|
||||
type: str
|
||||
choices: [ allow, deny, limit, reject ]
|
||||
choices: [allow, deny, limit, reject]
|
||||
log:
|
||||
description:
|
||||
- Log new connections matched to this rule
|
||||
- Log new connections matched to this rule.
|
||||
type: bool
|
||||
default: false
|
||||
from_ip:
|
||||
|
|
@ -104,7 +95,7 @@ options:
|
|||
- Source IP address.
|
||||
type: str
|
||||
default: any
|
||||
aliases: [ from, src ]
|
||||
aliases: [from, src]
|
||||
from_port:
|
||||
description:
|
||||
- Source port.
|
||||
|
|
@ -114,54 +105,49 @@ options:
|
|||
- Destination IP address.
|
||||
type: str
|
||||
default: any
|
||||
aliases: [ dest, to]
|
||||
aliases: [dest, to]
|
||||
to_port:
|
||||
description:
|
||||
- Destination port.
|
||||
type: str
|
||||
aliases: [ port ]
|
||||
aliases: [port]
|
||||
proto:
|
||||
description:
|
||||
- TCP/IP protocol.
|
||||
type: str
|
||||
choices: [ any, tcp, udp, ipv6, esp, ah, gre, igmp ]
|
||||
aliases: [ protocol ]
|
||||
choices: [any, tcp, udp, ipv6, esp, ah, gre, igmp]
|
||||
aliases: [protocol]
|
||||
name:
|
||||
description:
|
||||
- Use profile located in C(/etc/ufw/applications.d).
|
||||
type: str
|
||||
aliases: [ app ]
|
||||
aliases: [app]
|
||||
delete:
|
||||
description:
|
||||
- Delete rule.
|
||||
- If O(delete=true) and a value is provided for O(insert),
|
||||
then O(insert) is ignored.
|
||||
- If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored.
|
||||
type: bool
|
||||
default: false
|
||||
interface:
|
||||
description:
|
||||
- Specify interface for the rule. The direction (in or out) used
|
||||
for the interface depends on the value of O(direction). See
|
||||
O(interface_in) and O(interface_out) for routed rules that needs
|
||||
to supply both an input and output interface. Mutually
|
||||
exclusive with O(interface_in) and O(interface_out).
|
||||
- Specify interface for the rule. The direction (in or out) used for the interface depends on the value of O(direction). See O(interface_in)
|
||||
and O(interface_out) for routed rules that needs to supply both an input and output interface. Mutually exclusive with O(interface_in)
|
||||
and O(interface_out).
|
||||
type: str
|
||||
aliases: [ if ]
|
||||
aliases: [if]
|
||||
interface_in:
|
||||
description:
|
||||
- Specify input interface for the rule. This is mutually
|
||||
exclusive with O(direction) and O(interface). However, it is
|
||||
compatible with O(interface_out) for routed rules.
|
||||
- Specify input interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_out)
|
||||
for routed rules.
|
||||
type: str
|
||||
aliases: [ if_in ]
|
||||
aliases: [if_in]
|
||||
version_added: '0.2.0'
|
||||
interface_out:
|
||||
description:
|
||||
- Specify output interface for the rule. This is mutually
|
||||
exclusive with O(direction) and O(interface). However, it is
|
||||
compatible with O(interface_in) for routed rules.
|
||||
- Specify output interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_in)
|
||||
for routed rules.
|
||||
type: str
|
||||
aliases: [ if_out ]
|
||||
aliases: [if_out]
|
||||
version_added: '0.2.0'
|
||||
route:
|
||||
description:
|
||||
|
|
@ -172,9 +158,9 @@ options:
|
|||
description:
|
||||
- Add a comment to the rule. Requires UFW version >=0.35.
|
||||
type: str
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Allow everything and enable UFW
|
||||
community.general.ufw:
|
||||
state: enabled
|
||||
|
|
@ -299,7 +285,7 @@ EXAMPLES = r'''
|
|||
route: true
|
||||
src: 192.0.2.0/24
|
||||
dest: 198.51.100.0/24
|
||||
'''
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue