Merge pull request #25 from NetApp/release-1.4.1

release-1.4.1

.gitignore

@@ -1,4 +1,7 @@
 *.pyc
 .idea
 *.iml
-ansible.cfg
+ansible.cfg
+tests/output/
+certificate.crt
+

CHANGELOG.rst

@@ -5,6 +5,15 @@ Netapp E-Series SANtricity Collection Release Notes
 .. contents:: Topics
 
 
+v1.4.1
+======
+
+Bugfixes
+--------
+
+- Fixed pep8, pylint, and validate-modules issues found by ansible-test.
+- Updated outdated command in unit tests.
+
 v1.4.0
 ======
 

README.md

@@ -5,6 +5,7 @@ NetApp E-Series SANtricity Collection
         This collection provides NetApp E-Series customers with a wide range of configuration options through the collection's modules. However, the real
     benefit of using the SANtricity collection is found in the host and management roles. These roles provide ready-made, policy-based orchestration for
     E-Series platforms based on predefined role variables.
+
         Once the physical hardware has been installed, the SANtricity roles are capable of discovering the DHCP-assigned addresses, setting initial passwords
     and management interfaces so your automation can do full deployments for you without logging directly into the devices. Yet that's just the beginning,
     the management role will also ensure alerts, ASUP, logging, LDAP, and firmware are configured as expected; and the host role will setup host interfaces,
@@ -863,191 +864,6 @@ License
 
 Maintainer Information
 ------------------
-    - Nathan Swartz (@ndswartz)
+    - Nathan Swartz (@swartzn)
+    - Vu Tran (@VuTran007)
     - Joe McCormick (@iamjoemccormick)
-    - Tracy Cummins (@tracycummins)
-
-=============
-Release Notes
-=============
-
-v1.2.13
-=======
-
-Bugfixes
---------
-
-- Fix availability of client certificate change.
-
-v1.2.12
-=======
-
-Bugfixes
---------
-
-- Fix host and host port names from being changed to lower case.
-
-v1.2.11
-=======
-
-Bugfixes
---------
-
-- Fix login banner message option bytes error in na_santricity_global.
-
-v1.2.10
-=======
-
-Minor Changes
--------------
-
-- Add login banner message to na_santricity_global module and nar_santricity_management role.
-- Add usable drive option for na_santricity_storagepool module and nar_santricity_host role which can be used to choose selected drives for storage pool/volumes or define a pattern drive selection.
-
-Bugfixes
---------
-
-- Fix PEM certificate/key imports in the na_santricity_server_certificate module.
-- Fix na_santricity_mgmt_interface IPv4 and IPv6 form validation.
-
-v1.2.9
-======
-
-Minor Changes
--------------
-
-- Add eseries_system_old_password variable to faciliate changing the storage system's admin password.
-- Add remove_unspecified_user_certificates variable to the client certificates module.
-
-Bugfixes
---------
-
-- Fix missing proxy client and server certificate in management role.
-- Fix missing proxy validate_certs and change current proxy password variables.
-- Fix server certificate module not forwarding certificate imports to the embedded web services.
-
-v1.2.8
-======
-
-Bugfixes
---------
-
-- Fix pkcs8 private key passphrase issue.
-- Fix storage system admin password change from web services proxy in na_santricity_auth module.
-
-v1.2.7
-======
-
-v1.2.6
-======
-
-Bugfixes
---------
-
-- Fix jinja issue with collecting certificates paths in nar_santricity_management role.
-
-v1.2.5
-======
-
-Bugfixes
---------
-
-- Add missing http(s) proxy username and password parameters from na_santricity_asup module and nar_santricity_management role."
-- Add missing storage pool configuration parameter, criteria_drive_interface_type, to nar_santricity_host role.
-
-v1.2.4
-======
-
-v1.2.3
-======
-
-Minor Changes
--------------
-
-- Added nvme4k as a drive type interface to the na_santricity_storagepool module.
-- Added options for critical and warning threshold setting in na_santricity_storagepool module and nar_santricity_host role.
-- Fix dynamic disk pool critical and warning threshold settings.
-
-Bugfixes
---------
-
-- Fix drive firmware upgrade issue that prevented updating firware when drive was in use.
-
-v1.2.2
-======
-
-v1.2.1
-======
-
-Release Summary
----------------
-
-Release 1.2.2 simply removes resource-provisioned volumes feature from collection.
-
-
-Minor Changes
--------------
-
-- Add IPv6 and FQDN support for NTP
-- Add IPv6 support for DNS
-- Add criteria_drive_max_size option to na_santricity_storagepool and nar_santricity_host role.
-- Add resource-provisioned volumes option to globals and nar_santricity_management role.
-- Remove resource-provisioned volumes setting from na_santicity_global module and nar_santricity_management role."
-
-v1.2.0
-======
-
-Release Summary
----------------
-
-1.2.0 release of ``netapp_eseries.santricity`` collection on 2021-03-01.
-
-Minor Changes
--------------
-
-- na_santricity_discover - Add support for discovering storage systems directly using devmgr/v2/storage-systems/1/about endpoint since its old method of discover is being deprecated.
-- na_santricity_facts - Add storage system information to facilitate ``netapp_eseries.host`` collection various protocol configuration.
-- na_santricity_server_certificate - New module to configure storage system's web server certificate configuration.
-- na_santricity_snapshot - New module to configure NetApp E-Series Snapshot consistency groups any number of base volumes.
-- na_santricity_volume - Add percentage size unit (pct) and which allows the creates volumes based on the total storage pool size.
-- nar_santricity_host - Add eseries_storage_pool_configuration list options, criteria_volume_count, criteria_reserve_free_capacity_pct, and common_volume_host to facilitate volumes based on percentages of storage pool or volume group.
-- nar_santricity_host - Add support for snapshot group creation.
-- nar_santricity_host - Improve host mapping information discovery.
-- nar_santricity_host - Improve storage system discovery related error messages.
-- nar_santricity_management - Add support for server certificate management.
-
-Bugfixes
---------
-
-- nar_santricity_host - Fix README.md examples.
-
-v1.1.0
-======
-
-Release Summary
----------------
-
-This release focused on providing volume details to through the netapp_volumes_by_initiators in the na_santricity_facts module, improving on the nar_santricity_common role storage system API information and resolving issues.
-
-Minor Changes
--------------
-
-- Add functionality to remove all inventory configuration in the nar_santricity_host role. Set configuration.eseries_remove_all_configuration=True to remove all storage pool/volume configuration, host, hostgroup, and lun mapping configuration.
-- Add host_types, host_port_protocols, host_port_information, hostside_io_interface_protocols to netapp_volumes_by_initiators in the na_santricity_facts module.
-- Add storage pool information to the volume_by_initiator facts.
-- Add storage system not found exception to the common role's build_info task.
-- Add volume_metadata option to na_santricity_volume module, add volume_metadata information to the netapp_volumes_by_initiators dictionary in na_santricity_facts module, and update the nar_santricity_host role with the option.
-- Improve nar_santricity_common storage system api determinations; attempts to discover the storage system using the information provided in the inventory before attempting to search the subnet.
-- Increased the storage system discovery connection timeouts to 30 seconds to prevent systems from not being discovered over slow connections.
-- Minimize the facts gathered for the host initiators.
-- Update ib iser determination to account for changes in firmware 11.60.2.
-- Use existing Web Services Proxy storage system identifier when one is already created and one is not provided in the inventory.
-- Utilize eseries_iscsi_iqn before searching host for iqn in nar_santricity_host role.
-
-Bugfixes
---------
-
-- Fix check_port_type method for ib iser when ib is the port type.
-- Fix examples in the netapp_e_mgmt_interface module.
-- Fix issue with changing host port name.
-- Fix na_santricity_lun_mapping unmapping issue; previously mapped volumes failed to be unmapped.

changelogs/.plugin-cache.yaml

@@ -294,4 +294,4 @@ plugins:
   shell: {}
   strategy: {}
   vars: {}
-version: 1.4.0
+version: 1.4.1

changelogs/changelog.yaml

@@ -269,3 +269,9 @@ releases:
     - fix_global_management_interface_configuration.yml
     - fix_nvme_roce_mtu_default.yml
     release_date: '2023-01-30'
+  1.4.1:
+    changes:
+      bugfixes:
+      - Fixed pep8, pylint, and validate-modules issues found by ansible-test.
+      - Updated outdated command in unit tests.
+    release_date: '2024-09-30'

galaxy.yml

@@ -1,11 +1,12 @@
 namespace: "netapp_eseries"
 description: "Latest content available for NetApp E-Series Ansible automation."
 name: "santricity"
