Tidy up validate-modules ignores for modules: web_infrastructure/sophos_utm (#1351) (#1352)

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py

* fixed validation-modules for plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py

* Enabling validation-modules for web_infrastructure/sophos_utm modules

* Rolled back utm_network_interface_address.py for 2.9 sake

(cherry picked from commit 4c88a8edc0)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group.py

@@ -30,6 +30,7 @@ options:
         description:
           - List of adirectory group strings.
         type: list
+        elements: str
     adirectory_groups_sids:
         description:
           - Dictionary of group sids.
@@ -64,6 +65,7 @@ options:
         description:
           - List of edirectory group strings.
         type: list
+        elements: str
     ipsec_dn:
         description:
           - The ipsec dn string.
@@ -80,6 +82,7 @@ options:
         description:
           - A list of user ref names (aaa/user).
         type: list
+        elements: str
         default: []
     network:
         description:
@@ -90,11 +93,13 @@ options:
         description:
           - A list of radius group strings.
         type: list
+        elements: str
         default: []
     tacacs_groups:
         description:
           - A list of tacacs group strings.
         type: list
+        elements: str
         default: []
 
 extends_documentation_fragment:

plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py

@@ -23,6 +23,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true

plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py

@@ -26,21 +26,26 @@ options:
         description:
           - The name of the object. Will be used to identify the entry.
         required: true
+        type: str
     ca:
         description:
           - A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
         required: true
+        type: str
     meta:
         description:
           - A reference to an existing utm_ca_meta_x509 object.
         required: true
+        type: str
     certificate:
         description:
           - The certificate in PEM format.
         required: true
+        type: str
     comment:
         description:
           - Optional comment string.
+        type: str
     encrypted:
         description:
           - Optionally enable encryption.
@@ -49,6 +54,7 @@ options:
     key:
         description:
           - Optional private key in PEM format.
+        type: str
 
 extends_documentation_fragment:
 - community.general.utm

plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py

@@ -22,6 +22,7 @@ description:
 
 options:
     name:
+        type: str
         description:
             - The name of the object. Will be used to identify the entry
         required: true

plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py

@@ -22,24 +22,30 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true
     address:
+        type: str
         description:
           - The IPV4 Address of the entry. Can be left empty for automatic resolving.
         default: 0.0.0.0
     address6:
+        type: str
         description:
           - The IPV6 Address of the entry. Can be left empty for automatic resolving.
         default: "::"
     comment:
+        type: str
         description:
           - An optional comment to add to the dns host object
     hostname:
+        type: str
         description:
           - The hostname for the dns host object
     interface:
+        type: str
         description:
           - The reference name of the interface to use. If not provided the default interface will be used
     resolved:
@@ -53,6 +59,7 @@ options:
         default: False
         type: bool
     timeout:
+        type: int
         description:
           - the timeout for the utm to resolve the ip address for the hostname again
         default: 0

plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py

@@ -22,18 +22,22 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true
     address:
+        type: str
         description:
           - The ip4 address of the network/interface_address object.
         required: true
     address6:
+        type: str
         description:
           - The ip6 address of the network/interface_address object.
         required: false
     comment:
+        type: str
         description:
           - An optional comment to add to the object
     resolved:
@@ -114,8 +118,8 @@ def main():
             address=dict(type='str', required=True),
             comment=dict(type='str', required=False, default=""),
             address6=dict(type='str', required=False),
-            resolved=dict(type='boolean', required=False),
+            resolved=dict(type='boolean', required=False),  # @FIXME bool instead of boolean
-            resolved6=dict(type='boolean', required=False)
+            resolved6=dict(type='boolean', required=False),  # @FIXME bool instead of boolean
         )
     )
     try:

plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py

@@ -21,6 +21,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py

@@ -23,18 +23,23 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true
     aaa:
+        type: list
+        elements: str
         description:
           - List of references to utm_aaa objects (allowed users or groups)
         required: true
     basic_prompt:
+        type: str
         description:
           - The message in the basic authentication prompt
         required: true
     backend_mode:
+        type: str
         description:
           - Specifies if the backend server needs authentication ([Basic|None])
         default: None
@@ -50,37 +55,47 @@ options:
           - True
           - False
     backend_user_prefix:
+        type: str
         description:
           - Prefix string to prepend to the username for backend authentication
         default: ""
     backend_user_suffix:
+        type: str
         description:
           - Suffix string to append to the username for backend authentication
         default: ""
     comment:
