diff --git a/.ansible-lint b/.ansible-lint index 4a9971a..f615bf2 100644 --- a/.ansible-lint +++ b/.ansible-lint @@ -1,4 +1,2 @@ exclude_paths: - - changelogs/ - .github/ - - meta/ diff --git a/.github/workflows/ansible-test.yml b/.github/workflows/ansible-test.yml index fa3b247..5c592cc 100644 --- a/.github/workflows/ansible-test.yml +++ b/.github/workflows/ansible-test.yml @@ -15,15 +15,15 @@ jobs: strategy: fail-fast: false matrix: - ansible-version: [stable-2.13] + ansible-version: [stable-2.14] steps: - name: Check out code - uses: actions/checkout@v2 + uses: actions/checkout@v3 - - name: Set up Python 3.9 - uses: actions/setup-python@v1 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 with: - python-version: 3.9 + python-version: 3.11 - name: Install ansible (${{ matrix.ansible-version }}) run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz --disable-pip-version-check @@ -50,15 +50,16 @@ jobs: fail-fast: false matrix: python-version: ["3.9", "3.10", "3.11"] - ansible-version: [stable-2.13, stable-2.14, stable-2.15] + ansible-version: [stable-2.14, stable-2.15, stable-2.16] exclude: - # Python 3.11 is supported only from ansible-core 2.14 onwards - - python-version: "3.11" - ansible-version: stable-2.13 + # Ansible-core 2.16 is supported only from Python 3.10 onwards + - python-version: "3.9" + ansible-version: stable-2.16 + steps: - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} @@ -75,6 +76,7 @@ jobs: run: | ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz if [ -f /home/runner/.ansible/collections/ansible_collections/dellemc/powerstore/tests/requirements.txt ]; then pip install -r /home/runner/.ansible/collections/ansible_collections/dellemc/powerstore/tests/requirements.txt; fi + - name: Run Unit tests using ansible-test run: ansible-test units -v --color --python ${{ matrix.python-version }} --coverage working-directory: /home/runner/.ansible/collections/ansible_collections/dellemc/powerstore @@ -91,15 +93,20 @@ jobs: strategy: fail-fast: false matrix: - ansible-version: [stable-2.13, stable-2.14, stable-2.15] + python-version: ["3.9", "3.10", "3.11"] + ansible-version: [stable-2.14, stable-2.15, stable-2.16] + exclude: + # Ansible-core 2.16 is supported only from Python 3.10 onwards + - python-version: "3.9" + ansible-version: stable-2.16 steps: - - name: Set up Python 3.9 - uses: actions/setup-python@v1 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 with: # it is just required to run that once as "ansible-test sanity" in the docker image # will run on all python versions it supports. - python-version: 3.9 + python-version: 3.11 - name: Install ansible (${{ matrix.ansible-version }}) version run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible-version }}.tar.gz --disable-pip-version-check @@ -128,7 +135,11 @@ jobs: fail-fast: false matrix: python-version: ["3.9", "3.10", "3.11"] - ansible-version: [stable-2.13, stable-2.14, stable-2.15] + ansible-version: [stable-2.14, stable-2.15, stable-2.16] + exclude: + # Ansible-core 2.16 is supported only from Python 3.10 onwards + - python-version: "3.9" + ansible-version: stable-2.16 steps: # Important: This sets up your GITHUB_WORKSPACE environment variable @@ -138,7 +149,7 @@ jobs: fetch-depth: 0 # needed for progressive mode to work - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f6d016f..bdee53e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,14 @@ Dellemc.Powerstore Change Logs .. contents:: Topics +v3.0.0 +====== + +Minor Changes +------------- + +- Added support for PowerStore 3.6.x.x. + v2.2.0 ====== diff --git a/README.md b/README.md index 2eee705..c69fb00 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,29 @@ The Ansible Modules for Dell Technologies (Dell) PowerStore allow Data Center an 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. ## Table of contents -* [Code of conduct](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/CODE_OF_CONDUCT.md) -* [Maintainer guide](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/MAINTAINER_GUIDE.md) -* [Committer guide](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/COMMITTER_GUIDE.md) -* [Contributing guide](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/CONTRIBUTING.md) -* [Branching strategy](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/BRANCHING.md) -* [List of adopters](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/ADOPTERS.md) -* [Maintainers](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/MAINTAINERS.md) -* [Support](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/SUPPORT.md) +* [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) * [License](#license) -* [Security](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/SECURITY.md) +* [Security](https://github.com/dell/ansible-powerstore/blob/3.0.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/2.2.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/2.2.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.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. ## Prerequisites | **Ansible Modules** | **PowerStore Version** | **SDK version** | **Python version** | **Ansible** | |---------------------|-----------------------|-----------------|--------------------|--------------------------| -| v2.2.0 | 3.0.x
3.2.x
3.5.x | 2.0.0 | 3.9.x
3.10.x
3.11.x | 2.13
2.14
2.15 | +| 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 | * Please follow PyPowerStore installation instructions on [PyPowerStore Documentation](https://github.com/dell/python-powerstore) @@ -35,43 +35,43 @@ 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/2.2.0/docs/modules/volume.rst) -* [Volume group module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/volumegroup.rst) -* [Host module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/host.rst) -* [Host group module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/hostgroup.rst) -* [Snapshot module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/snapshot.rst) -* [Snapshot rule module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/snapshotrule.rst) -* [Replication rule module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/replicationrule.rst) -* [Replication session module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/replicationsession.rst) -* [Protection policy module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/protectionpolicy.rst) -* [Info module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/info.rst) -* [File system module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/filesystem.rst) -* [NAS server module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/nasserver.rst) -* [SMB share module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/smbshare.rst) -* [Quota module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/quota.rst) -* [File system snapshot module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/filesystem_snapshot.rst) -* [NFS export module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/nfs.rst) -* [Cluster module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/cluster.rst) -* [Network module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/network.rst) -* [Local user module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/local_user.rst) -* [Role module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/role.rst) -* [Job module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/job.rst) -* [Certificate module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/certificate.rst) -* [Remote system module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/remotesystem.rst) -* [Security config module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/security_config.rst) -* [DNS module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/dns.rst) -* [Email module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/email.rst) -* [NTP module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/ntp.rst) -* [Remote support module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/remote_support.rst) -* [Remote support contact module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/remote_support_contact.rst) -* [SMTP config module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/smtp_config.rst) -* [LDAP Account module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/ldap_account.rst) -* [LDAP Domain module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/ldap_domain.rst) -* [vCenter module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/vcenter.rst) -* [Storage container module](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/modules/storage_container.rst) +* [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) ## 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/2.2.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.0.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 5b3e324..8ad0865 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -2,176 +2,176 @@ ancestor: null releases: 1.0.0: modules: - - description: Managing Dell PowerStore host - name: host - namespace: '' - - description: Manage host group on Dell PowerStore - name: hostgroup - namespace: '' - - description: Gathering information about Dell PowerStore - name: info - namespace: '' - - description: Manage Protection policies on Dell PowerStore - name: protectionpolicy - namespace: '' - - description: Manage Snapshot Rule on Dell PowerStore - name: snapshotrule - namespace: '' - - description: Manage volumes on Dell PowerStore - name: volume - namespace: '' - - description: Manage volume group on Dell PowerStore - name: volumegroup - namespace: '' + - description: Managing Dell PowerStore host + name: host + namespace: '' + - description: Manage host group on Dell PowerStore + name: hostgroup + namespace: '' + - description: Gathering information about Dell PowerStore + name: info + namespace: '' + - description: Manage Protection policies on Dell PowerStore + name: protectionpolicy + namespace: '' + - description: Manage Snapshot Rule on Dell PowerStore + name: snapshotrule + namespace: '' + - description: Manage volumes on Dell PowerStore + name: volume + namespace: '' + - description: Manage volume group on Dell PowerStore + name: volumegroup + namespace: '' release_date: '2020-05-06' 1.1.0: changes: minor_changes: - - Gather facts module is enhanced to list filesystems, - NAS servers, NFS exports, SMB shares, tree quotas, user quotas. + - Gather facts module is enhanced to list filesystems, + NAS servers, NFS exports, SMB shares, tree quotas, user quotas. modules: - - description: Manage File System on Dell PowerStore - name: filesystem - namespace: '' - - description: Manage Filesystem Snapshot on Dell PowerStore - name: filesystem_snapshot - namespace: '' - - description: Manage NAS server on Dell PowerStore - name: nasserver - namespace: '' - - description: Manage NFS Export on Dell PowerStore - name: nfs - namespace: '' - - description: Manage Quota on Dell PowerStore - name: quota - namespace: '' - - description: Manage SMB Share on Dell PowerStore - name: smbshare - namespace: '' - - description: Manage Snapshot on Dell PowerStore - name: snapshot - namespace: '' + - description: Manage File System on Dell PowerStore + name: filesystem + namespace: '' + - description: Manage Filesystem Snapshot on Dell PowerStore + name: filesystem_snapshot + namespace: '' + - description: Manage NAS server on Dell PowerStore + name: nasserver + namespace: '' + - description: Manage NFS Export on Dell PowerStore + name: nfs + namespace: '' + - description: Manage Quota on Dell PowerStore + name: quota + namespace: '' + - description: Manage SMB Share on Dell PowerStore + name: smbshare + namespace: '' + - description: Manage Snapshot on Dell PowerStore + name: snapshot + namespace: '' release_date: '2020-09-25' 1.2.0: changes: minor_changes: - - Gather facts module is enhanced to list remote systems, - replication rules and replication sessions. - - Protection policy module is enhanced to add/remove replication rule - to/from protection policy. + - Gather facts module is enhanced to list remote systems, + replication rules and replication sessions. + - Protection policy module is enhanced to add/remove replication rule + to/from protection policy. modules: - - description: Manage Replication Rules on Dell PowerStore - name: replicationrule - namespace: '' - - description: Manage Replication Session on Dell PowerStore - name: replicationsession - namespace: '' + - description: Manage Replication Rules on Dell PowerStore + name: replicationrule + namespace: '' + - description: Manage Replication Session on Dell PowerStore + name: replicationsession + namespace: '' release_date: '2021-06-25' 1.3.0: changes: minor_changes: - - Added dual licensing. - - Gather facts module is enhanced to list users, roles, - networks and appliances. + - Added dual licensing. + - Gather facts module is enhanced to list users, roles, + networks and appliances. modules: - - description: Manage Cluster on Dell PowerStore - name: cluster - namespace: '' - - description: Manage Job on Dell PowerStore - name: job - namespace: '' - - description: Manage local user on Dell PowerStore - name: local_user - namespace: '' - - description: Manage Network operations on Dell PowerStore - name: network - namespace: '' - - description: Manage Roles on Dell PowerStore - name: role - namespace: '' + - description: Manage Cluster on Dell PowerStore + name: cluster + namespace: '' + - description: Manage Job on Dell PowerStore + name: job + namespace: '' + - description: Manage local user on Dell PowerStore + name: local_user + namespace: '' + - description: Manage Network operations on Dell PowerStore + name: network + namespace: '' + - description: Manage Roles on Dell PowerStore + name: role + namespace: '' release_date: '2021-09-28' 1.4.0: changes: minor_changes: - - Host module is enhanced to provide support for NVMe initiators. - - Info module is enhanced to list certificates, AD/LDAP providers and - security configuration. - - Names of previously released modules have been changed from - dellemc_powerstore_\ to \. + - Host module is enhanced to provide support for NVMe initiators. + - Info module is enhanced to list certificates, AD/LDAP providers and + security configuration. + - Names of previously released modules have been changed from + dellemc_powerstore_\ to \. modules: - - description: Manage Certificates on Dell PowerStore - name: certificate - namespace: '' - - description: Manage Remote system on Dell PowerStore - name: remotesystem - namespace: '' - - description: Manage Security config on Dell PowerStore - name: security_config - namespace: '' + - description: Manage Certificates on Dell PowerStore + name: certificate + namespace: '' + - description: Manage Remote system on Dell PowerStore + name: remotesystem + namespace: '' + - description: Manage Security config on Dell PowerStore + name: security_config + namespace: '' release_date: '2021-12-16' 1.5.0: changes: minor_changes: - - Info module is enhanced to list dns servers, NTP servers, - email notification destinations, remote support configuration, - remote support contacts and SMTP configuration. - - Remote support module is added to get the details, - modify the attributes, verify the connection and - send a test alert. + - Info module is enhanced to list dns servers, NTP servers, + email notification destinations, remote support configuration, + remote support contacts and SMTP configuration. + - Remote support module is added to get the details, + modify the attributes, verify the connection and + send a test alert. modules: - - description: Manage DNS on Dell PowerStore - name: dns - namespace: '' - - description: Manage email on Dell PowerStore - name: email - namespace: '' - - description: Manage NTP on Dell PowerStore - name: ntp - namespace: '' - - description: Manage Remote support on Dell PowerStore - name: remote_support - namespace: '' - - description: Manage Remote support contact on Dell PowerStore - name: remote_support_contact - namespace: '' - - description: Manage SMTP config on Dell PowerStore - name: smtp_config - namespace: '' + - description: Manage DNS on Dell PowerStore + name: dns + namespace: '' + - description: Manage email on Dell PowerStore + name: email + namespace: '' + - description: Manage NTP on Dell PowerStore + name: ntp + namespace: '' + - description: Manage Remote support on Dell PowerStore + name: remote_support + namespace: '' + - description: Manage Remote support contact on Dell PowerStore + name: remote_support_contact + namespace: '' + - description: Manage SMTP config on Dell PowerStore + name: smtp_config + namespace: '' release_date: '2021-03-25' 1.6.0: changes: minor_changes: - - Added execution environment manifest file to support building an - execution environment with ansible-builder. - - Enabled the check_mode support for info module. - - Info module is enhanced to list ldap domain, ldap accounts. + - Added execution environment manifest file to support building an + execution environment with ansible-builder. + - Enabled the check_mode support for info module. + - Info module is enhanced to list ldap domain, ldap accounts. modules: - - description: Manage LDAP account on Dell PowerStore - name: ldap_account - namespace: '' - - description: Manage LDAP domain on Dell PowerStore - name: ldap_domain - namespace: '' + - description: Manage LDAP account on Dell PowerStore + name: ldap_account + namespace: '' + - description: Manage LDAP domain on Dell PowerStore + name: ldap_domain + namespace: '' release_date: '2022-06-28' 1.7.0: changes: minor_changes: - - Added support for cluster creation and validating cluster creation - attributes. - - Added support to associate/disassociate protection policy to/from a - NAS server. - - Added support to clone, refresh and restore a volume group. - - Added support to handle filesystem and NAS server replication sessions. + - Added support for cluster creation and validating cluster creation + attributes. + - Added support to associate/disassociate protection policy to/from a + NAS server. + - Added support to clone, refresh and restore a volume group. + - Added support to handle filesystem and NAS server replication sessions. release_date: '2022-09-27' 1.8.0: changes: minor_changes: - - Added support for PowerStore version 3.2.0.0. - - Added support for host connectivity option to host and host group. - - Added support to clone, refresh and restore a volume. - - Added support to configure/remove the metro relationship for volume. - - Added support to modify the role of replication sessions. - - Updated modules to adhere with ansible community guidelines. + - Added support for PowerStore version 3.2.0.0. + - Added support for host connectivity option to host and host group. + - Added support to clone, refresh and restore a volume. + - Added support to configure/remove the metro relationship for volume. + - Added support to modify the role of replication sessions. + - Updated modules to adhere with ansible community guidelines. release_date: '2022-12-21' 1.9.0: changes: @@ -190,7 +190,7 @@ releases: changes: minor_changes: - Added support for manual appliance selection in volume module. - - Added support for replication group in replication session module + - Added support for replication group in replication session module to perform async vVOL replication. - Info module is enhanced to list storage containers and replication group. - Added support for PowerStore Medusa 3.5.x. @@ -211,3 +211,8 @@ releases: - Added support for creating and deleting NAS server. - Info module is enhanced to list discovered appliances. release_date: '2023-09-29' + 3.0.0: + changes: + minor_changes: + - Added support for PowerStore 3.6.x.x. + release_date: '2023-11-30' diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 94b8083..3b768ea 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/2.2.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.0.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/2.2.0/docs/ISSUE_TRIAGE.md). +Read more about the ways you can [Triage issues](https://github.com/dell/ansible-powerstore/blob/3.0.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/2.2.0/docs/BRANCHING.md) +* [Branching Strategy for Ansible modules for Dell PowerStore](https://github.com/dell/ansible-powerstore/blob/3.0.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/2.2.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.0.0/docs/SUPPORT.md). #### Code sanitization diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index a27b7b6..d87183b 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-2.2.0.tar.gz -p + ansible-galaxy collection install dellemc-powerstore-3.0.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/2.2.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.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. ## SSL certificate validation diff --git a/docs/ISSUE_TRIAGE.md b/docs/ISSUE_TRIAGE.md index 1ac9184..7c1a4af 100644 --- a/docs/ISSUE_TRIAGE.md +++ b/docs/ISSUE_TRIAGE.md @@ -43,7 +43,7 @@ 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. 2.2.0] + - Ansible modules for Dell PowerStore Version: [e.g. 3.0.0] - PowerStore SDK version: [e.g. PyPowerStore 1.10.0] - Any other additional information... diff --git a/docs/MAINTAINER_GUIDE.md b/docs/MAINTAINER_GUIDE.md index a7c038b..c309b4a 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/2.2.0/docs/CODE_OF_CONDUCT.md) and the guidelines in the [Contributing](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/CONTRIBUTING.md) and [Committer](https://github.com/dell/ansible-powerstore/blob/2.2.0/docs/COMMITTER_GUIDE.md) guides +* 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 * 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 ad7c32a..0a0058f 100644 --- a/docs/Release Notes.md +++ b/docs/Release Notes.md @@ -1,6 +1,6 @@ **Ansible Modules for Dell Technologies PowerStore** ========================================= -### Release Notes 2.2.0 +### Release Notes 3.0.0 > © 2022 Dell Inc. or its subsidiaries. All rights reserved. Dell, > and other trademarks are trademarks of Dell Inc. or its @@ -28,7 +28,7 @@ Table 1. Revision history | Revision | Date | Description | |----------|------------|-----------------------------------------------------------| -| 01 | September 2023 | Current release of Ansible Modules for Dell PowerStore 2.2.0 | +| 01 | November 2023 | Current release of Ansible Modules for Dell PowerStore 3.0.0 | Product Description ------------------- @@ -38,9 +38,7 @@ New features & enhancements --------------------------- Along with the previous release deliverables, this release supports these features: -- Added support for cloning, refreshing, and restoring filesystem. -- Added support for creating and deleting NAS server. -- Info module is enhanced to list discovered appliances. +- Added support for PowerStore 3.6.x.x. Known issues ------------ @@ -57,11 +55,11 @@ Limitations Distribution ---------------- The software package is available for download from the [Ansible Modules -for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/2.2.0) page. +for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.0.0) page. Documentation ------------- -The documentation is available on [Ansible Modules for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/2.2.0/docs) +The documentation is available on [Ansible Modules for PowerStore GitHub](https://github.com/dell/ansible-powerstore/tree/3.0.0/docs) page. It includes these: - README - Release Notes (this document) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 8cd026f..d5e48e2 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/2.2.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.0.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 2b6a2dc..c030e67 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *is_current* parameter is supported for modification of certificate. + - Only \ :emphasis:`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 *check_mode* is not supported. + - The \ :emphasis:`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 9d47ff9..e638e81 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -53,23 +53,23 @@ Parameters appliance_id (optional, str, None) ID of the appliance. - Parameters *appliance_id* and *appliance_name* are mutually exclusive. + Parameters \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. - Parameter *is_ssh_enabled* has to be passed along with *appliance_id*. + Parameter \ :emphasis:`is\_ssh\_enabled`\ has to be passed along with \ :emphasis:`appliance\_id`\ . appliance_name (optional, str, None) Name of the appliance. - Parameters *appliance_id* and *appliance_name* are mutually exclusive. + Parameters \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. - Parameter *is_ssh_enabled* has to be passed along with *appliance_name*. + Parameter \ :emphasis:`is\_ssh\_enabled`\ has to be passed along with \ :emphasis:`appliance\_name`\ . is_ssh_enabled (optional, bool, None) Whether SSH access is enabled for the cluster. - Either *appliance_id* or *appliance_name* is to be passed along with *is_ssh_enabled*. + Either \ :emphasis:`appliance\_id`\ or \ :emphasis:`appliance\_name`\ is to be passed along with \ :emphasis:`is\_ssh\_enabled`\ . physical_mtu (optional, int, None) @@ -150,7 +150,7 @@ Parameters snmp_community_string (optional, str, None) - Specifies ``SNMPv2`` community string, if ``SNMPv2`` connect method is selected. + Specifies \ :literal:`SNMPv2`\ community string, if \ :literal:`SNMPv2`\ connect method is selected. @@ -229,7 +229,7 @@ Parameters This should be specified when creating PowerStore X cluster. - Mutually exclusive with *data_center_id*. + Mutually exclusive with \ :emphasis:`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 *data_center_name*. + Mutually exclusive with \ :emphasis:`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. - ``true`` signifies synchronous execution. By default, create cluster operation will run asynchronously. + \ :literal:`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 ``present`` indicates that the cluster should exist on the system. + Value \ :literal:`present`\ indicates that the cluster should exist on the system. - Value ``absent`` indicates that the cluster should not exist on the system. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`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, *storage_discovery_address* and purposes should not be passed. - - The *vcenters* parameter is mandatory for PowerStore X cluster creation. + - 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. - Minimum 3 and 5 addresses are required for management network for PowerStore T and X model respectively. - - 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 \ :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 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 *is_ssh_enabled* parameter is used. + Name and Id of the appliance for which \ :emphasis:`is\_ssh\_enabled`\ parameter is used. id (, str, ) diff --git a/docs/modules/dns.rst b/docs/modules/dns.rst index d7b331d..337f4dc 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *dns_addresses*. + State of the addresses mentioned in \ :emphasis:`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 ``present``. + For get and modify operations it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *dns_addresses* and *dns_address_state* are required together. + - Parameters \ :emphasis:`dns\_addresses`\ and \ :emphasis:`dns\_address\_state`\ are required together. - Creation and deletion of DNS is not supported. - - The *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -102,39 +102,39 @@ Examples .. code-block:: yaml+jinja - - name: Get details of DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - state: "present" - - - name: Add addresses to DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - dns_addresses: - - "XX.XX.XX.XX" - - "YY.YY.YY.YY" - dns_address_state: "present-in-dns" - state: "present" - - - name: Remove addresses from DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - dns_addresses: - - "YY.YY.YY.YY" - dns_address_state: "absent-in-dns" - state: "present" + - name: Get details of DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + state: "present" + + - name: Add addresses to DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + dns_addresses: + - "XX.XX.XX.XX" + - "YY.YY.YY.YY" + dns_address_state: "present-in-dns" + state: "present" + + - name: Remove addresses from DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + dns_addresses: + - "YY.YY.YY.YY" + dns_address_state: "absent-in-dns" + state: "present" diff --git a/docs/modules/email.rst b/docs/modules/email.rst index be4df9e..c07feb3 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *email_address*. + Mutually exclusive with \ :emphasis:`email\_address`\ . email_address (optional, str, None) Email address to receive notifications. - Mutually exclusive with *email_id*. + Mutually exclusive with \ :emphasis:`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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all Create, Modify, Test or Get details operations it should be set to ``present``. + For all Create, Modify, Test or Get details operations it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -137,68 +137,68 @@ Examples .. code-block:: yaml+jinja - - name: Get details of destination email with email_id - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" - state: "present" - - - name: Get details of destination email with email_address - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc@dell.com" - state: "present" - - - name: Create destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc_xyz@dell.com" - notify: - info: true - critical: true - major: false - state: "present" - - - name: Modify destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc_xyz@dell.com" - new_address: "def_pqr@dell.com" - notify: - info: false - major: false - state: "present" - - - name: Send a test mail to the destination email with email_id - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" - send_test_email: true - state: "present" - - - name: Delete destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "def_pqr@dell.com" - state: "absent" + - name: Get details of destination email with email_id + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" + state: "present" + + - name: Get details of destination email with email_address + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc@dell.com" + state: "present" + + - name: Create destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc_xyz@dell.com" + notify: + info: true + critical: true + major: false + state: "present" + + - name: Modify destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc_xyz@dell.com" + new_address: "def_pqr@dell.com" + notify: + info: false + major: false + state: "present" + + - name: Send a test mail to the destination email with email_id + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" + send_test_email: true + state: "present" + + - name: Delete destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "def_pqr@dell.com" + state: "absent" diff --git a/docs/modules/filesystem.rst b/docs/modules/filesystem.rst index 4ffbf61..5d0d40d 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *filesystem_id*. Mandatory only for create operation. + Name of the file system. Mutually exclusive with \ :emphasis:`filesystem\_id`\ . Mandatory only for create operation. filesystem_id (optional, str, None) - Unique id of the file system. Mutually exclusive with *filesystem_name*. + Unique id of the file system. Mutually exclusive with \ :emphasis:`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 *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 \ :emphasis:`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 ``GB``, if not specified. + It defaults to \ :literal:`GB`\ , if not specified. access_policy (optional, str, None) @@ -67,19 +67,19 @@ Parameters locking_policy (optional, str, None) File system locking policies. - ``ADVISORY``- No lock checking for NFS and honor SMB lock range only for SMB. + \ :literal:`ADVISORY`\ - No lock checking for NFS and honor SMB lock range only for SMB. - ``MANDATORY``- Honor SMB and NFS lock range. + \ :literal:`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. - ``ALL_ALLOWED`` - All protocols are allowed to rename directories without any restrictions. + \ :literal:`ALL\_ALLOWED`\ - All protocols are allowed to rename directories without any restrictions. - ``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:`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. - ``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. + \ :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. 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 ``1``. + Determines the lowest directory level to which the enabled notifications apply. minimum value is \ :literal:`1`\ . @@ -145,7 +145,7 @@ Parameters flr_attributes (optional, dict, None) The attributes for file retention. - Can only be provided when the *config_type* is ``GENERAL``. + Can only be provided when the \ :emphasis:`config\_type`\ is \ :literal:`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 ``NFS_ONLY`` when *config_typ* is set to ``VMWARE``. + It can only be set to \ :literal:`NFS\_ONLY`\ when \ :emphasis:`config\_typ`\ is set to \ :literal:`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 *config_type* is ``VMWARE``. + Can only be set when the \ :emphasis:`config\_type`\ is \ :literal:`VMWARE`\ . Cannot be modified. @@ -224,29 +224,29 @@ Parameters access_policy (optional, str, None) File system security access policies. - ``Native`` - Native Security. + \ :literal:`Native`\ - Native Security. - ``UNIX`` - UNIX Security. + \ :literal:`UNIX`\ - UNIX Security. - ``Windows`` - Windows Security. + \ :literal:`Windows`\ - Windows Security. locking_policy (optional, str, None) File system locking policies. - ``Advisory``- No lock checking for NFS and honor SMB lock range only for SMB. + \ :literal:`Advisory`\ - No lock checking for NFS and honor SMB lock range only for SMB. - ``Mandatory``- Honor SMB and NFS lock range. + \ :literal:`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. - ``All_Allowed`` - All protocols are allowed to rename directories without any restrictions. + \ :literal:`All\_Allowed`\ - All protocols are allowed to rename directories without any restrictions. - ``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:`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. - ``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. + \ :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. 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 ``1``. + Determines the lowest directory level to which the enabled notifications apply. minimum value is \ :literal:`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. - ``None`` - File event notifications are disabled for this file system. + \ :literal:`None`\ - File event notifications are disabled for this file system. - ``SMB_Only`` - SMB notifications are enabled for this file system. + \ :literal:`SMB\_Only`\ - SMB notifications are enabled for this file system. - ``NFS_Only`` - NFS notifications are enabled for this file system. + \ :literal:`NFS\_Only`\ - NFS notifications are enabled for this file system. - ``All`` - SMB and NFS notifications are enabled for this file system. + \ :literal:`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. - ``true`` - means cloning an FLR-C file system is allowed. + \ :literal:`true`\ - means cloning an FLR-C file system is allowed. - ``false`` - means cloning an FLR-C file system is not allowed. and any attempt to do so will return an error. + \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *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 \ :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 modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -389,126 +389,125 @@ Examples .. code-block:: yaml+jinja - - - name: Create FileSystem by Name - register: result_fs - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_name: "{{filesystem_name}}" - description: "{{description}}" - nas_server: "{{nas_server_id}}" - size: "5" - cap_unit: "GB" - access_policy: "UNIX" - locking_policy: "MANDATORY" - smb_properties: - is_smb_no_notify_enabled: true - is_smb_notify_on_access_enabled: true - quota_defaults: - grace_period: 1 - grace_period_unit: 'days' - default_hard_limit: 3 - default_soft_limit: 2 - protection_policy: "{{protection_policy_id}}" - config_type: "VMWARE" - is_async_mtime_enabled: true - file_events_publishing_mode: "NFS_ONLY" - host_io_size: "VMWARE_16K" - state: "present" - - - name: Modify File System by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{fs_id}}" - folder_rename_policy: "ALL_ALLOWED" - smb_properties: - is_smb_op_locks_enabled: true - smb_notify_on_change_dir_depth: 3 - quota_defaults: - grace_period: 2 - grace_period_unit: 'weeks' - default_hard_limit: 2 - default_soft_limit: 1 - is_async_mtime_enabled: true - file_events_publishing_mode: "ALL" - flr_attributes: - mode: "Enterprise" - minimum_retention: "5D" - default_retention: "1M" - maximum_retention: "1Y" - state: "present" - - - name: Get File System details by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{result_fs.filesystem_details.id}}" - state: "present" - - - name: Delete File System by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{result_fs.filesystem_details.id}}" - state: "absent" - - - name: Clone File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - filesystem_name: 'Atest' - nas_server: 'Test_Nas' - clone_filesystem: - name: "Test_ansible" - description: "Test" - access_policy: "UNIX" - locking_policy: "Advisory" - folder_rename_policy: "All_Allowed" - is_smb_sync_writes_enabled: true - is_smb_no_notify_enabled: true - is_smb_op_locks_enabled: true - is_smb_notify_on_access_enabled: true - is_smb_notify_on_write_enabled: true - smb_notify_on_change_dir_depth: 32 - is_async_MTime_enabled: false - file_events_publishing_mode: "All" - flr_attributes: - force_clone: false - state: "present" - - - name: Refresh File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - snapshot_name: "Refresh_test" - nas_server: 'Sample_NAS' - refresh_filesystem: true - state: "present" - - - name: Restore File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - snapshot_id: "xxx-xxx-xxx" - restore_filesystem: true - backup_snap_name: "Restore_test" - state: "present" + - name: Create FileSystem by Name + register: result_fs + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_name: "{{filesystem_name}}" + description: "{{description}}" + nas_server: "{{nas_server_id}}" + size: "5" + cap_unit: "GB" + access_policy: "UNIX" + locking_policy: "MANDATORY" + smb_properties: + is_smb_no_notify_enabled: true + is_smb_notify_on_access_enabled: true + quota_defaults: + grace_period: 1 + grace_period_unit: 'days' + default_hard_limit: 3 + default_soft_limit: 2 + protection_policy: "{{protection_policy_id}}" + config_type: "VMWARE" + is_async_mtime_enabled: true + file_events_publishing_mode: "NFS_ONLY" + host_io_size: "VMWARE_16K" + state: "present" + + - name: Modify File System by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{fs_id}}" + folder_rename_policy: "ALL_ALLOWED" + smb_properties: + is_smb_op_locks_enabled: true + smb_notify_on_change_dir_depth: 3 + quota_defaults: + grace_period: 2 + grace_period_unit: 'weeks' + default_hard_limit: 2 + default_soft_limit: 1 + is_async_mtime_enabled: true + file_events_publishing_mode: "ALL" + flr_attributes: + mode: "Enterprise" + minimum_retention: "5D" + default_retention: "1M" + maximum_retention: "1Y" + state: "present" + + - name: Get File System details by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{result_fs.filesystem_details.id}}" + state: "present" + + - name: Delete File System by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{result_fs.filesystem_details.id}}" + state: "absent" + + - name: Clone File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + filesystem_name: 'Atest' + nas_server: 'Test_Nas' + clone_filesystem: + name: "Test_ansible" + description: "Test" + access_policy: "UNIX" + locking_policy: "Advisory" + folder_rename_policy: "All_Allowed" + is_smb_sync_writes_enabled: true + is_smb_no_notify_enabled: true + is_smb_op_locks_enabled: true + is_smb_notify_on_access_enabled: true + is_smb_notify_on_write_enabled: true + smb_notify_on_change_dir_depth: 32 + is_async_MTime_enabled: false + file_events_publishing_mode: "All" + flr_attributes: + force_clone: false + state: "present" + + - name: Refresh File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + snapshot_name: "Refresh_test" + nas_server: 'Sample_NAS' + refresh_filesystem: true + state: "present" + + - name: Restore File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + snapshot_id: "xxx-xxx-xxx" + restore_filesystem: true + backup_snap_name: "Restore_test" + state: "present" diff --git a/docs/modules/filesystem_snapshot.rst b/docs/modules/filesystem_snapshot.rst index ab5c6fe..158c77e 100644 --- a/docs/modules/filesystem_snapshot.rst +++ b/docs/modules/filesystem_snapshot.rst @@ -21,12 +21,13 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. + Parameters ---------- @@ -45,7 +46,7 @@ Parameters filesystem (optional, str, None) The ID/Name of the filesystem for which snapshot will be taken. - If filesystem name is specified, then *nas_server* is required to uniquely identify the filesystem. + If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. Mandatory for create operation. @@ -61,7 +62,7 @@ Parameters desired_retention (optional, int, None) The retention value for the Snapshot. - If the *desired_retention*/*expiration_timestamp* is not mentioned during creation, snapshot will be created with unlimited retention. + If the \ :emphasis:`desired\_retention`\ /\ :emphasis:`expiration\_timestamp`\ is not mentioned during creation, snapshot will be created with unlimited retention. Maximum supported desired retention is 31 days. @@ -79,7 +80,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 *access_type* is not specified, snapshot will be created with ``SNAPSHOT`` access type. + For create operation, if \ :emphasis:`access\_type`\ is not specified, snapshot will be created with \ :literal:`SNAPSHOT`\ access type. state (True, str, None) @@ -93,9 +94,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +126,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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 f188ee8..394b260 100644 --- a/docs/modules/host.rst +++ b/docs/modules/host.rst @@ -21,12 +21,13 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. + Parameters ---------- @@ -37,15 +38,15 @@ Parameters Required when creating a host. - Use either *host_id* or *host_name* for modify and delete tasks. + Use either \ :emphasis:`host\_id`\ or \ :emphasis:`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 *host_id* or *host_name* for modify and delete tasks. + Use either \ :emphasis:`host\_id`\ or \ :emphasis:`host\_name`\ for modify and delete tasks. - The *host_id* cannot be used while creating host, as it is generated by the array after creation of host. + The \ :emphasis:`host\_id`\ cannot be used while creating host, as it is generated by the array after creation of host. os_type (optional, str, None) @@ -63,19 +64,19 @@ Parameters Required when creating a host. - It is mutually exclusive with *detailed_initiators*. + It is mutually exclusive with \ :emphasis:`detailed\_initiators`\ . detailed_initiators (optional, list, None) Initiator properties. - It is mutually exclusive with *initiators*. + It is mutually exclusive with \ :emphasis:`initiators`\ . port_name (True, str, None) Name of port type. - The *port_name* is mandatory key. + The \ :emphasis:`port\_name`\ is mandatory key. port_type (optional, str, None) @@ -118,17 +119,17 @@ Parameters state (True, str, None) Define whether the host should exist or not. - Value ``present`` - indicates that the host should exist in system. + Value \ :literal:`present`\ - indicates that the host should exist in system. - Value ``absent`` - indicates that the host should not exist in system. + Value \ :literal:`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 ``present-in-host`` - indicates that the initiators should exist on host. + Value \ :literal:`present-in-host`\ - indicates that the initiators should exist on host. - Value ``absent-in-host`` - indicates that the initiators should not exist on host. + Value \ :literal:`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. @@ -152,9 +153,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -185,11 +186,11 @@ Notes .. note:: - Only completely and correctly configured iSCSI initiators can be associated with a host. - - The parameters *initiators* and *detailed_initiators* are mutually exclusive. + - The parameters \ :emphasis:`initiators`\ and \ :emphasis:`detailed\_initiators`\ are mutually exclusive. - For mutual CHAP authentication, single CHAP credentials are mandatory. - - 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. + - 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. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -201,107 +202,107 @@ Examples .. code-block:: yaml+jinja - - name: Create host with FC initiator - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - os_type: 'Windows' - host_connectivity: "Metro_Optimize_Local" - initiators: - - 21:00:00:24:ff:31:e9:fc - state: 'present' - initiator_state: 'present-in-host' - - - name: Create host with iSCSI initiator and its details - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-2" - os_type: 'Windows' - detailed_initiators: - - port_name: 'iqn.1998-01.com.vmware:lgc198248-5b06fb37' - port_type: 'iSCSI' - chap_single_username: 'chapuserSingle' - chap_single_password: 'chappasswd12345' - - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' - port_type: 'iSCSI' - chap_mutual_username: 'chapuserMutual' - chap_mutual_password: 'chappasswd12345' - state: 'present' - initiator_state: 'present-in-host' - - - name: Get host details by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" - state: 'present' - - - name: Add initiators to host by name - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - initiators: - - 21:00:00:24:ff:31:e9:ee - initiator_state: 'present-in-host' - state: 'present' - - - name: Add initiators to host by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" - detailed_initiators: - - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' - port_type: 'iSCSI' - chap_mutual_username: 'chapuserMutual' - chap_mutual_password: 'chappasswd12345' - initiator_state: 'present-in-host' - state: 'present' - - - name: Remove initiators from by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "8c1e869b-fe8a-4845-hiae-h802bc249d41" - initiators: - - 21:00:00:24:ff:31:e9:ee - initiator_state: 'absent-in-host' - state: 'present' - - - name: Modify host by name - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - new_name: "ansible-test-host-1-new" - host_connectivity: "Metro_Optimize_Remote" - state: 'present' - - - name: Delete host - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1-new" - state: 'absent' + - name: Create host with FC initiator + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + os_type: 'Windows' + host_connectivity: "Metro_Optimize_Local" + initiators: + - 21:00:00:24:ff:31:e9:fc + state: 'present' + initiator_state: 'present-in-host' + + - name: Create host with iSCSI initiator and its details + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-2" + os_type: 'Windows' + detailed_initiators: + - port_name: 'iqn.1998-01.com.vmware:lgc198248-5b06fb37' + port_type: 'iSCSI' + chap_single_username: 'chapuserSingle' + chap_single_password: 'chappasswd12345' + - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' + port_type: 'iSCSI' + chap_mutual_username: 'chapuserMutual' + chap_mutual_password: 'chappasswd12345' + state: 'present' + initiator_state: 'present-in-host' + + - name: Get host details by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" + state: 'present' + + - name: Add initiators to host by name + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + initiators: + - 21:00:00:24:ff:31:e9:ee + initiator_state: 'present-in-host' + state: 'present' + + - name: Add initiators to host by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" + detailed_initiators: + - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' + port_type: 'iSCSI' + chap_mutual_username: 'chapuserMutual' + chap_mutual_password: 'chappasswd12345' + initiator_state: 'present-in-host' + state: 'present' + + - name: Remove initiators from by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "8c1e869b-fe8a-4845-hiae-h802bc249d41" + initiators: + - 21:00:00:24:ff:31:e9:ee + initiator_state: 'absent-in-host' + state: 'present' + + - name: Modify host by name + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + new_name: "ansible-test-host-1-new" + host_connectivity: "Metro_Optimize_Remote" + state: 'present' + + - name: Delete host + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1-new" + state: 'absent' @@ -366,7 +367,7 @@ host_details (When host exists, complex, {'description': None, 'host_group_id': mapped_hosts (, complex, ) - This is the inverse of the resource type *host_volume_mapping* association. + This is the inverse of the resource type \ :emphasis:`host\_volume\_mapping`\ association. id (, str, ) diff --git a/docs/modules/hostgroup.rst b/docs/modules/hostgroup.rst index 86aa156..7eee119 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -39,15 +39,15 @@ Parameters Required when creating a host group. - Use either *hostgroup_id* or *hostgroup_name* for modify and delete tasks. + Use either \ :emphasis:`hostgroup\_id`\ or \ :emphasis:`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 *hostgroup_id* or *hostgroup_name* for modify and delete tasks. + Use either \ :emphasis:`hostgroup\_id`\ or \ :emphasis:`hostgroup\_name`\ for modify and delete tasks. - The *hostgroup_id* cannot be used while creating host group, as it is generated by the array after creation of host group. + The \ :emphasis:`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 ``present`` - indicates that the host group should exist on the system. + Value \ :literal:`present`\ - indicates that the host group should exist on the system. - Value ``absent`` - indicates that the host group should not exist on the system. + Value \ :literal:`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 ``present-in-group`` - indicates that the hosts should exist on the host group. + Value \ :literal:`present-in-group`\ - indicates that the hosts should exist on the host group. - Value ``absent-in-group`` - indicates that the hosts should not exist on the host group. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -129,8 +129,8 @@ Notes ----- .. note:: - - The *check_mode* is not supported. - - The *host_connectivity* is supported only PowerStore 3.0.0.0 and above. + - The \ :emphasis:`check\_mode`\ is not supported. + - The \ :emphasis:`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. @@ -142,71 +142,71 @@ Examples .. code-block:: yaml+jinja - - name: Create host group with hosts - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host1 - - c17fc987-bf82-480c-af31-9307b89923c3 - state: 'present' - host_state: 'present-in-group' - - - name: Get host group details using ID - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_id: "{{host group_id}}" - state: 'present' - - - name: Add hosts to host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host3 - host_state: 'present-in-group' - state: 'present' - - - name: Remove hosts from host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host3 - host_state: 'absent-in-group' - state: 'present' - - - name: Modify host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - host_connectivity: "Metro_Optimize_Both" - new_name: "{{new_hostgroup_name}}" - state: 'present' - - - name: Delete host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - state: 'absent' + - name: Create host group with hosts + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host1 + - c17fc987-bf82-480c-af31-9307b89923c3 + state: 'present' + host_state: 'present-in-group' + + - name: Get host group details using ID + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_id: "{{host group_id}}" + state: 'present' + + - name: Add hosts to host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host3 + host_state: 'present-in-group' + state: 'present' + + - name: Remove hosts from host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host3 + host_state: 'absent-in-group' + state: 'present' + + - name: Modify host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + host_connectivity: "Metro_Optimize_Both" + new_name: "{{new_hostgroup_name}}" + state: 'present' + + - name: Delete host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + state: 'absent' diff --git a/docs/modules/info.rst b/docs/modules/info.rst index 16d2fd2..cd7377b 100644 --- a/docs/modules/info.rst +++ b/docs/modules/info.rst @@ -33,97 +33,98 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 - ``vol``. + Volumes - \ :literal:`vol`\ . - All the nodes - ``node``. + All the nodes - \ :literal:`node`\ . - Volume groups - ``vg``. + Volume groups - \ :literal:`vg`\ . - Protection policies - ``protection_policy``. + Protection policies - \ :literal:`protection\_policy`\ . - Hosts - ``host``. + Hosts - \ :literal:`host`\ . - Host groups - ``hg``. + Host groups - \ :literal:`hg`\ . - Snapshot rules - ``snapshot_rule``. + Snapshot rules - \ :literal:`snapshot\_rule`\ . - NAS servers - ``nas_server``. + NAS servers - \ :literal:`nas\_server`\ . - NFS exports - ``nfs_export``. + NFS exports - \ :literal:`nfs\_export`\ . - SMB shares - ``smb_share``. + SMB shares - \ :literal:`smb\_share`\ . - Tree quotas - ``tree_quota``. + Tree quotas - \ :literal:`tree\_quota`\ . - User quotas - ``user_quota``. + User quotas - \ :literal:`user\_quota`\ . - File systems - ``file_system``. + File systems - \ :literal:`file\_system`\ . - Replication rules - ``replication_rule``. + Replication rules - \ :literal:`replication\_rule`\ . - Replication sessions - ``replication_session``. + Replication sessions - \ :literal:`replication\_session`\ . - Remote systems - ``remote_system``. + Remote systems - \ :literal:`remote\_system`\ . - Various networks - ``network``. + Various networks - \ :literal:`network`\ . - Roles - ``role``. + Roles - \ :literal:`role`\ . - Local users - ``user``. + Local users - \ :literal:`user`\ . - Appliances - ``appliance``. + Appliances - \ :literal:`appliance`\ . - Security configurations - ``security_config``. + Security configurations - \ :literal:`security\_config`\ . - Certificates - ``certificate``. + Certificates - \ :literal:`certificate`\ . - Active directories - ``ad``. + Active directories - \ :literal:`ad`\ . - LDAPs - ``ldap``. + LDAPs - \ :literal:`ldap`\ . - DNS servers - ``dns``. + DNS servers - \ :literal:`dns`\ . - NTP servers - ``ntp``. + NTP servers - \ :literal:`ntp`\ . - Email notification destinations - ``email_notification``. + Email notification destinations - \ :literal:`email\_notification`\ . - SMTP configurations - ``smtp_config``. + SMTP configurations - \ :literal:`smtp\_config`\ . - Remote Support - ``remote_support``. + Remote Support - \ :literal:`remote\_support`\ . - Remote support contacts - ``remote_support_contact``. + Remote support contacts - \ :literal:`remote\_support\_contact`\ . - LDAP accounts - ``ldap_account``. + LDAP accounts - \ :literal:`ldap\_account`\ . - LDAP domain - ``ldap_domain``. + LDAP domain - \ :literal:`ldap\_domain`\ . - All vCenters - ``vcenter``. + All vCenters - \ :literal:`vcenter`\ . - Virtual volumes - ``virtual_volume``. + Virtual volumes - \ :literal:`virtual\_volume`\ . - Storage containers - ``storage_container``. + Storage containers - \ :literal:`storage\_container`\ . - Replication groups - ``replication_group``. + Replication groups - \ :literal:`replication\_group`\ . - Discovered appliances - ``discovered_appliance``. + Discovered appliances - \ :literal:`discovered\_appliance`\ . filters (optional, list, None) A list of filters to support filtered output for storage entities. - Each filter is a list of *filter_key*, *filter_operator*, *filter_value*. + Each filter is a list of \ :emphasis:`filter\_key`\ , \ :emphasis:`filter\_operator`\ , \ :emphasis:`filter\_value`\ . Supports passing of multiple filters. @@ -144,7 +145,7 @@ Parameters all_pages (optional, bool, False) Indicates whether to return all available entities on the storage system. - 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. + 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. array_ip (True, str, None) @@ -154,9 +155,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -186,8 +187,8 @@ Notes ----- .. note:: - - 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. + - 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. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -369,11 +370,11 @@ Examples user: "{{user}}" password: "{{password}}" gather_subset: - - email_notification + - email_notification filters: - - filter_key: 'notify_minor' - filter_operator: 'equal' - filter_value: 'false' + - filter_key: 'notify_minor' + filter_operator: 'equal' + filter_value: 'false' - name: Get list of LDAP accounts dellemc.powerstore.info: @@ -391,11 +392,11 @@ Examples user: "{{user}}" password: "{{password}}" gather_subset: - - ldap_account + - ldap_account filters: - - filter_key: 'type' - filter_operator: 'equal' - filter_value: 'User' + - filter_key: 'type' + filter_operator: 'equal' + filter_value: 'User' - name: Get list of LDAP domain dellemc.powerstore.info: @@ -413,11 +414,11 @@ Examples user: "{{user}}" password: "{{password}}" gather_subset: - - ldap_domain + - ldap_domain filters: - - filter_key: 'protocol' - filter_operator: 'equal' - filter_value: 'LDAPS' + - filter_key: 'protocol' + filter_operator: 'equal' + filter_value: 'LDAPS' - name: Get list of vCenters dellemc.powerstore.info: @@ -457,7 +458,7 @@ changed (always, bool, false) Shows whether or not the resource has changed. -Array_Software_Version (always, str, 2.1.0.0) +Array_Software_Version (always, str, 3.0.0.0) API version of PowerStore array. @@ -539,7 +540,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, ) @@ -790,7 +791,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 ``false``. + Whether or not the catalog is global. Default value is \ :literal:`false`\ . user_id_attribute (, str, ) @@ -826,7 +827,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, ) @@ -972,7 +973,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. @@ -1226,7 +1227,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, ) @@ -1384,15 +1385,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 28bb905..e4230b8 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -73,7 +73,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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 19e07c0..d12acc0 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all other operations except delete, it should be set to ``present``. + For all other operations except delete, it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -107,7 +107,7 @@ Notes ----- .. note:: - - The *check_mode* is supported. + - The \ :emphasis:`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 7c99fc0..03394a8 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *ldap_servers* and *ldap_server_state* are required together. + The \ :emphasis:`ldap\_servers`\ and \ :emphasis:`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 ``sAMAccountName``. + Default value is \ :literal:`sAMAccountName`\ . user_object_class (optional, str, None) LDAP object class for users. - Default value is ``user``. + Default value is \ :literal:`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 ``cn``. + Default value is \ :literal:`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 ``member``. + Default value is \ :literal:`member`\ . group_object_class (optional, str, None) LDAP object class for groups. - Default value is ``group``. + Default value is \ :literal:`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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all other operations except delete, it should be set to ``present``. + For all other operations except delete, it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -191,10 +191,10 @@ Notes ----- .. note:: - - The *is_global_catalog* option can be enabled only for AD server type. + - The \ :emphasis:`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 *check_mode* is supported. + - The \ :emphasis:`check\_mode`\ is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -270,7 +270,7 @@ Examples password: "{{password}}" ldap_domain_name: "{{domain_name}}" ldap_servers: - - "10.xxx.xx.xx" + - "10.xxx.xx.xx" ldap_server_state: "present-in-domain" ldap_server_type: "AD" bind_user: "{{bind_user}}" @@ -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 3c869b0..2858746 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *user_id*. + Name of the local user account. Mutually exclusive with \ :emphasis:`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 *user_name*. + Mutually exclusive with \ :emphasis:`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 *role_id*. + It is mutually exclusive with \ :emphasis:`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 *role_name*. + It is mutually exclusive with \ :emphasis:`role\_name`\ . is_locked (optional, bool, None) Whether the user account is locked or not. - Defaults to ``false`` at creation time. + Defaults to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -113,7 +113,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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 dc798ac..f18f5bb 100644 --- a/docs/modules/nasserver.rst +++ b/docs/modules/nasserver.rst @@ -21,21 +21,22 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. + Parameters ---------- nas_server_name (optional, str, None) - Name of the NAS server. Mutually exclusive with *nas_server_id*. + Name of the NAS server. Mutually exclusive with \ :emphasis:`nas\_server\_id`\ . nas_server_id (optional, str, None) - Unique id of the NAS server. Mutually exclusive with *nas_server_name*. + Unique id of the NAS server. Mutually exclusive with \ :emphasis:`nas\_server\_name`\ . description (optional, str, None) @@ -69,7 +70,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 *protection_policy* parameter. + Policy can be removed by passing an empty string in the \ :emphasis:`protection\_policy`\ parameter. is_username_translation_enabled (optional, bool, None) @@ -93,9 +94,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +126,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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. @@ -138,83 +139,81 @@ Examples .. code-block:: yaml+jinja - - - name: Create a NAS Server - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "test-nas-server" - description: "NAS Server test" - current_unix_directory_service: "LDAP" - default_unix_user: "user1" - default_windows_user: "user2" - is_username_translation_enabled: true - is_auto_user_mapping_enabled: true - protection_policy: "ansible_policy" - state: "present" - - - name: Get details of NAS Server by name - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "{{ nas_server_name }}" - state: "present" - - - name: Get Details of NAS Server by ID - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - state: "present" - - - name: Rename NAS Server by Name - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "{{ nas_server_name }}" - nas_server_new_name : "{{ nas_server_new_name }}" - state: "present" - - - name: Modify NAS Server attributes by ID - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - current_unix_directory_service: "LOCAL_FILES" - current_node: "{{ cur_node_n1 }}" - preferred_node: "{{ prefered_node }}" - protection_policy: "protection_policy_1" - state: "present" - - - name: Remove protection policy - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - protection_policy: "" - state: "present" - - - name: Delete NAS Server - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - state: "absent" - + - name: Create a NAS Server + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "test-nas-server" + description: "NAS Server test" + current_unix_directory_service: "LDAP" + default_unix_user: "user1" + default_windows_user: "user2" + is_username_translation_enabled: true + is_auto_user_mapping_enabled: true + protection_policy: "ansible_policy" + state: "present" + + - name: Get details of NAS Server by name + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "{{ nas_server_name }}" + state: "present" + + - name: Get Details of NAS Server by ID + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + state: "present" + + - name: Rename NAS Server by Name + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "{{ nas_server_name }}" + nas_server_new_name: "{{ nas_server_new_name }}" + state: "present" + + - name: Modify NAS Server attributes by ID + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + current_unix_directory_service: "LOCAL_FILES" + current_node: "{{ cur_node_n1 }}" + preferred_node: "{{ prefered_node }}" + protection_policy: "protection_policy_1" + state: "present" + + - name: Remove protection policy + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + protection_policy: "" + state: "present" + + - name: Delete NAS Server + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + state: "absent" @@ -282,23 +281,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 796c620..f97dd54 100644 --- a/docs/modules/network.rst +++ b/docs/modules/network.rst @@ -21,12 +21,13 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. + Parameters ---------- @@ -35,7 +36,7 @@ Parameters This parameter is added in 2.0.0.0. - Specify either *network_name* or *network_id* for any operation. + Specify either \ :emphasis:`network\_name`\ or \ :emphasis:`network\_id`\ for any operation. network_id (optional, str, None) @@ -128,7 +129,7 @@ Parameters wait_for_completion (optional, bool, False) - Flag to indicate if the operation should be run synchronously or asynchronously. ``true`` signifies synchronous execution. By default, modify operation will run ``asynchronously``. + 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`\ . state (True, str, None) @@ -142,9 +143,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -175,9 +176,9 @@ Notes .. note:: - It is recommended to perform task asynchronously while changing cluster management address. - - 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. + - 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. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -226,12 +227,12 @@ Examples password: "{{password}}" network_id: "NW1" addresses: - - current_address: "100.230.x.x" - new_address: "100.230.x.x" - - current_address: "100.230.x.x" - new_address: "100.230.x.x" - - current_address: "100.230.x.x" - new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" new_cluster_mgmt_address: "100.230.x.x" vasa_provider_credentials: username: "vmadmin" @@ -246,7 +247,7 @@ Examples password: "{{password}}" network_id: "NW6" ports: - - "IP1" + - "IP1" port_state: "present-in-network" state: "present" @@ -258,7 +259,7 @@ Examples password: "{{password}}" network_id: "NW6" ports: - - "IP1" + - "IP1" port_state: "absent-in-network" state: "present" @@ -275,25 +276,25 @@ Examples mtu: 1500 prefix_length: 24 addresses: - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" new_cluster_mgmt_address: "100.231.x.x" vasa_provider_credentials: username: "vmadmin" password: "{{vm_password}}" esxi_credentials: - - "node_id": "N1" - "password": "{{node_password}}" - - "node_id": "N2" - "password": "{{node_password}}" + - "node_id": "N1" + "password": "{{node_password}}" + - "node_id": "N2" + "password": "{{node_password}}" state: "present" diff --git a/docs/modules/nfs.rst b/docs/modules/nfs.rst index d028446..4d798ba 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -35,7 +35,7 @@ Parameters Mandatory for create operation. - Specify either *nfs_export_name* or *nfs_export_id* but not both for any operation. + Specify either \ :emphasis:`nfs\_export\_name`\ or \ :emphasis:`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 *nas_server* is required to uniquely identify the filesystem. + If filesystem name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the filesystem. - If *filesystem* parameter is provided, then *snapshot* cannot be specified. + If \ :emphasis:`filesystem`\ parameter is provided, then \ :emphasis:`snapshot`\ cannot be specified. snapshot (optional, str, None) The ID/Name of the Snapshot for which NFS export will be created. - Either *filesystem* or *snapshot* is required for creation of the NFS Export. + Either \ :emphasis:`filesystem`\ or \ :emphasis:`snapshot`\ is required for creation of the NFS Export. - If snapshot name is specified, then *nas_server* is required to uniquely identify the snapshot. + If snapshot name is specified, then \ :emphasis:`nas\_server`\ is required to uniquely identify the snapshot. - If *snapshot* parameter is provided, then *filesystem* cannot be specified. + If \ :emphasis:`snapshot`\ parameter is provided, then \ :emphasis:`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 *default_access* is not mentioned during creation, then NFS export will be created with ``No_Access``. + If \ :emphasis:`default\_access`\ is not mentioned during creation, then NFS export will be created with \ :literal:`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 ``SYS``. + If not specified at the time of creation, it will be set to \ :literal:`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 ``false``. + If not specified at the time of creation, it will be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -181,7 +181,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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/ntp.rst b/docs/modules/ntp.rst index 84fba02..3e6fdc7 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *ntp_addresses*. + State of the addresses mentioned in \ :emphasis:`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 ``present``. + For get and modify operations it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *ntp_addresses* and *ntp_address_state* are required together. + - Parameters \ :emphasis:`ntp\_addresses`\ and \ :emphasis:`ntp\_address\_state`\ are required together. - Creation and deletion of NTP is not supported. - - The *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -102,39 +102,39 @@ Examples .. code-block:: yaml+jinja - - name: Get details of NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - state: "present" - - - name: Add addresses to NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - ntp_addresses: - - "XX.XX.XX.XX" - - "YY.YY.YY.YY" - ntp_address_state: "present-in-ntp" - state: "present" - - - name: Remove addresses from NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - ntp_addresses: - - "YY.YY.YY.YY" - ntp_address_state: "absent-in-ntp" - state: "present" + - name: Get details of NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + state: "present" + + - name: Add addresses to NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + ntp_addresses: + - "XX.XX.XX.XX" + - "YY.YY.YY.YY" + ntp_address_state: "present-in-ntp" + state: "present" + + - name: Remove addresses from NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + ntp_addresses: + - "YY.YY.YY.YY" + ntp_address_state: "absent-in-ntp" + state: "present" diff --git a/docs/modules/protectionpolicy.rst b/docs/modules/protectionpolicy.rst index edc4e97..b8ba1f3 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all other operations like Create, Modify or Get details, it should be set to ``present``. + For all other operations like Create, Modify or Get details, it should be set to \ :literal:`present`\ . snapshotrule_state (False, str, None) @@ -71,9 +71,9 @@ Parameters When snapshot rules are specified, this variable is required. - Value ``present-in-policy`` indicates to add to protection policy. + Value \ :literal:`present-in-policy`\ indicates to add to protection policy. - Value ``absent-in-policy`` indicates to remove from protection policy. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -144,8 +144,7 @@ Examples snapshotrule_state: "present-in-policy" state: "present" - - - name : Modify protection policy, change name + - name: Modify protection policy, change name dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -155,8 +154,7 @@ Examples new_name: "{{new_name}}" state: "present" - - - name : Modify protection policy, add snapshot rule + - name: Modify protection policy, add snapshot rule dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -168,7 +166,7 @@ Examples snapshotrule_state: "present-in-policy" state: "present" - - name : Modify protection policy, remove snapshot rule, replication rule + - name: Modify protection policy, remove snapshot rule, replication rule dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -181,7 +179,7 @@ Examples snapshotrule_state: "absent-in-policy" state: "present" - - name : Get details of protection policy by name + - name: Get details of protection policy by name dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -190,7 +188,7 @@ Examples name: "{{name}}" state: "present" - - name : Get details of protection policy by ID + - name: Get details of protection policy by ID dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -199,7 +197,7 @@ Examples protectionpolicy_id: "{{protectionpolicy_id}}" state: "present" - - name : Delete protection policy + - name: Delete protection policy dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" diff --git a/docs/modules/quota.rst b/docs/modules/quota.rst index d192248..e555d7f 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *path* is not specified, quota will be created at the root of the filesystem. + For user quota, if \ :emphasis:`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 *quota_id* is mentioned, then *path*/*nas_server*/*file_system*/*quota_type* is not required. + If \ :emphasis:`quota\_id`\ is mentioned, then \ :emphasis:`path`\ /\ :emphasis:`nas\_server`\ /\ :emphasis:`file\_system`\ /\ :emphasis:`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 *nas_server* is required to uniquely identify the filesystem. + If filesystem name is specified, then \ :emphasis:`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 *quota_type* is ``tree``. + Description parameter can only be used when \ :emphasis:`quota\_type`\ is \ :literal:`tree`\ . unix_name (optional, str, None) The name of the unix user account for which quota operations will be performed. - Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. + Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`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 ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. + Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . uid (optional, int, None) The ID of the unix user account for which quota operations will be performed. - Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. + Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`user`\ . windows_sid (optional, str, None) The SID of the Windows User account for which quota operations will be performed. - Any one among ``uid``/``unix_name``/``windows_name``/``windows_sid`` is required when *quota_type* is ``user``. + Any one among \ :literal:`uid`\ /\ :literal:`unix\_name`\ /\ :literal:`windows\_name`\ /\ :literal:`windows\_sid`\ is required when \ :emphasis:`quota\_type`\ is \ :literal:`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 ``0``. + No Soft limit when set to \ :literal:`0`\ . hard_limit (optional, int, None) Hard limit of the user quota. - No hard limit when set to ``0``. + No hard limit when set to \ :literal:`0`\ . cap_unit (optional, str, GB) @@ -116,9 +116,9 @@ Parameters state (True, str, None) Define whether the Quota should exist or not. - Value ``present`` indicates that the Quota should exist on the system. + Value \ :literal:`present`\ indicates that the Quota should exist on the system. - Value ``absent`` indicates that the Quota should not exist on the system. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *nas_server* is not required. If passed, then filesystem should exist for the *nas_server*, else the task will fail. + - 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. - 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. - - ``Delete`` User Quota operation is not supported. - - The *check_mode* is not supported. + - \ :literal:`Delete`\ User Quota operation is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -179,85 +179,83 @@ Examples .. code-block:: yaml+jinja - - - name: Create a Quota for a User using unix name - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "user" - unix_name: "{{unix_name}}" - filesystem: "sample_fs" - nas_server: "{{nas_server_id}}" - quota: - soft_limit: 5 - hard_limit: 10 - cap_unit: "TB" - state: "present" - - - name: Create a Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "tree" - path: "/home" - filesystem: "sample_fs" - nas_server: "sample_nas_server" - quota: - soft_limit: 5 - hard_limit: 10 - cap_unit: "TB" - state: "present" - - - name: Modify attributes for Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_id: "{{quota_id}}" - quota: - soft_limit: 10 - hard_limit: 15 - cap_unit: "TB" - state: "present" - - - name: Get details of User Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "user" - uid: 100 - path: "/home" - filesystem: "{{filesystem_id}}" - state: "present" - - - name: Get details of Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_id: "{{quota_id}}" - state: "present" - - - name: Delete a Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "tree" - path: "/home" - filesystem: "sample_fs" - nas_server: "sample_nas_server" - state: "absent" - + - name: Create a Quota for a User using unix name + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "user" + unix_name: "{{unix_name}}" + filesystem: "sample_fs" + nas_server: "{{nas_server_id}}" + quota: + soft_limit: 5 + hard_limit: 10 + cap_unit: "TB" + state: "present" + + - name: Create a Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "tree" + path: "/home" + filesystem: "sample_fs" + nas_server: "sample_nas_server" + quota: + soft_limit: 5 + hard_limit: 10 + cap_unit: "TB" + state: "present" + + - name: Modify attributes for Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_id: "{{quota_id}}" + quota: + soft_limit: 10 + hard_limit: 15 + cap_unit: "TB" + state: "present" + + - name: Get details of User Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "user" + uid: 100 + path: "/home" + filesystem: "{{filesystem_id}}" + state: "present" + + - name: Get details of Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_id: "{{quota_id}}" + state: "present" + + - name: Delete a Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "tree" + path: "/home" + filesystem: "sample_fs" + nas_server: "sample_nas_server" + state: "absent" @@ -293,7 +291,7 @@ quota_details (When Quota exists., complex, {'description': 'Tree quota created nas_server (, dict, ) - nas_server of filesystem. + nas\_server of filesystem. @@ -355,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 fa1095b..d984200 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -41,7 +41,7 @@ Parameters Mandatory for modify and verify operation. - ``SRS_Gateway``, *support_type* is only supported for verify operation. + \ :literal:`SRS\_Gateway`\ , \ :emphasis:`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 ``false`` when two servers are configured. + One server must be set to \ :literal:`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 *remote_support_servers*. + Required with \ :emphasis:`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. ``true`` signifies synchronous execution. By default, modify operation will run asynchronously. + Flag to indicate if the operation should be run synchronously or asynchronously. \ :literal:`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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For get/modify operation it should be set to ``present``. + For get/modify operation it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not available for this module. + - Support for \ :emphasis:`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. @@ -180,73 +180,72 @@ Examples .. code-block:: yaml+jinja - - - name: Get details of remote support configuration - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - state: "present" - - - name: Modify remote support configuration - SRS_Gateway_Tier2 - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Gateway_Tier2" - remote_support_servers: + - name: Get details of remote support configuration + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + state: "present" + + - name: Modify remote support configuration - SRS_Gateway_Tier2 + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Gateway_Tier2" + remote_support_servers: - address: "10.XX.XX.XX" port: 9443 is_primary: true - address: "10.XX.XX.YY" port: 9443 is_primary: false - server_state: "present-in-server" - is_rsc_enabled: true - is_cloudiq_enabled: false - timeout: 300 - state: "present" - - - name: Modify remote support configuration - SRS_Integrated_Tier2 - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Integrated_Tier2" - proxy_address: "10.XX.XX.ZZ" - proxy_port: 3128 - proxy_username: "user" - proxy_password: "password" - timeout: 300 - state: "present" - - - name: Verify remote support configuration - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Integrated_Tier3" - timeout: 300 - verify_connection: true - state: "present" - - - name: Send a test alert - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - send_test_alert: true - state: "present" + server_state: "present-in-server" + is_rsc_enabled: true + is_cloudiq_enabled: false + timeout: 300 + state: "present" + + - name: Modify remote support configuration - SRS_Integrated_Tier2 + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Integrated_Tier2" + proxy_address: "10.XX.XX.ZZ" + proxy_port: 3128 + proxy_username: "user" + proxy_password: "password" + timeout: 300 + state: "present" + + - name: Verify remote support configuration + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Integrated_Tier3" + timeout: 300 + verify_connection: true + state: "present" + + - name: Send a test alert + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + send_test_alert: true + state: "present" diff --git a/docs/modules/remote_support_contact.rst b/docs/modules/remote_support_contact.rst index 39ba7f7..af69bfd 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For get/modify operation it should be set to ``present``. + For get/modify operation it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *first_name*, *last_name*, *email* and *phone* can be removed by passing empty string. - - The *check_mode* 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. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -111,28 +111,27 @@ Examples .. code-block:: yaml+jinja - - - name: Get details of remote support contact - dellemc.powerstore.remote_support_contact: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - contact_id: 0 - state: "present" - - - name: Modify remote support contact - dellemc.powerstore.remote_support_contact: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - contact_id: 0 - first_name: "abc" - last_name: "xyz" - phone: "111-222-333-444" - email: "abc_xyz@dell.com" - state: "present" + - name: Get details of remote support contact + dellemc.powerstore.remote_support_contact: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + contact_id: 0 + state: "present" + + - name: Modify remote support contact + dellemc.powerstore.remote_support_contact: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + contact_id: 0 + first_name: "abc" + last_name: "xyz" + phone: "111-222-333-444" + email: "abc_xyz@dell.com" + state: "present" diff --git a/docs/modules/remotesystem.rst b/docs/modules/remotesystem.rst index 9d7cb42..b20f0dd 100644 --- a/docs/modules/remotesystem.rst +++ b/docs/modules/remotesystem.rst @@ -23,19 +23,20 @@ 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 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. + Parameters ---------- remote_name (optional, str, None) Name of the remote system. - Parameter *remote_name* cannot be mentioned during addition of a new remote system. + Parameter \ :emphasis:`remote\_name`\ cannot be mentioned during addition of a new remote system. remote_id (optional, str, None) @@ -43,7 +44,7 @@ Parameters ID for the remote system is autogenerated, cannot be passed during creation of a remote system. - Parameter *remote_id* and *remote_address* are mutually exclusive. + Parameter \ :emphasis:`remote\_id`\ and \ :emphasis:`remote\_address`\ are mutually exclusive. remote_user (optional, str, None) @@ -61,7 +62,7 @@ Parameters remote_address (optional, str, None) Management IP of the remote system. - Parameter *remote_id* and *remote_address* are mutually exclusive. + Parameter \ :emphasis:`remote\_id`\ and \ :emphasis:`remote\_address`\ are mutually exclusive. new_remote_address (optional, str, None) @@ -91,7 +92,7 @@ Parameters wait_for_completion (optional, bool, False) Flag to indicate if the operation should be run synchronously or asynchronously. - ``true`` signifies synchronous execution. + \ :literal:`true`\ signifies synchronous execution. By default, modify and delete operation will run asynchronously. @@ -99,9 +100,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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all Create, Modify or Get details operations it should be set to ``present``. + For all Create, Modify or Get details operations it should be set to \ :literal:`present`\ . array_ip (True, str, None) @@ -111,9 +112,9 @@ Parameters 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. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -145,10 +146,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 *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. + - 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. - By default, the timeout is set to 120 seconds. - - The *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -268,9 +269,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 c6c3748..2241e86 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -37,7 +37,7 @@ Parameters Required during creation of a replication rule. - Parameter *replication_rule_name* and *replication_rule_id* are mutually exclusive. + Parameter \ :emphasis:`replication\_rule\_name`\ and \ :emphasis:`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 *replication_rule_name* and *replication_rule_id* are mutually exclusive. + Parameter \ :emphasis:`replication\_rule\_name`\ and \ :emphasis:`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 *remote_system* parameter is not unique on the PowerStore Array. + It is required in case the remote system name passed in \ :emphasis:`remote\_system`\ parameter is not unique on the PowerStore Array. - If ID of the remote system is passed then no need to pass *remote_system_address*. + If ID of the remote system is passed then no need to pass \ :emphasis:`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 ``absent``. + For Delete operation only, it should be set to \ :literal:`absent`\ . - For all Create, Modify or Get details operations it should be set to ``present``. + For all Create, Modify or Get details operations it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +125,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`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 e7807d1..c8edeff 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. nas_server (optional, str, None) Name/ID of the NAS server for which replication session exists. - Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. volume_group (optional, str, None) Name/ID of the volume group for which a replication session exists. - Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. volume (optional, str, None) Name/ID of the volume for which replication session exists. - Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. replication_group (optional, str, None) Name or ID of the replication group for which replication session exists. - Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`session\_id`\ are mutually exclusive. session_id (optional, str, None) ID of the replication session. - Parameter *filesystem*, *nas_server*, *volume_group*, *volume*, *replication_group*, and *session_id* are mutually exclusive. + Parameter \ :emphasis:`filesystem`\ , \ :emphasis:`nas\_server`\ , \ :emphasis:`volume\_group`\ , \ :emphasis:`volume`\ , \ :emphasis:`replication\_group`\ , and \ :emphasis:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 ``synchronizing``, then it will return "changed" as false. + - When the current state of the replication session is 'OK' and in the playbook task \ :literal:`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 *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 \ :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 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 9883cf5..0e26e92 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``present``, indicates that the role should exist on the system. + Value \ :literal:`present`\ , indicates that the role should exist on the system. - Value ``absent``, indicates that the role should not exist on the system. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`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 70c909e..ff38b51 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`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/smbshare.rst b/docs/modules/smbshare.rst index 31ff22c..c40176d 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *share_name* or *share_id* is required. + For all other operations either \ :emphasis:`share\_name`\ or \ :emphasis:`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 *share_name* or *share_id* is required. + For all other operations either \ :emphasis:`share\_name`\ or \ :emphasis:`share\_id`\ is required. - If *share_id* is used then no need to pass *nas_server*/*filesystem*/*snapshot*/ *path*. + If \ :emphasis:`share\_id`\ is used then no need to pass \ :emphasis:`nas\_server`\ /\ :emphasis:`filesystem`\ /\ :emphasis:`snapshot`\ / \ :emphasis:`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 *nas_server* is required to uniquely identify the filesystem. + If filesystem name is specified, then \ :emphasis:`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 *nas_server* is required to uniquely identify the snapshot. + If snapshot name is specified, then \ :emphasis:`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 *share_id* is used. + It is not required if \ :emphasis:`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 ``false``. + During creation, if not mentioned, then the default is \ :literal:`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 ``false``. + During creation, if not mentioned then default is \ :literal:`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 ``false``. + During creation, if not mentioned, then the default is \ :literal:`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 ``false``. + During creation, if not mentioned then default is \ :literal:`false`\ . offline_availability (optional, str, None) Defines valid states of Offline Availability. - ``MANUAL``- Only specified files will be available offline. + \ :literal:`MANUAL`\ - Only specified files will be available offline. - ``DOCUMENTS``- All files that users open will be available offline. + \ :literal:`DOCUMENTS`\ - 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:`PROGRAMS`\ - Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline. - ``NONE``- Prevents clients from storing documents and programs in offline cache. + \ :literal:`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 ``present`` indicates that the share should exist on the system. + Value \ :literal:`present`\ indicates that the share should exist on the system. - Value ``absent`` indicates that the share should not exist on the system. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *nas_server* is not required. If passed, then the filesystem/snapshot should exist for the *nas_server*, else the task will fail. + - 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. - Multiple SMB shares can be created for the same local path. - - The *check_mode* is not supported. + - The \ :emphasis:`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 971811a..a181fcd 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``absent`` + For Delete operation only, it should be set to \ :literal:`absent`\ - For all operations it should be set to ``present``. + For all operations it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -113,36 +113,35 @@ Examples .. code-block:: yaml+jinja - - - name: Get details of SMTP configuration - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - state: "present" - - - name: Modify SMTP config details - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - smtp_address: "sample.smtp.com" - source_email: "def@dell.com" - state: "present" - - - name: Send a test mail through the SMTP server - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - destination_email: "abc@dell.com" - state: "present" + - name: Get details of SMTP configuration + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + state: "present" + + - name: Modify SMTP config details + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + smtp_address: "sample.smtp.com" + source_email: "def@dell.com" + state: "present" + + - name: Send a test mail through the SMTP server + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + destination_email: "abc@dell.com" + state: "present" diff --git a/docs/modules/snapshot.rst b/docs/modules/snapshot.rst index fba10f1..df37c2f 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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, ``hours`` is taken as default *retention_unit*. + If this unit is not specified, \ :literal:`hours`\ is taken as default \ :emphasis:`retention\_unit`\ . - If *desired_retention* is specified, *expiration_timestamp* cannot be specified. + If \ :emphasis:`desired\_retention`\ is specified, \ :emphasis:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -121,7 +121,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -133,104 +133,104 @@ Examples .. code-block:: yaml+jinja - - name: Create a volume snapshot on PowerStore - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume: "{{volume}}" - description: "{{description}}" - desired_retention: "{{desired_retention}}" - retention_unit: "{{retention_unit_days}}" - state: "{{state_present}}" - - - name: Get details of a volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume: "{{volume}}" - state: "{{state_present}}" - - - name: Rename volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - new_snapshot_name: "{{new_snapshot_name}}" - volume: "{{volume}}" - state: "{{state_present}}" - - - name: Delete volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{new_snapshot_name}}" - volume: "{{volume}}" - state: "{{state_absent}}" - - - name: Create a volume group snapshot on PowerStore - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - description: "{{description}}" - expiration_timestamp: "{{expiration_timestamp}}" - state: "{{state_present}}" - - - name: Get details of a volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_present}}" - - - name: Modify volume group snapshot expiration timestamp - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - description: "{{description}}" - expiration_timestamp: "{{expiration_timestamp_new}}" - state: "{{state_present}}" - - - name: Rename volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - new_snapshot_name: "{{new_snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_present}}" - - - name: Delete volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{new_snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_absent}}" + - name: Create a volume snapshot on PowerStore + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume: "{{volume}}" + description: "{{description}}" + desired_retention: "{{desired_retention}}" + retention_unit: "{{retention_unit_days}}" + state: "{{state_present}}" + + - name: Get details of a volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume: "{{volume}}" + state: "{{state_present}}" + + - name: Rename volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + new_snapshot_name: "{{new_snapshot_name}}" + volume: "{{volume}}" + state: "{{state_present}}" + + - name: Delete volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{new_snapshot_name}}" + volume: "{{volume}}" + state: "{{state_absent}}" + + - name: Create a volume group snapshot on PowerStore + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + description: "{{description}}" + expiration_timestamp: "{{expiration_timestamp}}" + state: "{{state_present}}" + + - name: Get details of a volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_present}}" + + - name: Modify volume group snapshot expiration timestamp + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + description: "{{description}}" + expiration_timestamp: "{{expiration_timestamp_new}}" + state: "{{state_present}}" + + - name: Rename volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + new_snapshot_name: "{{new_snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_present}}" + + - name: Delete volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{new_snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_absent}}" diff --git a/docs/modules/snapshotrule.rst b/docs/modules/snapshotrule.rst index b25f87a..8336cf2 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *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 \ :emphasis:`time\_of\_day`\ parameter is set. - 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. + 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. interval (False, str, None) String variable. Indicates the interval between Snapshots. - When creating a Snapshot rule, specify either *interval* or *time_of_day*, but not both. + When creating a Snapshot rule, specify either \ :emphasis:`interval`\ or \ :emphasis:`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 *interval* or *time_of_day* but not both. + When creating a Snapshot rule, specify either \ :emphasis:`interval`\ or \ :emphasis:`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. - ``true`` specifies to delete all previously created Snapshots by this rule while deleting this rule. + \ :literal:`true`\ specifies to delete all previously created Snapshots by this rule while deleting this rule. - ``false`` specifies to retain all previously created Snapshots while deleting this rule. + \ :literal:`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 ``absent``. + For "Delete" operation only, it should be set to \ :literal:`absent`\ . - For all Create, Modify or Get details operation it should be set to ``present``. + For all Create, Modify or Get details operation it should be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -125,7 +125,7 @@ Notes ----- .. note:: - - The *check_mode* is not supported. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -137,7 +137,6 @@ Examples .. code-block:: yaml+jinja - - name: Get details of an existing snapshot rule by name dellemc.powerstore.snapshotrule: array_ip: "{{array_ip}}" @@ -165,7 +164,7 @@ Examples name: "{{name}}" interval: "{{interval}}" days_of_week: - - Monday + - Monday desired_retention: "{{desired_retention}}" state: "present" diff --git a/docs/modules/storage_container.rst b/docs/modules/storage_container.rst index 3dff1c8..8079f38 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``0`` means there is no limit. + A value of \ :literal:`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. - ``SCSI`` is set when a storage container is dedicated to ``SCSI`` usage. + \ :literal:`SCSI`\ is set when a storage container is dedicated to \ :literal:`SCSI`\ usage. - ``NVMe`` is set when a storage container is dedicated to ``NVMe`` usage. + \ :literal:`NVMe`\ is set when a storage container is dedicated to \ :literal:`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 ``absent``. + For Delete operation only, it should be set to \ :literal:`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 ``absent``. + To delete storage container destination, it should be \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -174,7 +174,7 @@ Notes ----- .. note:: - - The *check_mode* is supported. + - The \ :emphasis:`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. @@ -245,7 +245,7 @@ Examples user: "{{user}}" password: "{{password}}" storage_container_name: "Ansible_storage_container_1" - force_delete: True + force_delete: true state: "absent" - name: Delete a storage container using id @@ -265,12 +265,12 @@ Examples validate_certs: "{{validate_certs}}" storage_container_name: "local_storage_container" storage_container_destination: - remote_address: "x.x.x.x" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_system: "remote_system_name" - remote_storage_container: "remote_storage_container_name" + remote_address: "x.x.x.x" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_system: "remote_system_name" + remote_storage_container: "remote_storage_container_name" - name: Delete a storage container destination dellemc.powerstore.storage_container: @@ -281,12 +281,12 @@ Examples storage_container_id: "storage_container_id" storage_container_destination_state: "absent" storage_container_destination: - remote_address: "x.x.x.x" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_system: "remote_system_name" - remote_storage_container: "remote_storage_container_name" + remote_address: "x.x.x.x" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_system: "remote_system_name" + remote_storage_container: "remote_storage_container_name" diff --git a/docs/modules/vcenter.rst b/docs/modules/vcenter.rst index 4190ceb..894ba85 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.0. - Python 3.9, 3.10 or 3.11. @@ -47,7 +47,7 @@ Parameters Mandatory while adding a vCenter. - *vcenter_password* needs to be provided to modify the user name. + \ :emphasis:`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 ``true``, remove the VASA provider from vCenter. This will only happen if provider is not connected to any other PowerStore system. + When \ :literal:`true`\ , remove the VASA provider from vCenter. This will only happen if provider is not connected to any other PowerStore system. - ``false`` is the API default. + \ :literal:`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 ``present``. + For get, create, and modify operations it should be set to \ :literal:`present`\ . update_password (optional, str, always) - This parameter controls the way the *vcenter_password* is updated during addition and modification of the vCenter. + This parameter controls the way the \ :emphasis:`vcenter\_password`\ is updated during addition and modification of the vCenter. - ``always`` will update password for each execution. + \ :literal:`always`\ will update password for each execution. - ``on_create`` will only set while adding a vCenter or modifying the *vcenter_username.* + \ :literal:`on\_create`\ will only set while adding a vCenter or modifying the \ :emphasis:`vcenter\_username.`\ - For modifying *vcenter_password*, set the *update_password* to ``always``. + For modifying \ :emphasis:`vcenter\_password`\ , set the \ :emphasis:`update\_password`\ to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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 *check_mode* is supported. + - The \ :emphasis:`check\_mode`\ is supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -150,49 +150,49 @@ Examples .. code-block:: yaml+jinja - - name: Get details of vCenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - - - name: Add a vcenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - address: "XX.XX.XX.XX" - vcenter_username: "user-name" - vcenter_password: "password" - update_password: "on_create" - vasa_provider_credentials: - username: "admin" - password: "pass" - - - name: Modify a vCenter attribute - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - address: "XX.XX.XX.YY" - vcenter_username: "user-name" - vcenter_password: "password" - update_password: "always" - - - name: Remove a vcenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - delete_vasa_provider: true - state: "absent" + - name: Get details of vCenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + + - name: Add a vcenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + address: "XX.XX.XX.XX" + vcenter_username: "user-name" + vcenter_password: "password" + update_password: "on_create" + vasa_provider_credentials: + username: "admin" + password: "pass" + + - name: Modify a vCenter attribute + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + address: "XX.XX.XX.YY" + vcenter_username: "user-name" + vcenter_password: "password" + update_password: "always" + + - name: Remove a vcenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + delete_vasa_provider: true + state: "absent" @@ -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 a8a8923..c371519 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 ``GB``, if not specified. + It defaults to \ :literal:`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 *app_type* is set to ``*Other`` types. + Application type for volume when \ :emphasis:`app\_type`\ is set to \ :literal:`\*Other`\ types. appliance_id (optional, str, None) ID of the appliance on which the volume is provisioned. - *appliance_id* and *appliance_name* are mutually exclusive. + \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. appliance_name (optional, str, None) Name of the appliance on which the volume is provisioned. - *appliance_id* and *appliance_name* are mutually exclusive. + \ :emphasis:`appliance\_id`\ and \ :emphasis:`appliance\_name`\ are mutually exclusive. protection_policy (optional, str, None) - The *protection_policy* of the volume. + The \ :emphasis:`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 *performance_policy* for the volume. + The \ :emphasis:`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 ``medium``. + If not given, performance policy will be \ :literal:`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 ``mapped`` - indicates that the volume should be mapped to the host or host group. + Value \ :literal:`mapped`\ - indicates that the volume should be mapped to the host or host group. - Value ``unmapped`` - indicates that the volume should not 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. 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 ``mapped`` volume. + logical unit number when creating a \ :literal:`mapped`\ volume. - If no ``host_id`` or ``host_group_id`` is specified, ``logical_unit_number`` is ignored. + If no \ :literal:`host\_id`\ or \ :literal:`host\_group\_id`\ is specified, \ :literal:`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 ``present`` - indicates that the volume should exist on the system. + Value \ :literal:`present`\ - indicates that the volume should exist on the system. - Value ``absent`` - indicates that the volume should not exist on the system. + Value \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`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, *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. + - 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. - 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 *Check_mode* is not supported. + - The \ :emphasis:`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 0d50458..d9c0801 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.13 or later. -- PyPowerStore 2.0.0. +- Ansible-core 2.14 or later. +- PyPowerStore 2.1.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 *vol_state* should also be specified. + If volumes are given, then \ :emphasis:`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 *vol_state* should also be specified. + If volume is given, then \ :emphasis:`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 ``true``. + If this parameter is not specified, the array by default sets it to \ :literal:`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 ``true``. + If not specified it will be set to \ :literal:`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. - ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. + \ :literal:`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. + \ :literal:`false`\ - indicates that the SSL certificate should not be verified. user (True, str, None) @@ -167,11 +167,11 @@ Notes ----- .. note:: - - Parameter *vol_state* is mandatory if volumes are provided. + - Parameter \ :emphasis:`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 *protection_policy* as empty string or "" removes the existing protection policy from a volume group. - - The *check_mode* is not supported. + - Specifying \ :emphasis:`protection\_policy`\ as empty string or "" removes the existing protection policy from a volume group. + - The \ :emphasis:`check\_mode`\ is not supported. - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform. @@ -268,7 +268,7 @@ Examples source_vg: "vg_source" create_backup_snap: true backup_snap_profile: - name: "test_snap" + name: "test_snap" state: "present" - name: Restore a volume group @@ -281,7 +281,7 @@ Examples source_snap: "snap_source" create_backup_snap: true backup_snap_profile: - name: "test_snap_restore" + name: "test_snap_restore" state: "present" - name: Clone a volume group @@ -292,8 +292,8 @@ Examples password: "{{password}}" vg_name: "ansible_vg" vg_clone: - name: "ansible_vg_clone" - protection_policy: "policy1" + name: "ansible_vg_clone" + protection_policy: "policy1" state: "present" diff --git a/galaxy.yml b/galaxy.yml index e22756b..24982bd 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: 2.2.0 +version: 3.0.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/2.2.0 +repository: https://github.com/dell/ansible-powerstore/tree/3.0.0 # The URL to any online docs -documentation: https://github.com/dell/ansible-powerstore/tree/2.2.0/docs +documentation: https://github.com/dell/ansible-powerstore/tree/3.0.0/docs # The URL to the homepage of the collection/project -homepage: https://github.com/dell/ansible-powerstore/tree/2.2.0 +homepage: https://github.com/dell/ansible-powerstore/tree/3.0.0 # The URL to the collection issue tracker issues: https://www.dell.com/community/Automation/bd-p/Automation diff --git a/meta/runtime.yml b/meta/runtime.yml index 5a434ef..fda6960 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,5 +1,5 @@ --- -requires_ansible: ">=2.12" +requires_ansible: ">=2.14.0" plugin_routing: modules: dellemc_powerstore_gatherfacts: diff --git a/plugins/modules/certificate.py b/plugins/modules/certificate.py index d231010..0ef368a 100644 --- a/plugins/modules/certificate.py +++ b/plugins/modules/certificate.py @@ -262,7 +262,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreCertificate(object): diff --git a/plugins/modules/cluster.py b/plugins/modules/cluster.py index bd775f3..5ae8828 100644 --- a/plugins/modules/cluster.py +++ b/plugins/modules/cluster.py @@ -627,7 +627,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreCluster(object): diff --git a/plugins/modules/dns.py b/plugins/modules/dns.py index 910e290..c4cf177 100644 --- a/plugins/modules/dns.py +++ b/plugins/modules/dns.py @@ -51,39 +51,39 @@ ''' EXAMPLES = r''' - - name: Get details of DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - state: "present" - - - name: Add addresses to DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - dns_addresses: - - "XX.XX.XX.XX" - - "YY.YY.YY.YY" - dns_address_state: "present-in-dns" - state: "present" - - - name: Remove addresses from DNS instance - dellemc.powerstore.dns: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - dns_id: "DNS1" - dns_addresses: - - "YY.YY.YY.YY" - dns_address_state: "absent-in-dns" - state: "present" +- name: Get details of DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + state: "present" + +- name: Add addresses to DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + dns_addresses: + - "XX.XX.XX.XX" + - "YY.YY.YY.YY" + dns_address_state: "present-in-dns" + state: "present" + +- name: Remove addresses from DNS instance + dellemc.powerstore.dns: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + dns_id: "DNS1" + dns_addresses: + - "YY.YY.YY.YY" + dns_address_state: "absent-in-dns" + state: "present" ''' RETURN = r''' @@ -127,7 +127,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreDns(object): diff --git a/plugins/modules/email.py b/plugins/modules/email.py index 15c3970..eadac12 100644 --- a/plugins/modules/email.py +++ b/plugins/modules/email.py @@ -79,68 +79,68 @@ ''' EXAMPLES = r''' - - name: Get details of destination email with email_id - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" - state: "present" - - - name: Get details of destination email with email_address - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc@dell.com" - state: "present" - - - name: Create destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc_xyz@dell.com" - notify: - info: true - critical: true - major: false - state: "present" - - - name: Modify destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "abc_xyz@dell.com" - new_address: "def_pqr@dell.com" - notify: - info: false - major: false - state: "present" - - - name: Send a test mail to the destination email with email_id - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" - send_test_email: true - state: "present" - - - name: Delete destination email - dellemc.powerstore.email: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - email_address: "def_pqr@dell.com" - state: "absent" +- name: Get details of destination email with email_id + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" + state: "present" + +- name: Get details of destination email with email_address + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc@dell.com" + state: "present" + +- name: Create destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc_xyz@dell.com" + notify: + info: true + critical: true + major: false + state: "present" + +- name: Modify destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "abc_xyz@dell.com" + new_address: "def_pqr@dell.com" + notify: + info: false + major: false + state: "present" + +- name: Send a test mail to the destination email with email_id + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_id: "780b6220-2d0b-4b9f-a485-4ae7f673bd98" + send_test_email: true + state: "present" + +- name: Delete destination email + dellemc.powerstore.email: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + email_address: "def_pqr@dell.com" + state: "absent" ''' RETURN = r''' @@ -205,7 +205,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreEmail(object): diff --git a/plugins/modules/filesystem.py b/plugins/modules/filesystem.py index 4840d05..64523ec 100644 --- a/plugins/modules/filesystem.py +++ b/plugins/modules/filesystem.py @@ -365,126 +365,125 @@ ''' EXAMPLES = r''' - - - name: Create FileSystem by Name - register: result_fs - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_name: "{{filesystem_name}}" - description: "{{description}}" - nas_server: "{{nas_server_id}}" - size: "5" - cap_unit: "GB" - access_policy: "UNIX" - locking_policy: "MANDATORY" - smb_properties: - is_smb_no_notify_enabled: true - is_smb_notify_on_access_enabled: true - quota_defaults: - grace_period: 1 - grace_period_unit: 'days' - default_hard_limit: 3 - default_soft_limit: 2 - protection_policy: "{{protection_policy_id}}" - config_type: "VMWARE" - is_async_mtime_enabled: true - file_events_publishing_mode: "NFS_ONLY" - host_io_size: "VMWARE_16K" - state: "present" - - - name: Modify File System by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{fs_id}}" - folder_rename_policy: "ALL_ALLOWED" - smb_properties: - is_smb_op_locks_enabled: true - smb_notify_on_change_dir_depth: 3 - quota_defaults: - grace_period: 2 - grace_period_unit: 'weeks' - default_hard_limit: 2 - default_soft_limit: 1 - is_async_mtime_enabled: true - file_events_publishing_mode: "ALL" - flr_attributes: - mode: "Enterprise" - minimum_retention: "5D" - default_retention: "1M" - maximum_retention: "1Y" - state: "present" - - - name: Get File System details by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{result_fs.filesystem_details.id}}" - state: "present" - - - name: Delete File System by id - dellemc.powerstore.filesystem: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - filesystem_id: "{{result_fs.filesystem_details.id}}" - state: "absent" - - - name: Clone File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - filesystem_name: 'Atest' - nas_server: 'Test_Nas' - clone_filesystem: - name: "Test_ansible" - description: "Test" - access_policy: "UNIX" - locking_policy: "Advisory" - folder_rename_policy: "All_Allowed" - is_smb_sync_writes_enabled: true - is_smb_no_notify_enabled: true - is_smb_op_locks_enabled: true - is_smb_notify_on_access_enabled: true - is_smb_notify_on_write_enabled: true - smb_notify_on_change_dir_depth: 32 - is_async_MTime_enabled: false - file_events_publishing_mode: "All" - flr_attributes: - force_clone: false - state: "present" - - - name: Refresh File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - snapshot_name: "Refresh_test" - nas_server: 'Sample_NAS' - refresh_filesystem: true - state: "present" - - - name: Restore File System - dellemc.powerstore.filesystem: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - snapshot_id: "xxx-xxx-xxx" - restore_filesystem: true - backup_snap_name: "Restore_test" - state: "present" +- name: Create FileSystem by Name + register: result_fs + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_name: "{{filesystem_name}}" + description: "{{description}}" + nas_server: "{{nas_server_id}}" + size: "5" + cap_unit: "GB" + access_policy: "UNIX" + locking_policy: "MANDATORY" + smb_properties: + is_smb_no_notify_enabled: true + is_smb_notify_on_access_enabled: true + quota_defaults: + grace_period: 1 + grace_period_unit: 'days' + default_hard_limit: 3 + default_soft_limit: 2 + protection_policy: "{{protection_policy_id}}" + config_type: "VMWARE" + is_async_mtime_enabled: true + file_events_publishing_mode: "NFS_ONLY" + host_io_size: "VMWARE_16K" + state: "present" + +- name: Modify File System by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{fs_id}}" + folder_rename_policy: "ALL_ALLOWED" + smb_properties: + is_smb_op_locks_enabled: true + smb_notify_on_change_dir_depth: 3 + quota_defaults: + grace_period: 2 + grace_period_unit: 'weeks' + default_hard_limit: 2 + default_soft_limit: 1 + is_async_mtime_enabled: true + file_events_publishing_mode: "ALL" + flr_attributes: + mode: "Enterprise" + minimum_retention: "5D" + default_retention: "1M" + maximum_retention: "1Y" + state: "present" + +- name: Get File System details by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{result_fs.filesystem_details.id}}" + state: "present" + +- name: Delete File System by id + dellemc.powerstore.filesystem: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + filesystem_id: "{{result_fs.filesystem_details.id}}" + state: "absent" + +- name: Clone File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + filesystem_name: 'Atest' + nas_server: 'Test_Nas' + clone_filesystem: + name: "Test_ansible" + description: "Test" + access_policy: "UNIX" + locking_policy: "Advisory" + folder_rename_policy: "All_Allowed" + is_smb_sync_writes_enabled: true + is_smb_no_notify_enabled: true + is_smb_op_locks_enabled: true + is_smb_notify_on_access_enabled: true + is_smb_notify_on_write_enabled: true + smb_notify_on_change_dir_depth: 32 + is_async_MTime_enabled: false + file_events_publishing_mode: "All" + flr_attributes: + force_clone: false + state: "present" + +- name: Refresh File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + snapshot_name: "Refresh_test" + nas_server: 'Sample_NAS' + refresh_filesystem: true + state: "present" + +- name: Restore File System + dellemc.powerstore.filesystem: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + snapshot_id: "xxx-xxx-xxx" + restore_filesystem: true + backup_snap_name: "Restore_test" + state: "present" ''' RETURN = r''' @@ -740,7 +739,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreFileSystem(object): diff --git a/plugins/modules/filesystem_snapshot.py b/plugins/modules/filesystem_snapshot.py index a884eaf..05fb007 100644 --- a/plugins/modules/filesystem_snapshot.py +++ b/plugins/modules/filesystem_snapshot.py @@ -253,7 +253,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreFilesystemSnapshot(object): diff --git a/plugins/modules/host.py b/plugins/modules/host.py index e6e9206..38db39b 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -144,107 +144,107 @@ - The I(check_mode) is not supported. ''' EXAMPLES = r''' - - name: Create host with FC initiator - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - os_type: 'Windows' - host_connectivity: "Metro_Optimize_Local" - initiators: - - 21:00:00:24:ff:31:e9:fc - state: 'present' - initiator_state: 'present-in-host' - - - name: Create host with iSCSI initiator and its details - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-2" - os_type: 'Windows' - detailed_initiators: - - port_name: 'iqn.1998-01.com.vmware:lgc198248-5b06fb37' - port_type: 'iSCSI' - chap_single_username: 'chapuserSingle' - chap_single_password: 'chappasswd12345' - - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' - port_type: 'iSCSI' - chap_mutual_username: 'chapuserMutual' - chap_mutual_password: 'chappasswd12345' - state: 'present' - initiator_state: 'present-in-host' - - - name: Get host details by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" - state: 'present' - - - name: Add initiators to host by name - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - initiators: - - 21:00:00:24:ff:31:e9:ee - initiator_state: 'present-in-host' - state: 'present' - - - name: Add initiators to host by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" - detailed_initiators: - - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' - port_type: 'iSCSI' - chap_mutual_username: 'chapuserMutual' - chap_mutual_password: 'chappasswd12345' - initiator_state: 'present-in-host' - state: 'present' - - - name: Remove initiators from by id - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_id: "8c1e869b-fe8a-4845-hiae-h802bc249d41" - initiators: - - 21:00:00:24:ff:31:e9:ee - initiator_state: 'absent-in-host' - state: 'present' - - - name: Modify host by name - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1" - new_name: "ansible-test-host-1-new" - host_connectivity: "Metro_Optimize_Remote" - state: 'present' - - - name: Delete host - dellemc.powerstore.host: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - host_name: "ansible-test-host-1-new" - state: 'absent' +- name: Create host with FC initiator + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + os_type: 'Windows' + host_connectivity: "Metro_Optimize_Local" + initiators: + - 21:00:00:24:ff:31:e9:fc + state: 'present' + initiator_state: 'present-in-host' + +- name: Create host with iSCSI initiator and its details + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-2" + os_type: 'Windows' + detailed_initiators: + - port_name: 'iqn.1998-01.com.vmware:lgc198248-5b06fb37' + port_type: 'iSCSI' + chap_single_username: 'chapuserSingle' + chap_single_password: 'chappasswd12345' + - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' + port_type: 'iSCSI' + chap_mutual_username: 'chapuserMutual' + chap_mutual_password: 'chappasswd12345' + state: 'present' + initiator_state: 'present-in-host' + +- name: Get host details by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" + state: 'present' + +- name: Add initiators to host by name + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + initiators: + - 21:00:00:24:ff:31:e9:ee + initiator_state: 'present-in-host' + state: 'present' + +- name: Add initiators to host by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "5c1e869b-ed8a-4845-abae-b102bc249d41" + detailed_initiators: + - port_name: 'iqn.1998-01.com.vmware:imn198248-5b06fb37' + port_type: 'iSCSI' + chap_mutual_username: 'chapuserMutual' + chap_mutual_password: 'chappasswd12345' + initiator_state: 'present-in-host' + state: 'present' + +- name: Remove initiators from by id + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_id: "8c1e869b-fe8a-4845-hiae-h802bc249d41" + initiators: + - 21:00:00:24:ff:31:e9:ee + initiator_state: 'absent-in-host' + state: 'present' + +- name: Modify host by name + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1" + new_name: "ansible-test-host-1-new" + host_connectivity: "Metro_Optimize_Remote" + state: 'present' + +- name: Delete host + dellemc.powerstore.host: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + host_name: "ansible-test-host-1-new" + state: 'absent' ''' RETURN = r''' @@ -373,7 +373,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.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 6a52643..7d9c693 100644 --- a/plugins/modules/hostgroup.py +++ b/plugins/modules/hostgroup.py @@ -92,71 +92,71 @@ EXAMPLES = r''' - - name: Create host group with hosts - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host1 - - c17fc987-bf82-480c-af31-9307b89923c3 - state: 'present' - host_state: 'present-in-group' - - - name: Get host group details using ID - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_id: "{{host group_id}}" - state: 'present' - - - name: Add hosts to host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host3 - host_state: 'present-in-group' - state: 'present' - - - name: Remove hosts from host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - hosts: - - host3 - host_state: 'absent-in-group' - state: 'present' - - - name: Modify host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - host_connectivity: "Metro_Optimize_Both" - new_name: "{{new_hostgroup_name}}" - state: 'present' - - - name: Delete host group - dellemc.powerstore.hostgroup: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - hostgroup_name: "{{hostgroup_name}}" - state: 'absent' +- name: Create host group with hosts + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host1 + - c17fc987-bf82-480c-af31-9307b89923c3 + state: 'present' + host_state: 'present-in-group' + +- name: Get host group details using ID + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_id: "{{host group_id}}" + state: 'present' + +- name: Add hosts to host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host3 + host_state: 'present-in-group' + state: 'present' + +- name: Remove hosts from host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + hosts: + - host3 + host_state: 'absent-in-group' + state: 'present' + +- name: Modify host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + host_connectivity: "Metro_Optimize_Both" + new_name: "{{new_hostgroup_name}}" + state: 'present' + +- name: Delete host group + dellemc.powerstore.hostgroup: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + hostgroup_name: "{{hostgroup_name}}" + state: 'absent' ''' RETURN = r''' @@ -224,7 +224,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreHostgroup(object): diff --git a/plugins/modules/info.py b/plugins/modules/info.py index 5a695b8..ada2c17 100644 --- a/plugins/modules/info.py +++ b/plugins/modules/info.py @@ -299,11 +299,11 @@ user: "{{user}}" password: "{{password}}" gather_subset: - - email_notification + - email_notification filters: - - filter_key: 'notify_minor' - filter_operator: 'equal' - filter_value: 'false' + - filter_key: 'notify_minor' + filter_operator: 'equal' + filter_value: 'false' - name: Get list of LDAP accounts dellemc.powerstore.info: @@ -321,11 +321,11 @@ user: "{{user}}" password: "{{password}}" gather_subset: - - ldap_account + - ldap_account filters: - - filter_key: 'type' - filter_operator: 'equal' - filter_value: 'User' + - filter_key: 'type' + filter_operator: 'equal' + filter_value: 'User' - name: Get list of LDAP domain dellemc.powerstore.info: @@ -343,11 +343,11 @@ user: "{{user}}" password: "{{password}}" gather_subset: - - ldap_domain + - ldap_domain filters: - - filter_key: 'protocol' - filter_operator: 'equal' - filter_value: 'LDAPS' + - filter_key: 'protocol' + filter_operator: 'equal' + filter_value: 'LDAPS' - name: Get list of vCenters dellemc.powerstore.info: @@ -390,7 +390,7 @@ description: API version of PowerStore array. returned: always type: str - sample: "2.2.0.0" + sample: "3.0.0.0" ActiveDirectory: description: Provides details of all active directories. type: list @@ -1547,7 +1547,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreInfo(object): diff --git a/plugins/modules/job.py b/plugins/modules/job.py index 8dbd831..b3cab3b 100644 --- a/plugins/modules/job.py +++ b/plugins/modules/job.py @@ -174,7 +174,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreJob(object): diff --git a/plugins/modules/ldap_account.py b/plugins/modules/ldap_account.py index 01c79f6..24dc96c 100644 --- a/plugins/modules/ldap_account.py +++ b/plugins/modules/ldap_account.py @@ -173,7 +173,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreLDAPAccount(object): diff --git a/plugins/modules/ldap_domain.py b/plugins/modules/ldap_domain.py index 5664c86..99817dd 100644 --- a/plugins/modules/ldap_domain.py +++ b/plugins/modules/ldap_domain.py @@ -212,7 +212,7 @@ password: "{{password}}" ldap_domain_name: "{{domain_name}}" ldap_servers: - - "10.xxx.xx.xx" + - "10.xxx.xx.xx" ldap_server_state: "present-in-domain" ldap_server_type: "AD" bind_user: "{{bind_user}}" @@ -354,7 +354,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreLDAPDomain(object): diff --git a/plugins/modules/local_user.py b/plugins/modules/local_user.py index 18f3d59..3c8d1ee 100644 --- a/plugins/modules/local_user.py +++ b/plugins/modules/local_user.py @@ -185,7 +185,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreLocalUser(object): diff --git a/plugins/modules/nasserver.py b/plugins/modules/nasserver.py index df5e12d..5cf8b79 100644 --- a/plugins/modules/nasserver.py +++ b/plugins/modules/nasserver.py @@ -95,83 +95,81 @@ ''' EXAMPLES = r''' - - - name: Create a NAS Server - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "test-nas-server" - description: "NAS Server test" - current_unix_directory_service: "LDAP" - default_unix_user: "user1" - default_windows_user: "user2" - is_username_translation_enabled: true - is_auto_user_mapping_enabled: true - protection_policy: "ansible_policy" - state: "present" - - - name: Get details of NAS Server by name - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "{{ nas_server_name }}" - state: "present" - - - name: Get Details of NAS Server by ID - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - state: "present" - - - name: Rename NAS Server by Name - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_name: "{{ nas_server_name }}" - nas_server_new_name : "{{ nas_server_new_name }}" - state: "present" - - - name: Modify NAS Server attributes by ID - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - current_unix_directory_service: "LOCAL_FILES" - current_node: "{{ cur_node_n1 }}" - preferred_node: "{{ prefered_node }}" - protection_policy: "protection_policy_1" - state: "present" - - - name: Remove protection policy - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - protection_policy: "" - state: "present" - - - name: Delete NAS Server - dellemc.powerstore.nasserver: - array_ip: "{{ array_ip }}" - validate_certs: "{{ validate_certs }}" - user: "{{ user }}" - password: "{{ password }}" - nas_server_id: "{{ nas_id }}" - state: "absent" - +- name: Create a NAS Server + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "test-nas-server" + description: "NAS Server test" + current_unix_directory_service: "LDAP" + default_unix_user: "user1" + default_windows_user: "user2" + is_username_translation_enabled: true + is_auto_user_mapping_enabled: true + protection_policy: "ansible_policy" + state: "present" + +- name: Get details of NAS Server by name + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "{{ nas_server_name }}" + state: "present" + +- name: Get Details of NAS Server by ID + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + state: "present" + +- name: Rename NAS Server by Name + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_name: "{{ nas_server_name }}" + nas_server_new_name: "{{ nas_server_new_name }}" + state: "present" + +- name: Modify NAS Server attributes by ID + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + current_unix_directory_service: "LOCAL_FILES" + current_node: "{{ cur_node_n1 }}" + preferred_node: "{{ prefered_node }}" + protection_policy: "protection_policy_1" + state: "present" + +- name: Remove protection policy + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + protection_policy: "" + state: "present" + +- name: Delete NAS Server + dellemc.powerstore.nasserver: + array_ip: "{{ array_ip }}" + validate_certs: "{{ validate_certs }}" + user: "{{ user }}" + password: "{{ password }}" + nas_server_id: "{{ nas_id }}" + state: "absent" ''' RETURN = r''' @@ -338,7 +336,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreNasServer(object): diff --git a/plugins/modules/network.py b/plugins/modules/network.py index 1f13d7f..59416fe 100644 --- a/plugins/modules/network.py +++ b/plugins/modules/network.py @@ -187,12 +187,12 @@ password: "{{password}}" network_id: "NW1" addresses: - - current_address: "100.230.x.x" - new_address: "100.230.x.x" - - current_address: "100.230.x.x" - new_address: "100.230.x.x" - - current_address: "100.230.x.x" - new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" + - current_address: "100.230.x.x" + new_address: "100.230.x.x" new_cluster_mgmt_address: "100.230.x.x" vasa_provider_credentials: username: "vmadmin" @@ -207,7 +207,7 @@ password: "{{password}}" network_id: "NW6" ports: - - "IP1" + - "IP1" port_state: "present-in-network" state: "present" @@ -219,7 +219,7 @@ password: "{{password}}" network_id: "NW6" ports: - - "IP1" + - "IP1" port_state: "absent-in-network" state: "present" @@ -236,25 +236,25 @@ mtu: 1500 prefix_length: 24 addresses: - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" - - current_address: "100.230.x.x" - new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" + - current_address: "100.230.x.x" + new_address: "100.231.x.x" new_cluster_mgmt_address: "100.231.x.x" vasa_provider_credentials: username: "vmadmin" password: "{{vm_password}}" esxi_credentials: - - "node_id": "N1" - "password": "{{node_password}}" - - "node_id": "N2" - "password": "{{node_password}}" + - "node_id": "N1" + "password": "{{node_password}}" + - "node_id": "N2" + "password": "{{node_password}}" state: "present" ''' @@ -498,7 +498,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreNetwork(object): diff --git a/plugins/modules/nfs.py b/plugins/modules/nfs.py index 9c5ab56..2590b92 100644 --- a/plugins/modules/nfs.py +++ b/plugins/modules/nfs.py @@ -380,7 +380,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreNfsExport(object): diff --git a/plugins/modules/ntp.py b/plugins/modules/ntp.py index c0a092f..03f7de7 100644 --- a/plugins/modules/ntp.py +++ b/plugins/modules/ntp.py @@ -51,39 +51,39 @@ ''' EXAMPLES = r''' - - name: Get details of NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - state: "present" - - - name: Add addresses to NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - ntp_addresses: - - "XX.XX.XX.XX" - - "YY.YY.YY.YY" - ntp_address_state: "present-in-ntp" - state: "present" - - - name: Remove addresses from NTP instance - dellemc.powerstore.ntp: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - ntp_id: "NTP1" - ntp_addresses: - - "YY.YY.YY.YY" - ntp_address_state: "absent-in-ntp" - state: "present" +- name: Get details of NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + state: "present" + +- name: Add addresses to NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + ntp_addresses: + - "XX.XX.XX.XX" + - "YY.YY.YY.YY" + ntp_address_state: "present-in-ntp" + state: "present" + +- name: Remove addresses from NTP instance + dellemc.powerstore.ntp: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + ntp_id: "NTP1" + ntp_addresses: + - "YY.YY.YY.YY" + ntp_address_state: "absent-in-ntp" + state: "present" ''' RETURN = r''' @@ -128,7 +128,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreNtp(object): diff --git a/plugins/modules/protectionpolicy.py b/plugins/modules/protectionpolicy.py index 6b97f82..43fcc3a 100644 --- a/plugins/modules/protectionpolicy.py +++ b/plugins/modules/protectionpolicy.py @@ -94,8 +94,7 @@ snapshotrule_state: "present-in-policy" state: "present" - -- name : Modify protection policy, change name +- name: Modify protection policy, change name dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -105,8 +104,7 @@ new_name: "{{new_name}}" state: "present" - -- name : Modify protection policy, add snapshot rule +- name: Modify protection policy, add snapshot rule dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -118,7 +116,7 @@ snapshotrule_state: "present-in-policy" state: "present" -- name : Modify protection policy, remove snapshot rule, replication rule +- name: Modify protection policy, remove snapshot rule, replication rule dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -131,7 +129,7 @@ snapshotrule_state: "absent-in-policy" state: "present" -- name : Get details of protection policy by name +- name: Get details of protection policy by name dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -140,7 +138,7 @@ name: "{{name}}" state: "present" -- name : Get details of protection policy by ID +- name: Get details of protection policy by ID dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -149,7 +147,7 @@ protectionpolicy_id: "{{protectionpolicy_id}}" state: "present" -- name : Delete protection policy +- name: Delete protection policy dellemc.powerstore.protectionpolicy: array_ip: "{{array_ip}}" validate_certs: "{{validate_certs}}" @@ -241,7 +239,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreProtectionpolicy(object): diff --git a/plugins/modules/quota.py b/plugins/modules/quota.py index 7d8e804..d63c765 100644 --- a/plugins/modules/quota.py +++ b/plugins/modules/quota.py @@ -138,86 +138,85 @@ - The I(check_mode) is not supported. ''' EXAMPLES = r''' - - - name: Create a Quota for a User using unix name - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "user" - unix_name: "{{unix_name}}" - filesystem: "sample_fs" - nas_server: "{{nas_server_id}}" - quota: - soft_limit: 5 - hard_limit: 10 - cap_unit: "TB" - state: "present" - - - name: Create a Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "tree" - path: "/home" - filesystem: "sample_fs" - nas_server: "sample_nas_server" - quota: - soft_limit: 5 - hard_limit: 10 - cap_unit: "TB" - state: "present" - - - name: Modify attributes for Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_id: "{{quota_id}}" - quota: - soft_limit: 10 - hard_limit: 15 - cap_unit: "TB" - state: "present" - - - name: Get details of User Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "user" - uid: 100 - path: "/home" - filesystem: "{{filesystem_id}}" - state: "present" - - - name: Get details of Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_id: "{{quota_id}}" - state: "present" - - - name: Delete a Tree Quota - dellemc.powerstore.quota: - array_ip: "{{array_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - quota_type: "tree" - path: "/home" - filesystem: "sample_fs" - nas_server: "sample_nas_server" - state: "absent" - +- name: Create a Quota for a User using unix name + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "user" + unix_name: "{{unix_name}}" + filesystem: "sample_fs" + nas_server: "{{nas_server_id}}" + quota: + soft_limit: 5 + hard_limit: 10 + cap_unit: "TB" + state: "present" + +- name: Create a Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "tree" + path: "/home" + filesystem: "sample_fs" + nas_server: "sample_nas_server" + quota: + soft_limit: 5 + hard_limit: 10 + cap_unit: "TB" + state: "present" + +- name: Modify attributes for Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_id: "{{quota_id}}" + quota: + soft_limit: 10 + hard_limit: 15 + cap_unit: "TB" + state: "present" + +- name: Get details of User Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "user" + uid: 100 + path: "/home" + filesystem: "{{filesystem_id}}" + state: "present" + +- name: Get details of Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_id: "{{quota_id}}" + state: "present" + +- name: Delete a Tree Quota + dellemc.powerstore.quota: + array_ip: "{{array_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + quota_type: "tree" + path: "/home" + filesystem: "sample_fs" + nas_server: "sample_nas_server" + state: "absent" ''' + RETURN = r''' changed: description: Whether or not the resource has changed. @@ -364,7 +363,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreQuota(object): diff --git a/plugins/modules/remote_support.py b/plugins/modules/remote_support.py index 28f63f3..c161bbb 100644 --- a/plugins/modules/remote_support.py +++ b/plugins/modules/remote_support.py @@ -133,73 +133,72 @@ ''' EXAMPLES = r''' - - - name: Get details of remote support configuration - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - state: "present" - - - name: Modify remote support configuration - SRS_Gateway_Tier2 - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Gateway_Tier2" - remote_support_servers: +- name: Get details of remote support configuration + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + state: "present" + +- name: Modify remote support configuration - SRS_Gateway_Tier2 + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Gateway_Tier2" + remote_support_servers: - address: "10.XX.XX.XX" port: 9443 is_primary: true - address: "10.XX.XX.YY" port: 9443 is_primary: false - server_state: "present-in-server" - is_rsc_enabled: true - is_cloudiq_enabled: false - timeout: 300 - state: "present" - - - name: Modify remote support configuration - SRS_Integrated_Tier2 - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Integrated_Tier2" - proxy_address: "10.XX.XX.ZZ" - proxy_port: 3128 - proxy_username: "user" - proxy_password: "password" - timeout: 300 - state: "present" - - - name: Verify remote support configuration - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - support_type: "SRS_Integrated_Tier3" - timeout: 300 - verify_connection: true - state: "present" - - - name: Send a test alert - dellemc.powerstore.remote_support: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_support_id: 0 - send_test_alert: true - state: "present" + server_state: "present-in-server" + is_rsc_enabled: true + is_cloudiq_enabled: false + timeout: 300 + state: "present" + +- name: Modify remote support configuration - SRS_Integrated_Tier2 + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Integrated_Tier2" + proxy_address: "10.XX.XX.ZZ" + proxy_port: 3128 + proxy_username: "user" + proxy_password: "password" + timeout: 300 + state: "present" + +- name: Verify remote support configuration + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + support_type: "SRS_Integrated_Tier3" + timeout: 300 + verify_connection: true + state: "present" + +- name: Send a test alert + dellemc.powerstore.remote_support: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_support_id: 0 + send_test_alert: true + state: "present" ''' RETURN = r''' @@ -357,7 +356,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreRemoteSupport(object): diff --git a/plugins/modules/remote_support_contact.py b/plugins/modules/remote_support_contact.py index 2e3610f..60e5430 100644 --- a/plugins/modules/remote_support_contact.py +++ b/plugins/modules/remote_support_contact.py @@ -58,28 +58,27 @@ - The I(check_mode) is not supported. ''' EXAMPLES = r''' - - - name: Get details of remote support contact - dellemc.powerstore.remote_support_contact: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - contact_id: 0 - state: "present" - - - name: Modify remote support contact - dellemc.powerstore.remote_support_contact: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - contact_id: 0 - first_name: "abc" - last_name: "xyz" - phone: "111-222-333-444" - email: "abc_xyz@dell.com" - state: "present" +- name: Get details of remote support contact + dellemc.powerstore.remote_support_contact: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + contact_id: 0 + state: "present" + +- name: Modify remote support contact + dellemc.powerstore.remote_support_contact: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + contact_id: 0 + first_name: "abc" + last_name: "xyz" + phone: "111-222-333-444" + email: "abc_xyz@dell.com" + state: "present" ''' RETURN = r''' @@ -137,7 +136,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreRemoteSupportContact(object): diff --git a/plugins/modules/remotesystem.py b/plugins/modules/remotesystem.py index 83fc1f1..91435de 100644 --- a/plugins/modules/remotesystem.py +++ b/plugins/modules/remotesystem.py @@ -308,7 +308,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreRemoteSystem(object): diff --git a/plugins/modules/replicationrule.py b/plugins/modules/replicationrule.py index 4eff362..37bd82a 100644 --- a/plugins/modules/replicationrule.py +++ b/plugins/modules/replicationrule.py @@ -197,7 +197,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreReplicationRule(object): diff --git a/plugins/modules/replicationsession.py b/plugins/modules/replicationsession.py index 30e4387..fa1e8a2 100644 --- a/plugins/modules/replicationsession.py +++ b/plugins/modules/replicationsession.py @@ -230,7 +230,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.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 3cee637..54726c5 100644 --- a/plugins/modules/role.py +++ b/plugins/modules/role.py @@ -113,7 +113,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreRole(object): diff --git a/plugins/modules/security_config.py b/plugins/modules/security_config.py index 2b7a5db..52e7d51 100644 --- a/plugins/modules/security_config.py +++ b/plugins/modules/security_config.py @@ -116,7 +116,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreSecurityConfig(object): diff --git a/plugins/modules/smbshare.py b/plugins/modules/smbshare.py index 7cfd656..75d2fb7 100644 --- a/plugins/modules/smbshare.py +++ b/plugins/modules/smbshare.py @@ -311,7 +311,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreSMBShare(object): diff --git a/plugins/modules/smtp_config.py b/plugins/modules/smtp_config.py index 803682b..6aa78ba 100644 --- a/plugins/modules/smtp_config.py +++ b/plugins/modules/smtp_config.py @@ -58,36 +58,35 @@ - The I(check_mode) is not supported. ''' EXAMPLES = r''' - - - name: Get details of SMTP configuration - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - state: "present" - - - name: Modify SMTP config details - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - smtp_address: "sample.smtp.com" - source_email: "def@dell.com" - state: "present" - - - name: Send a test mail through the SMTP server - dellemc.powerstore.smtp_config: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - smtp_id: "0" - destination_email: "abc@dell.com" - state: "present" +- name: Get details of SMTP configuration + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + state: "present" + +- name: Modify SMTP config details + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + smtp_address: "sample.smtp.com" + source_email: "def@dell.com" + state: "present" + +- name: Send a test mail through the SMTP server + dellemc.powerstore.smtp_config: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + smtp_id: "0" + destination_email: "abc@dell.com" + state: "present" ''' RETURN = r''' @@ -139,7 +138,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreSmtpConfig(object): diff --git a/plugins/modules/snapshot.py b/plugins/modules/snapshot.py index 6051535..543dab9 100644 --- a/plugins/modules/snapshot.py +++ b/plugins/modules/snapshot.py @@ -82,104 +82,104 @@ ''' EXAMPLES = r''' - - name: Create a volume snapshot on PowerStore - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume: "{{volume}}" - description: "{{description}}" - desired_retention: "{{desired_retention}}" - retention_unit: "{{retention_unit_days}}" - state: "{{state_present}}" - - - name: Get details of a volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume: "{{volume}}" - state: "{{state_present}}" - - - name: Rename volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - new_snapshot_name: "{{new_snapshot_name}}" - volume: "{{volume}}" - state: "{{state_present}}" - - - name: Delete volume snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{new_snapshot_name}}" - volume: "{{volume}}" - state: "{{state_absent}}" - - - name: Create a volume group snapshot on PowerStore - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - description: "{{description}}" - expiration_timestamp: "{{expiration_timestamp}}" - state: "{{state_present}}" - - - name: Get details of a volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_present}}" - - - name: Modify volume group snapshot expiration timestamp - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - volume_group: "{{volume_group}}" - description: "{{description}}" - expiration_timestamp: "{{expiration_timestamp_new}}" - state: "{{state_present}}" - - - name: Rename volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{snapshot_name}}" - new_snapshot_name: "{{new_snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_present}}" - - - name: Delete volume group snapshot - dellemc.powerstore.snapshot: - array_ip: "{{mgmt_ip}}" - validate_certs: "{{validate_certs}}" - user: "{{user}}" - password: "{{password}}" - snapshot_name: "{{new_snapshot_name}}" - volume_group: "{{volume_group}}" - state: "{{state_absent}}" +- name: Create a volume snapshot on PowerStore + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume: "{{volume}}" + description: "{{description}}" + desired_retention: "{{desired_retention}}" + retention_unit: "{{retention_unit_days}}" + state: "{{state_present}}" + +- name: Get details of a volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume: "{{volume}}" + state: "{{state_present}}" + +- name: Rename volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + new_snapshot_name: "{{new_snapshot_name}}" + volume: "{{volume}}" + state: "{{state_present}}" + +- name: Delete volume snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{new_snapshot_name}}" + volume: "{{volume}}" + state: "{{state_absent}}" + +- name: Create a volume group snapshot on PowerStore + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + description: "{{description}}" + expiration_timestamp: "{{expiration_timestamp}}" + state: "{{state_present}}" + +- name: Get details of a volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_present}}" + +- name: Modify volume group snapshot expiration timestamp + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + volume_group: "{{volume_group}}" + description: "{{description}}" + expiration_timestamp: "{{expiration_timestamp_new}}" + state: "{{state_present}}" + +- name: Rename volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{snapshot_name}}" + new_snapshot_name: "{{new_snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_present}}" + +- name: Delete volume group snapshot + dellemc.powerstore.snapshot: + array_ip: "{{mgmt_ip}}" + validate_certs: "{{validate_certs}}" + user: "{{user}}" + password: "{{password}}" + snapshot_name: "{{new_snapshot_name}}" + volume_group: "{{volume_group}}" + state: "{{state_absent}}" ''' RETURN = r''' @@ -344,7 +344,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreSnapshot(object): diff --git a/plugins/modules/snapshotrule.py b/plugins/modules/snapshotrule.py index e9e7a74..411edaa 100644 --- a/plugins/modules/snapshotrule.py +++ b/plugins/modules/snapshotrule.py @@ -95,7 +95,6 @@ ''' EXAMPLES = r''' - - name: Get details of an existing snapshot rule by name dellemc.powerstore.snapshotrule: array_ip: "{{array_ip}}" @@ -123,7 +122,7 @@ name: "{{name}}" interval: "{{interval}}" days_of_week: - - Monday + - Monday desired_retention: "{{desired_retention}}" state: "present" @@ -254,7 +253,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreSnapshotrule(object): diff --git a/plugins/modules/storage_container.py b/plugins/modules/storage_container.py index 173e91b..5f9ddac 100644 --- a/plugins/modules/storage_container.py +++ b/plugins/modules/storage_container.py @@ -211,7 +211,7 @@ user: "{{user}}" password: "{{password}}" storage_container_name: "Ansible_storage_container_1" - force_delete: True + force_delete: true state: "absent" - name: Delete a storage container using id @@ -231,12 +231,12 @@ validate_certs: "{{validate_certs}}" storage_container_name: "local_storage_container" storage_container_destination: - remote_address: "x.x.x.x" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_system: "remote_system_name" - remote_storage_container: "remote_storage_container_name" + remote_address: "x.x.x.x" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_system: "remote_system_name" + remote_storage_container: "remote_storage_container_name" - name: Delete a storage container destination dellemc.powerstore.storage_container: @@ -247,12 +247,12 @@ storage_container_id: "storage_container_id" storage_container_destination_state: "absent" storage_container_destination: - remote_address: "x.x.x.x" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - remote_system: "remote_system_name" - remote_storage_container: "remote_storage_container_name" + remote_address: "x.x.x.x" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + remote_system: "remote_system_name" + remote_storage_container: "remote_storage_container_name" ''' RETURN = r''' @@ -361,7 +361,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreStorageContainer(object): @@ -464,7 +464,7 @@ def delete_storage_container(self, storage_container_id, force_delete): except Exception as e: msg = (f'Deletion of storage container {storage_container_id}' - f' failed with error { str(e) }') + f' failed with error {str(e)}') LOG.error(msg) self.module.fail_json(msg=msg, **utils.failure_codes(e)) diff --git a/plugins/modules/vcenter.py b/plugins/modules/vcenter.py index cbd66e3..88a022b 100644 --- a/plugins/modules/vcenter.py +++ b/plugins/modules/vcenter.py @@ -95,49 +95,49 @@ ''' EXAMPLES = r''' - - name: Get details of vCenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - - - name: Add a vcenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - address: "XX.XX.XX.XX" - vcenter_username: "user-name" - vcenter_password: "password" - update_password: "on_create" - vasa_provider_credentials: - username: "admin" - password: "pass" - - - name: Modify a vCenter attribute - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - address: "XX.XX.XX.YY" - vcenter_username: "user-name" - vcenter_password: "password" - update_password: "always" - - - name: Remove a vcenter - dellemc.powerstore.vcenter: - array_ip: "{{array_ip}}" - user: "{{user}}" - password: "{{password}}" - validate_certs: "{{validate_certs}}" - vcenter_id: "24d333-59f-423c-205-c6181ea81b" - delete_vasa_provider: true - state: "absent" +- name: Get details of vCenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + +- name: Add a vcenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + address: "XX.XX.XX.XX" + vcenter_username: "user-name" + vcenter_password: "password" + update_password: "on_create" + vasa_provider_credentials: + username: "admin" + password: "pass" + +- name: Modify a vCenter attribute + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + address: "XX.XX.XX.YY" + vcenter_username: "user-name" + vcenter_password: "password" + update_password: "always" + +- name: Remove a vcenter + dellemc.powerstore.vcenter: + array_ip: "{{array_ip}}" + user: "{{user}}" + password: "{{password}}" + validate_certs: "{{validate_certs}}" + vcenter_id: "24d333-59f-423c-205-c6181ea81b" + delete_vasa_provider: true + state: "absent" ''' RETURN = r''' @@ -215,7 +215,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerstoreVCenter(object): diff --git a/plugins/modules/volume.py b/plugins/modules/volume.py index b59dad2..cdda348 100644 --- a/plugins/modules/volume.py +++ b/plugins/modules/volume.py @@ -631,7 +631,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreVolume(object): diff --git a/plugins/modules/volumegroup.py b/plugins/modules/volumegroup.py index d10510c..68cdab7 100644 --- a/plugins/modules/volumegroup.py +++ b/plugins/modules/volumegroup.py @@ -220,7 +220,7 @@ source_vg: "vg_source" create_backup_snap: true backup_snap_profile: - name: "test_snap" + name: "test_snap" state: "present" - name: Restore a volume group @@ -233,7 +233,7 @@ source_snap: "snap_source" create_backup_snap: true backup_snap_profile: - name: "test_snap_restore" + name: "test_snap_restore" state: "present" - name: Clone a volume group @@ -244,8 +244,8 @@ password: "{{password}}" vg_name: "ansible_vg" vg_clone: - name: "ansible_vg_clone" - protection_policy: "policy1" + name: "ansible_vg_clone" + protection_policy: "policy1" state: "present" ''' @@ -398,7 +398,7 @@ VERSION_ERROR = py4ps_version['unsupported_version_message'] # Application type -APPLICATION_TYPE = 'Ansible/2.2.0' +APPLICATION_TYPE = 'Ansible/3.0.0' class PowerStoreVolumeGroup(object): diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.16.txt similarity index 84% rename from tests/sanity/ignore-2.13.txt rename to tests/sanity/ignore-2.16.txt index a80053c..edeb17e 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.16.txt @@ -1,27 +1,15 @@ plugins/modules/vcenter.py compile-2.7 -plugins/modules/vcenter.py compile-3.5 plugins/modules/vcenter.py import-2.7 -plugins/modules/vcenter.py import-3.5 plugins/modules/nasserver.py import-2.7 plugins/modules/nasserver.py compile-2.7 -plugins/modules/nasserver.py import-3.5 -plugins/modules/nasserver.py compile-3.5 plugins/modules/filesystem.py compile-2.7 -plugins/modules/filesystem.py compile-3.5 plugins/modules/filesystem.py import-2.7 -plugins/modules/filesystem.py import-3.5 plugins/modules/volume.py compile-2.7 -plugins/modules/volume.py compile-3.5 plugins/modules/volume.py import-2.7 -plugins/modules/volume.py import-3.5 plugins/modules/storage_container.py compile-2.7 -plugins/modules/storage_container.py compile-3.5 plugins/modules/storage_container.py import-2.7 -plugins/modules/storage_container.py import-3.5 plugins/modules/replicationsession.py import-2.7 -plugins/modules/replicationsession.py import-3.5 plugins/modules/replicationsession.py compile-2.7 -plugins/modules/replicationsession.py compile-3.5 plugins/modules/certificate.py validate-modules:missing-gplv3-license plugins/modules/cluster.py validate-modules:missing-gplv3-license plugins/modules/dns.py validate-modules:missing-gplv3-license