-version: "1.4.0"
+version: "1.4.1"
 readme: "README.md"
 authors:
+  - "Nathan Swartz (@swartzn)"
+  - "Vu Tran (@VuTran007)"
   - "Joe McCormick (@iamjoemccormick)"
-  - "Nathan Swartz (@ndswartz)"
 dependencies: {}
 license:
   - "GPL-3.0-only"

meta/runtime.yml

@@ -1,2 +1,2 @@
 ---
-requires_ansible: '>=2.13'
+requires_ansible: '>=2.10'

plugins/doc_fragments/netapp.py

@@ -45,13 +45,14 @@ class ModuleDocFragment(object):
   ssid:
     required: false
     type: str
-    default: 1
+    default: "1"
     description:
     - The ID of the array to manage. This value must be unique for each array.
 
 notes:
   - The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage
     the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
   - Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
-  - M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
+  - M(netapp_eseries.santricity.netapp_e_storage_system) may be utilized for configuring the systems managed by
+    a WSP instance.
 '''

plugins/doc_fragments/santricity.py

@@ -47,7 +47,8 @@ class ModuleDocFragment(object):
     - The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage
         the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
     - Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
-    - M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
+    - M(netapp_eseries.santricity.netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP
+      instance.
 """
 
     # Documentation fragment for E-Series
@@ -78,13 +79,14 @@ class ModuleDocFragment(object):
     ssid:
         required: false
         type: str
-        default: 1
+        default: "1"
         description:
             - The ID of the array to manage. This value must be unique for each array.
 
 notes:
     - The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage
         the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
     - Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
-    - M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
+    - M(netapp_eseries.santricity.netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP
+      instance.
 """

plugins/lookup/santricity_host.py

@@ -1,11 +1,13 @@
-# (c) 2020, NetApp, Inc
-# BSD-3 Clause (see COPYING or https://opensource.org/licenses/BSD-3-Clause)
+# (c) 2024, NetApp, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = """
-    lookup: santricity_hosts
-    author: Nathan Swartz
+    name: santricity_host
+    author:
+        - Nathan Swartz (@swartzn)
+        - Vu Tran (@VuTran007)
     short_description: Collects host information
     description:
         - Collects current host, expected host and host group inventory definitions.
@@ -15,17 +17,19 @@
                 - E-Series storage array inventory, hostvars[inventory_hostname].
                 - Run na_santricity_facts prior to calling
             required: True
-            type: complex
+            type: raw
         volumes:
             description:
                 - Volume information returned from santricity_volume lookup plugin which expands
+            type: raw
 """
 from ansible.errors import AnsibleError
 from ansible.plugins.lookup import LookupBase
 
 
 class LookupModule(LookupBase):
 
+    # pylint: disable=arguments-renamed
     def run(self, inventory, volumes, **kwargs):
         if isinstance(inventory, list):
             inventory = inventory[0]

plugins/lookup/santricity_host_detail.py

@@ -1,11 +1,13 @@
-# (c) 2020, NetApp, Inc
-# BSD-3 Clause (see COPYING or https://opensource.org/licenses/BSD-3-Clause)
+# (c) 2024, NetApp, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = """
-    lookup: santricity_hosts_detail
-    author: Nathan Swartz
+    name: santricity_host_detail
+    author:
+        - Nathan Swartz (@swartzn)
+        - Vu Tran (@VuTran007)
     short_description: Expands the host information from santricity_host lookup
     description:
         - Expands the host information from santricity_host lookup to include system and port information
@@ -16,12 +18,14 @@
                 - Run na_santricity_facts prior to calling
             required: True
             type: list
+            elements: raw
         hosts_info:
             description:
                 - The registered results from the setup module from each expected_hosts, hosts_info['results'].
                 - Collected results from the setup module for each expected_hosts from the results of the santricity_host lookup plugin.
             required: True
             type: list
+            elements: raw
         host_interface_ports:
             description:
                 - List of dictionaries containing "stdout_lines" which is a list of iqn/wwpns for each expected_hosts from the results of
@@ -30,6 +34,7 @@
                   in a newline delineated list of iqns, nqns, or wwpns.
             required: True
             type: list
+            elements: raw
         protocol:
             description:
                 - Storage system interface protocol (iscsi, sas, fc, ib-iser, ib-srp, nvme_ib, nvme_fc, or nvme_roce)