+        type: str
         description:
           - Optional comment string
         default: ""
     frontend_cookie:
+        type: str
         description:
           - Frontend cookie name
     frontend_cookie_secret:
+        type: str
         description:
           - Frontend cookie secret
     frontend_form:
+        type: str
         description:
           - Frontend authentication form name
     frontend_form_template:
+        type: str
         description:
           - Frontend authentication form template
         default: ""
     frontend_login:
+        type: str
         description:
           - Frontend login name
     frontend_logout:
+        type: str
         description:
           - Frontend logout name
     frontend_mode:
+        type: str
         description:
           - Frontend authentication mode (Form|Basic)
         default: Basic
@@ -88,6 +103,7 @@ options:
           - Basic
           - Form
     frontend_realm:
+        type: str
         description:
           - Frontend authentication realm
     frontend_session_allow_persistency:
@@ -99,6 +115,7 @@ options:
           - True
           - False
     frontend_session_lifetime:
+        type: int
         description:
           - session lifetime
         required: true
@@ -111,6 +128,7 @@ options:
           - True
           - False
     frontend_session_lifetime_scope:
+        type: str
         description:
           - scope for frontend_session_lifetime (days|hours|minutes)
         default: hours
@@ -119,6 +137,7 @@ options:
           - hours
           - minutes
     frontend_session_timeout:
+        type: int
         description:
           - session timeout
         required: true
@@ -131,6 +150,7 @@ options:
           - True
           - False
     frontend_session_timeout_scope:
+        type: str
         description:
           - scope for frontend_session_timeout (days|hours|minutes)
         default: minutes
@@ -139,10 +159,13 @@ options:
           - hours
           - minutes
     logout_delegation_urls:
+        type: list
+        elements: str
         description:
           - List of logout URLs that logouts are delegated to
         default: []
     logout_mode:
+        type: str
         description:
           - Mode of logout (None|Delegation)
         default: None

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py

@@ -40,18 +40,21 @@ options:
         description:
             - The paths the exception in the reverse proxy is defined for
         type: list
+        elements: str
         default: []
         required: False
     skip_custom_threats_filters:
         description:
             - A list of threats to be skipped
         type: list
+        elements: str
         default: []
         required: False
     skip_threats_filter_categories:
         description:
             - Define which categories of threats are skipped
         type: list
+        elements: str
         default: []
         required: False
     skipav:
@@ -106,6 +109,7 @@ options:
         description:
             - Define which categories of threats are skipped
         type: list
+        elements: str
         default: []
         required: False
     status:
@@ -157,6 +161,7 @@ result:
             type: str
         comment:
             description: The optional comment string
+            type: str
         op:
             description: The operand to be used with the entries of the path parameter
             type: str
@@ -211,9 +216,9 @@ def main():
         argument_spec=dict(
             name=dict(type='str', required=True),
             op=dict(type='str', required=False, default='AND', choices=['AND', 'OR']),
-            path=dict(type='list', elements='string', required=False, default=[]),
+            path=dict(type='list', elements='string', required=False, default=[]),  # @FIXME: str instead of string
-            skip_custom_threats_filters=dict(type='list', elements='string', required=False, default=[]),
+            skip_custom_threats_filters=dict(type='list', elements='string', required=False, default=[]),  # @FIXME: str instead of string
-            skip_threats_filter_categories=dict(type='list', elements='string', required=False, default=[]),
+            skip_threats_filter_categories=dict(type='list', elements='string', required=False, default=[]),  # @FIXME: str instead of string
             skipav=dict(type='bool', required=False, default=False),
             skipbadclients=dict(type='bool', required=False, default=False),
             skipcookie=dict(type='bool', required=False, default=False),
@@ -222,7 +227,7 @@ def main():
             skiphtmlrewrite=dict(type='bool', required=False, default=False),
             skiptft=dict(type='bool', required=False, default=False),
             skipurl=dict(type='bool', required=False, default=False),
-            source=dict(type='list', elements='string', required=False, default=[]),
+            source=dict(type='list', elements='string', required=False, default=[]),  # @FIXME: str instead of string
             status=dict(type='bool', required=False, default=True),
         )
     )

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py

@@ -23,6 +23,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true
@@ -32,18 +33,23 @@ options:
         type: bool
         default: False
     address:
+        type: str
         description:
           - The reference name of the network/interface_address object.
         default: REF_DefaultInternalAddress
     allowed_networks:
