From c5506ab7137da99ae66f838c7b612e70eb3fe36a Mon Sep 17 00:00:00 2001
From: meenakshidembi691 <83949068+meenakshidembi691@users.noreply.github.com>
Date: Fri, 26 Jul 2024 16:17:49 +0530
Subject: [PATCH] Removed apache license from doc files and added 3.1.0 release
changes (#48)
* Removed apache license from doc files
* Added the file
* documentation changes
* documentation changes
* doc changes
* doc changes
* doc changes
* doc changes
---
CHANGELOG.rst | 9 ++
MODULE-LICENSE | 201 ----------------------------------
README.md | 101 ++++++++++-------
changelogs/changelog.yaml | 6 +
docs/ADOPTERS.md | 10 --
docs/BRANCHING.md | 10 --
docs/CODE_OF_CONDUCT.md | 10 --
docs/COMMITTER_GUIDE.md | 10 --
docs/CONTRIBUTING.md | 18 +--
docs/INSTALLATION.md | 14 +--
docs/ISSUE_TRIAGE.md | 14 +--
docs/MAINTAINERS.md | 10 --
docs/MAINTAINER_GUIDE.md | 12 +-
docs/Release Notes.md | 11 +-
docs/SECURITY.md | 12 +-
docs/SUPPORT.md | 10 --
galaxy.yml | 1 -
roles/capacity_role/README.md | 2 +-
18 files changed, 91 insertions(+), 370 deletions(-)
delete mode 100644 MODULE-LICENSE
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 43a0491..e94fd7e 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -4,6 +4,15 @@ Dellemc.Powermax Change Logs
.. contents:: Topics
+v3.1.0
+======
+
+Minor Changes
+-------------
+
+- Added Unisphere port parameter.
+- Added support for restoration of storage group from a snapshot using Snapshot module.
+
v3.0.0
======
diff --git a/MODULE-LICENSE b/MODULE-LICENSE
deleted file mode 100644
index 261eeb9..0000000
--- a/MODULE-LICENSE
+++ /dev/null
@@ -1,201 +0,0 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/README.md b/README.md
index eb3841a..416c71d 100644
--- a/README.md
+++ b/README.md
@@ -6,15 +6,15 @@ The capabilities of Ansible modules are managing volumes, storage groups, ports,
## Table of contents
-* [Code of conduct](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CODE_OF_CONDUCT.md)
-* [Maintainer guide](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/MAINTAINER_GUIDE.md)
-* [Committer guide](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/COMMITTER_GUIDE.md)
-* [Contributing guide](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CONTRIBUTING.md)
-* [Branching strategy](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/BRANCHING.md)
-* [List of adopters](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/ADOPTERS.md)
-* [Maintainers](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/MAINTAINERS.md)
-* [Support](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/SUPPORT.md)
-* [Security](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/SECURITY.md)
+* [Code of conduct](https://github.com/dell/ansible-powermax/blob/main/docs/CODE_OF_CONDUCT.md)
+* [Maintainer guide](https://github.com/dell/ansible-powermax/blob/main/docs/MAINTAINER_GUIDE.md)
+* [Committer guide](https://github.com/dell/ansible-powermax/blob/main/docs/COMMITTER_GUIDE.md)
+* [Contributing guide](https://github.com/dell/ansible-powermax/blob/main/docs/CONTRIBUTING.md)
+* [Branching strategy](https://github.com/dell/ansible-powermax/blob/main/docs/BRANCHING.md)
+* [List of adopters](https://github.com/dell/ansible-powermax/blob/main/docs/ADOPTERS.md)
+* [Maintainers](https://github.com/dell/ansible-powermax/blob/main/docs/MAINTAINERS.md)
+* [Support](https://github.com/dell/ansible-powermax/blob/main/docs/SUPPORT.md)
+* [Security](https://github.com/dell/ansible-powermax/blob/main/docs/SECURITY.md)
* [License](#license)
* [Supported platforms](#supported-platforms)
* [Prerequisites](#prerequisites)
@@ -22,46 +22,65 @@ The capabilities of Ansible modules are managing volumes, storage groups, ports,
* [Installation and execution of Ansible modules for Dell PowerMax](#installation-and-execution-of-ansible-modules-for-dell-powermax)
* [Maintanence](#maintanence)
-## License
-Ansible collection for PowerMax is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powermax/blob/3.0.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/3.0.0/MODULE-LICENSE) for the full terms.
-
-## Supported platforms
-Dell PowerMax and VMAX All Flash arrays support Unisphere version 9.2 and later.
-
-## Prerequisites
+## Requirements
This table provides information about the software prerequisites for the Ansible Modules for Dell PowerMax.
| **Ansible modules** | **Unisphere version** | **PowerMaxOS** | **Python version** | **Python library version** | **Ansible** |
|---------------------|-----------------------|----------------|-------------------------------|----------------------------|--------------------------|
-| v3.0.0 | 9.2
10.0
10.1 | 5978.444.444
5978.669.669
5978.711.711
6079.xxx.xxx | 3.9.x
3.10.x
3.11.x | 9.2.x.x
10.0.x.x
10.1.x.x | 2.14
2.15
2.16 |
+| v3.1.0 | 9.2
10.0
10.1 | 5978.444.444
5978.669.669
5978.711.711
6079.xxx.xxx | 3.9.x
3.10.x
3.11.x | 9.2.x.x
10.0.x.x
10.1.x.x | 2.15
2.16
2.17 |
+
+* Follow PyU4V installation instructions on [PyU4V Documentation](https://pyu4v.readthedocs.io/)
+
+## Installation and execution of Ansible modules for Dell PowerMax
+The installation and execution steps of Ansible modules for Dell PowerMax can be found [here](https://github.com/dell/ansible-powermax/blob/main/docs/INSTALLATION.md).
+
+## Use Cases
+Refer the [example playbooks](https://github.com/dell/ansible-powermax/tree/main/docs/samples) on how the collection can be used for [modules.](https://github.com/dell/ansible-powermax/tree/main/plugins/modules)
+
+## Testing
+The following tests are done on ansible-powermax collection
+
+* Unit tests.
+* Integration tests.
- * Follow PyU4V installation instructions on [PyU4V Documentation](https://pyu4v.readthedocs.io/)
+## Support
+Refer [Support](https://github.com/dell/ansible-powermax/blob/main/docs/SUPPORT.md) documenetation for more information on the support from Dell Technologies.
+
+## Release, Maintenance and Deprecation
+Ansible Modules for Dell Technologies PowerStore follows [Semantic Versioning](https://semver.org/).
+
+New version will be release regularly if significant changes (bug fix or new feature) are made in the collection.
+
+Released code versions are located on "release" branches with names of the form "release-x.y.z" where x.y.z corresponds to the version number. More information on branching strategy followed can be found [here](https://github.com/dell/ansible-powermax/blob/main/docs/BRANCHING.md).
+
+Ansible Modules for Dell Technologies PowerStore deprecation cycle is aligned with that of [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).
+
+See [change logs](https://github.com/dell/ansible-powermax/blob/main/CHANGELOG.rst) for more information on what is new in the releases.
+
+## Related Information
## 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 performed.
## List of Ansible modules for Dell PowerMax
- * [Volume module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/volume.rst)
- * [Host module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/host.rst)
- * [Host Group module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/hostgroup.rst)
- * [Snapshot module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/snapshot.rst)
- * [Masking View module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/maskingview.rst)
- * [Port module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/port.rst)
- * [Port Group module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/portgroup.rst)
- * [Storage Group module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/storagegroup.rst)
- * [Info module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/info.rst)
- * [SRDF module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/srdf.rst)
- * [RDF Group module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/rdfgroup.rst)
- * [Metro DR module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/metrodr.rst)
- * [Job module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/job.rst)
- * [Snapshot Policy module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/snapshotpolicy.rst)
- * [Storage Pool module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/storagepool.rst)
- * [Process Storage Pool module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/process_storage_pool_dict.rst)
- * [Initiator module](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/initiator.rst)
- * [Intelligent Volume Placement](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/modules/capacity_role.rst)
-
-## Installation and execution of Ansible modules for Dell PowerMax
-The installation and execution steps of Ansible modules for Dell PowerMax can be found [here](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/INSTALLATION.md).
+ * [Volume module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/volume.rst)
+ * [Host module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/host.rst)
+ * [Host Group module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/hostgroup.rst)
+ * [Snapshot module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/snapshot.rst)
+ * [Masking View module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/maskingview.rst)
+ * [Port module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/port.rst)
+ * [Port Group module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/portgroup.rst)
+ * [Storage Group module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/storagegroup.rst)
+ * [Info module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/info.rst)
+ * [SRDF module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/srdf.rst)
+ * [RDF Group module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/rdfgroup.rst)
+ * [Metro DR module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/metrodr.rst)
+ * [Job module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/job.rst)
+ * [Snapshot Policy module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/snapshotpolicy.rst)
+ * [Storage Pool module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/storagepool.rst)
+ * [Process Storage Pool module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/process_storage_pool_dict.rst)
+ * [Initiator module](https://github.com/dell/ansible-powermax/blob/main/docs/modules/initiator.rst)
+ * [Intelligent Volume Placement](https://github.com/dell/ansible-powermax/blob/main/docs/modules/capacity_role.rst)
-## Maintenance
-Ansible modules for Dell Technologies PowerMax deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).
+## License
+Ansible collection for PowerMax is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powermax/blob/main/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 GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powermax/blob/main/LICENSE) for the full terms.
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
index 0bae680..05cf315 100644
--- a/changelogs/changelog.yaml
+++ b/changelogs/changelog.yaml
@@ -179,3 +179,9 @@ releases:
- Added bug fix for SRDF module.
- Added support for connection timeout for all modules.
release_date: '2023-11-30'
+ 3.1.0:
+ changes:
+ minor_changes:
+ - Added unisphere port parameter.
+ - Added support for restoration of storage group from a snapshot using Snapshot module.
+ release_date: '2024-07-31'
diff --git a/docs/ADOPTERS.md b/docs/ADOPTERS.md
index 826b5cd..91e2224 100644
--- a/docs/ADOPTERS.md
+++ b/docs/ADOPTERS.md
@@ -1,11 +1 @@
-
-
# List of adopters
diff --git a/docs/BRANCHING.md b/docs/BRANCHING.md
index 27d56d6..9fabdde 100644
--- a/docs/BRANCHING.md
+++ b/docs/BRANCHING.md
@@ -1,13 +1,3 @@
-
-
# Branching strategy
Ansible modules for Dell PowerMax follows a scaled trunk branching strategy where short-lived branches are created off of the main branch. When coding is complete, the branch is merged back into main after being approved in a pull request code review.
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
index d2a932f..3bb84b5 100644
--- a/docs/CODE_OF_CONDUCT.md
+++ b/docs/CODE_OF_CONDUCT.md
@@ -1,13 +1,3 @@
-
-
# Code of conduct - contributor covenant
## Our pledge
diff --git a/docs/COMMITTER_GUIDE.md b/docs/COMMITTER_GUIDE.md
index 8b78cbf..d392b43 100644
--- a/docs/COMMITTER_GUIDE.md
+++ b/docs/COMMITTER_GUIDE.md
@@ -1,13 +1,3 @@
-
-
# Committer guidelines
These are the guidelines for people with commit privileges on the GitHub repository. Committers act as members of the Core Team and not necessarily employees of Dell.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index ec24cd0..144f070 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -1,16 +1,6 @@
-
-
# How to contribute
-Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CODE_OF_CONDUCT.md).
+Become one of the contributors to this project! We thrive to build a welcoming and open community for anyone who wants to use the project or contribute to it. There are just a few small guidelines you need to follow. To help us create a safe and positive community experience for all, we require all participants to adhere to the [Code of Conduct](https://github.com/dell/ansible-powermax/blob/main/docs/CODE_OF_CONDUCT.md).
## Table of contents
@@ -76,7 +66,7 @@ Triage helps resolve issues quickly by:
If you do not have the knowledge or time to code, consider helping with _issue triage_. The Ansible modules for Dell PowerMax community thanks you for saving them time by spending some of yours.
-Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/ISSUE_TRIAGE.md).
+Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powermax/blob/main/docs/ISSUE_TRIAGE.md).
## Your first contribution
@@ -90,7 +80,7 @@ When you are ready to contribute, it is time to create a pull request.
For information about branching, see
## Branching
-* [Branching Strategy for Ansible modules for Dell PowerMax](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/BRANCHING.md)
+* [Branching Strategy for Ansible modules for Dell PowerMax](https://github.com/dell/ansible-powermax/blob/main/docs/BRANCHING.md)
## Signing your commits
@@ -145,7 +135,7 @@ Ensure that the title for your pull request uses the same format as the subject
### Quality gates for pull requests
-GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will investigate the check log, understand the problem, and resolve the issue. If help is needed, reach out to the maintainers of the project for [support](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/SUPPORT.md).
+GitHub Actions are used to enforce quality gates when a pull request is created or when any commit is made to the pull request. These GitHub Actions enforce our minimum code quality requirement for any code that get checked into the repository. If any of the quality gates fail, it is expected that the contributor will investigate the check log, understand the problem, and resolve the issue. If help is needed, reach out to the maintainers of the project for [support](https://github.com/dell/ansible-powermax/blob/main/docs/SUPPORT.md).
#### Code sanitization
diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md
index 45c26a7..b095d6b 100644
--- a/docs/INSTALLATION.md
+++ b/docs/INSTALLATION.md
@@ -1,13 +1,3 @@
-
-
# Installation and execution of Ansible modules for Dell PowerMax
## Installation of SDK
@@ -40,7 +30,7 @@ Depending on which PowerMax Unisphere version is being used, follow this procedu
2. Use this command to install the collection anywhere in your system:
- ansible-galaxy collection install dellemc-powermax-3.0.0.tar.gz -p
+ ansible-galaxy collection install dellemc-powermax-3.1.0.tar.gz -p
3. Set the environment variable:
@@ -67,7 +57,7 @@ Depending on which PowerMax Unisphere version is being used, follow this procedu
## Running Ansible modules
-The Ansible server must be configured with Python library for Unisphere to run the Ansible playbooks. The [Documents](https://github.com/dell/ansible-powermax/blob/3.0.0/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.
+The Ansible server must be configured with Python library for Unisphere to run the Ansible playbooks. The [Documents](https://github.com/dell/ansible-powermax/blob/main/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
diff --git a/docs/ISSUE_TRIAGE.md b/docs/ISSUE_TRIAGE.md
index 4866f94..2337b65 100644
--- a/docs/ISSUE_TRIAGE.md
+++ b/docs/ISSUE_TRIAGE.md
@@ -1,13 +1,3 @@
-
-
# Triage issues
The main goal of issue triage is to categorize all incoming issues and make sure each issue has all basic information needed for anyone else to understand and be able to start working on it.
@@ -41,9 +31,9 @@ This section describes the various issue templates and the expected content.
Bug reports should explain what happened, what was expected and how to reproduce it. Additionally, any applicable material about the reported problem that may give a complete picture of what happened such as screenshots, outputs, and environment related information:
- - Ansible Version: [e.g. 2.14]
+ - Ansible Version: [e.g. 2.15]
- Python Version [e.g. 3.10]
- - Ansible modules for Dell PowerMax Version: [e.g. 3.0.0]
+ - Ansible modules for Dell PowerMax Version: [e.g. 3.1.0]
- PowerMax SDK version: [e.g. PyU4V 10.0.0.16]
- Any other additional information...
diff --git a/docs/MAINTAINERS.md b/docs/MAINTAINERS.md
index 4679f6d..8ced20f 100644
--- a/docs/MAINTAINERS.md
+++ b/docs/MAINTAINERS.md
@@ -1,13 +1,3 @@
-
-
# Maintainers
* Ananthu Kuttattu (kuttattz)
diff --git a/docs/MAINTAINER_GUIDE.md b/docs/MAINTAINER_GUIDE.md
index 292ec2e..4379bcd 100644
--- a/docs/MAINTAINER_GUIDE.md
+++ b/docs/MAINTAINER_GUIDE.md
@@ -1,13 +1,3 @@
-
-
# Maintainer guidelines
As a Maintainer of this project you have the responsibility of aligning to the vision of the project with a high-degree quality. As a part of this group, it is a privilege that requires dedication and time to attend to the daily activities that are associated with the maintenance of this project.
@@ -27,7 +17,7 @@ If a candidate is approved, a Maintainer contacts the candidate to invite them t
## Maintainer policies
* Lead by example
-* Follow the [Code of Conduct](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CODE_OF_CONDUCT.md) and the guidelines in the [Contributing](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CONTRIBUTING.md) and [Committer](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/COMMITTER_GUIDE.md) guides
+* Follow the [Code of Conduct](https://github.com/dell/ansible-powermax/blob/main/docs/CODE_OF_CONDUCT.md) and the guidelines in the [Contributing](https://github.com/dell/ansible-powermax/blob/main/docs/CONTRIBUTING.md) and [Committer](https://github.com/dell/ansible-powermax/blob/main/docs/COMMITTER_GUIDE.md) guides
* Promote a friendly and collaborative environment within our community
* Be actively engaged in discussions, answering questions, updating defects, and reviewing pull requests
* Criticize code, not people. Ideally, tell the contributor a better way to do what they need achieve.
diff --git a/docs/Release Notes.md b/docs/Release Notes.md
index 57bba91..46aa5f3 100644
--- a/docs/Release Notes.md
+++ b/docs/Release Notes.md
@@ -1,7 +1,7 @@
**Ansible modules for Dell Technologies PowerMax**
=========================================
-### Release Notes 3.0.0
+### Release Notes 3.1.0
> © 2022 Dell Inc. or its subsidiaries. All rights reserved. Dell
> and other trademarks are trademarks of Dell Inc. or its
@@ -26,7 +26,7 @@ Revision History
| **Date** | **Document revision** | **Description of changes** |
|------------ |-----------------------|-------------------------------------------------|
-| November 2023 | 01 | Ansible modules for Dell PowerMax release 3.0.0 |
+| July 2024 | 01 | Ansible modules for Dell PowerMax release 3.1.0 |
Product Description
-------------------
@@ -56,9 +56,8 @@ New Features and Enhancements
The Ansible modules for Dell PowerMax release has the following
changes:
-- Added support for PowerMax Laurel.
-- Added bug fix for SRDF module.
-- Added support for connection timeout for all modules.
+- Added Unisphere port parameter.
+- Added support for restoration of storage group from a snapshot using Snapshot module.
> **NOTE:** Unisphere Version 9.1 is compatible with PowerMax Python
> library version 9.1.x.x and similarly Unisphere versions later than 9.1 will
@@ -75,7 +74,7 @@ There are no known limitations.
Distribution
------------
The software package is available for download from the [Ansible modules
-for PowerMax GitHub](https://github.com/dell/ansible-powermax/tree/3.0.0) page.
+for PowerMax GitHub](https://github.com/dell/ansible-powermax/tree/main) page.
Documentation
-------------
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
index c59d830..a9af6a8 100644
--- a/docs/SECURITY.md
+++ b/docs/SECURITY.md
@@ -1,18 +1,8 @@
-
-
# Security policy
The Ansible modules for Dell PowerMax repository is inspected for security vulnerabilities through blackduck scans and static code analysis.
-In addition to this, there are various security checks that are performed against a branch when a pull request is created or updated. See [pull request](https://github.com/dell/ansible-powermax/blob/3.0.0/docs/CONTRIBUTING.md#Pull-requests) for more information.
+In addition to this, there are various security checks that are performed against a branch when a pull request is created or updated. See [pull request](https://github.com/dell/ansible-powermax/blob/main/docs/CONTRIBUTING.md#Pull-requests) for more information.
## Reporting a vulnerability
diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md
index a295a1a..e461b7a 100644
--- a/docs/SUPPORT.md
+++ b/docs/SUPPORT.md
@@ -1,13 +1,3 @@
-
-
# Support
For all your support needs you can interact with us on [GitHub](https://github.com/dell/ansible-powermax) by creating a [GitHub Issue](https://github.com/dell/ansible-powermax/issues) or through the [Ansible Community](https://www.dell.com/community/Automation/bd-p/Automation).
diff --git a/galaxy.yml b/galaxy.yml
index 311da3f..48d193e 100644
--- a/galaxy.yml
+++ b/galaxy.yml
@@ -42,7 +42,6 @@ description: Ansible modules for PowerMax
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
license:
- GPL-3.0-or-later
- - Apache-2.0
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
# requirements as 'namespace' and 'name'
diff --git a/roles/capacity_role/README.md b/roles/capacity_role/README.md
index faf70dc..2abc4b3 100644
--- a/roles/capacity_role/README.md
+++ b/roles/capacity_role/README.md
@@ -43,7 +43,7 @@ Example Playbook
License
-------
-Apache 2
+ GPL-3.0-or-later
Author Information
------------------