mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-23 06:21:43 -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
|
@ -33,7 +33,6 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Specify desired state of the resource.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present','absent','delete_acl']
|
||||
acl_name:
|
||||
|
@ -47,84 +46,59 @@ options:
|
|||
description:
|
||||
- ACL number.
|
||||
The value is an integer ranging from 2000 to 2999.
|
||||
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.
|
||||
The value is case-insensitive, and cannot contain spaces or begin with an underscore (_).
|
||||
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']
|
||||
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:
|
||||
- Mask of a source IP address.
|
||||
The value is an integer ranging from 1 to 32.
|
||||
required: false
|
||||
default: null
|
||||
frag_type:
|
||||
description:
|
||||
- Type of packet fragmentation.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['fragment', 'clear_fragment']
|
||||
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
|
||||
time_range:
|
||||
description:
|
||||
- Name of a time range in which an ACL rule takes effect.
|
||||
The value is a string of 1 to 32 characters.
|
||||
The value is case-insensitive, and cannot contain spaces. The name must start with an uppercase
|
||||
or lowercase letter. In addition, the word "all" cannot be specified as a time range name.
|
||||
required: false
|
||||
default: null
|
||||
rule_description:
|
||||
description:
|
||||
- Description about an ACL rule.
|
||||
The value is a string of 1 to 127 characters.
|
||||
required: false
|
||||
default: null
|
||||
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