+        type: list
+        elements: str
         description:
           - A list of reference names for the allowed networks.
         default: ['REF_NetworkAny']
     certificate:
+        type: str
         description:
           - The reference name of the ca/host_key_cert object.
         default: ""
     comment:
+        type: str
         description:
           - An optional comment to add to the object
         default: ""
@@ -53,9 +59,13 @@ options:
         type: bool
         default: False
     domain:
+        type: list
+        elements: str
         description:
           - A list of domain names for the frontend object
     exceptions:
+        type: list
+        elements: str
         description:
           - A list of exception ref names (reverse_proxy/exception)
         default: []
@@ -75,6 +85,7 @@ options:
         type: bool
         default: False
     lbmethod:
+        type: str
         description:
           - Which loadbalancer method should be used
         choices:
@@ -84,10 +95,13 @@ options:
           - byrequests
         default: bybusyness
     locations:
+        type: list
+        elements: str
         description:
           - A list of location ref names (reverse_proxy/location)
         default: []
     port:
+        type: int
         description:
           - The frontend http port
         default: 80
@@ -97,6 +111,7 @@ options:
         type: bool
         default: False
     profile:
+        type: str
         description:
           - The reference string of the reverse_proxy/profile
         default: ""
@@ -106,6 +121,7 @@ options:
         type: bool
         default: True
     type:
+        type: str
         description:
           - Which protocol should be used
         choices:

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py

@@ -23,6 +23,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py

@@ -23,6 +23,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true
@@ -38,21 +39,29 @@ options:
         description:
           - A list of allowed networks
         type: list
+        elements: str
         default: REF_NetworkAny
     auth_profile:
+        type: str
         description:
           - The reference name of the auth profile
     backend:
+        type: list
+        elements: str
         description:
           - A list of backends that are connected with this location declaration
         default: []
     be_path:
+        type: str
         description:
           - The path of the backend
     comment:
+        type: str
         description:
           - The optional comment string
     denied_networks:
+        type: list
+        elements: str
         description:
           - A list of denied network references
         default: []
@@ -62,6 +71,7 @@ options:
         type: bool
         default: False
     path:
+        type: str
         description:
           - The path of the location
         default: "/"
@@ -71,6 +81,7 @@ options:
         type: bool
         default: True
     stickysession_id:
+        type: str
         description:
           - The stickysession id
         default: ROUTEID

plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py

@@ -23,6 +23,7 @@ description:
 
 options:
     name:
+        type: str
         description:
           - The name of the object. Will be used to identify the entry
         required: true

tests/sanity/ignore-2.10.txt

@@ -857,23 +857,8 @@ plugins/modules/system/timezone.py pylint:blacklisted-name
 plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice
 plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path
 plugins/modules/web_infrastructure/rundeck_acl_policy.py pylint:blacklisted-name
-plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py validate-modules:parameter-type-not-in-doc
 plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py validate-modules:return-syntax-error
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py validate-modules:parameter-type-not-in-doc
 scripts/inventory/gce.py pylint:blacklisted-name
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py future-import-boilerplate
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py metaclass-boilerplate

tests/sanity/ignore-2.11.txt

@@ -857,23 +857,8 @@ plugins/modules/system/timezone.py pylint:blacklisted-name
 plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice
 plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path
 plugins/modules/web_infrastructure/rundeck_acl_policy.py pylint:blacklisted-name
-plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py validate-modules:parameter-type-not-in-doc
 plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py validate-modules:return-syntax-error
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py validate-modules:doc-elements-mismatch
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py validate-modules:parameter-type-not-in-doc
 scripts/inventory/gce.py pylint:blacklisted-name
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py future-import-boilerplate
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py metaclass-boilerplate

tests/sanity/ignore-2.9.txt

@@ -689,17 +689,7 @@ plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path
 plugins/modules/web_infrastructure/nginx_status_facts.py validate-modules:deprecation-mismatch
 plugins/modules/web_infrastructure/nginx_status_facts.py validate-modules:invalid-documentation
 plugins/modules/web_infrastructure/rundeck_acl_policy.py pylint:blacklisted-name
-plugins/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_dns_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location.py validate-modules:parameter-type-not-in-doc
-plugins/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py validate-modules:parameter-type-not-in-doc
 scripts/inventory/gce.py pylint:blacklisted-name
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py future-import-boilerplate
 tests/unit/plugins/modules/cloud/google/test_gcp_forwarding_rule.py metaclass-boilerplate