Documentation changes for PowerScale 3.4.0 Release (#115)

* Added attribution.md file

* Made changes related to License

* Doc changes for R3.4.0

* Info module documentation

CHANGELOG.rst

@@ -4,15 +4,24 @@ Dellemc.Powerscale Change Logs
 
 .. contents:: Topics
 
+v3.4.0
+======
+
+Minor Changes
+-------------
+
+- ADS module has been enhanced to support the additional parameters.
+- Added support to list all the paginated data for the users in Info module.
+- NFS module is enhanced to remove masked paths in response and also added declarative approach of managing clients.
 
 v3.3.0
 ======
 
 Minor Changes
 -------------
 
-- Added support for listing writable snapshots in Info module.
 - Added fix for firewall policy issue for network pool operations.
+- Added support for listing writable snapshots in Info module.
 
 New Modules
 -----------

README.md

@@ -81,7 +81,7 @@ This table provides information about the software prerequisites for the Ansible
 
 | **Ansible Modules** | **OneFS Version** | **Python version** | **Python SDK version** | **Ansible**              |
 |---------------------|-----------------------|--------------------|----------------------------|--------------------------|
-| v3.3.0 | 9.4.x <br> 9.5.x <br> 9.7.x <br> 9.8.x | 3.9 <br> 3.10 <br> 3.11 <br> 3.12 | 0.3.0.1 | 2.15 <br> 2.16 <br> 2.17 |
+| v3.4.0 | 9.4.x <br> 9.5.x <br> 9.7.x <br> 9.8.x | 3.9 <br> 3.10 <br> 3.11 <br> 3.12 | 0.3.0.1 | 2.15 <br> 2.16 <br> 2.17 |
 
 # List of Ansible modules for Dell PowerScale
   * [File System Module](https://github.com/dell/ansible-powerscale/blob/main/docs/modules/filesystem.rst)

changelogs/changelog.yaml

@@ -312,3 +312,10 @@ releases:
         name: writable_snapshots
         namespace: ''
     release_date: '2024-08-30'
+  3.4.0:
+    changes:
+      minor_changes:
+        - Added support to list all the paginated data for the users in Info module.
+        - ADS module has been enhanced to support the additional parameters.
+        - NFS module is enhanced to remove masked paths in response and also added declarative approach of managing clients.
+    release_date: '2024-09-30'

docs/ATTRIBUTION.md

@@ -0,0 +1,11 @@
+OpenSource Licenses for Dell PowerScale Ansible Modules
+=======================================================================
+
+***
+Package: Python SDK for Dell PowerScale.   
+Version: 0.3.0.1 
+Copyright: Copyright (c) 2018 Dell EMC Isilon.
+License: [MIT](https://github.com/Isilon/isilon_sdk_python/blob/d079c07611b5b43206f7f167d3c059b880ab3e50/isilon_sdk/setup.py#L33C5-L33C19)
+Repository: "https://github.com/Isilon/isilon_sdk_python"
+
+***

docs/INSTALLATION.md

@@ -22,7 +22,7 @@ Use this procedure to install SDK:
   #### Offline installation of collections
   1. Download the latest tar build from either of the available distribution channels [Ansible Galaxy](https://galaxy.ansible.com/dellemc/powerscale) /[Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/dellemc/powerscale) and use this command to install the collection anywhere in your system:
 
-	      ansible-galaxy collection install dellemc-powerscale-3.3.0.tar.gz -p <install_path>
+	      ansible-galaxy collection install dellemc-powerscale-3.4.0.tar.gz -p <install_path>
 
   2. Set the environment variable:
 

docs/ISSUE_TRIAGE.md

@@ -33,7 +33,7 @@ Should explain what happened, what was expected and how to reproduce it together
 
  - Ansible Version: [e.g. 2.15]
  - Python Version [e.g. 3.11]
- - Ansible modules for Dell PowerScale Version: [e.g. 3.3.0]
+ - Ansible modules for Dell PowerScale Version: [e.g. 3.4.0]
  - PowerScale SDK version: [e.g. 0.3.0.1]
  - Any other additional information...
 

docs/Release Notes.md

@@ -1,6 +1,6 @@
 **Ansible Modules for Dell Technologies PowerScale** 
 =========================================
-### Release notes 3.3.0
+### Release notes 3.4.0
 
 >   © 2024 Dell Inc. or its subsidiaries. All rights reserved. Dell
 >   and other trademarks are trademarks of Dell Inc. or its
@@ -27,7 +27,7 @@ Table 1. Revision history
 
 | Revision | Date          | Description                                               |
 |----------|---------------|-----------------------------------------------------------|
-| 01       | August 2024   | Ansible Modules for Dell PowerScale 3.3.0                 |
+| 01       | Sepetember 2024   | Ansible Modules for Dell PowerScale 3.4.0                 |
 
 
 Product description
@@ -80,12 +80,11 @@ New Features and Enhancements
 ---------------------------
 This section describes the features of the Ansible Modules for Dell PowerScale for this release.
 
-The Ansible Modules for Dell PowerScale release 3.3.0 supports the following features:
+The Ansible Modules for Dell PowerScale release 3.4.0 supports the following features:
 
-- Added support for create, modify, and delete Alert Channel.
-- Added support for create, modify, and delete Alert Rule.
-- Added support for create, and delete Writable Snapshots.
-- Added support for listing Writable Snapshots in Info module
+- ADS module has been enhanced to support the additional parameters.
+- Added support to list all the paginated data for the users in Info module.
+- NFS module is enhanced to remove masked paths in response and also added declarative approach of managing clients.
 
 Known issues
 ------------

docs/modules/info.rst

@@ -57,24 +57,29 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-  include_all_access_zones (optional, bool, None)
-    Specifies if requested component details need to be fetched from all access zones.
+  access_zone (optional, str, System)
+    The access zone. If no Access Zone is specified, the 'System' access zone would be taken by default.
 
-    It is mutually exclusive with \ :emphasis:`access\_zone`\ .
 
+  filters (False, list, None)
+    List of filters to support filtered output for storage entities.
 
-  access_zone (optional, str, System)
-    The access zone. If no Access Zone is specified, the 'System' access zone would be taken by default.
+    Each filter is a tuple of {filter\_key, filter\_operator, filter\_value}.
 
+    Supports passing of multiple filters.
 
-  scope (optional, str, effective)
-    The scope of ldap. If no scope is specified, the \ :literal:`effective`\  scope would be taken by default.
 
-    If specified as \ :literal:`effective`\  or not specified, all fields are returned.
+    filter_key (True, str, None)
+      Name identifier of the filter.
 
-    If specified as \ :literal:`user`\ , only fields with non-default values are shown.
 
-    If specified as \ :literal:`default`\ , the original values are returned.
+    filter_operator (True, str, None)
+      Operation to be performed on filter key.
+
+
+    filter_value (True, raw, None)
+      Value of the filter key.
+
 
 
   gather_subset (True, list, None)
@@ -195,25 +200,20 @@ Parameters
     Writable snapshots - \ :literal:`writable\_snapshots`\ .
 
 
-  filters (False, list, None)
-    List of filters to support filtered output for storage entities.
-
-    Each filter is a tuple of {filter\_key, filter\_operator, filter\_value}.
-
-    Supports passing of multiple filters.
-
+  include_all_access_zones (optional, bool, None)
+    Specifies if requested component details need to be fetched from all access zones.
 
-    filter_key (True, str, None)
-      Name identifier of the filter.
+    It is mutually exclusive with \ :emphasis:`access\_zone`\ .
 
 
-    filter_operator (True, str, None)
-      Operation to be performed on filter key.
+  scope (optional, str, effective)
+    The scope of ldap. If no scope is specified, the \ :literal:`effective`\  scope would be taken by default.
 
+    If specified as \ :literal:`effective`\  or not specified, all fields are returned.
 
-    filter_value (True, raw, None)
-      Value of the filter key.
+    If specified as \ :literal:`user`\ , only fields with non-default values are shown.
 
+    If specified as \ :literal:`default`\ , the original values are returned.
 
 
   query_parameters (optional, dict, None)
@@ -323,6 +323,9 @@ Examples
         access_zone: "{{access_zone}}"
         gather_subset:
           - users
+        query_parameters:
+          users:
+            - filter: 'sample_user'
 
     - name: Get list of groups for an access zone of the PowerScale cluster
       dellemc.powerscale.info:

galaxy.yml

@@ -14,7 +14,7 @@ name: powerscale
 
 # The version of the collection.
 # Must be compatible with semantic versioning
-version: 3.3.0
+version: 3.4.0
 
 # The path to the Markdown (.md) readme file.
 # This path is relative to the root of the collection.