ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 12:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Clean up module documentation (#36909)

Browse source 
* 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:
Dag Wieers 2018-03-15 22:15:24 +01:00 • committed by GitHub
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions
Download patch file Download diff file Expand all files Collapse all files

28
lib/ansible/modules/network/panos/_panos_nat_policy.py
View file

@ -50,7 +50,6 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
rule_name:
description:
@ -67,63 +66,48 @@ options:
source:
description:
- list of source addresses
required: false
default: ["any"]
destination:
description:
- list of destination addresses
required: false
default: ["any"]
service:
description:
- service
required: false
default: "any"
snat_type:
description:
- type of source translation
required: false
default: None
snat_address:
description:
- snat translated address
required: false
default: None
snat_interface:
description:
- snat interface
required: false
default: None
snat_interface_address:
description:
- snat interface address
required: false
default: None
snat_bidirectional:
description:
- bidirectional flag
required: false
default: "false"
type: bool
default: 'no'
dnat_address:
description:
- dnat translated address
required: false
default: None
dnat_port:
description:
- dnat translated port
required: false
default: None
override:
description:
- attempt to override rule if one with the same name already exists
required: false
default: "false"
type: bool
default: 'no'
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

12
lib/ansible/modules/network/panos/_panos_security_policy.py
View file

@ -72,11 +72,9 @@ options:
description:
description:
- Description for the security rule.
default: "None"
tag:
description:
- Administrative tags that can be added to the rule. Note, tags must be already defined.
default: "None"
from_zone:
description:
- List of source zones.
@ -114,7 +112,6 @@ options:
log_start:
description:
- Whether to log at session start.
default: false
log_end:
description:
- Whether to log at session end.
@ -127,40 +124,31 @@ options:
description: >
Security profile group that is already defined in the system. This property supersedes antivirus,
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
default: None
antivirus:
description:
- Name of the already defined antivirus profile.
default: None
vulnerability:
description:
- Name of the already defined vulnerability profile.
default: None
spyware:
description:
- Name of the already defined spyware profile.
default: None
url_filtering:
description:
- Name of the already defined url_filtering profile.
default: None
file_blocking:
description:
- Name of the already defined file_blocking profile.
default: None
data_filtering:
description:
- Name of the already defined data_filtering profile.
default: None
wildfire_analysis:
description:
- Name of the already defined wildfire_analysis profile.
default: None
devicegroup:
description: >
Device groups are used for the Panorama interaction with Firewall(s). The group must exists on Panorama.
If device group is not define we assume that we are contacting Firewall.
default: None
commit:
description:
- Commit configuration if changed.

8
lib/ansible/modules/network/panos/panos_admin.py
View file

@ -47,12 +47,10 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
admin_username:
description:
- username for admin user
required: false
default: "admin"
admin_password:
description:
@ -61,13 +59,11 @@ options:
role:
description:
- role for admin user
required: false
default: null
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

7
lib/ansible/modules/network/panos/panos_cert_gen_ssh.py
View file

@ -37,36 +37,29 @@ options:
description:
- IP address (or hostname) of PAN-OS device being configured.
required: true
default: null
key_filename:
description:
- Location of the filename that is used for the auth. Either I(key_filename) or I(password) is required.
required: true
default: null
password:
description:
- Password credentials to use for auth. Either I(key_filename) or I(password) is required.
required: true
default: null
cert_friendly_name:
description:
- Human friendly certificate name (not CN but just a friendly name).
required: true
default: null
cert_cn:
description:
- Certificate CN (common name) embedded in the certificate signature.
required: true
default: null
signed_by:
description:
- Undersigning authority (CA) that MUST already be presents on the device.
required: true
default: null
rsa_nbits:
description:
- Number of bits used by the RSA algorithm for the certificate generation.
required: false
default: "2048"
'''

8
lib/ansible/modules/network/panos/panos_commit.py
View file

@ -42,23 +42,19 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
interval:
description:
- interval for checking commit job
required: false
default: 0.5
timeout:
description:
- timeout for commit job
required: false
default: None
sync:
description:
- if commit should be synchronous
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

9
lib/ansible/modules/network/panos/panos_dag.py
View file

@ -34,32 +34,27 @@ options:
description:
- IP address (or hostname) of PAN-OS device
required: true
default: null
password:
description:
- password for authentication
required: true
default: null
username:
description:
- username for authentication
required: false
default: "admin"
dag_name:
description:
- name of the dynamic address group
required: true
default: null
dag_filter:
description:
- dynamic filter user by the dynamic address group
required: true
default: null
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

6
lib/ansible/modules/network/panos/panos_import.py
View file

@ -43,23 +43,17 @@ options:
username:
description:
- Username for device authentication.
required: false
default: "admin"
category:
description:
- Category of file uploaded. The default is software.
required: false
default: software
file:
description:
- Location of the file to import into device.
required: false
default: None
url:
description:
- URL of the file that will be imported to device.
required: false
default: None
'''
EXAMPLES = '''

7
lib/ansible/modules/network/panos/panos_loadcfg.py
View file

@ -41,18 +41,15 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
file:
description:
- configuration file to load
required: false
default: None
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

13
lib/ansible/modules/network/panos/panos_mgtconfig.py
View file

@ -41,33 +41,24 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
dns_server_primary:
description:
- address of primary DNS server
required: false
default: None
dns_server_secondary:
description:
- address of secondary DNS server
required: false
default: None
panorama_primary:
description:
- address of primary Panorama server
required: false
default: None
panorama_secondary:
description:
- address of secondary Panorama server
required: false
default: None
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

25
lib/ansible/modules/network/panos/panos_nat_rule.py
View file

@ -56,67 +56,50 @@ options:
source_ip:
description:
- list of source addresses
required: false
default: ["any"]
destination_ip:
description:
- list of destination addresses
required: false
default: ["any"]
service:
description:
- service
required: false
default: "any"
snat_type:
description:
- type of source translation
required: false
default: None
snat_address_type:
description:
- type of source translation. Supported values are I(translated-address)/I(translated-address).
required: false
default: 'translated-address'
snat_static_address:
description:
- Source NAT translated address. Used with Static-IP translation.
required: false
default: None
snat_dynamic_address:
description:
- Source NAT translated address. Used with Dynamic-IP and Dynamic-IP-and-Port.
required: false
default: None
snat_interface:
description:
- snat interface
required: false
default: None
snat_interface_address:
description:
- snat interface address
required: false
default: None
snat_bidirectional:
description:
- bidirectional flag
required: false
default: "false"
type: bool
default: 'no'
dnat_address:
description:
- dnat translated address
required: false
default: None
dnat_port:
description:
- dnat translated port
required: false
default: None
commit:
description:
- Commit configuration if changed.
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

3
lib/ansible/modules/network/panos/panos_object.py
View file

@ -47,7 +47,6 @@ options:
username:
description:
- Username credentials to use for authentication.
required: false
default: "admin"
password:
description:
@ -110,8 +109,6 @@ options:
description: >
- The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it
is assumed that we are contacting a firewall.
required: false
default: None
'''
EXAMPLES = '''

19
lib/ansible/modules/network/panos/panos_pg.py
View file

@ -41,7 +41,6 @@ options:
username:
description:
- username for authentication
required: false
default: "admin"
pg_name:
description:
@ -50,43 +49,29 @@ options:
data_filtering:
description:
- name of the data filtering profile
required: false
default: None
file_blocking:
description:
- name of the file blocking profile
required: false
default: None
spyware:
description:
- name of the spyware profile
required: false
default: None
url_filtering:
description:
- name of the url filtering profile
required: false
default: None
virus:
description:
- name of the anti-virus profile
required: false
default: None
vulnerability:
description:
- name of the vulnerability profile
required: false
default: None
wildfire:
description:
- name of the wildfire analysis profile
required: false
default: None
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''

21
lib/ansible/modules/network/panos/panos_query_rules.py
View file

@ -49,7 +49,6 @@ options:
username:
description:
- Username credentials to use for authentication.
required: false
default: "admin"
password:
description:
@ -61,53 +60,33 @@ options:
application:
description:
- Name of the application or application group to be queried.
required: false
default: None
source_zone:
description:
- Name of the source security zone to be queried.
required: false
default: None
source_ip:
description:
- The source IP address to be queried.
required: false
default: None
source_port:
description:
- The source port to be queried.
required: false
default: None
destination_zone:
description:
- Name of the destination security zone to be queried.
required: false
default: None
destination_ip:
description:
- The destination IP address to be queried.
required: false
default: None
destination_port:
description:
- The destination port to be queried.
required: false
default: None
protocol:
description:
- The protocol used to be queried. Must be either I(tcp) or I(udp).
required: false
default: None
tag_name:
description:
- Name of the rule tag to be queried.
required: false
default: None
devicegroup:
description:
- The Panorama device group in which to conduct the query.
required: false
default: None
'''
EXAMPLES = '''

16
lib/ansible/modules/network/panos/panos_sag.py
View file

@ -36,16 +36,13 @@ options:
description:
- IP address (or hostname) of PAN-OS device
required: true
default: null
password:
description:
- password for authentication
required: true
default: null
username:
description:
- username for authentication
required: false
default: "admin"
api_key:
description:
@ -54,38 +51,29 @@ options:
description:
- name of the dynamic address group
required: true
default: null
static_match_filter:
description:
- Static filter user by the address group
required: true
default: null
devicegroup:
description: >
- The name of the Panorama device group. The group must exist on Panorama. If device group is not defined
it is assumed that we are contacting a firewall.
required: false
default: None
description:
description:
- The purpose / objective of the static Address Group
required: false
default: null
tags:
description:
- Tags to be associated with the address group
required: false
default: null
commit:
description:
- commit if changed
required: false
default: true
type: bool
default: 'yes'
operation:
description:
- The operation to perform Supported values are I(add)/I(list)/I(delete).
required: true
default: null
'''
EXAMPLES = '''

15
lib/ansible/modules/network/panos/panos_security_rule.py
View file

@ -60,11 +60,9 @@ options:
description:
description:
- Description for the security rule.
default: "None"
tag_name:
description:
- Administrative tags that can be added to the rule. Note, tags must be already defined.
default: "None"
source_zone:
description:
- List of source zones.
@ -102,7 +100,6 @@ options:
log_start:
description:
- Whether to log at session start.
default: false
log_end:
description:
- Whether to log at session end.
@ -115,44 +112,36 @@ options:
description: >
- Security profile group that is already defined in the system. This property supersedes antivirus,
vulnerability, spyware, url_filtering, file_blocking, data_filtering, and wildfire_analysis properties.
default: None
antivirus:
description:
- Name of the already defined antivirus profile.
default: None
vulnerability:
description:
- Name of the already defined vulnerability profile.
default: None
spyware:
description:
- Name of the already defined spyware profile.
default: None
url_filtering:
description:
- Name of the already defined url_filtering profile.
default: None
file_blocking:
description:
- Name of the already defined file_blocking profile.
default: None
data_filtering:
description:
- Name of the already defined data_filtering profile.
default: None
wildfire_analysis:
description:
- Name of the already defined wildfire_analysis profile.
default: None
devicegroup:
description: >
- Device groups are used for the Panorama interaction with Firewall(s). The group must exists on Panorama.
If device group is not define we assume that we are contacting Firewall.
default: None
commit:
description:
- Commit configuration if changed.
default: true
type: bool
default: 'yes'
'''
EXAMPLES = '''