Merge pull request #14 from dell/RTS_v1.7.0

Release version 1.7.0

.github/workflows/ansible-test.yml

@@ -13,15 +13,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ansible-version: [stable-2.9]
+        ansible-version: [stable-2.10]
     steps:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Set up Python 3.6
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
-          python-version: 3.6
+          python-version: 3.9
 
       - name: Install ansible (${{ matrix.ansible-version }})
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz --disable-pip-version-check
@@ -46,15 +46,15 @@ jobs:
     needs: [build]
     strategy:
       matrix:
-        ansible-version: [stable-2.9, stable-2.10]
+        ansible-version: [stable-2.10, stable-2.11, stable-2.12]
 
     steps:
-      - name: Set up Python 3.6
+      - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
           # it is just required to run that once as "ansible-test sanity" in the docker image
           # will run on all python versions it supports.
-          python-version: 3.6
+          python-version: 3.9
 
       - name: Install ansible (${{ matrix.ansible-version }}) version
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz --disable-pip-version-check

ChangeLog.md

@@ -1,18 +1,26 @@
 # ansible-powermax Change Log
+## Version 1.7.0 - released on 25/03/22
+- Added initiator module to get initiator details and rename initiator alias.
+- Added rotating file handler for log files.
+- Renamed gatherfacts module to info module.
+- Enhanced info module to list the initiators.
+- Enhanced host module to add or remove initiators to or from host using alias.
+- Removed dellemc_powermax prefix from module names.
+
 ## Version 1.6.1 - released on 16/12/21
-- Bug fixes in snapshot policy and masking view modules.
+- Fixed bugs in snapshot policy and masking view modules.
 
 ## Version 1.6.0 - released on 23/09/21
-- The check mode feature is enabled for the storage group, port group, snapshot, snapshot policy, masking view, SRDF and metroDR modules.
+- Enabled the check mode feature for the storage group, port group, snapshot, snapshot policy, masking view, SRDF and metroDR modules.
 - Added dual licensing.
 
 ## Version 1.5.0 - released on 18/06/21
 - Added CRUD operations for the snapshot policy.
 - Added get operation for storage pool.
 - Enhanced the gatherfacts module to list the snapshot policies.
-- Enhanced the storagegroup module to associate/disassociate the snapshot policy to/from a storage group.
+- Enhanced the storagegroup module to associate or disassociate the snapshot policy to or from a storage group.
 - Enhanced the snapshot module to include the new parameter snapshot_id.
-- Added the ansible role for automatic volume placement.
+- Added the Ansible role for automatic volume placement.
 - Enabled the check mode feature for the host, host group and volume modules.
 
 ## Version 1.4.0 - released on 15/03/21
@@ -27,8 +35,8 @@
 - Enhanced the gatherfacts module to list alerts.
 
 ## Version 1.2.0 - released on 29/09/20
-- Enhanced the storage group module to add/remove volumes to/from the SRDF protected storage group.
-- Enhanced the volume module to add new volume to the SRDF protected storage group, to expand the volume which is part of the storage group.
+- Enhanced the storage group module to add or remove volumes to or from the SRDF protected storage group.
+- Enhanced the volume module to add new volume to the SRDF protected storage group and expand the volume which is part of the storage group.
 - Enhanced the SRDF module to support CRUD operations for concurrent configuration.
 - Enhanced the gatherfacts module to get health status and support generic filters.
 

README.md

@@ -1,68 +1,70 @@
-# Ansible Modules for Dell EMC PowerMax
+# Ansible Modules for Dell Technologies PowerMax
 
-The Ansible Modules for Dell EMC PowerMax allow data center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell EMC PowerMax arrays.
+The Ansible Modules for Dell Technologies (Dell) PowerMax allow data center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell PowerMax arrays.
 
-The capabilities of Ansible modules are managing volumes, storage groups, ports, port groups, hosts, host groups, masking views, snapshots, SRDF links, RDF groups, metro DR environments, jobs, snapshot policies, storage pools and gathering high-level facts about the arrays. The options available for each capability are list, show, create, delete, and modify. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, therefore making multiple identical requests has the same effect as making a single request.
+The capabilities of Ansible modules are managing volumes, storage groups, ports, port groups, hosts, host groups, masking views, initiators, snapshots, SRDF links, RDF groups, metro DR environments, jobs, snapshot policies, storage pools and gathering high-level facts about the arrays. The options available for each capability are list, show, create, delete, and modify. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, therefore making multiple identical requests has the same effect as making a single request.
 
 ## License
-Ansible collection for PowerMax is released and licensed under the GPL-3.0 license. See [LICENSE](LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerMax are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](MODULE-LICENSE) for the full terms.
+Ansible collection for PowerMax is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powermax/blob/1.7.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerMax are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powermax/blob/1.7.0/MODULE-LICENSE) for the full terms.
 
 ## Support
-Ansible collection for PowerMax are supported by Dell EMC and are provided under the terms of the license attached to the collection. Please see the [LICENSE](#license) section for the full terms. Dell EMC does not provide any support for the source code modifications. For any Ansible modules issues, questions or feedback, join the [Dell EMC Automation community](https://www.dell.com/community/Automation/bd-p/Automation).
+Ansible collection for PowerMax is supported by Dell Technologies and is provided under the terms of the license attached to the collection. Please see the [LICENSE](#license) section for the full terms. Dell Technologies does not provide any support for the source code modifications. For any Ansible modules issues, questions or feedback, join the [Dell Automation community](https://www.dell.com/community/Automation/bd-p/Automation).
 
 ## Supported Platforms
-  * Dell EMC PowerMax and VMAX All Flash arrays with Unisphere version 9.1 and later.
+Dell PowerMax and VMAX All Flash arrays with Unisphere version 9.1 and later.
 
 ## Prerequisites
-This table provides information about the software prerequisites for the Ansible Modules for Dell EMC PowerMax.
+This table provides information about the software prerequisites for the Ansible Modules for Dell PowerMax.
 
 | **Ansible Modules** | **Unisphere Version** | **PowerMaxOS** | **Red Hat Enterprise Linux** | **Python version** | **Python library version** | **Ansible** |
 |---------------------|-----------------------|----------------|------------------------------|--------------------|----------------------------|-------------|
-| v1.6.1 | 9.1 <br> 9.2 | 5978.221.221 <br> 5978.444.444 <br> 5978.669.669 <br> 5978.711.711 |	7.5 <br> 7.6, 7.7, 7.8, and 8.2 | 2.7.12 <br> 3.5.2 <br> 3.6.x <br> 3.7.x | 9.1.x.x <br> 9.2.x.x | 2.9 and 2.10 | 
+| v1.7.0 | 9.1 <br> 9.2 | 5978.221.221 <br> 5978.444.444 <br> 5978.669.669 <br> 5978.711.711 |	8.4 <br> 8.5 | 3.7.x <br> 3.8.x <br> 3.9.x | 9.1.x.x <br> 9.2.x.x | 2.10 <br> 2.11 <br> 2.12 | 
 
   * Please follow PyU4V installation instructions on [PyU4V Documentation](https://pyu4v.readthedocs.io/)
 
 ## Idempotency
 The modules are written in such a way that all requests are idempotent and hence fault-tolerant. This means that the result of a successfully performed request is independent of the number of times it is executed.
 
-## List of Ansible Modules for Dell EMC PowerMax
-  * [Volume module](docs/Product%20Guide.md#volume-module)
-  * [Host module](docs/Product%20Guide.md#host-module)
-  * [Host Group module](docs/Product%20Guide.md#host-group-module)
-  * [Snapshot module](docs/Product%20Guide.md#snapshot-module)
-  * [Masking View module](docs/Product%20Guide.md#masking-view-module)
-  * [Port module](docs/Product%20Guide.md#port-module)
-  * [Port Group module](docs/Product%20Guide.md#port-group-module)
-  * [Storage Group module](docs/Product%20Guide.md#storage-group-module)  
-  * [Gatherfacts module](docs/Product%20Guide.md#gatherfacts-module)
-  * [SRDF module](docs/Product%20Guide.md#srdf-module)
-  * [RDF Group module](docs/Product%20Guide.md#rdf-group-module)
-  * [Metro DR module](docs/Product%20Guide.md#metro-dr-module)
-  * [Job module](docs/Product%20Guide.md#job-module)
-  * [Snapshot Policy module](docs/Product%20Guide.md#snapshot-policy-module)
-  * [Storage Pool module](docs/Product%20Guide.md#storage-pool-module)
-  * [Process Storage Pool module](docs/Product%20Guide.md#process-storage-pool-dict-module)
+## List of Ansible Modules for Dell PowerMax
+  * [Volume module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#volume-module)
+  * [Host module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#host-module)
+  * [Host Group module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#host-group-module)
+  * [Snapshot module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#snapshot-module)
+  * [Masking View module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#masking-view-module)
+  * [Port module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#port-module)
+  * [Port Group module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#port-group-module)
+  * [Storage Group module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#storage-group-module)  
+  * [Info module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#info-module)
+  * [SRDF module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#srdf-module)
+  * [RDF Group module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#rdf-group-module)
+  * [Metro DR module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#metro-dr-module)
+  * [Job module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#job-module)
+  * [Snapshot Policy module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#snapshot-policy-module)
+  * [Storage Pool module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#storage-pool-module)
+  * [Process Storage Pool module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#process-storage-pool-dict-module)
+  * [Initiator module](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#initiator-module)
+  * [Intelligent Volume Placement](https://github.com/dell/ansible-powermax/blob/1.7.0/docs/Product%20Guide.md#intelligent-volume-placement)
 
 ## Installation of SDK
 Install the python [sdk](https://pypi.org/project/PyU4V/) named 'PyU4V'. It can be installed using pip, based on the appropriate python version.
 
 ## Building Collections
-  1. Use the following command to build the collection from source code:
+  * Use the following command to build the collection from source code:
 
     ansible-galaxy collection build
 
    For more details on how to build a tar ball, refer: [Building the collection](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_distributing.html#building-your-collection-tarball)
 
 ## Installing Collections
 #### Online Installation of Collections 
-  1. Use the following command to install the latest collection hosted in galaxy:
+  * Use the following command to install the latest collection hosted in galaxy:
 
 	ansible-galaxy collection install dellemc.powermax -p <install_path>
 
 #### Offline Installation of Collections
   1. Download the latest tar build from any of the available distribution channel [Ansible Galaxy](https://galaxy.ansible.com/dellemc/powermax) /[Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/dellemc/powermax) and use the following command to install the collection anywhere in your system:
 
-	ansible-galaxy collection install dellemc-powermax-1.6.1.tar.gz -p <install_path>
+	ansible-galaxy collection install dellemc-powermax-1.7.0.tar.gz -p <install_path>
 
   2. Set the environment variable:
 
@@ -79,26 +81,26 @@ Install the python [sdk](https://pypi.org/project/PyU4V/) named 'PyU4V'. It can
 
 	tasks:
     - name: Get Volume details
-	  dellemc.powermax.dellemc_powermax_volume
+	    dellemc.powermax.volume
 
   3. For generating Ansible documentation for a specific module, embed the FQCN  before the module name. Refer to the following example:
 
-	ansible-doc dellemc.powermax.dellemc_powermax_gatherfacts
+	ansible-doc dellemc.powermax.info
 
 ## Running Ansible Modules
 
 The Ansible server must be configured with Python library for Unisphere to run the Ansible playbooks. The [Documents](docs) provide information on different Ansible modules along with their functions and syntax. The parameters table in the Product Guide provides information on various parameters which need to be configured before running the modules.
 
 ## SSL Certificate Validation
 
-* Copy the CA certificate to the "/etc/pki/ca-trust/source/anchors" path of the host by any external means.
+* Copy the CA certificate to the *"/etc/pki/ca-trust/source/anchors"* path of the host by any external means.
 * Set the "REQUESTS_CA_BUNDLE" environment variable to the path of the SSL certificate using the following command:
 <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; *export REQUESTS_CA_BUNDLE=/etc/pki/ca-trust/source/anchors/<<Certificate_Name>>*
 * Import the SSL certificate to the host using the following command:
 <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; *update-ca-trust extract*
 * If "TLS CA certificate bundle error" occurs, then follow below steps:
-    * cd /etc/pki/tls/certs/
-    * openssl x509 -in ca-bundle.crt -text -noout
+    * *cd /etc/pki/tls/certs/*
+    * *openssl x509 -in ca-bundle.crt -text -noout*
 
 ## Results
 Each module returns the updated state and details of the entity, for example, if you are using the Volume module, all calls will return the updated details of the volume. A sample result is shown in each module's documentation.