diff --git a/CHANGELOG.rst b/CHANGELOG.rst index bdee53e..902b90f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,26 @@ Dellemc.Powerstore Change Logs .. contents:: Topics +v3.1.0 +====== + +Minor Changes +------------- + +- Added support for creating multiple NFS exports with same name + but different NAS servers +- Info module is enhanced to list file interfaces, file DNS, + file NIS, SMB servers and NFS servers. + +New Modules +----------- + +- dellemc.powerstore.file_interface - Manage file interfaces for PowerStore +- dellemc.powerstore.file_dns - Manage file DNS for PowerStore +- dellemc.powerstore.file_nis - Manage file NIS for PowerStore +- dellemc.powerstore.smb_server - Manage SMB server for PowerStore +- dellemc.powerstore.nfs_server - Manage NFS server for PowerStore +- dellemc.powerstore.service_config - Manage service config for PowerStore v3.0.0 ====== diff --git a/README.md b/README.md index c69fb00..b9cc398 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,32 @@ # Ansible Modules for Dell Technologies PowerStore The Ansible Modules for Dell Technologies (Dell) PowerStore allow Data Center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration and management of Dell PowerStore arrays. -The capabilities of the Ansible modules are managing volumes, volume groups, vCenters, hosts, host groups, snapshots, snapshot rules, replication rules, replication sessions, protection policies, file systems, NAS servers, SMB shares, user and tree quotas, file system snapshots, NFS exports, Clusters, Networks, Local users, Jobs, Roles, Certificates, Remote systems, security configuration, DNS server, Email notification destination, NTP server, Remote support configuration, Remote support contacts, SMTP configuration, LDAP accounts, LDAP domain configuration and storage containers. It also allows gathering high level info from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request. +The capabilities of the Ansible modules are managing volumes, volume groups, vCenters, hosts, host groups, snapshots, snapshot rules, replication rules, replication sessions, protection policies, file systems, NAS servers, SMB shares, user and tree quotas, file system snapshots, NFS exports, Clusters, Networks, Local users, Jobs, Roles, Certificates, Remote systems, security configuration, DNS server, Email notification destination, NTP server, Remote support configuration, Remote support contacts, SMTP configuration, LDAP accounts, LDAP domain configuration, storage containers, File DNS, File interface, File NIS, NFS server, SMB Server and service config. It also allows gathering high level info from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request. ## Table of contents -* [Code of conduct](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CODE_OF_CONDUCT.md) -* [Maintainer guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/MAINTAINER_GUIDE.md) -* [Committer guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/COMMITTER_GUIDE.md) -* [Contributing guide](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CONTRIBUTING.md) -* [Branching strategy](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/BRANCHING.md) -* [List of adopters](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/ADOPTERS.md) -* [Maintainers](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/MAINTAINERS.md) -* [Support](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/SUPPORT.md) +* [Code of conduct](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CODE_OF_CONDUCT.md) +* [Maintainer guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/MAINTAINER_GUIDE.md) +* [Committer guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/COMMITTER_GUIDE.md) +* [Contributing guide](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CONTRIBUTING.md) +* [Branching strategy](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/BRANCHING.md) +* [List of adopters](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/ADOPTERS.md) +* [Maintainers](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/MAINTAINERS.md) +* [Support](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SUPPORT.md) * [License](#license) -* [Security](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/SECURITY.md) +* [Security](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SECURITY.md) * [Prerequisites](#prerequisites) * [List of Ansible modules for Dell PowerStore](#list-of-ansible-modules-for-dell-powerstore) * [Installation and execution of Ansible modules for Dell PowerStore](#installation-and-execution-of-ansible-modules-for-dell-powerstore) * [Maintenance](#maintenance) ## License -The Ansible collection for PowerStore is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerstore/blob/3.0.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerStore are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerstore/blob/3.0.0/MODULE-LICENSE) for the full terms. +The Ansible collection for PowerStore is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-powerstore/blob/3.1.0/LICENSE) for the full terms. Ansible modules and modules utilities that are part of the Ansible collection for PowerStore are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-powerstore/blob/3.1.0/MODULE-LICENSE) for the full terms. ## Prerequisites | **Ansible Modules** | **PowerStore Version** | **SDK version** | **Python version** | **Ansible** | |---------------------|-----------------------|-----------------|--------------------|--------------------------| -| v3.0.0 | 3.2.x
3.5.x
3.6.x | 2.0.0 | 3.9.x
3.10.x
3.11.x | 2.14
2.15
2.16 | +| v3.1.0 | 2.9.x
3.2.x
3.5.x
3.6.x | 2.0.0 | 3.6.x
3.9.x
3.10.x
3.11.x | 2.14
2.15
2.16 | * Please follow PyPowerStore installation instructions on [PyPowerStore Documentation](https://github.com/dell/python-powerstore) @@ -35,43 +35,49 @@ The Ansible collection for PowerStore is released and licensed under the GPL-3.0 The modules are written in such a way that all requests are idempotent and hence fault-tolerant. It essentially 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 PowerStore -* [Volume module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/volume.rst) -* [Volume group module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/volumegroup.rst) -* [Host module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/host.rst) -* [Host group module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/hostgroup.rst) -* [Snapshot module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/snapshot.rst) -* [Snapshot rule module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/snapshotrule.rst) -* [Replication rule module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/replicationrule.rst) -* [Replication session module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/replicationsession.rst) -* [Protection policy module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/protectionpolicy.rst) -* [Info module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/info.rst) -* [File system module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/filesystem.rst) -* [NAS server module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/nasserver.rst) -* [SMB share module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/smbshare.rst) -* [Quota module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/quota.rst) -* [File system snapshot module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/filesystem_snapshot.rst) -* [NFS export module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/nfs.rst) -* [Cluster module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/cluster.rst) -* [Network module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/network.rst) -* [Local user module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/local_user.rst) -* [Role module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/role.rst) -* [Job module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/job.rst) -* [Certificate module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/certificate.rst) -* [Remote system module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remotesystem.rst) -* [Security config module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/security_config.rst) -* [DNS module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/dns.rst) -* [Email module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/email.rst) -* [NTP module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ntp.rst) -* [Remote support module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remote_support.rst) -* [Remote support contact module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/remote_support_contact.rst) -* [SMTP config module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/smtp_config.rst) -* [LDAP Account module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ldap_account.rst) -* [LDAP Domain module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/ldap_domain.rst) -* [vCenter module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/vcenter.rst) -* [Storage container module](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/modules/storage_container.rst) +* [Volume module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/volume.rst) +* [Volume group module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/volumegroup.rst) +* [Host module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/host.rst) +* [Host group module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/hostgroup.rst) +* [Snapshot module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/snapshot.rst) +* [Snapshot rule module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/snapshotrule.rst) +* [Replication rule module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/replicationrule.rst) +* [Replication session module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/replicationsession.rst) +* [Protection policy module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/protectionpolicy.rst) +* [Info module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/info.rst) +* [File system module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/filesystem.rst) +* [NAS server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nasserver.rst) +* [SMB share module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smbshare.rst) +* [Quota module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/quota.rst) +* [File system snapshot module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/filesystem_snapshot.rst) +* [NFS export module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nfs.rst) +* [Cluster module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/cluster.rst) +* [Network module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/network.rst) +* [Local user module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/local_user.rst) +* [Role module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/role.rst) +* [Job module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/job.rst) +* [Certificate module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/certificate.rst) +* [Remote system module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remotesystem.rst) +* [Security config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/security_config.rst) +* [DNS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/dns.rst) +* [Email module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/email.rst) +* [NTP module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ntp.rst) +* [Remote support module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remote_support.rst) +* [Remote support contact module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/remote_support_contact.rst) +* [SMTP config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smtp_config.rst) +* [LDAP Account module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ldap_account.rst) +* [LDAP Domain module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/ldap_domain.rst) +* [vCenter module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/vcenter.rst) +* [Storage container module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/storage_container.rst) +* [File interface module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_interface.rst) +* [File DNS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_dns.rst) +* [File NIS module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/file_nis.rst) +* [SMB server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/smb_server.rst) +* [NFS server module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/nfs_server.rst) +* [Service config module](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/modules/service_config.rst) ## Installation and execution of Ansible modules for Dell PowerStore -The installation and execution steps of Ansible modules for Dell PowerStore can be found [here](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/INSTALLATION.md) +The installation and execution steps of Ansible modules for Dell PowerStore can be found [here](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/INSTALLATION.md) ## Maintenance Ansible Modules for Dell Technologies PowerStore deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html). \ No newline at end of file diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 8ad0865..3fa855f 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -216,3 +216,30 @@ releases: minor_changes: - Added support for PowerStore 3.6.x.x. release_date: '2023-11-30' + 3.1.0: + changes: + minor_changes: + - Added support for creating multiple NFS exports with same name + but different NAS servers + - Info module is enhanced to list file interfaces, file DNS, + file NIS, SMB servers and NFS servers. + modules: + - description: Manage file interfaces on Dell PowerStore + name: file_interface + namespace: '' + - description: Manage file DNS on Dell PowerStore + name: file_dns + namespace: '' + - description: Manage file NIS on Dell PowerStore + name: file_nis + namespace: '' + - description: Manage SMB servers on Dell PowerStore + name: smb_server + namespace: '' + - description: Manage NFS servers on Dell PowerStore + name: nfs_server + namespace: '' + - description: Manage service configurations on Dell PowerStore + name: service_config + namespace: '' + release_date: '2024-01-31' diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3b768ea..c9190ab 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -10,7 +10,7 @@ You may obtain a copy of the License at # 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-powerstore/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-powerstore/blob/3.1.0/docs/CODE_OF_CONDUCT.md). ## Table of contents @@ -76,7 +76,7 @@ Triage helps ensure that issues resolve quickly by: If you don't have the knowledge or time to code, consider helping with _issue triage_. The Ansible modules for Dell PowerStore community will thank you for saving them time by spending some of yours. -Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/ISSUE_TRIAGE.md). +Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/ISSUE_TRIAGE.md). ## Your first contribution @@ -89,7 +89,7 @@ When you're ready to contribute, it's time to create a pull request. ## Branching -* [Branching Strategy for Ansible modules for Dell PowerStore](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/BRANCHING.md) +* [Branching Strategy for Ansible modules for Dell PowerStore](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/BRANCHING.md) ## Signing your commits @@ -144,7 +144,7 @@ Make sure that the title for your pull request uses the same format as the subje ### 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 look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/ansible-powerstore/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 look into the check log, understand the problem and resolve the issue. If help is needed, please feel free to reach out the maintainers of the project for [support](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/SUPPORT.md). #### Code sanitization diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index d87183b..ecca410 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -41,7 +41,7 @@ You may obtain a copy of the License at * Download the latest tar build from any of the available distribution channel [Ansible Galaxy](https://galaxy.ansible.com/dellemc/powerstore) /[Automation Hub](https://console.redhat.com/ansible/automation-hub/repo/published/dellemc/powerstore) and use this command to install the collection anywhere in your system: - ansible-galaxy collection install dellemc-powerstore-3.0.0.tar.gz -p + ansible-galaxy collection install dellemc-powerstore-3.1.0.tar.gz -p * Set the environment variable: @@ -68,7 +68,7 @@ You may obtain a copy of the License at ## Ansible modules execution -The Ansible server must be configured with Python library for PowerStore to run the Ansible playbooks. The [Documents](https://github.com/dell/ansible-powerstore/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 needs to be configured before running the modules. +The Ansible server must be configured with Python library for PowerStore to run the Ansible playbooks. The [Documents](https://github.com/dell/ansible-powerstore/blob/3.1.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 needs to be configured before running the modules. ## SSL certificate validation diff --git a/docs/ISSUE_TRIAGE.md b/docs/ISSUE_TRIAGE.md index 7c1a4af..9805097 100644 --- a/docs/ISSUE_TRIAGE.md +++ b/docs/ISSUE_TRIAGE.md @@ -43,8 +43,8 @@ Should explain what happened, what was expected and how to reproduce it together - Ansible Version: [e.g. 2.14] - Python Version [e.g. 3.11] - - Ansible modules for Dell PowerStore Version: [e.g. 3.0.0] - - PowerStore SDK version: [e.g. PyPowerStore 1.10.0] + - Ansible modules for Dell PowerStore Version: [e.g. 3.1.0] + - PowerStore SDK version: [e.g. PyPowerStore 3.0.0] - Any other additional information... #### Feature requests diff --git a/docs/MAINTAINER_GUIDE.md b/docs/MAINTAINER_GUIDE.md index c309b4a..88d058c 100644 --- a/docs/MAINTAINER_GUIDE.md +++ b/docs/MAINTAINER_GUIDE.md @@ -27,7 +27,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-powerstore/blob/3.0.0/docs/CODE_OF_CONDUCT.md) and the guidelines in the [Contributing](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CONTRIBUTING.md) and [Committer](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/COMMITTER_GUIDE.md) guides +* Follow the [Code of Conduct](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CODE_OF_CONDUCT.md) and the guidelines in the [Contributing](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CONTRIBUTING.md) and [Committer](https://github.com/dell/ansible-powerstore/blob/3.1.0/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. diff --git a/docs/Release Notes.md b/docs/Release Notes.md index 0a0058f..02a7278 100644 --- a/docs/Release Notes.md +++ b/docs/Release Notes.md @@ -1,8 +1,8 @@ **Ansible Modules for Dell Technologies PowerStore** ========================================= -### Release Notes 3.0.0 +### Release Notes 3.1.0 -> © 2022 Dell Inc. or its subsidiaries. All rights reserved. Dell, +> © 2024 Dell Inc. or its subsidiaries. All rights reserved. Dell, > and other trademarks are trademarks of Dell Inc. or its > subsidiaries. Other trademarks may be trademarks of their respective > owners. @@ -26,19 +26,34 @@ The table in this section lists the revision history of this document. Table 1. Revision history -| Revision | Date | Description | -|----------|------------|-----------------------------------------------------------| -| 01 | November 2023 | Current release of Ansible Modules for Dell PowerStore 3.0.0 | +| Revision | Date | Description | +|----------|--------------|-----------------------------------------------------------| +| 01 | January 2024 | Current release of Ansible Modules for Dell PowerStore 3.1.0 | Product Description ------------------- -The Ansible modules for Dell PowerStore are used to automate and orchestrate the deployment, configuration, and management of Dell PowerStore storage systems. The capabilities of Ansible modules are managing Volumes, Volume groups, Hosts, Host groups, Protection policies, Replication rules, Replication sessions, NFS exports, SMB shares, NAS server, File systems, File system snapshots, Tree quotas, User quotas, Clusters, Networks, Local users, Roles, Jobs, Certificates, Remote systems, Security Configuration, DNS server, Email notification destinations, NTP server, Remote support contacts, Remote support configuration, SMTP configuration, LDAP accounts, LDAP domain, and obtaining high-level information about a PowerStore system. The options available are list, show, create, delete, and modify. +The Ansible modules for Dell PowerStore are used to automate and orchestrate the deployment, configuration, and management of Dell PowerStore storage systems. The capabilities of Ansible modules are managing Volumes, Volume groups, Hosts, Host groups, Protection policies, Replication rules, Replication sessions, NFS exports, SMB shares, NAS server, File interfaces, File DNS, File NIS, SMB servers, NFS servers, service configurations, File systems, File system snapshots, Tree quotas, User quotas, Clusters, Networks, Local users, Roles, Jobs, Certificates, Remote systems, Security Configuration, DNS server, Email notification destinations, NTP server, Remote support contacts, Remote support configuration, SMTP configuration, LDAP accounts, LDAP domain, and obtaining high-level information about a PowerStore system. The options available are list, show, create, delete, and modify. New features & enhancements --------------------------- Along with the previous release deliverables, this release supports these features: - Added support for PowerStore 3.6.x.x. +- Added support for creating, getting details, modifying and deleting + a file interface. +- Added support for enabling, getting details, modifying and disabling + the file DNS. +- Added support for enabling, getting details, modifying and disabling + the file NIS. +- Added support for enabling, getting details, modifying and disabling + the SMB server. +- Added support for enabling, getting details, modifying and disabling + the NFS server. +- Added support for getting details and modifying a service configuration. +- Added support for creating multiple NFS exports with same name + but different NAS servers +- Info module is enhanced to list file interfaces, file DNS, + file NIS, SMB servers and NFS servers. Known issues ------------ @@ -55,11 +70,11 @@ Limitations Distribution ---------------- The software package is available for download from the [Ansible Modules -for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.0.0) page. +for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.1.0) page. Documentation ------------- -The documentation is available on [Ansible Modules for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.0.0/docs) +The documentation is available on [Ansible Modules for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.1.0/docs) page. It includes these: - README - Release Notes (this document) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index d5e48e2..ab84d51 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -12,7 +12,7 @@ You may obtain a copy of the License at The Ansible modules for Dell PowerStore repository are inspected for security vulnerabilities via blackduck scans and static code analysis. -In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](https://github.com/dell/ansible-powerstore/blob/3.0.0/docs/CONTRIBUTING.md#Pull-requests) for more information. +In addition to this, there are various security checks that get executed against a branch when a pull request is created/updated. Please refer to [pull request](https://github.com/dell/ansible-powerstore/blob/3.1.0/docs/CONTRIBUTING.md#Pull-requests) for more information. ## Reporting a vulnerability diff --git a/docs/modules/certificate.rst b/docs/modules/certificate.rst index c030e67..1178e48 100644 --- a/docs/modules/certificate.rst +++ b/docs/modules/certificate.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -51,7 +51,7 @@ Parameters certificate (optional, str, None) - Concatenated PEM encoded x509\_certificate string from end-entity certificate to root certificate. + Concatenated PEM encoded x509_certificate string from end-entity certificate to root certificate. remote_address (optional, str, None) @@ -85,9 +85,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -118,10 +118,10 @@ Notes .. note:: - Idempotency is not supported for adding/importing certificates, exchange of certificates and the reset of certificates. - - Only \ :emphasis:`is\_current`\ parameter is supported for modification of certificate. + - Only *is_current* parameter is supported for modification of certificate. - Reset operation can reset more than one certificate at a time. - Add/import, modify and reset are supported for PowerStore versions 2.0 and above only. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -228,7 +228,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482 members (, complex, ) - Member certificates included in this x509\_certificate. + Member certificates included in this x509_certificate. subject (, str, ) @@ -256,7 +256,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482 subject_alternative_names (, list, ) - Additional DNS names or IP addresses in the x509\_certificate. + Additional DNS names or IP addresses in the x509_certificate. public_key_algorithm (, str, ) @@ -284,7 +284,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482 thumbprint_algorithm_l10n (, str, ) - Localized message string corresponding to thumbprint\_algorithm. + Localized message string corresponding to thumbprint_algorithm. diff --git a/docs/modules/cluster.rst b/docs/modules/cluster.rst index e638e81..0e1b4e5 100644 --- a/docs/modules/cluster.rst +++ b/docs/modules/cluster.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -53,23 +53,23 @@ Parameters appliance_id (optional, str, None) ID of the appliance. - Parameters \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. + Parameters *appliance_id* and *appliance_name* are mutually exclusive. - Parameter \ :emphasis:`is\_ssh\_enabled`\ has to be passed along with \ :emphasis:`appliance\_id`\ . + Parameter *is_ssh_enabled* has to be passed along with *appliance_id*. appliance_name (optional, str, None) Name of the appliance. - Parameters \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. + Parameters *appliance_id* and *appliance_name* are mutually exclusive. - Parameter \ :emphasis:`is\_ssh\_enabled`\ has to be passed along with \ :emphasis:`appliance\_name`\ . + Parameter *is_ssh_enabled* has to be passed along with *appliance_name*. is_ssh_enabled (optional, bool, None) Whether SSH access is enabled for the cluster. - Either \ :emphasis:`appliance\_id`\ or \ :emphasis:`appliance\_name`\ is to be passed along with \ :emphasis:`is\_ssh\_enabled`\ . + Either *appliance_id* or *appliance_name* is to be passed along with *is_ssh_enabled*. physical_mtu (optional, int, None) @@ -150,7 +150,7 @@ Parameters snmp_community_string (optional, str, None) - Specifies \ :literal:`SNMPv2`\ community string, if \ :literal:`SNMPv2`\ connect method is selected. + Specifies ``SNMPv2`` community string, if ``SNMPv2`` connect method is selected. @@ -229,7 +229,7 @@ Parameters This should be specified when creating PowerStore X cluster. - Mutually exclusive with \ :emphasis:`data\_center\_id`\ . + Mutually exclusive with *data_center_id*. data_center_id (optional, str, None) @@ -239,7 +239,7 @@ Parameters This should be specified when creating PowerStore X cluster. - Mutually exclusive with \ :emphasis:`data\_center\_name`\ . + Mutually exclusive with *data_center_name*. esx_cluster_name (optional, str, None) @@ -273,15 +273,15 @@ Parameters wait_for_completion (optional, bool, False) Flag to indicate if the operation should be run synchronously or asynchronously. - \ :literal:`true`\ signifies synchronous execution. By default, create cluster operation will run asynchronously. + ``true`` signifies synchronous execution. By default, create cluster operation will run asynchronously. state (True, str, None) Define whether the cluster should exist or not. - Value \ :literal:`present`\ indicates that the cluster should exist on the system. + Value ``present`` indicates that the cluster should exist on the system. - Value \ :literal:`absent`\ indicates that the cluster should not exist on the system. + Value ``absent`` indicates that the cluster should not exist on the system. array_ip (True, str, None) @@ -291,9 +291,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -324,13 +324,13 @@ Notes .. note:: - Deletion of a cluster is not supported by ansible module. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - Before performing create operation, the default password for admin user and service user should be changed. - - For management type network during cluster creation, \ :emphasis:`storage\_discovery\_address`\ and purposes should not be passed. - - The \ :emphasis:`vcenters`\ parameter is mandatory for PowerStore X cluster creation. + - For management type network during cluster creation, *storage_discovery_address* and purposes should not be passed. + - The *vcenters* parameter is mandatory for PowerStore X cluster creation. - Minimum 3 and 5 addresses are required for management network for PowerStore T and X model respectively. - - The \ :literal:`File\_Mobility`\ purpose is supported only in FootHills Prime and above. - - Parameter \ :emphasis:`is\_http\_redirect\_enabled`\ is supported only in PowerStore FootHills Prime and above. + - The ``File_Mobility`` purpose is supported only in FootHills Prime and above. + - Parameter *is_http_redirect_enabled* is supported only in PowerStore FootHills Prime and above. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -577,7 +577,7 @@ cluster_details (When Cluster exists., complex, {'appliance_count': 1, 'chap_mod appliance_details (When appliance name or id is passed in the playbook task., complex, ) - Name and Id of the appliance for which \ :emphasis:`is\_ssh\_enabled`\ parameter is used. + Name and Id of the appliance for which *is_ssh_enabled* parameter is used. id (, str, ) diff --git a/docs/modules/dns.rst b/docs/modules/dns.rst index 337f4dc..d2a2695 100644 --- a/docs/modules/dns.rst +++ b/docs/modules/dns.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -39,13 +39,13 @@ Parameters dns_address_state (optional, str, None) - State of the addresses mentioned in \ :emphasis:`dns\_addresses`\ . + State of the addresses mentioned in *dns_addresses*. state (True, str, None) The state of the DNS instance after the task is performed. - For get and modify operations it should be set to \ :literal:`present`\ . + For get and modify operations it should be set to ``present``. array_ip (True, str, None) @@ -55,9 +55,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -88,9 +88,9 @@ Notes .. note:: - Minimum 1 and maximum 3 addresses can be associated to a DNS instance. - - Parameters \ :emphasis:`dns\_addresses`\ and \ :emphasis:`dns\_address\_state`\ are required together. + - Parameters *dns_addresses* and *dns_address_state* are required together. - Creation and deletion of DNS is not supported. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/email.rst b/docs/modules/email.rst index c07feb3..d6d0934 100644 --- a/docs/modules/email.rst +++ b/docs/modules/email.rst @@ -27,8 +27,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -39,13 +39,13 @@ Parameters email_id (optional, str, None) Unique identifier of the destination email address. - Mutually exclusive with \ :emphasis:`email\_address`\ . + Mutually exclusive with *email_address*. email_address (optional, str, None) Email address to receive notifications. - Mutually exclusive with \ :emphasis:`email\_id`\ . + Mutually exclusive with *email_id*. new_address (optional, str, None) @@ -80,9 +80,9 @@ Parameters state (True, str, None) The state of the destination email address after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all Create, Modify, Test or Get details operations it should be set to \ :literal:`present`\ . + For all Create, Modify, Test or Get details operations it should be set to ``present``. array_ip (True, str, None) @@ -92,9 +92,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +125,7 @@ Notes .. note:: - Idempotency is not supported for Test operation of Email module. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/file_dns.rst b/docs/modules/file_dns.rst new file mode 100644 index 0000000..68f193d --- /dev/null +++ b/docs/modules/file_dns.rst @@ -0,0 +1,233 @@ +.. _file_dns_module: + + +file_dns -- Manage File DNS for PowerStore +========================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +Managing storage containers on PowerStore Storage System includes creating a file DNS, getting details of a file DNS, modifying a file DNS and deleting a file DNS. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- A Dell PowerStore storage system version 3.0.0.0 or later. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. +- Python 3.9, 3.10 or 3.11. + + + +Parameters +---------- + + file_dns_id (optional, str, None) + The unique identifier of the file DNS. + + + nas_server (optional, str, None) + Unique identifier/name of the associated NAS Server instance that uses this DNS Service object. + + + domain (optional, str, None) + Name of the DNS domain, where the NAS Server does host names lookup when an FQDN is not specified in the request. + + + add_ip_addresses (optional, list, None) + IP addresses to add to the current list. + + IPv4 and IPv6 are supported. + + + remove_ip_addresses (optional, list, None) + IP addresses to remove from the current list. + + IPv4 and IPv6 are supported. + + + transport (optional, str, None) + Transport used when connecting to the DNS Server. + + ``UDP`` - DNS uses the UDP protocol. + + ``TCP`` - DNS uses the TCP protocol. + + + is_destination_override_enabled (optional, bool, None) + In order to modify any properties of this resource when the associated NAS server is a replication destination, the *is_destination_override_enabled* flag must be set to ``true``. + + + state (optional, str, present) + Define whether the file DNS should be enabled or not. + + For Delete operation only, it should be set to ``absent``. + + + array_ip (True, str, None) + IP or FQDN of the PowerStore management system. + + + validate_certs (optional, bool, True) + Boolean variable to specify whether to validate SSL certificate or not. + + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + + ``false`` - indicates that the SSL certificate should not be verified. + + + user (True, str, None) + The username of the PowerStore host. + + + password (True, str, None) + The password of the PowerStore host. + + + timeout (optional, int, 120) + Time after which the connection will get terminated. + + It is to be mentioned in seconds. + + + port (optional, int, None) + Port number for the PowerStore array. + + If not passed, it will take 443 as default. + + + + + +Notes +----- + +.. note:: + - The *check_mode* is supported. + - The details of a file DNS can be fetched using *file_dns_id* or *nas_server*. + - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + + - name: Enable file DNS + register: result + dellemc.powerstore.file_dns: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ nas_server_name }}" + domain: "NAS_domain" + add_ip_addresses: + - "10.**.**.**" + transport: "UDP" + state: "present" + + - name: Get File DNS + dellemc.powerstore.file_dns: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_dns_id: "{{ result.file_dns_details.id }}" + + - name: Get File DNS with NAS server + dellemc.powerstore.file_dns: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ result.file_dns_details.nas_server_id }}" + + - name: Modify File DNS + dellemc.powerstore.file_dns: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_dns_id: "{{ result.file_dns_details.id }}" + domain: "NAS_domain" + add_ip_addresses: + - "10.**.**.@@" + remove_ip_addresses: + - "10.**.**.**" + transport: "UDP" + + - name: Delete file DNS + dellemc.powerstore.file_dns: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_dns_id: "{{ result.file_dns_details.id }}" + state: "absent" + + + +Return Values +------------- + +changed (always, bool, false) + Whether or not the resource has changed. + + +file_nis_details (When file DNS exists., complex, {'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.**.**.**'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'transport': 'UDP'}) + Details of the file DNS. + + + domain (, str, ) + Name of the DNS domain. + + + id (, str, ) + The unique identifier of the file DNS. + + + ip_addresses (, list, ) + The addresses may be IPv4 or IPv6. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + transport (, str, ) + Transport used when connecting to the DNS Server. + + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Trisha Datta (@trisha-dell) + diff --git a/docs/modules/file_interface.rst b/docs/modules/file_interface.rst new file mode 100644 index 0000000..5744be5 --- /dev/null +++ b/docs/modules/file_interface.rst @@ -0,0 +1,269 @@ +.. _file_interface_module: + + +file_interface -- Manage File interface for PowerStore +====================================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +Managing file interfaces on PowerStore Storage System includes creating a file interface, getting details of a file interface, modifying a file interface and deleting a file interface. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- A Dell PowerStore storage system version 3.0.0.0 or later. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. +- Python 3.9, 3.10 or 3.11. + + + +Parameters +---------- + + file_interface_id (optional, str, None) + The unique identifier of the file interface. + + + nas_server (optional, str, None) + Unique identifier/name of the NAS server to which the network interface belongs, as defined by the *nas_server* resource type. + + + ip_address (optional, str, None) + IP address of the network interface. + + IPv4 and IPv6 are supported. + + + prefix_length (optional, int, None) + Prefix length for the interface. + + IPv4 and IPv6 are supported. + + + gateway (optional, str, None) + Gateway address for the network interface. + + IPv4 and IPv6 are supported. + + + vlan_id (optional, int, None) + Virtual Local Area Network (VLAN) identifier for the interface. + + + role (optional, str, None) + ``Production`` type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in destination mode. + + ``Backup`` type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes. + + ``System`` type of interface are reserved for system traffic such as for NAS server migration, they can not be used for the production traffic. + + ``System`` type is not supported during create interface. + + + is_disabled (optional, bool, None) + Indicates whether the network interface is disabled. + + + ip_port_id (optional, str, None) + Unique Identifier of the IP Port that is associated with the file interface. + + + is_destination_override_enabled (optional, bool, None) + Used in replication context when the user wants to override the settings on the destination. + + + state (optional, str, present) + Define whether the file interface should exist or not. + + For Delete operation only, it should be set to ``absent``. + + + array_ip (True, str, None) + IP or FQDN of the PowerStore management system. + + + validate_certs (optional, bool, True) + Boolean variable to specify whether to validate SSL certificate or not. + + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + + ``false`` - indicates that the SSL certificate should not be verified. + + + user (True, str, None) + The username of the PowerStore host. + + + password (True, str, None) + The password of the PowerStore host. + + + timeout (optional, int, 120) + Time after which the connection will get terminated. + + It is to be mentioned in seconds. + + + port (optional, int, None) + Port number for the PowerStore array. + + If not passed, it will take 443 as default. + + + + + +Notes +----- + +.. note:: + - The *check_mode* is supported. + - The details of a file interface can be fetched using *file_interface_id* or *nas_server* and *ip_address*. + - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + + - name: Create File interface + register: result + dellemc.powerstore.file_interface: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ nas_server_id }}" + ip_address: "10.**.**.**" + vlan_id: 0 + prefix_length: 21 + gateway: "10.**.**.1" + state: "present" + + - name: Get file interface with file_interface_id + dellemc.powerstore.file_interface: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_interface_id: "{{ file_interface_id }}" + + - name: Get file interface with nas_server_name and ip_addresss + dellemc.powerstore.file_interface: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "sample_nas_server" + ip_address: "10.**.**.**" + + - name: Modify file interface + dellemc.powerstore.file_interface: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_interface_id: "{{ file_interface_id }}" + ip_address: "10.**.**.@@" + vlan_id: 0 + prefix_length: 21 + gateway: "10.**.**.1" + state: "present" + + - name: Delete file interface + dellemc.powerstore.file_interface: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_interface_id: "{{ file_interface_id }}" + state: "absent" + + + +Return Values +------------- + +changed (always, bool, false) + Whether or not the resource has changed. + + +file_interface_details (When file interface exists., complex, {'gateway': '10.**.**.1', 'id': '65a50e0d-25f9-bd0a-8ca7-62b767ad9845', 'ip_address': '10.**.**.**', 'ip_port_id': 'IP_PORT2', 'is_destination_override_enabled': False, 'is_disabled': False, 'is_dr_test': False, 'name': 'PROD022_19c8adfb1d41_1d', 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'prefix_length': 21, 'role': 'Production', 'source_parameters': 'None', 'vlan_id': 0}) + Details of the file interface. + + + gateway (, str, ) + Gateway address for the network interface. + + + id (, str, ) + The unique identifier of the file interface. + + + ip_address (, str, ) + IP address of the network interface. + + + ip_port_id (, str, ) + Unique Identifier of the IP Port that is associated with the file interface. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + is_disabled (, bool, ) + Indicates whether the network interface is disabled. + + + name (, str, ) + Name of the network interface. This property supports case-insensitive filtering. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + prefix_length (, int, ) + Prefix length for the interface. + + + role (, str, ) + Role of the interface + + + vlan_id (, int, ) + Virtual Local Area Network (VLAN) identifier for the interface. + + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Trisha Datta (@trisha-dell) + diff --git a/docs/modules/file_nis.rst b/docs/modules/file_nis.rst new file mode 100644 index 0000000..9b4b4a1 --- /dev/null +++ b/docs/modules/file_nis.rst @@ -0,0 +1,219 @@ +.. _file_nis_module: + + +file_nis -- Manage File NIS for PowerStore +========================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +Managing file NIS on PowerStore Storage System includes enabling the file NIS, getting details of a file NIS, modifying a file NIS and disabling the file NIS. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- A Dell PowerStore storage system version 3.0.0.0 or later. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. +- Python 3.9, 3.10 or 3.11. + + + +Parameters +---------- + + file_nis_id (optional, str, None) + The unique identifier of the file NIS. + + + nas_server (optional, str, None) + Unique identifier/name of the associated NAS Server instance that uses this NIS Service object. + + + domain (optional, str, None) + Name of the NIS domain. + + + add_ip_addresses (optional, list, None) + IP addresses to add to the current list. + + IPv4 and IPv6 are supported. + + + remove_ip_addresses (optional, list, None) + IP addresses to remove from the current list. + + IPv4 and IPv6 are supported. + + + is_destination_override_enabled (optional, bool, None) + In order to modify any properties of this resource when the associated NAS server is a replication destination, the *is_destination_override_enabled* flag must be set to ``true``. + + + state (optional, str, present) + Define whether the file NIS should be enabled or not. + + For Delete operation only, it should be set to ``absent``. + + + array_ip (True, str, None) + IP or FQDN of the PowerStore management system. + + + validate_certs (optional, bool, True) + Boolean variable to specify whether to validate SSL certificate or not. + + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + + ``false`` - indicates that the SSL certificate should not be verified. + + + user (True, str, None) + The username of the PowerStore host. + + + password (True, str, None) + The password of the PowerStore host. + + + timeout (optional, int, 120) + Time after which the connection will get terminated. + + It is to be mentioned in seconds. + + + port (optional, int, None) + Port number for the PowerStore array. + + If not passed, it will take 443 as default. + + + + + +Notes +----- + +.. note:: + - The *check_mode* is supported. + - The details of a file NIS can be fetched using *file_nis_id* or *nas_server*. + - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + + - name: Enable file NIS + register: result + dellemc.powerstore.file_nis: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ nas_server_name }}" + domain: "NAS_domain" + add_ip_addresses: + - "10.**.**.**" + state: "present" + + - name: Get File NIS + dellemc.powerstore.file_nis: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_nis_id: "{{ result.file_nis_details.id }}" + + - name: Get File NIS with NAS server + dellemc.powerstore.file_nis: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ result.file_nis_details.nas_server_id }}" + + - name: Modify File NIS + dellemc.powerstore.file_nis: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_nis_id: "{{ result.file_nis_details.id }}" + domain: "NAS_domain" + add_ip_addresses: + - "10.**.**.@@" + remove_ip_addresses: + - "10.**.**.**" + + - name: Delete file NIS + dellemc.powerstore.file_nis: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + file_nis_id: "{{ result.file_nis_details.id }}" + state: "absent" + + + +Return Values +------------- + +changed (always, bool, false) + Whether or not the resource has changed. + + +file_nis_details (When file NIS exists., complex, {'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.**.**.**'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845'}) + Details of the file NIS. + + + domain (, str, ) + Name of the NIS domain. + + + id (, str, ) + The unique identifier of the file NIS. + + + ip_addresses (, list, ) + The addresses may be IPv4 or IPv6. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Trisha Datta (@trisha-dell) + diff --git a/docs/modules/filesystem.rst b/docs/modules/filesystem.rst index 5d0d40d..e1de8a2 100644 --- a/docs/modules/filesystem.rst +++ b/docs/modules/filesystem.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -33,11 +33,11 @@ Parameters ---------- filesystem_name (optional, str, None) - Name of the file system. Mutually exclusive with \ :emphasis:`filesystem\_id`\ . Mandatory only for create operation. + Name of the file system. Mutually exclusive with *filesystem_id*. Mandatory only for create operation. filesystem_id (optional, str, None) - Unique id of the file system. Mutually exclusive with \ :emphasis:`filesystem\_name`\ . + Unique id of the file system. Mutually exclusive with *filesystem_name*. description (optional, str, None) @@ -45,7 +45,7 @@ Parameters nas_server (optional, str, None) - Name or ID of the NAS Server on which the file system is created. Mandatory parameter whenever \ :emphasis:`filesystem\_name`\ is provided, since filesystem names are unique only within a NAS server. + Name or ID of the NAS Server on which the file system is created. Mandatory parameter whenever *filesystem_name* is provided, since filesystem names are unique only within a NAS server. size (optional, int, None) @@ -57,7 +57,7 @@ Parameters cap_unit (optional, str, None) Capacity unit for the size. - It defaults to \ :literal:`GB`\ , if not specified. + It defaults to ``GB``, if not specified. access_policy (optional, str, None) @@ -67,19 +67,19 @@ Parameters locking_policy (optional, str, None) File system locking policies. - \ :literal:`ADVISORY`\ - No lock checking for NFS and honor SMB lock range only for SMB. + ``ADVISORY``- No lock checking for NFS and honor SMB lock range only for SMB. - \ :literal:`MANDATORY`\ - Honor SMB and NFS lock range. + ``MANDATORY``- Honor SMB and NFS lock range. folder_rename_policy (optional, str, None) File system folder rename policies for the file system with multi-protocol access enabled. - \ :literal:`ALL\_ALLOWED`\ - All protocols are allowed to rename directories without any restrictions. + ``ALL_ALLOWED`` - All protocols are allowed to rename directories without any restrictions. - \ :literal:`SMB\_FORBIDDEN`\ - A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. + ``SMB_FORBIDDEN`` - A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. - \ :literal:`All\_FORBIDDEN`\ - Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. + ``All_FORBIDDEN`` - Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. smb_properties (optional, dict, None) @@ -107,7 +107,7 @@ Parameters smb_notify_on_change_dir_depth (optional, int, None) - Determines the lowest directory level to which the enabled notifications apply. minimum value is \ :literal:`1`\ . + Determines the lowest directory level to which the enabled notifications apply. minimum value is ``1``. @@ -145,7 +145,7 @@ Parameters flr_attributes (optional, dict, None) The attributes for file retention. - Can only be provided when the \ :emphasis:`config\_type`\ is \ :literal:`GENERAL`\ . + Can only be provided when the *config_type* is ``GENERAL``. mode (optional, str, None) @@ -196,13 +196,13 @@ Parameters file_events_publishing_mode (optional, str, None) State of the event notification services for all file systems of the NAS server. - It can only be set to \ :literal:`NFS\_ONLY`\ when \ :emphasis:`config\_typ`\ is set to \ :literal:`VMWARE`\ . + It can only be set to ``NFS_ONLY`` when *config_typ* is set to ``VMWARE``. host_io_size (optional, str, None) Typical size of writes from the server or other computer using the VMware file system to the storage system. - Can only be set when the \ :emphasis:`config\_type`\ is \ :literal:`VMWARE`\ . + Can only be set when the *config_type* is ``VMWARE``. Cannot be modified. @@ -224,29 +224,29 @@ Parameters access_policy (optional, str, None) File system security access policies. - \ :literal:`Native`\ - Native Security. + ``Native`` - Native Security. - \ :literal:`UNIX`\ - UNIX Security. + ``UNIX`` - UNIX Security. - \ :literal:`Windows`\ - Windows Security. + ``Windows`` - Windows Security. locking_policy (optional, str, None) File system locking policies. - \ :literal:`Advisory`\ - No lock checking for NFS and honor SMB lock range only for SMB. + ``Advisory``- No lock checking for NFS and honor SMB lock range only for SMB. - \ :literal:`Mandatory`\ - Honor SMB and NFS lock range. + ``Mandatory``- Honor SMB and NFS lock range. folder_rename_policy (optional, str, None) File system folder rename policies for the file system with multi-protocol access enabled. - \ :literal:`All\_Allowed`\ - All protocols are allowed to rename directories without any restrictions. + ``All_Allowed`` - All protocols are allowed to rename directories without any restrictions. - \ :literal:`SMB\_Forbidden`\ - A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. + ``SMB_Forbidden`` - A directory rename from the SMB protocol will be denied if at least one file is opened in the directory or in one of its child directories. - \ :literal:`All\_Forbidden`\ - Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. + ``All_Forbidden`` - Any directory rename request will be denied regardless of the protocol used, if at least one file is opened in the directory or in one of its child directories. is_smb_sync_writes_enabled (optional, bool, None) @@ -270,7 +270,7 @@ Parameters smb_notify_on_change_dir_depth (optional, int, None) - Determines the lowest directory level to which the enabled notifications apply. minimum value is \ :literal:`1`\ . + Determines the lowest directory level to which the enabled notifications apply. minimum value is ``1``. is_async_MTime_enabled (optional, bool, None) @@ -280,13 +280,13 @@ Parameters file_events_publishing_mode (optional, str, None) State of the event notification services for all file systems of the NAS server. - \ :literal:`None`\ - File event notifications are disabled for this file system. + ``None`` - File event notifications are disabled for this file system. - \ :literal:`SMB\_Only`\ - SMB notifications are enabled for this file system. + ``SMB_Only`` - SMB notifications are enabled for this file system. - \ :literal:`NFS\_Only`\ - NFS notifications are enabled for this file system. + ``NFS_Only`` - NFS notifications are enabled for this file system. - \ :literal:`All`\ - SMB and NFS notifications are enabled for this file system. + ``All`` - SMB and NFS notifications are enabled for this file system. flr_attributes (optional, dict, None) @@ -296,9 +296,9 @@ Parameters force_clone (optional, bool, None) Specifies whether an FLR-C file system should be cloned. - \ :literal:`true`\ - means cloning an FLR-C file system is allowed. + ``true`` - means cloning an FLR-C file system is allowed. - \ :literal:`false`\ - means cloning an FLR-C file system is not allowed. and any attempt to do so will return an error. + ``false`` - means cloning an FLR-C file system is not allowed. and any attempt to do so will return an error. @@ -342,9 +342,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -375,9 +375,9 @@ Notes .. note:: - It is recommended to remove the protection policy before deleting the filesystem. - - The \ :emphasis:`check\_mode`\ is not supported. - - The pattern for \ :emphasis:`minimum\_retention`\ , \ :emphasis:`default\_retention`\ and \ :emphasis:`maximum\_retention`\ is (^\\d+[DMY])|(^infinite$). - - Filesystem snapshot can be created using filesystem\_snapshot module. + - The *check_mode* is not supported. + - The pattern for *minimum_retention*, *default_retention* and *maximum_retention* is (^\d+[DMY])|(^infinite$). + - Filesystem snapshot can be created using filesystem_snapshot module. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/filesystem_snapshot.rst b/docs/modules/filesystem_snapshot.rst index 158c77e..dc2441e 100644 --- a/docs/modules/filesystem_snapshot.rst +++ b/docs/modules/filesystem_snapshot.rst @@ -21,13 +21,12 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- @@ -46,7 +45,7 @@ Parameters filesystem (optional, str, None) The ID/Name of the filesystem for which snapshot will be taken. - If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. + If filesystem name is specified, then *nas_server* is required to uniquely identify the filesystem. Mandatory for create operation. @@ -62,7 +61,7 @@ Parameters desired_retention (optional, int, None) The retention value for the Snapshot. - If the \ :emphasis:`desired\_retention`\ /\ :emphasis:`expiration\_timestamp`\ is not mentioned during creation, snapshot will be created with unlimited retention. + If the *desired_retention*/*expiration_timestamp* is not mentioned during creation, snapshot will be created with unlimited retention. Maximum supported desired retention is 31 days. @@ -80,7 +79,7 @@ Parameters access_type (optional, str, None) Specifies whether the snapshot directory or protocol access is granted to the filesystem snapshot. - For create operation, if \ :emphasis:`access\_type`\ is not specified, snapshot will be created with \ :literal:`SNAPSHOT`\ access type. + For create operation, if *access_type* is not specified, snapshot will be created with ``SNAPSHOT`` access type. state (True, str, None) @@ -94,9 +93,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -126,7 +125,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/host.rst b/docs/modules/host.rst index 394b260..f26157d 100644 --- a/docs/modules/host.rst +++ b/docs/modules/host.rst @@ -21,13 +21,12 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- @@ -38,15 +37,15 @@ Parameters Required when creating a host. - Use either \ :emphasis:`host\_id`\ or \ :emphasis:`host\_name`\ for modify and delete tasks. + Use either *host_id* or *host_name* for modify and delete tasks. host_id (optional, str, None) The 36 character long host id automatically generated when a host is created. - Use either \ :emphasis:`host\_id`\ or \ :emphasis:`host\_name`\ for modify and delete tasks. + Use either *host_id* or *host_name* for modify and delete tasks. - The \ :emphasis:`host\_id`\ cannot be used while creating host, as it is generated by the array after creation of host. + The *host_id* cannot be used while creating host, as it is generated by the array after creation of host. os_type (optional, str, None) @@ -64,19 +63,19 @@ Parameters Required when creating a host. - It is mutually exclusive with \ :emphasis:`detailed\_initiators`\ . + It is mutually exclusive with *detailed_initiators*. detailed_initiators (optional, list, None) Initiator properties. - It is mutually exclusive with \ :emphasis:`initiators`\ . + It is mutually exclusive with *initiators*. port_name (True, str, None) Name of port type. - The \ :emphasis:`port\_name`\ is mandatory key. + The *port_name* is mandatory key. port_type (optional, str, None) @@ -119,17 +118,17 @@ Parameters state (True, str, None) Define whether the host should exist or not. - Value \ :literal:`present`\ - indicates that the host should exist in system. + Value ``present`` - indicates that the host should exist in system. - Value \ :literal:`absent`\ - indicates that the host should not exist in system. + Value ``absent`` - indicates that the host should not exist in system. initiator_state (optional, str, None) Define whether the initiators should be present or absent in host. - Value \ :literal:`present-in-host`\ - indicates that the initiators should exist on host. + Value ``present-in-host`` - indicates that the initiators should exist on host. - Value \ :literal:`absent-in-host`\ - indicates that the initiators should not exist on host. + Value ``absent-in-host`` - indicates that the initiators should not exist on host. Required when creating a host with initiators or adding/removing initiators to/from existing host. @@ -153,9 +152,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -186,11 +185,11 @@ Notes .. note:: - Only completely and correctly configured iSCSI initiators can be associated with a host. - - The parameters \ :emphasis:`initiators`\ and \ :emphasis:`detailed\_initiators`\ are mutually exclusive. + - The parameters *initiators* and *detailed_initiators* are mutually exclusive. - For mutual CHAP authentication, single CHAP credentials are mandatory. - - Support of \ :literal:`NVMe`\ type of initiators is for PowerStore 2.0 and beyond. - - The \ :emphasis:`host\_connectivity`\ is supported only in PowerStore 3.0.0.0 and above. - - The \ :emphasis:`check\_mode`\ is not supported. + - Support of ``NVMe`` type of initiators is for PowerStore 2.0 and beyond. + - The *host_connectivity* is supported only in PowerStore 3.0.0.0 and above. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -367,7 +366,7 @@ host_details (When host exists, complex, {'description': None, 'host_group_id': mapped_hosts (, complex, ) - This is the inverse of the resource type \ :emphasis:`host\_volume\_mapping`\ association. + This is the inverse of the resource type *host_volume_mapping* association. id (, str, ) diff --git a/docs/modules/hostgroup.rst b/docs/modules/hostgroup.rst index 7eee119..13799cf 100644 --- a/docs/modules/hostgroup.rst +++ b/docs/modules/hostgroup.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -39,15 +39,15 @@ Parameters Required when creating a host group. - Use either \ :emphasis:`hostgroup\_id`\ or \ :emphasis:`hostgroup\_name`\ for modify and delete tasks. + Use either *hostgroup_id* or *hostgroup_name* for modify and delete tasks. hostgroup_id (optional, str, None) The 36-character long host group id, automatically generated when a host group is created. - Use either \ :emphasis:`hostgroup\_id`\ or \ :emphasis:`hostgroup\_name`\ for modify and delete tasks. + Use either *hostgroup_id* or *hostgroup_name* for modify and delete tasks. - The \ :emphasis:`hostgroup\_id`\ cannot be used while creating host group, as it is generated by the array after creation of host group. + The *hostgroup_id* cannot be used while creating host group, as it is generated by the array after creation of host group. hosts (optional, list, None) @@ -63,9 +63,9 @@ Parameters state (True, str, None) Define whether the host group should exist or not. - Value \ :literal:`present`\ - indicates that the host group should exist on the system. + Value ``present`` - indicates that the host group should exist on the system. - Value \ :literal:`absent`\ - indicates that the host group should not exist on the system. + Value ``absent`` - indicates that the host group should not exist on the system. Deletion of a host group results in deletion of the containing hosts as well. Remove hosts from the host group first to retain them. @@ -73,9 +73,9 @@ Parameters host_state (optional, str, None) Define whether the hosts should be present or absent in host group. - Value \ :literal:`present-in-group`\ - indicates that the hosts should exist on the host group. + Value ``present-in-group`` - indicates that the hosts should exist on the host group. - Value \ :literal:`absent-in-group`\ - indicates that the hosts should not exist on the host group. + Value ``absent-in-group`` - indicates that the hosts should not exist on the host group. Required when creating a host group with hosts or adding/removing hosts from existing host group. @@ -97,9 +97,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -129,8 +129,8 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. - - The \ :emphasis:`host\_connectivity`\ is supported only PowerStore 3.0.0.0 and above. + - The *check_mode* is not supported. + - The *host_connectivity* is supported only PowerStore 3.0.0.0 and above. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/info.rst b/docs/modules/info.rst index cd7377b..f8a3d44 100644 --- a/docs/modules/info.rst +++ b/docs/modules/info.rst @@ -16,13 +16,15 @@ Gathers the list of specified PowerStore Storage System entities, includes block Block provisioning module includes volumes, volume groups, hosts, host groups, snapshot rules, and protection policies. -File provisioning module includes NAS servers, NFS exports, SMB shares, tree quotas, user quotas, and file systems. +File provisioning module includes NAS servers, NFS exports, SMB shares, tree quotas, user quotas, file systems, file interface, SMB server, NFS server, file DNS, and file NIS. Replication module includes replication rules, replication sessions, replication groups, and remote system. Virtualization module includes vCenters and virtual volumes. -Configuration module includes cluster nodes, networks, roles, local users, appliances, discovered appliances, security configs, certificates, AD/LDAP servers, LDAP accounts, and LDAP domain. +Configuration module includes cluster nodes, networks, roles, local users, appliances, discovered appliances, security configs, certificates. + +Configureation modules also includes AD/LDAP servers, LDAP accounts, LDAP domain, and service configs. It also includes DNS/NTP servers, smtp configs, email destinations, remote support, and remote support contacts. @@ -33,98 +35,109 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- gather_subset (True, list, None) A list of string variables which specify the PowerStore system entities requiring information. - Volumes - \ :literal:`vol`\ . + Volumes - ``vol``. + + All the nodes - ``node``. + + Volume groups - ``vg``. + + Protection policies - ``protection_policy``. - All the nodes - \ :literal:`node`\ . + Hosts - ``host``. - Volume groups - \ :literal:`vg`\ . + Host groups - ``hg``. - Protection policies - \ :literal:`protection\_policy`\ . + Snapshot rules - ``snapshot_rule``. - Hosts - \ :literal:`host`\ . + NAS servers - ``nas_server``. - Host groups - \ :literal:`hg`\ . + NFS exports - ``nfs_export``. - Snapshot rules - \ :literal:`snapshot\_rule`\ . + SMB shares - ``smb_share``. - NAS servers - \ :literal:`nas\_server`\ . + Tree quotas - ``tree_quota``. - NFS exports - \ :literal:`nfs\_export`\ . + User quotas - ``user_quota``. - SMB shares - \ :literal:`smb\_share`\ . + File systems - ``file_system``. - Tree quotas - \ :literal:`tree\_quota`\ . + Replication rules - ``replication_rule``. - User quotas - \ :literal:`user\_quota`\ . + Replication sessions - ``replication_session``. - File systems - \ :literal:`file\_system`\ . + Remote systems - ``remote_system``. - Replication rules - \ :literal:`replication\_rule`\ . + Various networks - ``network``. - Replication sessions - \ :literal:`replication\_session`\ . + Roles - ``role``. - Remote systems - \ :literal:`remote\_system`\ . + Local users - ``user``. - Various networks - \ :literal:`network`\ . + Appliances - ``appliance``. - Roles - \ :literal:`role`\ . + Security configurations - ``security_config``. - Local users - \ :literal:`user`\ . + Certificates - ``certificate``. - Appliances - \ :literal:`appliance`\ . + Active directories - ``ad``. - Security configurations - \ :literal:`security\_config`\ . + LDAPs - ``ldap``. - Certificates - \ :literal:`certificate`\ . + DNS servers - ``dns``. - Active directories - \ :literal:`ad`\ . + NTP servers - ``ntp``. - LDAPs - \ :literal:`ldap`\ . + Email notification destinations - ``email_notification``. - DNS servers - \ :literal:`dns`\ . + SMTP configurations - ``smtp_config``. - NTP servers - \ :literal:`ntp`\ . + Remote Support - ``remote_support``. - Email notification destinations - \ :literal:`email\_notification`\ . + Remote support contacts - ``remote_support_contact``. - SMTP configurations - \ :literal:`smtp\_config`\ . + LDAP accounts - ``ldap_account``. - Remote Support - \ :literal:`remote\_support`\ . + LDAP domain - ``ldap_domain``. - Remote support contacts - \ :literal:`remote\_support\_contact`\ . + All vCenters - ``vcenter``. - LDAP accounts - \ :literal:`ldap\_account`\ . + Virtual volumes - ``virtual_volume``. - LDAP domain - \ :literal:`ldap\_domain`\ . + Storage containers - ``storage_container``. - All vCenters - \ :literal:`vcenter`\ . + Replication groups - ``replication_group``. - Virtual volumes - \ :literal:`virtual\_volume`\ . + Discovered appliances - ``discovered_appliance``. - Storage containers - \ :literal:`storage\_container`\ . + File interfaces - ``file_interface``. - Replication groups - \ :literal:`replication\_group`\ . + SMB servers - ``smb_server``. - Discovered appliances - \ :literal:`discovered\_appliance`\ . + NFS servers - ``nfs_server``. + + File DNS - ``file_dns``. + + File NIS - ``file_nis``. + + Service configs - ``service_configs``. filters (optional, list, None) A list of filters to support filtered output for storage entities. - Each filter is a list of \ :emphasis:`filter\_key`\ , \ :emphasis:`filter\_operator`\ , \ :emphasis:`filter\_value`\ . + Each filter is a list of *filter_key*, *filter_operator*, *filter_value*. Supports passing of multiple filters. @@ -145,7 +158,7 @@ Parameters all_pages (optional, bool, False) Indicates whether to return all available entities on the storage system. - If set to \ :literal:`true`\ , the Info module will implement pagination and return all entities. Otherwise, a maximum of the first 100 entities of any type will be returned. + If set to ``true``, the Info module will implement pagination and return all entities. Otherwise, a maximum of the first 100 entities of any type will be returned. array_ip (True, str, None) @@ -155,9 +168,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -187,8 +200,8 @@ Notes ----- .. note:: - - Pagination is not supported for role, local user, security configs, LDAP accounts, discovered appliances and LDAP domain. If \ :emphasis:`all\_pages`\ is passed, it will be ignored. - - The \ :emphasis:`check\_mode`\ is supported. + - Pagination is not supported for role, local user, security configs, LDAP accounts, discovered appliances and LDAP domain. If *all_pages* is passed, it will be ignored. + - The *check_mode* is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -449,6 +462,28 @@ Examples - storage_container - discovered_appliance + - name: Get list of file interfaces, SMB servers, NFS servers, file DNS and file NIS + dellemc.powerstore.info: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + gather_subset: + - file_interface + - smb_server + - nfs_server + - file_dns + - file_nis + + - name: Get list of service configs + dellemc.powerstore.info: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + gather_subset: + - service_config + Return Values @@ -540,7 +575,7 @@ Appliance (When C(appliance) is in a given I(gather_subset), list, [{'id': 'A1', eth_be_ports (, list, ) - Provides details of all eth\_be\_ports. It was added in version 3.0.0.0. + Provides details of all eth_be_ports. It was added in version 3.0.0.0. software_installed (, list, ) @@ -677,6 +712,109 @@ EmailNotification (When C(email_notification) is in a given I(gather_subset), li +FileDNS (When C(file_dns) is in a given I(gather_subset), list, [{'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.10.10.11'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'transport': 'UDP'}]) + Provides details of all file DNS. + + + domain (, str, ) + Name of the DNS domain. + + + id (, str, ) + The unique identifier of the file DNS. + + + ip_addresses (, list, ) + The addresses may be IPv4 or IPv6. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + transport (, str, ) + Transport used when connecting to the DNS Server. + + + +FileInterfaces (When C(file_interface) is in a given I(gather_subset), list, [{'gateway': '10.10.10.1', 'id': '65a50e0d-25f9-bd0a-8ca7-62b767ad9845', 'ip_address': '10.10.10.10', 'ip_port_id': 'IP_PORT2', 'is_destination_override_enabled': False, 'is_disabled': False, 'is_dr_test': False, 'name': 'PROD022_19c8adfb1d41_1d', 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'prefix_length': 21, 'role': 'Production', 'source_parameters': 'None', 'vlan_id': 0}]) + Provides details of all file interfaces. + + + gateway (, str, ) + Gateway address for the network interface. + + + id (, str, ) + The unique identifier of the file interface. + + + ip_address (, str, ) + IP address of the network interface. + + + ip_port_id (, str, ) + Unique Identifier of the IP Port that is associated with the file interface. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + is_disabled (, bool, ) + Indicates whether the network interface is disabled. + + + name (, str, ) + Name of the network interface. This property supports case-insensitive filtering. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + prefix_length (, int, ) + Prefix length for the interface. + + + role (, str, ) + Role of the interface + + + vlan_id (, int, ) + Virtual Local Area Network (VLAN) identifier for the interface. + + + +FileNIS (When C(file_nis) is in a given I(gather_subset), list, [{'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.10.10.11'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845'}]) + Provides details of all file NIS. + + + domain (, str, ) + Name of the NIS domain. + + + id (, str, ) + The unique identifier of the file NIS. + + + ip_addresses (, list, ) + The addresses may be IPv4 or IPv6. + + + is_destination_override_enabled (, bool, ) + Used in replication context when the user wants to override the settings on the destination. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + FileSystems (When C(file_system) is in a given I(gather_subset), list, [{'id': '61ef399b-f4c4-ccb6-1761-16c6ac7490fc', 'name': 'test_fs'}]) Provides details of all filesystems. @@ -791,7 +929,7 @@ LDAPDomain (When C(ldap_domain) configuration is in a given I(gather_subset), li is_global_catalog (, bool, ) - Whether or not the catalog is global. Default value is \ :literal:`false`\ . + Whether or not the catalog is global. Default value is ``false``. user_id_attribute (, str, ) @@ -827,7 +965,7 @@ LDAPDomain (When C(ldap_domain) configuration is in a given I(gather_subset), li ldap_server_type_l10n (, str, ) - Localized message string corresponding to ldap\_server\_type. + Localized message string corresponding to ldap_server_type. protocol_l10n (, str, ) @@ -887,6 +1025,55 @@ NFSExports (When C(nfs_export) is in a given I(gather_subset), list, [{'id': '61 +NFSServers (When C(nfs_server) is in a given I(gather_subset), list, [{'credentials_cache_TTL': 120, 'host_name': 'sample_host_name', 'id': '65ad14fe-5f6e-beb3-424f-62b767ad9845', 'is_extended_credentials_enabled': True, 'is_joined': False, 'is_nfsv3_enabled': True, 'is_nfsv4_enabled': False, 'is_secure_enabled': False, 'is_use_smb_config_enabled': None, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'service_principal_name': None}]) + Provides details of all nfs servers. + + + credentials_cache_TTL (, int, ) + Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache. + + + id (, str, ) + The unique identifier of the NFS server. + + + host_name (, str, ) + The name that will be used by NFS clients to connect to this NFS server. + + + is_extended_credentials_enabled (, bool, ) + Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. + + + is_joined (, bool, ) + Indicates whether the NFS server is joined to Active Directory. + + + is_nfsv3_enabled (, bool, ) + Indicates whether NFSv3 is enabled on the NAS server. + + + is_nfsv4_enabled (, bool, ) + Indicates whether NFSv4 is enabled on the NAS server. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + is_secure_enabled (, bool, ) + Indicates whether secure NFS is enabled on the NFS server. + + + is_use_smb_config_enabled (, bool, ) + Indicates whether SMB authentication is used to authenticate to the KDC. + + + service_principal_name (, str, ) + The Service Principal Name (SPN) for the NFS server. + + + Nodes (When a C(node) is in a given I(gather_subset), list, [{'id': 'N1', 'name': 'Appliance-RT-D1006-node-A'}]) Provides details of all nodes. @@ -940,7 +1127,7 @@ RemoteSupportContact (When C(remote_support_contact) is in a given I(gather_subs -ReplicationGroups (when C(replication_group) is in a given I(gather_subset)., list, [{'id': 'c4ba4ad3-2200-47d4-8f61-ddf51d83aac2', 'storage_container_id': '0b460d65-b8b6-40bf-8578-aa2e2fd3d02a', 'name': 'Ansible_RTD8337_VM', 'description': 'Ansible_RTD8337_VM', 'creator_type': 'User', 'creation_timestamp': '2023-05-16T13:58:09.348368+00:00', 'is_replication_destination': False, 'creator_type_l10n': 'User'}]) +ReplicationGroups (when C(replication_group) is in a given I(gather_subset)., list, [{'id': 'c4ba4ad3-2200-47d4-8f61-ddf51d83aac2', 'storage_container_id': '0b460d65-b8b6-40bf-8578-aa2e2fd3d02a', 'name': 'Ansible_RTD8337_VM', 'description': 'Ansible_RTD8337_VM', 'creator_type': 'User', 'creation_timestamp': '2024-05-16T13:58:09.348368+00:00', 'is_replication_destination': False, 'creator_type_l10n': 'User'}]) Provide details of all replication group. @@ -973,7 +1160,7 @@ ReplicationGroups (when C(replication_group) is in a given I(gather_subset)., li creator_type_l10n (, str, ) - Localized message string corresponding to creator\_type. + Localized message string corresponding to creator_type. @@ -1034,6 +1221,64 @@ SecurityConfig (When C(security_config) is in a given I(gather_subset), list, [{ +ServiceConfigs (When C(service_config) is in a given I(gather_subset), list, [{'id': 'A1', 'appliance_id': 'A1', 'is_ssh_enabled': True}]) + Provides details of all service configurations. + + + id (, str, ) + ID of the service config. + + + appliance_id (, str, ) + ID of the appliance. + + + is_ssh_enabled (, bool, ) + Indicates whether ssh is enabled or not on the appliance. + + + +SMBServers (When C(smb_server) is in a given I(gather_subset), list, [{'computer_name': None, 'description': 'string2', 'domain': None, 'id': '65ad211b-374b-5f77-2946-62b767ad9845', 'is_joined': False, 'is_standalone': True, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'netbios_name': 'STRING2', 'workgroup': 'STRING2'}]) + Provides details of all SMB servers. + + + computer_name (, str, ) + DNS name of the associated computer account when the SMB server is joined to an Active Directory domain. + + + id (, str, ) + The unique identifier of the SMB server. + + + description (, str, ) + Description of the SMB server. + + + domain (, str, ) + Domain name where SMB server is registered in Active Directory, if applicable. + + + is_joined (, bool, ) + Indicates whether the SMB server is joined to the Active Directory. + + + is_standalone (, bool, ) + Indicates whether the SMB server is standalone. + + + netbios_name (, str, ) + NetBIOS name is the network name of the standalone SMB server. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + workgroup (, str, ) + Windows network workgroup for the SMB server. + + + SMBShares (When C(smb_share) is in a given I(gather_subset), list, [{'id': '72ef39a0-09b3-5339-c8bb-16c6ac7490fc', 'name': 'test_smb'}]) Provides details of all smb shares. @@ -1227,7 +1472,7 @@ vCenter (When C(vCenter) is in a given I(gather_subset), list, [{'id': '0d330d6c vendor_provider_status_l10n (, str, ) - Localized message string corresponding to vendor\_provider\_status. + Localized message string corresponding to vendor_provider_status. virtual_machines (, list, ) @@ -1385,15 +1630,15 @@ VirtualVolume (When C(virtual_volume) is in a given I(gather_subset), list, [{'i usage_type_l10n (, str, ) - Localized message string corresponding to usage\_type. + Localized message string corresponding to usage_type. io_priority_l10n (, str, ) - Localized message string corresponding to io\_priority. + Localized message string corresponding to io_priority. creator_type_l10n (, str, ) - Localized message string corresponding to creator\_type. + Localized message string corresponding to creator_type. host_virtual_volume_mappings (, complex, ) diff --git a/docs/modules/job.rst b/docs/modules/job.rst index e4230b8..65fcdfc 100644 --- a/docs/modules/job.rst +++ b/docs/modules/job.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -41,9 +41,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -73,7 +73,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/ldap_account.rst b/docs/modules/ldap_account.rst index d12acc0..2576a94 100644 --- a/docs/modules/ldap_account.rst +++ b/docs/modules/ldap_account.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -63,9 +63,9 @@ Parameters state (True, str, None) Define whether the LDAP account should exist or not. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all other operations except delete, it should be set to \ :literal:`present`\ . + For all other operations except delete, it should be set to ``present``. array_ip (True, str, None) @@ -75,9 +75,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -107,7 +107,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is supported. + - The *check_mode* is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/ldap_domain.rst b/docs/modules/ldap_domain.rst index 03394a8..d695aa2 100644 --- a/docs/modules/ldap_domain.rst +++ b/docs/modules/ldap_domain.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -47,7 +47,7 @@ Parameters ldap_server_state (optional, str, None) State of the LDAP server. - The \ :emphasis:`ldap\_servers`\ and \ :emphasis:`ldap\_server\_state`\ are required together. + The *ldap_servers* and *ldap_server_state* are required together. ldap_server_port (optional, int, None) @@ -89,13 +89,13 @@ Parameters user_id_attribute (optional, str, None) Name of the LDAP attribute whose value indicates the unique identifier of the user. - Default value is \ :literal:`sAMAccountName`\ . + Default value is ``sAMAccountName``. user_object_class (optional, str, None) LDAP object class for users. - Default value is \ :literal:`user`\ . + Default value is ``user``. user_search_path (optional, str, None) @@ -112,19 +112,19 @@ Parameters group_name_attribute (optional, str, None) Name of the LDAP attribute whose value indicates the group name. - Default value is \ :literal:`cn`\ . + Default value is ``cn``. group_member_attribute (optional, str, None) Name of the LDAP attribute whose value contains the names of group members within a group. - Default value is \ :literal:`member`\ . + Default value is ``member``. group_object_class (optional, str, None) LDAP object class for groups. - Default value is \ :literal:`group`\ . + Default value is ``group``. group_search_path (optional, str, None) @@ -147,9 +147,9 @@ Parameters state (True, str, None) Define whether the LDAP domain configuration should exist or not. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all other operations except delete, it should be set to \ :literal:`present`\ . + For all other operations except delete, it should be set to ``present``. array_ip (True, str, None) @@ -159,9 +159,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -191,10 +191,10 @@ Notes ----- .. note:: - - The \ :emphasis:`is\_global\_catalog`\ option can be enabled only for AD server type. + - The *is_global_catalog* option can be enabled only for AD server type. - To use LDAPS protocol, the pre-requisite is to upload the certificate of LDAP server on PowerStore array. - Verify operation does not support idempotency. - - The \ :emphasis:`check\_mode`\ is supported. + - The *check_mode* is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -384,7 +384,7 @@ ldap_domain_details (When LDAP domain configuration exists., complex, {'id': '9' ldap_server_type_l10n (, str, ) - Localized message string corresponding to ldap\_server\_type. + Localized message string corresponding to ldap_server_type. protocol_l10n (, str, ) diff --git a/docs/modules/local_user.rst b/docs/modules/local_user.rst index 2858746..b8b460e 100644 --- a/docs/modules/local_user.rst +++ b/docs/modules/local_user.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -31,7 +31,7 @@ Parameters ---------- user_name (optional, str, None) - Name of the local user account. Mutually exclusive with \ :emphasis:`user\_id`\ . + Name of the local user account. Mutually exclusive with *user_id*. Mandatory only for create operation. @@ -39,7 +39,7 @@ Parameters user_id (optional, str, None) Unique identifier of the local user account. - Mutually exclusive with \ :emphasis:`user\_name`\ . + Mutually exclusive with *user_name*. user_password (optional, str, None) @@ -55,19 +55,19 @@ Parameters role_name (optional, str, None) The name of the role to which the local user account will be mapped. - It is mutually exclusive with \ :emphasis:`role\_id`\ . + It is mutually exclusive with *role_id*. role_id (optional, int, None) The unique identifier of the role to which the local user account will be mapped. - It is mutually exclusive with \ :emphasis:`role\_name`\ . + It is mutually exclusive with *role_name*. is_locked (optional, bool, None) Whether the user account is locked or not. - Defaults to \ :literal:`false`\ at creation time. + Defaults to ``false`` at creation time. state (True, str, None) @@ -81,9 +81,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -113,7 +113,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/nasserver.rst b/docs/modules/nasserver.rst index f18f5bb..65e781d 100644 --- a/docs/modules/nasserver.rst +++ b/docs/modules/nasserver.rst @@ -21,22 +21,21 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- nas_server_name (optional, str, None) - Name of the NAS server. Mutually exclusive with \ :emphasis:`nas\_server\_id`\ . + Name of the NAS server. Mutually exclusive with *nas_server_id*. nas_server_id (optional, str, None) - Unique id of the NAS server. Mutually exclusive with \ :emphasis:`nas\_server\_name`\ . + Unique id of the NAS server. Mutually exclusive with *nas_server_name*. description (optional, str, None) @@ -70,7 +69,7 @@ Parameters protection_policy (optional, str, None) Name/ID of the protection policy applied to the nas server. - Policy can be removed by passing an empty string in the \ :emphasis:`protection\_policy`\ parameter. + Policy can be removed by passing an empty string in the *protection_policy* parameter. is_username_translation_enabled (optional, bool, None) @@ -94,9 +93,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -126,7 +125,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - Adding/Removing protection policy to/from a NAS server is supported for PowerStore version 3.0.0 and above. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -281,23 +280,23 @@ nasserver_details (When nas server exists, complex, {'backup_IPv4_interface_id': file_interfaces (, dict, ) - This is the inverse of the resource type file\_interface association. Will return the id,name & ip\_address of the associated file interface. + This is the inverse of the resource type file_interface association. Will return the id,name & ip_address of the associated file interface. nfs_servers (, str, ) - This is the inverse of the resource type nfs\_server association. + This is the inverse of the resource type nfs_server association. smb_servers (, str, ) - This is the inverse of the resource type smb\_server association. + This is the inverse of the resource type smb_server association. file_ldaps (, str, ) - This is the inverse of the resource type file\_ldap association. + This is the inverse of the resource type file_ldap association. file_systems (, dict, ) - This is the inverse of the resource type file\_system association. + This is the inverse of the resource type file_system association. protection_policy_id (, str, ) diff --git a/docs/modules/network.rst b/docs/modules/network.rst index f97dd54..32ba1d3 100644 --- a/docs/modules/network.rst +++ b/docs/modules/network.rst @@ -21,13 +21,12 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- @@ -36,7 +35,7 @@ Parameters This parameter is added in 2.0.0.0. - Specify either \ :emphasis:`network\_name`\ or \ :emphasis:`network\_id`\ for any operation. + Specify either *network_name* or *network_id* for any operation. network_id (optional, str, None) @@ -129,7 +128,7 @@ Parameters wait_for_completion (optional, bool, False) - Flag to indicate if the operation should be run synchronously or asynchronously. \ :literal:`true`\ signifies synchronous execution. By default, modify operation will run \ :literal:`asynchronously`\ . + Flag to indicate if the operation should be run synchronously or asynchronously. ``true`` signifies synchronous execution. By default, modify operation will run ``asynchronously``. state (True, str, None) @@ -143,9 +142,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -176,9 +175,9 @@ Notes .. note:: - It is recommended to perform task asynchronously while changing cluster management address. - - Idempotency is not supported for \ :emphasis:`vasa\_provider\_credentials`\ and \ :emphasis:`esxi\_credentials`\ . - - For PowerStore X model, \ :emphasis:`vasa\_provider\_credentials`\ has to be specified along with \ :emphasis:`new\_cluster\_mgmt\_address`\ . - - The \ :emphasis:`check\_mode`\ is not supported. + - Idempotency is not supported for *vasa_provider_credentials* and *esxi_credentials*. + - For PowerStore X model, *vasa_provider_credentials* has to be specified along with *new_cluster_mgmt_address*. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/nfs.rst b/docs/modules/nfs.rst index 4d798ba..78e5d14 100644 --- a/docs/modules/nfs.rst +++ b/docs/modules/nfs.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -35,7 +35,7 @@ Parameters Mandatory for create operation. - Specify either \ :emphasis:`nfs\_export\_name`\ or \ :emphasis:`nfs\_export\_id`\ but not both for any operation. + Specify either *nfs_export_name* or *nfs_export_id* but not both for any operation. nfs_export_id (optional, str, None) @@ -47,19 +47,19 @@ Parameters Either filesystem or snapshot is required for creation of the NFS Export. - If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. + If filesystem name is specified, then *nas_server* is required to uniquely identify the filesystem. - If \ :emphasis:`filesystem`\ parameter is provided, then \ :emphasis:`snapshot`\ cannot be specified. + If *filesystem* parameter is provided, then *snapshot* cannot be specified. snapshot (optional, str, None) The ID/Name of the Snapshot for which NFS export will be created. - Either \ :emphasis:`filesystem`\ or \ :emphasis:`snapshot`\ is required for creation of the NFS Export. + Either *filesystem* or *snapshot* is required for creation of the NFS Export. - If snapshot name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the snapshot. + If snapshot name is specified, then *nas_server* is required to uniquely identify the snapshot. - If \ :emphasis:`snapshot`\ parameter is provided, then \ :emphasis:`filesystem`\ cannot be specified. + If *snapshot* parameter is provided, then *filesystem* cannot be specified. NFS export can be created only if access type of snapshot is "protocol". @@ -71,7 +71,7 @@ Parameters path (optional, str, None) Local path to export relative to the NAS server root. - With NFS, each export of a file\_system or file\_snap must have a unique local path. + With NFS, each export of a file_system or file_snap must have a unique local path. Mandatory while creating NFS export. @@ -85,7 +85,7 @@ Parameters For hosts that need different access than the default, they can be configured by adding to the list. - If \ :emphasis:`default\_access`\ is not mentioned during creation, then NFS export will be created with \ :literal:`No\_Access`\ . + If *default_access* is not mentioned during creation, then NFS export will be created with ``No_Access``. no_access_hosts (optional, list, None) @@ -111,7 +111,7 @@ Parameters min_security (optional, str, None) NFS enforced security type for users accessing an NFS export. - If not specified at the time of creation, it will be set to \ :literal:`SYS`\ . + If not specified at the time of creation, it will be set to ``SYS``. anonymous_uid (optional, int, None) @@ -129,7 +129,7 @@ Parameters is_no_suid (optional, bool, None) If set, do not allow access to set SUID. Otherwise, allow access. - If not specified at the time of creation, it will be set to \ :literal:`false`\ . + If not specified at the time of creation, it will be set to ``false``. host_state (optional, str, None) @@ -149,9 +149,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -181,7 +181,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/nfs_server.rst b/docs/modules/nfs_server.rst new file mode 100644 index 0000000..49db911 --- /dev/null +++ b/docs/modules/nfs_server.rst @@ -0,0 +1,261 @@ +.. _nfs_server_module: + + +nfs_server -- Manage NFS server for PowerStore +============================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +Managing storage containers on PowerStore Storage System includes creating an NFS server, getting details of an NFS server, modifying an NFS server and deleting an NFS server. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- A Dell PowerStore storage system version 3.0.0.0 or later. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. +- Python 3.9, 3.10 or 3.11. + + + +Parameters +---------- + + nfs_server_id (optional, str, None) + The unique identifier of the NFS server. + + + nas_server (optional, str, None) + Unique identifier/name of the NAS server to which the network interface belongs, as defined by the *nas_server* resource type. + + + host_name (optional, str, None) + The name that will be used by NFS clients to connect to this NFS server. + + + is_nfsv3_enabled (optional, bool, None) + Indicates whether NFSv3 is enabled on the NAS server. + + + is_nfsv4_enabled (optional, bool, None) + Indicates whether NFSv4 is enabled on the NAS server. + + + is_secure_enabled (optional, bool, None) + Indicates whether secure NFS is enabled on the NFS server. + + + is_use_smb_config_enabled (optional, bool, None) + Indicates whether SMB authentication is used to authenticate to the KDC. + + + is_extended_credentials_enabled (optional, bool, None) + Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. + + + credentials_cache_TTL (optional, int, None) + Sets the Time-To-Live (in minutes) expiration time in minutes for a Windows entry in the credentials cache. + + + is_skip_unjoin (optional, bool, None) + Allow to bypass NFS server unjoin. + + If false modification will fail if secure is enabled and current kdc_type is MS Windows. + + If secure is enabled either unjoin NFS server before deleting or set value to true. + + + state (optional, str, present) + Define whether the NFS server should be enabled or not. + + For Delete operation only, it should be set to ``absent``. + + + array_ip (True, str, None) + IP or FQDN of the PowerStore management system. + + + validate_certs (optional, bool, True) + Boolean variable to specify whether to validate SSL certificate or not. + + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + + ``false`` - indicates that the SSL certificate should not be verified. + + + user (True, str, None) + The username of the PowerStore host. + + + password (True, str, None) + The password of the PowerStore host. + + + timeout (optional, int, 120) + Time after which the connection will get terminated. + + It is to be mentioned in seconds. + + + port (optional, int, None) + Port number for the PowerStore array. + + If not passed, it will take 443 as default. + + + + + +Notes +----- + +.. note:: + - The *check_mode* is supported. + - The details of an NFS server can be fetched using *nfs_server_id* or *nas_server*. + - To set *is_use_smb_config_enabled* as ``true``, *is_secure_enabled* should be set to ``true``. + - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + + - name: Enable NFS server + register: result + dellemc.powerstore.nfs_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ nas_server_name }}" + host_name: "sample.hostname" + is_nfsv3_enabled: true + is_nfsv4_enabled: true + is_secure_enabled: false + is_extended_credentials_enabled: false + credentials_cache_TTL: 60 + state: "present" + + - name: Get NFS server + dellemc.powerstore.nfs_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nfs_server_id: "{{ result.nfs_server_details.id }}" + + - name: Get NFS server with NAS server + dellemc.powerstore.nfs_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ result.nfs_server_details.nas_server_id }}" + + - name: Modify NFS server + dellemc.powerstore.nfs_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nfs_server_id: "{{ result.nfs_server_details.id }}" + is_nfsv4_enabled: false + is_extended_credentials_enabled: true + credentials_cache_TTL: 120 + + - name: Delete NFS server + dellemc.powerstore.nfs_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nfs_server_id: "{{ result.nfs_server_details.id }}" + state: "absent" + + + +Return Values +------------- + +changed (always, bool, false) + Whether or not the resource has changed. + + +nfs_server_details (When NFS server is enabled., complex, {'credentials_cache_TTL': 120, 'host_name': 'sample_host_name', 'id': '65ad14fe-5f6e-beb3-424f-62b767ad9845', 'is_extended_credentials_enabled': True, 'is_joined': False, 'is_nfsv3_enabled': True, 'is_nfsv4_enabled': False, 'is_secure_enabled': False, 'is_use_smb_config_enabled': None, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'service_principal_name': None}) + Details of the NFS server. + + + credentials_cache_TTL (, int, ) + Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache. + + + id (, str, ) + The unique identifier of the NFS server. + + + host_name (, str, ) + The name that will be used by NFS clients to connect to this NFS server. + + + is_extended_credentials_enabled (, bool, ) + Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. + + + is_joined (, bool, ) + Indicates whether the NFS server is joined to Active Directory. + + + is_nfsv3_enabled (, bool, ) + Indicates whether NFSv3 is enabled on the NAS server. + + + is_nfsv4_enabled (, bool, ) + Indicates whether NFSv4 is enabled on the NAS server. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + is_secure_enabled (, bool, ) + Indicates whether secure NFS is enabled on the NFS server. + + + is_use_smb_config_enabled (, bool, ) + Indicates whether SMB authentication is used to authenticate to the KDC. + + + service_principal_name (, str, ) + The Service Principal Name (SPN) for the NFS server. + + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Trisha Datta (@trisha-dell) + diff --git a/docs/modules/ntp.rst b/docs/modules/ntp.rst index 3e6fdc7..4e1c0a3 100644 --- a/docs/modules/ntp.rst +++ b/docs/modules/ntp.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -39,13 +39,13 @@ Parameters ntp_address_state (optional, str, None) - State of the addresses mentioned in \ :emphasis:`ntp\_addresses`\ . + State of the addresses mentioned in *ntp_addresses*. state (True, str, None) The state of the NTP instance after the task is performed. - For get and modify operations it should be set to \ :literal:`present`\ . + For get and modify operations it should be set to ``present``. array_ip (True, str, None) @@ -55,9 +55,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -88,9 +88,9 @@ Notes .. note:: - Minimum 1 and maximum 3 addresses can be associated to a NTP instance. - - Parameters \ :emphasis:`ntp\_addresses`\ and \ :emphasis:`ntp\_address\_state`\ are required together. + - Parameters *ntp_addresses* and *ntp_address_state* are required together. - Creation and deletion of NTP is not supported. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/protectionpolicy.rst b/docs/modules/protectionpolicy.rst index b8ba1f3..0992c28 100644 --- a/docs/modules/protectionpolicy.rst +++ b/docs/modules/protectionpolicy.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -61,9 +61,9 @@ Parameters state (True, str, None) String variable. Indicates the state of protection policy. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all other operations like Create, Modify or Get details, it should be set to \ :literal:`present`\ . + For all other operations like Create, Modify or Get details, it should be set to ``present``. snapshotrule_state (False, str, None) @@ -71,9 +71,9 @@ Parameters When snapshot rules are specified, this variable is required. - Value \ :literal:`present-in-policy`\ indicates to add to protection policy. + Value ``present-in-policy`` indicates to add to protection policy. - Value \ :literal:`absent-in-policy`\ indicates to remove from protection policy. + Value ``absent-in-policy`` indicates to remove from protection policy. array_ip (True, str, None) @@ -83,9 +83,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -117,7 +117,7 @@ Notes .. note:: - Before deleting a protection policy, the replication rule has to be removed from the protection policy. - In PowerStore version 3.0.0.0, protection policy without snapshot rule/replication rule is not allowed. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/quota.rst b/docs/modules/quota.rst index e555d7f..8ac7238 100644 --- a/docs/modules/quota.rst +++ b/docs/modules/quota.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -35,7 +35,7 @@ Parameters Path is relative to the root of the filesystem. - For user quota, if \ :emphasis:`path`\ is not specified, quota will be created at the root of the filesystem. + For user quota, if *path* is not specified, quota will be created at the root of the filesystem. quota_type (optional, str, None) @@ -45,13 +45,13 @@ Parameters quota_id (optional, str, None) Id of the user/tree quota. - If \ :emphasis:`quota\_id`\ is mentioned, then \ :emphasis:`path`\ /\ :emphasis:`nas\_server`\ /\ :emphasis:`file\_system`\ /\ :emphasis:`quota\_type`\ is not required. + If *quota_id* is mentioned, then *path*/*nas_server*/*file_system*/*quota_type* is not required. filesystem (optional, str, None) The ID/Name of the filesystem for which the Tree/User Quota will be created. - If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. + If filesystem name is specified, then *nas_server* is required to uniquely identify the filesystem. nas_server (optional, str, None) @@ -61,33 +61,33 @@ Parameters description (optional, str, None) Additional information that can be mentioned for a Tree Quota. - Description parameter can only be used when \ :emphasis:`quota\_type`\ is \ :literal:`tree`\ . + Description parameter can only be used when *quota_type* is ``tree``. unix_name (optional, str, None) The name of the unix user account for which quota operations will be performed. - Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . + Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. windows_name (optional, str, None) The name of the Windows User for which quota operations will be performed. - The name should be mentioned along with Domain Name as 'DOMAIN\_NAME\\user\_name' or as "DOMAIN\_NAME\\\\user\_name". + The name should be mentioned along with Domain Name as 'DOMAIN_NAME\user_name' or as "DOMAIN_NAME\\user_name". - Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . + Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. uid (optional, int, None) The ID of the unix user account for which quota operations will be performed. - Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . + Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. windows_sid (optional, str, None) The SID of the Windows User account for which quota operations will be performed. - Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . + Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. quota (optional, dict, None) @@ -97,13 +97,13 @@ Parameters soft_limit (optional, int, None) Soft limit of the User/Tree quota. - No Soft limit when set to \ :literal:`0`\ . + No Soft limit when set to ``0``. hard_limit (optional, int, None) Hard limit of the user quota. - No hard limit when set to \ :literal:`0`\ . + No hard limit when set to ``0``. cap_unit (optional, str, GB) @@ -116,9 +116,9 @@ Parameters state (True, str, None) Define whether the Quota should exist or not. - Value \ :literal:`present`\ indicates that the Quota should exist on the system. + Value ``present`` indicates that the Quota should exist on the system. - Value \ :literal:`absent`\ indicates that the Quota should not exist on the system. + Value ``absent`` indicates that the Quota should not exist on the system. array_ip (True, str, None) @@ -128,9 +128,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -161,13 +161,13 @@ Notes .. note:: - Tree quota cannot be created at the root of the filesystem. - - When the ID of the filesystem is passed then \ :emphasis:`nas\_server`\ is not required. If passed, then filesystem should exist for the \ :emphasis:`nas\_server`\ , else the task will fail. + - When the ID of the filesystem is passed then *nas_server* is not required. If passed, then filesystem should exist for the *nas_server*, else the task will fail. - If a primary directory of the current directory or a subordinate directory of the path is having a Tree Quota configured, then the quota for that path cannot be created. - Hierarchical tree quotas are not allowed. - When the first quota is created for a directory/user in a filesystem then the quotas will be enabled for that filesystem automatically. - If a user quota is to be created on a tree quota, then the user quotas will be enabled automatically in a tree quota. - - \ :literal:`Delete`\ User Quota operation is not supported. - - The \ :emphasis:`check\_mode`\ is not supported. + - ``Delete`` User Quota operation is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -291,7 +291,7 @@ quota_details (When Quota exists., complex, {'description': 'Tree quota created nas_server (, dict, ) - nas\_server of filesystem. + nas_server of filesystem. @@ -353,7 +353,7 @@ quota_details (When Quota exists., complex, {'description': 'Tree quota created state (, str, Ok) - State of the user quota or tree quota record period. OK means No quota limits are exceeded. Soft\_Exceeded means Soft limit is exceeded, and grace period is not expired. Soft\_Exceeded\_And\_Expired means Soft limit is exceeded, and grace period is expired. Hard\_Reached means Hard limit is reached. + State of the user quota or tree quota record period. OK means No quota limits are exceeded. Soft_Exceeded means Soft limit is exceeded, and grace period is not expired. Soft_Exceeded_And_Expired means Soft limit is exceeded, and grace period is expired. Hard_Reached means Hard limit is reached. state_l10n (, str, Ok) diff --git a/docs/modules/remote_support.rst b/docs/modules/remote_support.rst index d984200..80b1973 100644 --- a/docs/modules/remote_support.rst +++ b/docs/modules/remote_support.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -41,7 +41,7 @@ Parameters Mandatory for modify and verify operation. - \ :literal:`SRS\_Gateway`\ , \ :emphasis:`support\_type`\ is only supported for verify operation. + ``SRS_Gateway``, *support_type* is only supported for verify operation. remote_support_servers (optional, list, None) @@ -61,14 +61,14 @@ Parameters is_primary (optional, bool, None) Indicates whether the server is acting as the primary. - One server must be set to \ :literal:`false`\ when two servers are configured. + One server must be set to ``false`` when two servers are configured. server_state (optional, str, None) - Indicates the state of the remote\_support\_servers. + Indicates the state of the remote_support_servers. - Required with \ :emphasis:`remote\_support\_servers`\ . + Required with *remote_support_servers*. is_support_assist_license_accepted (optional, bool, None) @@ -112,7 +112,7 @@ Parameters wait_for_completion (optional, bool, False) - Flag to indicate if the operation should be run synchronously or asynchronously. \ :literal:`true`\ signifies synchronous execution. By default, modify operation will run asynchronously. + Flag to indicate if the operation should be run synchronously or asynchronously. ``true`` signifies synchronous execution. By default, modify operation will run asynchronously. return_support_license_text (optional, bool, False) @@ -122,9 +122,9 @@ Parameters state (True, str, None) The state of the remote support configuration after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For get/modify operation it should be set to \ :literal:`present`\ . + For get/modify operation it should be set to ``present``. array_ip (True, str, None) @@ -134,9 +134,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -167,7 +167,7 @@ Notes .. note:: - Creation and deletion of remote support configuration is not supported. - - Support for \ :emphasis:`check\_mode`\ is not available for this module. + - Support for *check_mode* is not available for this module. - Verify and send test alert operations do not support idempotency. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/remote_support_contact.rst b/docs/modules/remote_support_contact.rst index af69bfd..86bb657 100644 --- a/docs/modules/remote_support_contact.rst +++ b/docs/modules/remote_support_contact.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -53,9 +53,9 @@ Parameters state (True, str, None) The state of the remote support contact after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For get/modify operation it should be set to \ :literal:`present`\ . + For get/modify operation it should be set to ``present``. array_ip (True, str, None) @@ -65,9 +65,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -98,8 +98,8 @@ Notes .. note:: - Creation and deletion of remote support contact is not supported. - - Parameters \ :emphasis:`first\_name`\ , \ :emphasis:`last\_name`\ , \ :emphasis:`email`\ and \ :emphasis:`phone`\ can be removed by passing empty string. - - The \ :emphasis:`check\_mode`\ is not supported. + - Parameters *first_name*, *last_name*, *email* and *phone* can be removed by passing empty string. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/remotesystem.rst b/docs/modules/remotesystem.rst index b20f0dd..568ada8 100644 --- a/docs/modules/remotesystem.rst +++ b/docs/modules/remotesystem.rst @@ -23,20 +23,19 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. - Parameters ---------- remote_name (optional, str, None) Name of the remote system. - Parameter \ :emphasis:`remote\_name`\ cannot be mentioned during addition of a new remote system. + Parameter *remote_name* cannot be mentioned during addition of a new remote system. remote_id (optional, str, None) @@ -44,7 +43,7 @@ Parameters ID for the remote system is autogenerated, cannot be passed during creation of a remote system. - Parameter \ :emphasis:`remote\_id`\ and \ :emphasis:`remote\_address`\ are mutually exclusive. + Parameter *remote_id* and *remote_address* are mutually exclusive. remote_user (optional, str, None) @@ -62,7 +61,7 @@ Parameters remote_address (optional, str, None) Management IP of the remote system. - Parameter \ :emphasis:`remote\_id`\ and \ :emphasis:`remote\_address`\ are mutually exclusive. + Parameter *remote_id* and *remote_address* are mutually exclusive. new_remote_address (optional, str, None) @@ -92,7 +91,7 @@ Parameters wait_for_completion (optional, bool, False) Flag to indicate if the operation should be run synchronously or asynchronously. - \ :literal:`true`\ signifies synchronous execution. + ``true`` signifies synchronous execution. By default, modify and delete operation will run asynchronously. @@ -100,9 +99,9 @@ Parameters state (True, str, None) The state of the remote system after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all Create, Modify or Get details operations it should be set to \ :literal:`present`\ . + For all Create, Modify or Get details operations it should be set to ``present``. array_ip (True, str, None) @@ -112,9 +111,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -146,10 +145,10 @@ Notes .. note:: - The module support allows create/delete/update only for remote PowerStore arrays. - Get details can be done for all type of remote arrays. - - Parameters \ :emphasis:`remote\_user`\ , \ :emphasis:`remote\_port`\ and \ :emphasis:`remote\_password`\ are not required during modification, getting and deleting. If passed then these parameters will be ignored and the operation will be performed. - - If \ :emphasis:`wait\_for\_completion`\ is set to \ :literal:`true`\ then the connection will be terminated after the timeout is exceeded. User can tweak timeout and pass it in the playbook task. + - Parameters *remote_user*, *remote_port* and *remote_password* are not required during modification, getting and deleting. If passed then these parameters will be ignored and the operation will be performed. + - If *wait_for_completion* is set to ``true`` then the connection will be terminated after the timeout is exceeded. User can tweak timeout and pass it in the playbook task. - By default, the timeout is set to 120 seconds. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -269,9 +268,9 @@ remote_system_details (When remote system exists, complex, {'data_connection_sta OK, Normal conditions. - Update\_Needed, Verify and update needed to handle network configuration changes on the systems. + Update_Needed, Verify and update needed to handle network configuration changes on the systems. - Management\_Connection\_Lost, Management connection to the remote peer is lost. + Management_Connection_Lost, Management connection to the remote peer is lost. data_connection_state (, str, ) diff --git a/docs/modules/replicationrule.rst b/docs/modules/replicationrule.rst index 2241e86..2fa1726 100644 --- a/docs/modules/replicationrule.rst +++ b/docs/modules/replicationrule.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -37,7 +37,7 @@ Parameters Required during creation of a replication rule. - Parameter \ :emphasis:`replication\_rule\_name`\ and \ :emphasis:`replication\_rule\_id`\ are mutually exclusive. + Parameter *replication_rule_name* and *replication_rule_id* are mutually exclusive. replication_rule_id (optional, str, None) @@ -45,7 +45,7 @@ Parameters ID for the rule is autogenerated, cannot be passed during creation of a replication rule. - Parameter \ :emphasis:`replication\_rule\_name`\ and \ :emphasis:`replication\_rule\_id`\ are mutually exclusive. + Parameter *replication_rule_name* and *replication_rule_id* are mutually exclusive. new_name (optional, str, None) @@ -73,17 +73,17 @@ Parameters remote_system_address (False, str, None) The management IPv4 address of the remote system. - It is required in case the remote system name passed in \ :emphasis:`remote\_system`\ parameter is not unique on the PowerStore Array. + It is required in case the remote system name passed in *remote_system* parameter is not unique on the PowerStore Array. - If ID of the remote system is passed then no need to pass \ :emphasis:`remote\_system\_address`\ . + If ID of the remote system is passed then no need to pass *remote_system_address*. state (True, str, None) The state of the replication rule after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. - For all Create, Modify or Get details operations it should be set to \ :literal:`present`\ . + For all Create, Modify or Get details operations it should be set to ``present``. array_ip (True, str, None) @@ -93,9 +93,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +125,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/replicationsession.rst b/docs/modules/replicationsession.rst index c8edeff..8d3ef29 100644 --- a/docs/modules/replicationsession.rst +++ b/docs/modules/replicationsession.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -35,37 +35,37 @@ Parameters filesystem (optional, str, None) Name/ID of the filesystem for which replication session exists. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. nas_server (optional, str, None) Name/ID of the NAS server for which replication session exists. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. volume_group (optional, str, None) Name/ID of the volume group for which a replication session exists. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. volume (optional, str, None) Name/ID of the volume for which replication session exists. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. replication_group (optional, str, None) Name or ID of the replication group for which replication session exists. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. session_id (optional, str, None) ID of the replication session. - Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. + Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. session_state (optional, str, None) @@ -83,9 +83,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -116,10 +116,10 @@ Notes .. note:: - Manual synchronization for a replication session is not supported through the Ansible module. - - When the current state of the replication session is 'OK' and in the playbook task \ :literal:`synchronizing`\ , then it will return "changed" as false. + - When the current state of the replication session is 'OK' and in the playbook task ``synchronizing``, then it will return "changed" as false. - The changed as false in above scenario is because there is a scheduled synchronization in place with the associated replication rule's RPO in the protection policy. - - The \ :emphasis:`check\_mode`\ is not supported. - - Parameter \ :emphasis:`nas\_server`\ , \ :emphasis:`filesystem`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`role`\ parameters are supported only for PowerStore version 3.0.0. and above. + - The *check_mode* is not supported. + - Parameter *nas_server*, *filesystem*, *replication_group*, and *role* parameters are supported only for PowerStore version 3.0.0. and above. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -192,7 +192,7 @@ replication_session_details (When replication session exists, complex, {'estimat resource_type (, str, ) - Storage resource type eligible for replication protection. volume - Replication session created on a volume. volume\_group - Replication session created on a volume group. + Storage resource type eligible for replication protection. volume - Replication session created on a volume. volume_group - Replication session created on a volume group. local_resource_id (, str, ) diff --git a/docs/modules/role.rst b/docs/modules/role.rst index 0e26e92..c7904a6 100644 --- a/docs/modules/role.rst +++ b/docs/modules/role.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -41,9 +41,9 @@ Parameters state (True, str, None) Define whether the role should exist or not. - Value \ :literal:`present`\ , indicates that the role should exist on the system. + Value ``present``, indicates that the role should exist on the system. - Value \ :literal:`absent`\ , indicates that the role should not exist on the system. + Value ``absent``, indicates that the role should not exist on the system. array_ip (True, str, None) @@ -53,9 +53,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -87,7 +87,7 @@ Notes .. note:: - Only getting the details of the role is supported by the ansible module. - Creation, modification and deletion of roles is not supported by the ansible modules. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/security_config.rst b/docs/modules/security_config.rst index ff38b51..1011ea0 100644 --- a/docs/modules/security_config.rst +++ b/docs/modules/security_config.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -53,9 +53,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -87,7 +87,7 @@ Notes .. note:: - Creation and deletion of security configs is not supported by Ansible modules. - Modification of protocol mode is only supported for PowerStore v2.0.0.0 and above. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/smb_server.rst b/docs/modules/smb_server.rst new file mode 100644 index 0000000..1614964 --- /dev/null +++ b/docs/modules/smb_server.rst @@ -0,0 +1,250 @@ +.. _smb_server_module: + + +smb_server -- Manage SMB server for PowerStore +============================================== + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +Managing storage containers on PowerStore Storage System includes creating an SMB server, getting details of an SMB server, modifying an SMB server and deleting an SMB server. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- A Dell PowerStore storage system version 3.0.0.0 or later. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. +- Python 3.9, 3.10 or 3.11. + + + +Parameters +---------- + + smb_server_id (optional, str, None) + The unique identifier of the SMB server. + + + nas_server (optional, str, None) + Unique identifier/name of the NAS server to which the network interface belongs, as defined by the *nas_server* resource type. + + + is_standalone (optional, bool, None) + Indicates whether the SMB server is standalone. + + *true* - SMB server is standalone. + + *false* - SMB server is joined to the Active Directory. + + + computer_name (optional, str, None) + DNS Name of the associated Computer Account when the SMB server is joined to an Active Directory domain. + + + domain (optional, str, None) + Domain name where SMB server is registered in Active Directory, if applicable. + + + netbios_name (optional, str, None) + NetBIOS name is the network name of the standalone SMB server. + + + workgroup (optional, str, None) + Windows network workgroup for the SMB server. + + Applies to standalone SMB servers only. + + + description (optional, str, None) + Description of the SMB server in UTF-8 characters. + + + local_admin_password (optional, str, None) + Password for the local administrator account of the SMB server. + + + state (optional, str, present) + Define whether the SMB server should be enabled or not. + + For Delete operation only, it should be set to ``absent``. + + + array_ip (True, str, None) + IP or FQDN of the PowerStore management system. + + + validate_certs (optional, bool, True) + Boolean variable to specify whether to validate SSL certificate or not. + + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + + ``false`` - indicates that the SSL certificate should not be verified. + + + user (True, str, None) + The username of the PowerStore host. + + + password (True, str, None) + The password of the PowerStore host. + + + timeout (optional, int, 120) + Time after which the connection will get terminated. + + It is to be mentioned in seconds. + + + port (optional, int, None) + Port number for the PowerStore array. + + If not passed, it will take 443 as default. + + + + + +Notes +----- + +.. note:: + - The *check_mode* is supported. + - The details of an SMB server can be fetched using *smb_server_id* or *nas_server*. + - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. + + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + + - name: Enable SMB server + register: result + dellemc.powerstore.smb_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ nas_server_name }}" + is_standalone: true + netbios_name: "string" + workgroup: "string" + description: "string" + local_admin_password: "string" + state: "present" + + - name: Get SMB server + dellemc.powerstore.smb_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + smb_server_id: "{{ result.smb_server_details.id }}" + + - name: Get SMB server with NAS server + dellemc.powerstore.smb_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server: "{{ result.smb_server_details.nas_server_id }}" + + - name: Modify SMB server + dellemc.powerstore.smb_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + smb_server_id: "{{ result.smb_server_details.id }}" + netbios_name: "string2" + workgroup: "string2" + description: "string2" + local_admin_password: "string2" + + - name: Delete SMB server + dellemc.powerstore.smb_server: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + smb_server_id: "{{ result.smb_server_details.id }}" + state: "absent" + + + +Return Values +------------- + +changed (always, bool, false) + Whether or not the resource has changed. + + +smb_server_details (When SMB server exists., complex, {'computer_name': None, 'description': 'string2', 'domain': None, 'id': '65ad211b-374b-5f77-2946-62b767ad9845', 'is_joined': False, 'is_standalone': True, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'netbios_name': 'STRING2', 'workgroup': 'STRING2'}) + Details of the SMB server. + + + computer_name (, str, ) + DNS name of the associated computer account when the SMB server is joined to an Active Directory domain. + + + id (, str, ) + The unique identifier of the SMB server. + + + description (, str, ) + Description of the SMB server. + + + domain (, str, ) + Domain name where SMB server is registered in Active Directory, if applicable. + + + is_joined (, bool, ) + Indicates whether the SMB server is joined to the Active Directory. + + + is_standalone (, bool, ) + Indicates whether the SMB server is standalone. + + + netbios_name (, str, ) + NetBIOS name is the network name of the standalone SMB server. + + + nas_server_id (, str, ) + Unique identifier of the NAS server. + + + workgroup (, str, ) + Windows network workgroup for the SMB server. + + + + + + +Status +------ + + + + + +Authors +~~~~~~~ + +- Trisha Datta (@trisha-dell) + diff --git a/docs/modules/smbshare.rst b/docs/modules/smbshare.rst index c40176d..dc7637b 100644 --- a/docs/modules/smbshare.rst +++ b/docs/modules/smbshare.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -35,7 +35,7 @@ Parameters Required during creation of the SMB share. - For all other operations either \ :emphasis:`share\_name`\ or \ :emphasis:`share\_id`\ is required. + For all other operations either *share_name* or *share_id* is required. share_id (optional, str, None) @@ -43,9 +43,9 @@ Parameters Should not be specified during creation. ID is auto generated. - For all other operations either \ :emphasis:`share\_name`\ or \ :emphasis:`share\_id`\ is required. + For all other operations either *share_name* or *share_id* is required. - If \ :emphasis:`share\_id`\ is used then no need to pass \ :emphasis:`nas\_server`\ /\ :emphasis:`filesystem`\ /\ :emphasis:`snapshot`\ / \ :emphasis:`path`\ . + If *share_id* is used then no need to pass *nas_server*/*filesystem*/*snapshot*/ *path*. path (optional, str, None) @@ -61,7 +61,7 @@ Parameters Either filesystem or snapshot is required for creation of the SMB share. - If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. + If filesystem name is specified, then *nas_server* is required to uniquely identify the filesystem. If filesystem parameter is provided, then snapshot cannot be specified. @@ -71,7 +71,7 @@ Parameters Either filesystem or snapshot is required for creation of the SMB share. - If snapshot name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the snapshot. + If snapshot name is specified, then *nas_server* is required to uniquely identify the snapshot. If snapshot parameter is provided, then filesystem cannot be specified. @@ -81,7 +81,7 @@ Parameters nas_server (optional, str, None) The ID/Name of the NAS Server. - It is not required if \ :emphasis:`share\_id`\ is used. + It is not required if *share_id* is used. description (optional, str, None) @@ -95,37 +95,37 @@ Parameters is_abe_enabled (optional, bool, None) Indicates whether Access-based Enumeration (ABE) for SMB share is enabled. - During creation, if not mentioned, then the default is \ :literal:`false`\ . + During creation, if not mentioned, then the default is ``false``. is_branch_cache_enabled (optional, bool, None) Indicates whether Branch Cache optimization for SMB share is enabled. - During creation, if not mentioned then default is \ :literal:`false`\ . + During creation, if not mentioned then default is ``false``. is_continuous_availability_enabled (optional, bool, None) Indicates whether continuous availability for SMB 3.0 is enabled. - During creation, if not mentioned, then the default is \ :literal:`false`\ . + During creation, if not mentioned, then the default is ``false``. is_encryption_enabled (optional, bool, None) Indicates whether encryption for SMB 3.0 is enabled at the shared folder level. - During creation, if not mentioned then default is \ :literal:`false`\ . + During creation, if not mentioned then default is ``false``. offline_availability (optional, str, None) Defines valid states of Offline Availability. - \ :literal:`MANUAL`\ - Only specified files will be available offline. + ``MANUAL``- Only specified files will be available offline. - \ :literal:`DOCUMENTS`\ - All files that users open will be available offline. + ``DOCUMENTS``- All files that users open will be available offline. - \ :literal:`PROGRAMS`\ - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. + ``PROGRAMS``- Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. - \ :literal:`NONE`\ - Prevents clients from storing documents and programs in offline cache. + ``NONE``- Prevents clients from storing documents and programs in offline cache. umask (optional, str, None) @@ -139,9 +139,9 @@ Parameters state (True, str, None) Define whether the SMB share should exist or not. - Value \ :literal:`present`\ indicates that the share should exist on the system. + Value ``present`` indicates that the share should exist on the system. - Value \ :literal:`absent`\ indicates that the share should not exist on the system. + Value ``absent`` indicates that the share should not exist on the system. array_ip (True, str, None) @@ -151,9 +151,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -183,9 +183,9 @@ Notes ----- .. note:: - - When the ID of the filesystem/snapshot is passed then \ :emphasis:`nas\_server`\ is not required. If passed, then the filesystem/snapshot should exist for the \ :emphasis:`nas\_server`\ , else the task will fail. + - When the ID of the filesystem/snapshot is passed then *nas_server* is not required. If passed, then the filesystem/snapshot should exist for the *nas_server*, else the task will fail. - Multiple SMB shares can be created for the same local path. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -321,7 +321,7 @@ smb_share_details (When share exists., complex, {'description': 'SMB Share creat nas_server (, dict, ) - nas\_server of filesystem. + nas_server of filesystem. diff --git a/docs/modules/smtp_config.rst b/docs/modules/smtp_config.rst index a181fcd..ca515eb 100644 --- a/docs/modules/smtp_config.rst +++ b/docs/modules/smtp_config.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -55,9 +55,9 @@ Parameters state (True, str, None) The state of the SMTP configuration after the task is performed. - For Delete operation only, it should be set to \ :literal:`absent`\ + For Delete operation only, it should be set to ``absent`` - For all operations it should be set to \ :literal:`present`\ . + For all operations it should be set to ``present``. array_ip (True, str, None) @@ -67,9 +67,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -99,9 +99,9 @@ Notes ----- .. note:: - - Idempotency is not supported for test operation for smtp\_config module. + - Idempotency is not supported for test operation for smtp_config module. - Creation and deletion of SMTP configuration is not supported. - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/snapshot.rst b/docs/modules/snapshot.rst index df37c2f..91b58e0 100644 --- a/docs/modules/snapshot.rst +++ b/docs/modules/snapshot.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -65,9 +65,9 @@ Parameters retention_unit (optional, str, None) The unit for retention. - If this unit is not specified, \ :literal:`hours`\ is taken as default \ :emphasis:`retention\_unit`\ . + If this unit is not specified, ``hours`` is taken as default *retention_unit*. - If \ :emphasis:`desired\_retention`\ is specified, \ :emphasis:`expiration\_timestamp`\ cannot be specified. + If *desired_retention* is specified, *expiration_timestamp* cannot be specified. expiration_timestamp (optional, str, None) @@ -89,9 +89,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -121,7 +121,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/snapshotrule.rst b/docs/modules/snapshotrule.rst index 8336cf2..06c1ecc 100644 --- a/docs/modules/snapshotrule.rst +++ b/docs/modules/snapshotrule.rst @@ -14,7 +14,7 @@ Synopsis Performs all snapshot rule operations on PowerStore Storage System. -This modules supports get details of a snapshot rule, create new Snapshot Rule with Interval, create new Snapshot Rule with specific time and days\_of\_week. Modify Snapshot Rule. Delete Snapshot Rule. +This modules supports get details of a snapshot rule, create new Snapshot Rule with Interval, create new Snapshot Rule with specific time and days_of_week. Modify Snapshot Rule. Delete Snapshot Rule. @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -47,15 +47,15 @@ Parameters days_of_week (optional, list, None) - List of strings to specify days of the week on which the Snapshot rule should be applied. Must be applied for Snapshot rules where the \ :emphasis:`time\_of\_day`\ parameter is set. + List of strings to specify days of the week on which the Snapshot rule should be applied. Must be applied for Snapshot rules where the *time_of_day* parameter is set. - Optional for the Snapshot rule created with an interval. When \ :emphasis:`days\_of\_week`\ is not specified for a new Snapshot rule, the rule is applied on every day of the week. + Optional for the Snapshot rule created with an interval. When *days_of_week* is not specified for a new Snapshot rule, the rule is applied on every day of the week. interval (False, str, None) String variable. Indicates the interval between Snapshots. - When creating a Snapshot rule, specify either \ :emphasis:`interval`\ or \ :emphasis:`time\_of\_day`\ , but not both. + When creating a Snapshot rule, specify either *interval* or *time_of_day*, but not both. desired_retention (False, int, None) @@ -67,23 +67,23 @@ Parameters time_of_day (False, str, None) String variable. Indicates the time of the day to take a daily Snapshot, with the format "hh:mm" in 24 hour time format. - When creating a Snapshot rule, specify either \ :emphasis:`interval`\ or \ :emphasis:`time\_of\_day`\ but not both. + When creating a Snapshot rule, specify either *interval* or *time_of_day* but not both. delete_snaps (optional, bool, False) Boolean variable to specify whether all Snapshots previously created by this rule should also be deleted when this rule is removed. - \ :literal:`true`\ specifies to delete all previously created Snapshots by this rule while deleting this rule. + ``true`` specifies to delete all previously created Snapshots by this rule while deleting this rule. - \ :literal:`false`\ specifies to retain all previously created Snapshots while deleting this rule. + ``false`` specifies to retain all previously created Snapshots while deleting this rule. state (True, str, None) String variable indicates the state of Snapshot rule. - For "Delete" operation only, it should be set to \ :literal:`absent`\ . + For "Delete" operation only, it should be set to ``absent``. - For all Create, Modify or Get details operation it should be set to \ :literal:`present`\ . + For all Create, Modify or Get details operation it should be set to ``present``. array_ip (True, str, None) @@ -93,9 +93,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +125,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/storage_container.rst b/docs/modules/storage_container.rst index 8079f38..3276350 100644 --- a/docs/modules/storage_container.rst +++ b/docs/modules/storage_container.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -45,7 +45,7 @@ Parameters quota (optional, int, None) The total number of bytes that can be provisioned/reserved against this storage container. - A value of \ :literal:`0`\ means there is no limit. + A value of ``0`` means there is no limit. It is possible to set the quota to a value that overprovisions the amount of space available in the system. @@ -57,9 +57,9 @@ Parameters storage_protocol (optional, str, None) The type of storage container. - \ :literal:`SCSI`\ is set when a storage container is dedicated to \ :literal:`SCSI`\ usage. + ``SCSI`` is set when a storage container is dedicated to ``SCSI`` usage. - \ :literal:`NVMe`\ is set when a storage container is dedicated to \ :literal:`NVMe`\ usage. + ``NVMe`` is set when a storage container is dedicated to ``NVMe`` usage. high_water_mark (optional, int, None) @@ -81,13 +81,13 @@ Parameters state (False, str, present) Define whether the storage container should exist or not. - For Delete operation only, it should be set to \ :literal:`absent`\ . + For Delete operation only, it should be set to ``absent``. storage_container_destination_state (optional, str, present) Define whether the storage container destination should exist in the storage container. - To delete storage container destination, it should be \ :literal:`absent`\ . + To delete storage container destination, it should be ``absent``. storage_container_destination (optional, dict, None) @@ -125,9 +125,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. remote_storage_container (True, str, None) @@ -142,9 +142,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -174,7 +174,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is supported. + - The *check_mode* is supported. - Either storage container name or ID required while deleting the storage container destination. - The details of the storage container destination are embedded in the response of the storage container. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/docs/modules/vcenter.rst b/docs/modules/vcenter.rst index 894ba85..7172be9 100644 --- a/docs/modules/vcenter.rst +++ b/docs/modules/vcenter.rst @@ -21,8 +21,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -47,7 +47,7 @@ Parameters Mandatory while adding a vCenter. - \ :emphasis:`vcenter\_password`\ needs to be provided to modify the user name. + *vcenter_password* needs to be provided to modify the user name. vcenter_password (optional, str, None) @@ -76,25 +76,25 @@ Parameters delete_vasa_provider (optional, bool, None) Whether to remove VASA provider. - When \ :literal:`true`\ , remove the VASA provider from vCenter. This will only happen if provider is not connected to any other PowerStore system. + When ``true``, remove the VASA provider from vCenter. This will only happen if provider is not connected to any other PowerStore system. - \ :literal:`false`\ is the API default. + ``false`` is the API default. state (optional, str, present) The state of the vCenter instance after the task is performed. - For get, create, and modify operations it should be set to \ :literal:`present`\ . + For get, create, and modify operations it should be set to ``present``. update_password (optional, str, always) - This parameter controls the way the \ :emphasis:`vcenter\_password`\ is updated during addition and modification of the vCenter. + This parameter controls the way the *vcenter_password* is updated during addition and modification of the vCenter. - \ :literal:`always`\ will update password for each execution. + ``always`` will update password for each execution. - \ :literal:`on\_create`\ will only set while adding a vCenter or modifying the \ :emphasis:`vcenter\_username.`\ + ``on_create`` will only set while adding a vCenter or modifying the *vcenter_username.* - For modifying \ :emphasis:`vcenter\_password`\ , set the \ :emphasis:`update\_password`\ to \ :literal:`always`\ . + For modifying *vcenter_password*, set the *update_password* to ``always``. array_ip (True, str, None) @@ -104,9 +104,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -138,7 +138,7 @@ Notes .. note:: - In unified+ deployment, the one vCenter instance residing in the PowerStore cluster will be prepopulated and cannot be deleted, nor may any other vCenter be added. - For unified deployment, one external vCenter may be configured if desired. - - The \ :emphasis:`check\_mode`\ is supported. + - The *check_mode* is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -232,7 +232,7 @@ vcenter_details (When vCenter exists., complex, {'id': '0d330d6c-3fe6-41c6-8023- vendor_provider_status_l10n (, str, ) - Localized message string corresponding to vendor\_provider\_status. + Localized message string corresponding to vendor_provider_status. virtual_machines (, list, ) diff --git a/docs/modules/volume.rst b/docs/modules/volume.rst index c371519..8bdef3b 100644 --- a/docs/modules/volume.rst +++ b/docs/modules/volume.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -61,7 +61,7 @@ Parameters Used to signify unit of the size provided for creation and expansion of volume. - It defaults to \ :literal:`GB`\ , if not specified. + It defaults to ``GB``, if not specified. new_name (optional, str, None) @@ -81,23 +81,23 @@ Parameters app_type_other (optional, str, None) - Application type for volume when \ :emphasis:`app\_type`\ is set to \ :literal:`\*Other`\ types. + Application type for volume when *app_type* is set to ``*Other`` types. appliance_id (optional, str, None) ID of the appliance on which the volume is provisioned. - \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. + *appliance_id* and *appliance_name* are mutually exclusive. appliance_name (optional, str, None) Name of the appliance on which the volume is provisioned. - \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. + *appliance_id* and *appliance_name* are mutually exclusive. protection_policy (optional, str, None) - The \ :emphasis:`protection\_policy`\ of the volume. + The *protection_policy* of the volume. To represent policy, both name or ID can be used interchangably. The module will detect both. @@ -111,7 +111,7 @@ Parameters performance_policy (optional, str, None) - The \ :emphasis:`performance\_policy`\ for the volume. + The *performance_policy* for the volume. A volume can be assigned a performance policy at the time of creation of the volume, or later. @@ -119,7 +119,7 @@ Parameters Check examples for more clarity. - If not given, performance policy will be \ :literal:`medium`\ . + If not given, performance policy will be ``medium``. host (optional, str, None) @@ -139,9 +139,9 @@ Parameters mapping_state (optional, str, None) Define whether the volume should be mapped to a host or hostgroup. - Value \ :literal:`mapped`\ - indicates that the volume should be mapped to the host or host group. + Value ``mapped`` - indicates that the volume should be mapped to the host or host group. - Value \ :literal:`unmapped`\ - indicates that the volume should not be mapped to the host or host group. + Value ``unmapped`` - indicates that the volume should not be mapped to the host or host group. Only one of a host or host group can be supplied in one call. @@ -175,9 +175,9 @@ Parameters logical_unit_number (optional, int, None) - logical unit number when creating a \ :literal:`mapped`\ volume. + logical unit number when creating a ``mapped`` volume. - If no \ :literal:`host\_id`\ or \ :literal:`host\_group\_id`\ is specified, \ :literal:`logical\_unit\_number`\ is ignored. + If no ``host_id`` or ``host_group_id`` is specified, ``logical_unit_number`` is ignored. protection_policy (optional, str, None) @@ -227,9 +227,9 @@ Parameters state (True, str, None) Define whether the volume should exist or not. - Value \ :literal:`present`\ - indicates that the volume should exist on the system. + Value ``present`` - indicates that the volume should exist on the system. - Value \ :literal:`absent`\ - indicates that the volume should not exist on the system. + Value ``absent`` - indicates that the volume should not exist on the system. remote_system (optional, str, None) @@ -269,9 +269,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -301,13 +301,13 @@ Notes ----- .. note:: - - To create a new volume, \ :emphasis:`vol\_name`\ and \ :emphasis:`size`\ is required. \ :emphasis:`cap\_unit`\ , \ :emphasis:`description`\ , \ :emphasis:`vg\_name`\ , \ :emphasis:`performance\_policy`\ , and \ :emphasis:`protection\_policy`\ are optional. - - Parameter \ :emphasis:`new\_name`\ should not be provided when creating a new volume. - - The \ :emphasis:`size`\ is a required parameter for expand volume. + - To create a new volume, *vol_name* and *size* is required. *cap_unit*, *description*, *vg_name*, *performance_policy*, and *protection_policy* are optional. + - Parameter *new_name* should not be provided when creating a new volume. + - The *size*is a required parameter for expand volume. - Clones or Snapshots of a deleted production volume or a clone are not deleted. - A volume that is attached to a host/host group, or that is part of a volume group cannot be deleted. - If volume in metro session, volume can only be modified, refreshed and restored when session is in the pause state. - - The \ :emphasis:`Check\_mode`\ is not supported. + - The *Check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -484,7 +484,7 @@ volume_details (When volume exists, complex, {'appliance_id': 'A1', 'creation_ti app_type_other (, str, ) - Application type for volume when app\_type is set to \*Other. + Application type for volume when app_type is set to *Other. id (, str, ) @@ -613,7 +613,7 @@ volume_details (When volume exists, complex, {'appliance_id': 'A1', 'creation_ti mapped_volumes (, complex, ) - This is the inverse of the resource type host\_volume\_mapping association. + This is the inverse of the resource type host_volume_mapping association. id (, str, ) diff --git a/docs/modules/volumegroup.rst b/docs/modules/volumegroup.rst index d9c0801..cceefe7 100644 --- a/docs/modules/volumegroup.rst +++ b/docs/modules/volumegroup.rst @@ -23,8 +23,8 @@ Requirements The below requirements are needed on the host that executes this module. - A Dell PowerStore storage system version 3.0.0.0 or later. -- Ansible-core 2.14 or later. -- PyPowerStore 2.1.0. +- Ansible-core 2.13 or later. +- PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. @@ -47,13 +47,13 @@ Parameters Either the volume ID or name must be provided for adding/removing existing volumes from a volume group. - If volumes are given, then \ :emphasis:`vol\_state`\ should also be specified. + If volumes are given, then *vol_state* should also be specified. vol_state (optional, str, None) String variable. Describes the state of volumes inside a volume group. - If volume is given, then \ :emphasis:`vol\_state`\ should also be specified. + If volume is given, then *vol_state* should also be specified. new_vg_name (optional, str, None) @@ -73,7 +73,7 @@ Parameters is_write_order_consistent (optional, bool, None) A boolean flag to indicate whether Snapshot sets of the volume group will be write-order consistent. - If this parameter is not specified, the array by default sets it to \ :literal:`true`\ . + If this parameter is not specified, the array by default sets it to ``true``. source_vg (optional, str, None) @@ -87,7 +87,7 @@ Parameters create_backup_snap (optional, bool, None) Specifies whether a backup snapshot set of the target volume group needs to be created before attempting refresh or restore. - If not specified it will be set to \ :literal:`true`\ . + If not specified it will be set to ``true``. backup_snap_profile (optional, dict, None) @@ -135,9 +135,9 @@ Parameters validate_certs (optional, bool, True) Boolean variable to specify whether to validate SSL certificate or not. - \ :literal:`true`\ - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate. + ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - \ :literal:`false`\ - indicates that the SSL certificate should not be verified. + ``false`` - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -167,11 +167,11 @@ Notes ----- .. note:: - - Parameter \ :emphasis:`vol\_state`\ is mandatory if volumes are provided. + - Parameter *vol_state* is mandatory if volumes are provided. - A protection policy can be specified either for an volume group, or for the individual volumes inside the volume group. - A volume can be a member of at most one volume group. - - Specifying \ :emphasis:`protection\_policy`\ as empty string or "" removes the existing protection policy from a volume group. - - The \ :emphasis:`check\_mode`\ is not supported. + - Specifying *protection_policy* as empty string or "" removes the existing protection policy from a volume group. + - The *check_mode* is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. diff --git a/galaxy.yml b/galaxy.yml index 7feac09..8093b63 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ namespace: dellemc name: powerstore # The version of the collection. Must be compatible with semantic versioning -version: 3.0.0 +version: 3.1.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md @@ -51,13 +51,13 @@ tags: [storage] dependencies: {} # The URL of the originating SCM repository -repository: https://github.com/dell/ansible-powerstore/tree/3.0.0 +repository: https://github.com/dell/ansible-powerstore/tree/3.1.0 # The URL to any online docs -documentation: https://github.com/dell/ansible-powerstore/tree/3.0.0/docs +documentation: https://github.com/dell/ansible-powerstore/tree/3.1.0/docs # The URL to the homepage of the collection/project -homepage: https://github.com/dell/ansible-powerstore/tree/3.0.0 +homepage: https://github.com/dell/ansible-powerstore/tree/3.1.0 # The URL to the collection issue tracker issues: https://www.dell.com/community/Automation/bd-p/Automation diff --git a/plugins/doc_fragments/powerstore.py b/plugins/doc_fragments/powerstore.py index a3bc726..9128561 100644 --- a/plugins/doc_fragments/powerstore.py +++ b/plugins/doc_fragments/powerstore.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2019, Dell Technologies. +# Copyright: (c) 2024, Dell Technologies. # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -51,7 +51,7 @@ class ModuleDocFragment(object): requirements: - A Dell PowerStore storage system version 3.0.0.0 or later. - Ansible-core 2.13 or later. - - PyPowerStore 2.0.0. + - PyPowerStore 3.0.0. - Python 3.9, 3.10 or 3.11. notes: - The modules present in this collection named as 'dellemc.powerstore' diff --git a/plugins/module_utils/storage/dell/utils.py b/plugins/module_utils/storage/dell/utils.py index 2912361..aefb737 100644 --- a/plugins/module_utils/storage/dell/utils.py +++ b/plugins/module_utils/storage/dell/utils.py @@ -1,5 +1,5 @@ # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) -# Copyright: (c) 2019, Dell Technologies +# Copyright: (c) 2024, Dell Technologies """ import PyPowerStore library for PowerStore Storage """ @@ -62,7 +62,7 @@ def py4ps_version_check(): " please install the required" \ " package" else: - min_ver = '1.9.0' + min_ver = '3.0.0' curr_version = PyPowerStore.__version__ unsupported_version_message = "PyPowerStore {0} is not supported " \ "by this module. Minimum supported" \ diff --git a/plugins/modules/certificate.py b/plugins/modules/certificate.py index 0ef368a..5294faf 100644 --- a/plugins/modules/certificate.py +++ b/plugins/modules/certificate.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing certificates for PowerStore""" @@ -262,7 +262,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreCertificate(object): diff --git a/plugins/modules/cluster.py b/plugins/modules/cluster.py index 5ae8828..96bda29 100644 --- a/plugins/modules/cluster.py +++ b/plugins/modules/cluster.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing cluster related operations for PowerStore""" from __future__ import (absolute_import, division, print_function) @@ -627,7 +627,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreCluster(object): diff --git a/plugins/modules/dns.py b/plugins/modules/dns.py index c4cf177..69a2217 100644 --- a/plugins/modules/dns.py +++ b/plugins/modules/dns.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -127,7 +127,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreDns(object): diff --git a/plugins/modules/email.py b/plugins/modules/email.py index eadac12..ae4c86f 100644 --- a/plugins/modules/email.py +++ b/plugins/modules/email.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -205,7 +205,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreEmail(object): diff --git a/plugins/modules/file_dns.py b/plugins/modules/file_dns.py index 89a66c9..92879e6 100644 --- a/plugins/modules/file_dns.py +++ b/plugins/modules/file_dns.py @@ -71,7 +71,7 @@ notes: - The I(check_mode) is supported. - The details of a file DNS can be fetched using I(file_dns_id) or - I(nas_server) + I(nas_server). ''' EXAMPLES = r''' diff --git a/plugins/modules/file_interface.py b/plugins/modules/file_interface.py index 28d10ad..146e331 100644 --- a/plugins/modules/file_interface.py +++ b/plugins/modules/file_interface.py @@ -56,7 +56,7 @@ This type of interface is inactive while a NAS server is in destination mode. - C(Backup) type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes. - - C(System) type of interface are reserved for system traffic such as for NAS server migration, they can't be used for the production traffic. + - C(System) type of interface are reserved for system traffic such as for NAS server migration, they can not be used for the production traffic. - C(System) type is not supported during create interface. choices: ['Production', 'Backup', 'System'] type: str @@ -83,7 +83,7 @@ notes: - The I(check_mode) is supported. - The details of a file interface can be fetched using I(file_interface_id) or - I(nas_server) and I(ip_address) + I(nas_server) and I(ip_address). ''' EXAMPLES = r''' diff --git a/plugins/modules/file_nis.py b/plugins/modules/file_nis.py index 123d374..467d2ea 100644 --- a/plugins/modules/file_nis.py +++ b/plugins/modules/file_nis.py @@ -63,7 +63,7 @@ notes: - The I(check_mode) is supported. - The details of a file NIS can be fetched using I(file_nis_id) or - I(nas_server) + I(nas_server). ''' EXAMPLES = r''' diff --git a/plugins/modules/filesystem.py b/plugins/modules/filesystem.py index 64523ec..d281a58 100644 --- a/plugins/modules/filesystem.py +++ b/plugins/modules/filesystem.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing filesystems for PowerStore""" @@ -739,7 +739,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreFileSystem(object): diff --git a/plugins/modules/filesystem_snapshot.py b/plugins/modules/filesystem_snapshot.py index 05fb007..2702a6a 100644 --- a/plugins/modules/filesystem_snapshot.py +++ b/plugins/modules/filesystem_snapshot.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """Ansible module for managing filesystem snapshots on PowerStore""" @@ -253,7 +253,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreFilesystemSnapshot(object): diff --git a/plugins/modules/host.py b/plugins/modules/host.py index 38db39b..a6a10de 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -373,7 +373,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' # DO NOT CHANGE BELOW PORT_TYPES SEQUENCE AS ITS USED IN SCRIPT USING INDEX PORT_TYPES = ["iSCSI", "FC", "NVMe"] diff --git a/plugins/modules/hostgroup.py b/plugins/modules/hostgroup.py index 7d9c693..828e2dc 100644 --- a/plugins/modules/hostgroup.py +++ b/plugins/modules/hostgroup.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -224,7 +224,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreHostgroup(object): diff --git a/plugins/modules/info.py b/plugins/modules/info.py index 2ba6b6a..dd38757 100644 --- a/plugins/modules/info.py +++ b/plugins/modules/info.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -24,8 +24,9 @@ replication groups, and remote system. - Virtualization module includes vCenters and virtual volumes. - Configuration module includes cluster nodes, networks, roles, local users, - appliances, discovered appliances, security configs, certificates, - AD/LDAP servers, LDAP accounts, LDAP domain, and service configs. + appliances, discovered appliances, security configs, certificates. +- Configureation modules also includes AD/LDAP servers, LDAP accounts, + LDAP domain, and service configs. - It also includes DNS/NTP servers, smtp configs, email destinations, remote support, and remote support contacts. author: @@ -399,7 +400,7 @@ - file_dns - file_nis -- name: Get list of service configs. +- name: Get list of service configs dellemc.powerstore.info: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -677,7 +678,7 @@ "id": "9c3e5cba-17d5-4d64-b97c-350f91e2b714" } ] -FileDNSes: +FileDNS: description: Provides details of all file DNS. type: list returned: When C(file_dns) is in a given I(gather_subset) @@ -770,7 +771,7 @@ "vlan_id": 0 } ] -FileNISes: +FileNIS: description: Provides details of all file NIS. type: list returned: When C(file_nis) is in a given I(gather_subset) @@ -1224,7 +1225,7 @@ "name": "Ansible_RTD8337_VM", "description": "Ansible_RTD8337_VM", "creator_type": "User", - "creation_timestamp": "2023-05-16T13:58:09.348368+00:00", + "creation_timestamp": "2024-05-16T13:58:09.348368+00:00", "is_replication_destination": false, "creator_type_l10n": "User" } @@ -2033,11 +2034,11 @@ def __init__(self): }, 'file_dns': { 'func': self.file_dns.get_file_dns_list, - 'display_as': 'FileDNSes' + 'display_as': 'FileDNS' }, 'file_nis': { 'func': self.file_nis.get_file_nis_list, - 'display_as': 'FileNISes' + 'display_as': 'FileNIS' }, 'service_config': { 'func': self.configuration.get_service_configs, diff --git a/plugins/modules/job.py b/plugins/modules/job.py index b3cab3b..93350e0 100644 --- a/plugins/modules/job.py +++ b/plugins/modules/job.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -174,7 +174,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreJob(object): diff --git a/plugins/modules/ldap_account.py b/plugins/modules/ldap_account.py index 24dc96c..259eca5 100644 --- a/plugins/modules/ldap_account.py +++ b/plugins/modules/ldap_account.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -173,7 +173,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreLDAPAccount(object): diff --git a/plugins/modules/ldap_domain.py b/plugins/modules/ldap_domain.py index 99817dd..dec93de 100644 --- a/plugins/modules/ldap_domain.py +++ b/plugins/modules/ldap_domain.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -354,7 +354,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreLDAPDomain(object): diff --git a/plugins/modules/local_user.py b/plugins/modules/local_user.py index 3c8d1ee..ae46d3b 100644 --- a/plugins/modules/local_user.py +++ b/plugins/modules/local_user.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing local users on PowerStore""" @@ -185,7 +185,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreLocalUser(object): diff --git a/plugins/modules/nasserver.py b/plugins/modules/nasserver.py index 5cf8b79..1af4796 100644 --- a/plugins/modules/nasserver.py +++ b/plugins/modules/nasserver.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing NAS server on PowerStore""" @@ -336,7 +336,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreNasServer(object): diff --git a/plugins/modules/network.py b/plugins/modules/network.py index 59416fe..4e2e31a 100644 --- a/plugins/modules/network.py +++ b/plugins/modules/network.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -498,7 +498,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreNetwork(object): diff --git a/plugins/modules/nfs.py b/plugins/modules/nfs.py index 8f688e2..e8bfd4f 100644 --- a/plugins/modules/nfs.py +++ b/plugins/modules/nfs.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """Ansible module for managing NFS exports on PowerStore""" @@ -380,7 +380,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreNfsExport(object): diff --git a/plugins/modules/nfs_server.py b/plugins/modules/nfs_server.py index c45e41a..40467c7 100644 --- a/plugins/modules/nfs_server.py +++ b/plugins/modules/nfs_server.py @@ -77,9 +77,9 @@ notes: - The I(check_mode) is supported. - The details of an NFS server can be fetched using I(nfs_server_id) or - I(nas_server) + I(nas_server). - To set I(is_use_smb_config_enabled) as C(true), I(is_secure_enabled) should be - set to C(true) + set to C(true). ''' EXAMPLES = r''' diff --git a/plugins/modules/ntp.py b/plugins/modules/ntp.py index 03f7de7..eb9bf47 100644 --- a/plugins/modules/ntp.py +++ b/plugins/modules/ntp.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -128,7 +128,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreNtp(object): diff --git a/plugins/modules/protectionpolicy.py b/plugins/modules/protectionpolicy.py index 43fcc3a..a5b2763 100644 --- a/plugins/modules/protectionpolicy.py +++ b/plugins/modules/protectionpolicy.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -239,7 +239,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreProtectionpolicy(object): diff --git a/plugins/modules/quota.py b/plugins/modules/quota.py index d63c765..9cd8eef 100644 --- a/plugins/modules/quota.py +++ b/plugins/modules/quota.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing Tree Quotas and User Quotas on PowerStore""" @@ -363,7 +363,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreQuota(object): diff --git a/plugins/modules/remote_support.py b/plugins/modules/remote_support.py index c161bbb..4398d70 100644 --- a/plugins/modules/remote_support.py +++ b/plugins/modules/remote_support.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -356,7 +356,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreRemoteSupport(object): diff --git a/plugins/modules/remote_support_contact.py b/plugins/modules/remote_support_contact.py index 60e5430..5d413c8 100644 --- a/plugins/modules/remote_support_contact.py +++ b/plugins/modules/remote_support_contact.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -136,7 +136,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreRemoteSupportContact(object): diff --git a/plugins/modules/remotesystem.py b/plugins/modules/remotesystem.py index 91435de..5be8243 100644 --- a/plugins/modules/remotesystem.py +++ b/plugins/modules/remotesystem.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -308,7 +308,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreRemoteSystem(object): diff --git a/plugins/modules/replicationrule.py b/plugins/modules/replicationrule.py index 37bd82a..8ac78c1 100644 --- a/plugins/modules/replicationrule.py +++ b/plugins/modules/replicationrule.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -197,7 +197,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreReplicationRule(object): diff --git a/plugins/modules/replicationsession.py b/plugins/modules/replicationsession.py index fa1e8a2..559e54f 100644 --- a/plugins/modules/replicationsession.py +++ b/plugins/modules/replicationsession.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -230,7 +230,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' """ =============================================================================== Idempotency table for the replication session ansible module on the basis of diff --git a/plugins/modules/role.py b/plugins/modules/role.py index 54726c5..025efd0 100644 --- a/plugins/modules/role.py +++ b/plugins/modules/role.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing roles on PowerStore""" @@ -113,7 +113,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreRole(object): diff --git a/plugins/modules/security_config.py b/plugins/modules/security_config.py index 52e7d51..b83546a 100644 --- a/plugins/modules/security_config.py +++ b/plugins/modules/security_config.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """ Ansible module for managing security configs on PowerStore""" @@ -116,7 +116,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreSecurityConfig(object): diff --git a/plugins/modules/smb_server.py b/plugins/modules/smb_server.py index 77a6c6e..c960321 100644 --- a/plugins/modules/smb_server.py +++ b/plugins/modules/smb_server.py @@ -73,7 +73,7 @@ notes: - The I(check_mode) is supported. - The details of an SMB server can be fetched using I(smb_server_id) or - I(nas_server) + I(nas_server). ''' EXAMPLES = r''' diff --git a/plugins/modules/smbshare.py b/plugins/modules/smbshare.py index 75d2fb7..a813c9c 100644 --- a/plugins/modules/smbshare.py +++ b/plugins/modules/smbshare.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2020-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies from __future__ import (absolute_import, division, print_function) __metaclass__ = type @@ -311,7 +311,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreSMBShare(object): diff --git a/plugins/modules/smtp_config.py b/plugins/modules/smtp_config.py index 6aa78ba..0db7d00 100644 --- a/plugins/modules/smtp_config.py +++ b/plugins/modules/smtp_config.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -138,7 +138,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreSmtpConfig(object): diff --git a/plugins/modules/snapshot.py b/plugins/modules/snapshot.py index 543dab9..916b0e8 100644 --- a/plugins/modules/snapshot.py +++ b/plugins/modules/snapshot.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import (absolute_import, division, print_function) @@ -344,7 +344,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreSnapshot(object): diff --git a/plugins/modules/snapshotrule.py b/plugins/modules/snapshotrule.py index 411edaa..9cebe68 100644 --- a/plugins/modules/snapshotrule.py +++ b/plugins/modules/snapshotrule.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -253,7 +253,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreSnapshotrule(object): diff --git a/plugins/modules/storage_container.py b/plugins/modules/storage_container.py index 5f9ddac..84fbf4e 100644 --- a/plugins/modules/storage_container.py +++ b/plugins/modules/storage_container.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -361,7 +361,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreStorageContainer(object): diff --git a/plugins/modules/vcenter.py b/plugins/modules/vcenter.py index 88a022b..95b39a0 100644 --- a/plugins/modules/vcenter.py +++ b/plugins/modules/vcenter.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -215,7 +215,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerstoreVCenter(object): diff --git a/plugins/modules/volume.py b/plugins/modules/volume.py index cdda348..df88300 100644 --- a/plugins/modules/volume.py +++ b/plugins/modules/volume.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -631,7 +631,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreVolume(object): diff --git a/plugins/modules/volumegroup.py b/plugins/modules/volumegroup.py index 68cdab7..5066151 100644 --- a/plugins/modules/volumegroup.py +++ b/plugins/modules/volumegroup.py @@ -1,5 +1,5 @@ #!/usr/bin/python -# Copyright: (c) 2019-2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) from __future__ import absolute_import, division, print_function @@ -398,7 +398,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/3.0.0' +APPLICATION_TYPE = 'Ansible/3.1.0' class PowerStoreVolumeGroup(object): diff --git a/tests/unit/plugins/module_utils/libraries/fail_json.py b/tests/unit/plugins/module_utils/libraries/fail_json.py index 8c9ce40..fd6db43 100644 --- a/tests/unit/plugins/module_utils/libraries/fail_json.py +++ b/tests/unit/plugins/module_utils/libraries/fail_json.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/module_utils/libraries/powerstore_unit_base.py b/tests/unit/plugins/module_utils/libraries/powerstore_unit_base.py index d1ef20a..a0f7921 100644 --- a/tests/unit/plugins/module_utils/libraries/powerstore_unit_base.py +++ b/tests/unit/plugins/module_utils/libraries/powerstore_unit_base.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/module_utils/mock_nfs_api.py b/tests/unit/plugins/module_utils/mock_nfs_api.py index 61e5373..1ac26da 100644 --- a/tests/unit/plugins/module_utils/mock_nfs_api.py +++ b/tests/unit/plugins/module_utils/mock_nfs_api.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/module_utils/mock_quota_api.py b/tests/unit/plugins/module_utils/mock_quota_api.py index e1b56b4..29ffe34 100644 --- a/tests/unit/plugins/module_utils/mock_quota_api.py +++ b/tests/unit/plugins/module_utils/mock_quota_api.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022-24, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_certificate.py b/tests/unit/plugins/modules/test_certificate.py index 940a768..ecb59ea 100644 --- a/tests/unit/plugins/modules/test_certificate.py +++ b/tests/unit/plugins/modules/test_certificate.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_cluster.py b/tests/unit/plugins/modules/test_cluster.py index 3e499e6..4cf98d7 100644 --- a/tests/unit/plugins/modules/test_cluster.py +++ b/tests/unit/plugins/modules/test_cluster.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_dns.py b/tests/unit/plugins/modules/test_dns.py index b65b092..e846962 100644 --- a/tests/unit/plugins/modules/test_dns.py +++ b/tests/unit/plugins/modules/test_dns.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_email.py b/tests/unit/plugins/modules/test_email.py index aefb2d2..68ecae4 100644 --- a/tests/unit/plugins/modules/test_email.py +++ b/tests/unit/plugins/modules/test_email.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_filesystem.py b/tests/unit/plugins/modules/test_filesystem.py index b34bd91..8c8c3ef 100644 --- a/tests/unit/plugins/modules/test_filesystem.py +++ b/tests/unit/plugins/modules/test_filesystem.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_filesystem_snapshot.py b/tests/unit/plugins/modules/test_filesystem_snapshot.py index 8c64ebb..23dba3a 100644 --- a/tests/unit/plugins/modules/test_filesystem_snapshot.py +++ b/tests/unit/plugins/modules/test_filesystem_snapshot.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_host.py b/tests/unit/plugins/modules/test_host.py index ba9254d..3dfab78 100644 --- a/tests/unit/plugins/modules/test_host.py +++ b/tests/unit/plugins/modules/test_host.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_hostgroup.py b/tests/unit/plugins/modules/test_hostgroup.py index 8e197f2..d8a79be 100644 --- a/tests/unit/plugins/modules/test_hostgroup.py +++ b/tests/unit/plugins/modules/test_hostgroup.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_info.py b/tests/unit/plugins/modules/test_info.py index 9f710e5..c85802c 100644 --- a/tests/unit/plugins/modules/test_info.py +++ b/tests/unit/plugins/modules/test_info.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_job.py b/tests/unit/plugins/modules/test_job.py index 565c29b..f702657 100644 --- a/tests/unit/plugins/modules/test_job.py +++ b/tests/unit/plugins/modules/test_job.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_ldap_account.py b/tests/unit/plugins/modules/test_ldap_account.py index a3fdded..3ba5fe3 100644 --- a/tests/unit/plugins/modules/test_ldap_account.py +++ b/tests/unit/plugins/modules/test_ldap_account.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_ldap_domain.py b/tests/unit/plugins/modules/test_ldap_domain.py index daa7a87..1b69787 100644 --- a/tests/unit/plugins/modules/test_ldap_domain.py +++ b/tests/unit/plugins/modules/test_ldap_domain.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_local_user.py b/tests/unit/plugins/modules/test_local_user.py index a9daa56..e26e75f 100644 --- a/tests/unit/plugins/modules/test_local_user.py +++ b/tests/unit/plugins/modules/test_local_user.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_nasserver.py b/tests/unit/plugins/modules/test_nasserver.py index 2f222b7..577705d 100644 --- a/tests/unit/plugins/modules/test_nasserver.py +++ b/tests/unit/plugins/modules/test_nasserver.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_network.py b/tests/unit/plugins/modules/test_network.py index 595da3f..bf569e9 100644 --- a/tests/unit/plugins/modules/test_network.py +++ b/tests/unit/plugins/modules/test_network.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_nfs.py b/tests/unit/plugins/modules/test_nfs.py index af6f717..8cf8ee5 100644 --- a/tests/unit/plugins/modules/test_nfs.py +++ b/tests/unit/plugins/modules/test_nfs.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_ntp.py b/tests/unit/plugins/modules/test_ntp.py index b005ed4..bb8ce4d 100644 --- a/tests/unit/plugins/modules/test_ntp.py +++ b/tests/unit/plugins/modules/test_ntp.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) """Unit Tests for NTP module for PowerStore""" diff --git a/tests/unit/plugins/modules/test_protectionpolicy.py b/tests/unit/plugins/modules/test_protectionpolicy.py index d58798d..a5ac64d 100644 --- a/tests/unit/plugins/modules/test_protectionpolicy.py +++ b/tests/unit/plugins/modules/test_protectionpolicy.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_quota.py b/tests/unit/plugins/modules/test_quota.py index b548088..2d382eb 100644 --- a/tests/unit/plugins/modules/test_quota.py +++ b/tests/unit/plugins/modules/test_quota.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022-24, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_remote_support.py b/tests/unit/plugins/modules/test_remote_support.py index 1f58271..9fe1985 100644 --- a/tests/unit/plugins/modules/test_remote_support.py +++ b/tests/unit/plugins/modules/test_remote_support.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_remote_support_contact.py b/tests/unit/plugins/modules/test_remote_support_contact.py index 3419914..098b935 100644 --- a/tests/unit/plugins/modules/test_remote_support_contact.py +++ b/tests/unit/plugins/modules/test_remote_support_contact.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_remotesystem.py b/tests/unit/plugins/modules/test_remotesystem.py index 1fd04b3..b9fc7c3 100644 --- a/tests/unit/plugins/modules/test_remotesystem.py +++ b/tests/unit/plugins/modules/test_remotesystem.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_replicationrule.py b/tests/unit/plugins/modules/test_replicationrule.py index 1b77233..e8ab7f1 100644 --- a/tests/unit/plugins/modules/test_replicationrule.py +++ b/tests/unit/plugins/modules/test_replicationrule.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_replicationsession.py b/tests/unit/plugins/modules/test_replicationsession.py index 40d3445..deca583 100644 --- a/tests/unit/plugins/modules/test_replicationsession.py +++ b/tests/unit/plugins/modules/test_replicationsession.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_role.py b/tests/unit/plugins/modules/test_role.py index 6e37787..04e405f 100644 --- a/tests/unit/plugins/modules/test_role.py +++ b/tests/unit/plugins/modules/test_role.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_security_config.py b/tests/unit/plugins/modules/test_security_config.py index b8b9e17..870fdb9 100644 --- a/tests/unit/plugins/modules/test_security_config.py +++ b/tests/unit/plugins/modules/test_security_config.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_smbshare.py b/tests/unit/plugins/modules/test_smbshare.py index 312220d..dbce7f7 100644 --- a/tests/unit/plugins/modules/test_smbshare.py +++ b/tests/unit/plugins/modules/test_smbshare.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2021, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_smtp_config.py b/tests/unit/plugins/modules/test_smtp_config.py index 7c6a615..edb649b 100644 --- a/tests/unit/plugins/modules/test_smtp_config.py +++ b/tests/unit/plugins/modules/test_smtp_config.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_snapshot.py b/tests/unit/plugins/modules/test_snapshot.py index 6a9f436..cfa4652 100644 --- a/tests/unit/plugins/modules/test_snapshot.py +++ b/tests/unit/plugins/modules/test_snapshot.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_snapshotrule.py b/tests/unit/plugins/modules/test_snapshotrule.py index 3d6dac0..fe4aa08 100644 --- a/tests/unit/plugins/modules/test_snapshotrule.py +++ b/tests/unit/plugins/modules/test_snapshotrule.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_storage_container.py b/tests/unit/plugins/modules/test_storage_container.py index b14d634..8d3b718 100644 --- a/tests/unit/plugins/modules/test_storage_container.py +++ b/tests/unit/plugins/modules/test_storage_container.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_vcenter.py b/tests/unit/plugins/modules/test_vcenter.py index b0c64f0..7e57403 100644 --- a/tests/unit/plugins/modules/test_vcenter.py +++ b/tests/unit/plugins/modules/test_vcenter.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2023, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) diff --git a/tests/unit/plugins/modules/test_volume.py b/tests/unit/plugins/modules/test_volume.py index 99639f3..a32a854 100644 --- a/tests/unit/plugins/modules/test_volume.py +++ b/tests/unit/plugins/modules/test_volume.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt) @@ -677,7 +677,7 @@ def test_refresh_volume_backup_snap_error(self, volume_module_mock): def test_refresh_volume_expiration_timestamp_error(self, volume_module_mock): self.operation_before_refresh_volume(volume_module_mock) - self.get_module_args['backup_snap_profile']['expiration_timestamp'] = '2022-23T01:20:00Z' + self.get_module_args['backup_snap_profile']['expiration_timestamp'] = '2024-23T01:20:00Z' volume_module_mock.module.params = self.get_module_args volume_module_mock.provisioning.refresh_volume = MagicMock(return_value='snap_id_3') self.perform_operation(volume_module_mock) diff --git a/tests/unit/plugins/modules/test_volumegroup.py b/tests/unit/plugins/modules/test_volumegroup.py index daf46fa..84f808f 100644 --- a/tests/unit/plugins/modules/test_volumegroup.py +++ b/tests/unit/plugins/modules/test_volumegroup.py @@ -1,4 +1,4 @@ -# Copyright: (c) 2022, Dell Technologies +# Copyright: (c) 2024, Dell Technologies # Apache License version 2.0 (see MODULE-LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt)