mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-29 19:50:25 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -47,159 +47,107 @@ options:
|
|||
description:
|
||||
- ACL number.
|
||||
The value is an integer ranging from 3000 to 3999.
|
||||
required: false
|
||||
default: null
|
||||
acl_step:
|
||||
description:
|
||||
- ACL step.
|
||||
The value is an integer ranging from 1 to 20. The default value is 5.
|
||||
required: false
|
||||
default: null
|
||||
acl_description:
|
||||
description:
|
||||
- ACL description.
|
||||
The value is a string of 1 to 127 characters.
|
||||
required: false
|
||||
default: null
|
||||
rule_name:
|
||||
description:
|
||||
- Name of a basic ACL rule.
|
||||
The value is a string of 1 to 32 characters.
|
||||
required: false
|
||||
default: null
|
||||
rule_id:
|
||||
description:
|
||||
- ID of a basic ACL rule in configuration mode.
|
||||
The value is an integer ranging from 0 to 4294967294.
|
||||
required: false
|
||||
default: null
|
||||
rule_action:
|
||||
description:
|
||||
- Matching mode of basic ACL rules.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['permit','deny']
|
||||
protocol:
|
||||
description:
|
||||
- Protocol type.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['ip', 'icmp', 'igmp', 'ipinip', 'tcp', 'udp', 'gre', 'ospf']
|
||||
source_ip:
|
||||
description:
|
||||
- Source IP address.
|
||||
The value is a string of 0 to 255 characters.The default value is 0.0.0.0.
|
||||
The value is in dotted decimal notation.
|
||||
required: false
|
||||
default: null
|
||||
src_mask:
|
||||
description:
|
||||
- Source IP address mask.
|
||||
The value is an integer ranging from 1 to 32.
|
||||
required: false
|
||||
default: null
|
||||
src_pool_name:
|
||||
description:
|
||||
- Name of a source pool.
|
||||
The value is a string of 1 to 32 characters.
|
||||
required: false
|
||||
default: null
|
||||
dest_ip:
|
||||
description:
|
||||
- Destination IP address.
|
||||
The value is a string of 0 to 255 characters.The default value is 0.0.0.0.
|
||||
The value is in dotted decimal notation.
|
||||
required: false
|
||||
default: null
|
||||
dest_mask:
|
||||
description:
|
||||
- Destination IP address mask.
|
||||
The value is an integer ranging from 1 to 32.
|
||||
required: false
|
||||
default: null
|
||||
dest_pool_name:
|
||||
description:
|
||||
- Name of a destination pool.
|
||||
The value is a string of 1 to 32 characters.
|
||||
required: false
|
||||
default: null
|
||||
src_port_op:
|
||||
description:
|
||||
- Range type of the source port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['lt','eq', 'gt', 'range']
|
||||
src_port_begin:
|
||||
description:
|
||||
- Start port number of the source port.
|
||||
The value is an integer ranging from 0 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
src_port_end:
|
||||
description:
|
||||
- End port number of the source port.
|
||||
The value is an integer ranging from 0 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
src_port_pool_name:
|
||||
description:
|
||||
- Name of a source port pool.
|
||||
The value is a string of 1 to 32 characters.
|
||||
required: false
|
||||
default: null
|
||||
dest_port_op:
|
||||
description:
|
||||
- Range type of the destination port.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['lt','eq', 'gt', 'range']
|
||||
dest_port_begin:
|
||||
description:
|
||||
- Start port number of the destination port.
|
||||
The value is an integer ranging from 0 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
dest_port_end:
|
||||
description:
|
||||
- End port number of the destination port.
|
||||
The value is an integer ranging from 0 to 65535.
|
||||
required: false
|
||||
default: null
|
||||
dest_port_pool_name:
|
||||
description:
|
||||
- Name of a destination port pool.
|
||||
The value is a string of 1 to 32 characters.
|
||||
required: false
|
||||
default: null
|
||||
frag_type:
|
||||
description:
|
||||
- Type of packet fragmentation.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['fragment', 'clear_fragment']
|
||||
precedence:
|
||||
description:
|
||||
- Data packets can be filtered based on the priority field.
|
||||
The value is an integer ranging from 0 to 7.
|
||||
required: false
|
||||
default: null
|
||||
tos:
|
||||
description:
|
||||
- ToS value on which data packet filtering is based.
|
||||
The value is an integer ranging from 0 to 15.
|
||||
required: false
|
||||
default: null
|
||||
dscp:
|
||||
description:
|
||||
- Differentiated Services Code Point.
|
||||
The value is an integer ranging from 0 to 63.
|
||||
required: false
|
||||
default: null
|
||||
icmp_name:
|
||||
description:
|
||||
- ICMP name.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['unconfiged', 'echo', 'echo-reply', 'fragmentneed-DFset', 'host-redirect',
|
||||
'host-tos-redirect', 'host-unreachable', 'information-reply', 'information-request',
|
||||
'net-redirect', 'net-tos-redirect', 'net-unreachable', 'parameter-problem',
|
||||
|
@ -210,67 +158,48 @@ options:
|
|||
description:
|
||||
- ICMP type. This parameter is available only when the packet protocol is ICMP.
|
||||
The value is an integer ranging from 0 to 255.
|
||||
required: false
|
||||
default: null
|
||||
icmp_code:
|
||||
description:
|
||||
- ICMP message code. Data packets can be filtered based on the ICMP message code.
|
||||
The value is an integer ranging from 0 to 255.
|
||||
required: false
|
||||
default: null
|
||||
ttl_expired:
|
||||
description:
|
||||
- Whether TTL Expired is matched, with the TTL value of 1.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
vrf_name:
|
||||
description:
|
||||
- VPN instance name.
|
||||
The value is a string of 1 to 31 characters.The default value is _public_.
|
||||
required: false
|
||||
default: null
|
||||
syn_flag:
|
||||
description:
|
||||
- TCP flag value.
|
||||
The value is an integer ranging from 0 to 63.
|
||||
required: false
|
||||
default: null
|
||||
tcp_flag_mask:
|
||||
description:
|
||||
- TCP flag mask value.
|
||||
The value is an integer ranging from 0 to 63.
|
||||
required: false
|
||||
default: null
|
||||
established:
|
||||
description:
|
||||
- Match established connections.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
time_range:
|
||||
description:
|
||||
- Name of a time range in which an ACL rule takes effect.
|
||||
required: false
|
||||
default: null
|
||||
rule_description:
|
||||
description:
|
||||
- Description about an ACL rule.
|
||||
required: false
|
||||
default: null
|
||||
igmp_type:
|
||||
description:
|
||||
- Internet Group Management Protocol.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['host-query', 'mrouter-adver', 'mrouter-solic', 'mrouter-termi', 'mtrace-resp', 'mtrace-route',
|
||||
'v1host-report', 'v2host-report', 'v2leave-group', 'v3host-report']
|
||||
log_flag:
|
||||
description:
|
||||
- Flag of logging matched data packets.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true', 'false']
|
||||
type: bool
|
||||
default: 'no'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue