Merge branch 'devel' into main

.ansible-lint-ignore

@@ -0,0 +1,2 @@
+# This file contains ignores rule violations for ansible-lint
+ansible_collections/f5networks/f5_bigip/changelogs/changelog.yaml yaml[indentation]

.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Collection Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  create_release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Build Collection
+        uses: artis3n/ansible_galaxy_collection@v2
+        with:
+          collection_dir: 'ansible_collections/f5networks/${{ vars.COLNAME }}'
+          api_key: "${{ secrets.GALAXY_API_KEY }}"
+          publish: false
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "f5networks-${{ vars.COLNAME }}-${{ github.ref_name }}.tar.gz"
+          tag: "${{ github.ref_name }}"
+          name: "Declarative Collection Release ${{ github.ref_name }}"
+          omitBody: true
+          token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Publish Collection
+        uses: artis3n/ansible_galaxy_collection@v2
+        with:
+          collection_dir: 'ansible_collections/f5networks/${{ vars.COLNAME }}'
+          api_key: "${{ secrets.GALAXY_API_KEY }}"
+          build: false
+
+      - uses: neonidian/teams-notify-build-status@v3
+        with:
+          webhookUrl: ${{ secrets.RELEASE_TEAMS_WEBHOOK }}
+          message: "Collection ${{ vars.COLNAME }} version: ${{ github.ref_name }} released."

ansible_collections/f5networks/f5_bigip/CHANGELOG.rst

@@ -5,6 +5,9 @@ F5Networks F5_BIGIP Collection Release Notes
 .. contents:: Topics
 
 
+v3.2.2
+======
+
 v3.2.1
 ======
 

ansible_collections/f5networks/f5_bigip/changelogs/changelog.yaml

@@ -552,3 +552,5 @@ releases:
     fragments:
     - true-names-bigfixes.yaml
     release_date: '2023-10-12'
+  3.2.2:
+    release_date: '2023-11-23'

ansible_collections/f5networks/f5_bigip/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_BIGIP Collection
 trivial_section_name: trivial

ansible_collections/f5networks/f5_bigip/galaxy.yml

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

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

@@ -0,0 +1,93 @@
+# -*- 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_bigip/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 = "3.2.1"
+CURRENT_COLL_VERSION = "3.2.2"

ansible_collections/f5networks/f5_bigip/plugins/modules/bigip_apm_policy_fetch.py

@@ -55,36 +55,23 @@
 '''
 
 EXAMPLES = r'''
-- hosts: all
-  collections:
-    - f5networks.f5_bigip
-  connection: httpapi
-
-  vars:
-    ansible_host: "lb.mydomain.com"
-    ansible_user: "admin"
-    ansible_httpapi_password: "secret"
-    ansible_network_os: f5networks.f5_bigip.bigip
-    ansible_httpapi_use_ssl: yes
-
-  tasks:
-    - name: Export APM access profile
-      bigip_apm_policy_fetch:
-        name: foobar
-        file: export_foo
-        dest: /root/download
-
-    - name: Export APM access policy
-      bigip_apm_policy_fetch:
-        name: foobar
-        file: export_foo
-        dest: /root/download
-        type: access_policy
-
-    - name: Export APM access profile, autogenerate name
-      bigip_apm_policy_fetch:
-        name: foobar
-        dest: /root/download
+- name: Export APM access profile
+  bigip_apm_policy_fetch:
+    name: foobar
+    file: export_foo
+    dest: /root/download
+
+- name: Export APM access policy
+  bigip_apm_policy_fetch:
+    name: foobar
+    file: export_foo
+    dest: /root/download
+    type: access_policy
+
+- name: Export APM access profile, autogenerate name
+  bigip_apm_policy_fetch:
+    name: foobar
+    dest: /root/download
 '''
 
 RETURN = r'''

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

@@ -59,41 +59,28 @@
 '''
 
 EXAMPLES = r'''
-- hosts: all
-  collections:
-    - f5networks.f5_bigip
-  connection: httpapi
-
-  vars:
-    ansible_host: "lb.mydomain.com"
-    ansible_user: "admin"
-    ansible_httpapi_password: "secret"
-    ansible_network_os: f5networks.f5_bigip.bigip
-    ansible_httpapi_use_ssl: yes
-
-  tasks:
-    - name: Import APM profile
-      bigip_apm_policy_import:
-        name: new_apm_profile
-        source: /root/apm_profile.tar.gz
-
-    - name: Import APM policy
-      bigip_apm_policy_import:
-        name: new_apm_policy
-        source: /root/apm_policy.tar.gz
-        type: access_policy
-
-    - name: Override existing APM policy
-      bigip_asm_policy:
-        name: new_apm_policy
-        source: /root/apm_policy.tar.gz
-        force: yes
-
-    - name: Import APM profile without re-using existing configuration objects
-      bigip_apm_policy_import:
-        name: new_apm_profile
-        source: /root/apm_profile.tar.gz
-        reuse_objects: false
+- name: Import APM profile
+  bigip_apm_policy_import:
+    name: new_apm_profile
+    source: /root/apm_profile.tar.gz
+
+- name: Import APM policy
+  bigip_apm_policy_import:
+    name: new_apm_policy
+    source: /root/apm_policy.tar.gz
+    type: access_policy
+
+- name: Override existing APM policy
+  bigip_asm_policy:
+    name: new_apm_policy
+    source: /root/apm_policy.tar.gz
+    force: true
+
+- name: Import APM profile without re-using existing configuration objects
+  bigip_apm_policy_import:
+    name: new_apm_profile
+    source: /root/apm_profile.tar.gz
+    reuse_objects: false
 '''
 
 RETURN = r'''

ansible_collections/f5networks/f5_bigip/plugins/modules/bigip_as3_deploy.py

@@ -57,27 +57,14 @@
 '''
 
 EXAMPLES = r'''
-- hosts: all
-  collections:
-    - f5networks.f5_bigip
-  connection: httpapi
-
-  vars:
-    ansible_host: "lb.mydomain.com"
-    ansible_user: "admin"
-    ansible_httpapi_password: "secret"
-    ansible_network_os: f5networks.f5_bigip.bigip
-    ansible_httpapi_use_ssl: yes
-
-  tasks:
-    - name: Declaration with 2 Tenants - AS3
-      bigip_as3_deploy:
-        content: "{{ lookup('file', 'two_tenants.json') }}"
-
-    - name: Remove one tenant - AS3
-      bigip_as3_deploy:
-        tenant: "Sample_01"
-        state: absent
+- name: Declaration with 2 Tenants - AS3
+  bigip_as3_deploy:
+    content: "{{ lookup('file', 'two_tenants.json') }}"
+
+- name: Remove one tenant - AS3
+  bigip_as3_deploy:
+    tenant: "Sample_01"
+    state: absent
 '''
 
 RETURN = r'''