Merge branch 'devel' into main

ansible_collections/f5networks/f5_modules/CHANGELOG.rst

@@ -5,6 +5,14 @@ F5Networks F5_Modules Collection Release Notes
 .. contents:: Topics
 
 
+v1.27.1
+=======
+
+Minor Changes
+-------------
+
+- bigiq_device_discovery - Changes in documentation related to Provider block
+
 v1.27.0
 =======
 

ansible_collections/f5networks/f5_modules/changelogs/changelog.yaml

@@ -1034,6 +1034,13 @@ releases:
     - error-handling-for-connection-error.yaml
     - policy-rule-ssl-extension-options.yaml
     release_date: '2023-10-12'
+  1.27.1:
+    changes:
+      minor_changes:
+      - bigiq_device_discovery - Changes in documentation related to Provider block
+    fragments:
+    - bigiq-device-discovery-doc-changes.yaml
+    release_date: '2023-11-23'
   1.3.0:
     changes:
       bugfixes:

ansible_collections/f5networks/f5_modules/changelogs/config.yaml

@@ -11,21 +11,21 @@ notesdir: fragments
 prelude_section_name: release_summary
 prelude_section_title: Release Summary
 sections:
-- - major_changes
-  - Major Changes
-- - minor_changes
-  - Minor Changes
-- - breaking_changes
-  - Breaking Changes / Porting Guide
-- - deprecated_features
-  - Deprecated Features
-- - removed_features
-  - Removed Features (previously deprecated)
-- - security_fixes
-  - Security Fixes
-- - bugfixes
-  - Bugfixes
-- - known_issues
-  - Known Issues
+  - - major_changes
+    - Major Changes
+  - - minor_changes
+    - Minor Changes
+  - - breaking_changes
+    - Breaking Changes / Porting Guide
+  - - deprecated_features
+    - Deprecated Features
+  - - removed_features
+    - Removed Features (previously deprecated)
+  - - security_fixes
+    - Security Fixes
+  - - bugfixes
+    - Bugfixes
+  - - known_issues
+    - Known Issues
 title: F5Networks F5_Modules Collection
 trivial_section_name: trivial

ansible_collections/f5networks/f5_modules/galaxy.yml

@@ -11,10 +11,12 @@ license:
 name: f5_modules
 namespace: f5networks
 readme: README.md
+build_ignore:
+  - tests
 repository: https://github.com/F5Networks/f5-ansible-f5modules
 tags:
   - f5
   - networking
   - bigip
   - bigiq
-version: 1.27.0
+version: 1.27.1

ansible_collections/f5networks/f5_modules/plugins/doc_fragments/files.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2014, Matt Martz <[email protected]>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+
+    # Standard files documentation fragment
+
+    # Note: mode is overridden by the copy and template modules so if you change the description
+    # here, you should also change it there.
+    DOCUMENTATION = r'''
+options:
+  mode:
+    description:
+    - The permissions the resulting filesystem object should have.
+    - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
+      You must give Ansible enough information to parse them correctly.
+      For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
+      a string and can do its own conversion from string into number.
+      Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances.
+    - Giving Ansible a number without following either of these rules will end up with a decimal
+      number which will have unexpected results.
+    - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or
+      V(u=rw,g=r,o=r)).
+    - If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used
+      when setting the mode for the newly created filesystem object.
+    - If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used.
+    - Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions.
+      See CVE-2020-1736 for further details.
+    type: raw
+  owner:
+    description:
+    - Name of the user that should own the filesystem object, as would be fed to I(chown).
+    - When left unspecified, it uses the current user unless you are root, in which
+      case it can preserve the previous ownership.
+    - Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion.
+
+    type: str
+  group:
+    description:
+    - Name of the group that should own the filesystem object, as would be fed to I(chown).
+    - When left unspecified, it uses the current group of the current user unless you are root,
+      in which case it can preserve the previous ownership.
+    type: str
+  seuser:
+    description:
+    - The user part of the SELinux filesystem object context.
+    - By default it uses the V(system) policy, where applicable.
+    - When set to V(_default), it will use the C(user) portion of the policy if available.
+    type: str
+  serole:
+    description:
+    - The role part of the SELinux filesystem object context.
+    - When set to V(_default), it will use the C(role) portion of the policy if available.
+    type: str
+  setype:
+    description:
+    - The type part of the SELinux filesystem object context.
+    - When set to V(_default), it will use the C(type) portion of the policy if available.
+    type: str
+  selevel:
+    description:
+    - The level part of the SELinux filesystem object context.
+    - This is the MLS/MCS attribute, sometimes known as the C(range).
+    - When set to V(_default), it will use the C(level) portion of the policy if available.
+    type: str
+  unsafe_writes:
+    description:
+    - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object.
+    - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects,
+      but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects,
+      which cannot be updated atomically from inside the container and can only be written in an unsafe manner.
+    - This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail
+      (however, it doesn't force Ansible to perform unsafe writes).
+    - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
+    type: bool
+    default: no
+    version_added: '2.2'
+  attributes:
+    description:
+    - The attributes the resulting filesystem object should have.
+    - To get supported flags look at the man page for I(chattr) on the target system.
+    - This string should contain the attributes in the same order as the one displayed by I(lsattr).
+    - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string.
+    type: str
+    aliases: [ attr ]
+    version_added: '2.3'
+'''

ansible_collections/f5networks/f5_modules/plugins/lookup/bigiq_license.py

@@ -7,13 +7,14 @@
 __metaclass__ = type
 
 DOCUMENTATION = """
-    lookup: bigiq_license
-    author: Wojciech Wypior <[email protected]>
-    version_added: "1.0"
+    name: bigiq_license
+    author:
+      - Wojciech Wypior (@wojtek0806)
+    version_added: "1.0.0"
     short_description: Select a random license key from a pool of biqiq available licenses
     description:
-      - Select a random license key from a pool of biqiq available licenses
-         ,Requires specifying BIGIQ license pool name and connection parameters
+      - Select a random license key from a pool of biqiq available licenses.
+      - Requires specifying BIGIQ license pool name and connection parameters.
 """
 
 EXAMPLES = """

ansible_collections/f5networks/f5_modules/plugins/lookup/license_hopper.py

@@ -5,13 +5,13 @@
 __metaclass__ = type
 
 DOCUMENTATION = """
-    lookup: Select a random license key from a file and remove it from future lookups
-    author: Tim Rupp <[email protected]>
-    version_added: "1.0"
+    name: license_hopper
+    author: Tim Rupp (@caphrim007)
+    version_added: "1.0.0"
     short_description: Return random license from list
     description:
-      - Select a random license key from a file and remove it from future lookups
-      - Can optionally remove the key if C(remove=True) is specified
+      - Select a random license key from a file and remove it from future lookups.
+      - Can optionally remove the key if C(remove=True) is specified.
 """
 
 EXAMPLES = """

ansible_collections/f5networks/f5_modules/plugins/module_utils/version.py

@@ -4,4 +4,4 @@
 # GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 # This collection version needs to be updated at each release
-CURRENT_COLL_VERSION = "1.27.0"
+CURRENT_COLL_VERSION = "1.27.1"

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_apm_acl.py

@@ -199,7 +199,7 @@
     name: L7foo
     acl_order: 1
     type: static
-    path_match_case: no
+    path_match_case: false
     entries:
       - action: allow
         host_name: 'foobar.com'
@@ -221,7 +221,7 @@
     name: L7L4foo
     acl_order: 2
     type: static
-    path_match_case: no
+    path_match_case: false
     entries:
       - action: allow
         host_name: 'foobar.com'

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_apm_network_access.py

@@ -152,7 +152,7 @@
   bigip_apm_network_access:
     name: foobar
     ip_version: ipv4
-    split_tunnel: yes
+    split_tunnel: true
     snat_pool: "none"
     ipv4_lease_pool: leasefoo
     ipv4_address_space:
@@ -174,8 +174,8 @@
       - subnet: 172.16.23.0/24
     excluded_ipv4_adresses:
       - subnet: 10.10.2.0/24
-    allow_local_subnet: yes
-    allow_local_dns: yes
+    allow_local_subnet: true
+    allow_local_dns: true
     provider:
       password: secret
       server: lb.mydomain.com

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_apm_policy_import.py

@@ -87,7 +87,7 @@
   bigip_asm_policy:
     name: new_apm_policy
     source: /root/apm_policy.tar.gz
-    force: yes
+    force: true
     provider:
       server: lb.mydomain.com
       user: admin

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_asm_dos_application.py

@@ -192,11 +192,11 @@
       whitelist:
         - Cuba
     heavy_urls:
-      auto_detect: yes
+      auto_detect: true
       latency_threshold: 1000
     rtbh_duration: 3600
-    rtbh_enable: yes
-    single_page_application: yes
+    rtbh_enable: true
+    single_page_application: true
     provider:
       password: secret
       server: lb.mydomain.com
@@ -207,9 +207,9 @@
   bigip_asm_dos_application:
     profile: dos_foo
     mobile_detection:
-      enabled: yes
-      allow_any_ios_package: yes
-      allow_emulators: yes
+      enabled: true
+      allow_any_ios_package: true
+      allow_emulators: true
     provider:
       password: secret
       server: lb.mydomain.com

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_asm_policy_fetch.py

@@ -72,7 +72,7 @@
     name: foobar
     file: export_foo
     dest: /root/download
-    binary: yes
+    binary: true
     provider:
       password: secret
       server: lb.mydomain.com
@@ -82,8 +82,8 @@
 - name: Export policy inline base64 encoded format
   bigip_asm_policy_fetch:
     name: foobar
-    inline: yes
-    base64: yes
+    inline: true
+    base64: true
     provider:
       password: secret
       server: lb.mydomain.com
@@ -106,7 +106,7 @@
     name: foobar
     file: export_foo.xml
     dest: /root/download/
-    compact: yes
+    compact: true
     provider:
       password: secret
       server: lb.mydomain.com
@@ -117,7 +117,7 @@
   bigip_asm_policy_fetch:
     name: foobar
     dest: /root/download/
-    binary: yes
+    binary: true
     provider:
       password: secret
       server: lb.mydomain.com

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_asm_policy_import.py

@@ -150,7 +150,7 @@
   bigip_asm_policy:
     name: new_asm_policy
     source: /root/asm_policy_new.xml
-    force: yes
+    force: true
     provider:
       server: lb.mydomain.com
       user: admin

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_asm_policy_manage.py

@@ -126,7 +126,7 @@
 - name: Create blank ASM policy and activate
   bigip_asm_policy_manage:
     name: new_blank_policy
-    active: yes
+    active: true
     state: present
     provider:
       server: lb.mydomain.com
@@ -137,7 +137,7 @@
 - name: Activate ASM policy
   bigip_asm_policy_manage:
     name: inactive_policy
-    active: yes
+    active: true
     state: present
     provider:
       server: lb.mydomain.com

ansible_collections/f5networks/f5_modules/plugins/modules/bigip_config.py

@@ -65,7 +65,7 @@
 EXAMPLES = r'''
 - name: Save the running configuration of the BIG-IP
   bigip_config:
-    save: yes
+    save: true
     provider:
       server: lb.mydomain.com
       password: secret
@@ -74,8 +74,8 @@
 
 - name: Reset the BIG-IP configuration, for example, to RMA the device
   bigip_config:
-    reset: yes
-    save: yes
+    reset: true
+    save: true
     provider:
       server: lb.mydomain.com
       password: secret