5.0.1 Patch Release (#361)

* 5.0.1 Patch Release
dell · Feb 11, 2022 · 14064b2 · 14064b2
1 parent 16424fe
commit 14064b2
Show file tree

Hide file tree

Showing 157 changed files with 1,344 additions and 1,785 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,38 @@ Dell EMC OpenManage Ansible Modules Release Notes
 .. contents:: Topics
 
 
+v5.0.1
+======
+
+Release Summary
+---------------
+
+Support to provide custom or organizational CA signed certificate for SSL validation from the environment variable.
+
+Major Changes
+-------------
+
+- All modules can read custom or organizational CA signed certificate from the environment variables. Please refer to `SSL Certificate Validation <https://github.com/dell/dellemc-openmanage-ansible-modules#ssl-certificate-validation>`_ section in the `README.md <https://github.com/dell/dellemc-openmanage-ansible-modules/blob/collections/README.md#SSL-Certificate-Validation>`_ for modification to existing playbooks or setting environment variable.
+
+Bugfixes
+--------
+
+- All playbooks require modification because the validate_certs argument is set to True by default (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/357)
+- The ome_application_network_time and ome_application_network_proxy modules are breaking due to the changes introduced for SSL validation.(https://github.com/dell/dellemc-openmanage-ansible-modules/issues/360)
+
+Known Issues
+------------
+
+- idrac_user - Issue(192043) The module may error out with the message ``unable to perform the import or export operation because there are pending attribute changes or a configuration job is in progress``. Wait for the job to complete and run the task again.
+- ome_application_alerts_smtp - Issue(212310) - The module does not provide a proper error message if the destination_address is more than 255 characters.
+- ome_application_alerts_syslog - Issue(215374) - The module does not provide a proper error message if the destination_address is more than 255 characters.
+- ome_device_local_access_configuration - Issue(215035) - The module reports ``Successfully updated the local access setting`` if an unsupported value is provided for the parameter timeout_limit. However, this value is not actually applied on OpenManage Enterprise Modular.
+- ome_device_local_access_configuration - Issue(217865) - The module does not display a proper error message if an unsupported value is provided for the user_defined and lcd_language parameters.
+- ome_device_network_services - Issue(212681) - The module does not provide a proper error message if unsupported values are provided for the parameters- port_number, community_name, max_sessions, max_auth_retries, and idle_timeout.
+- ome_device_power_settings - Issue(212679) - The module errors out with the following message if the value provided for the parameter ``power_cap`` is not within the supported range of 0 to 32767, ``Unable to complete the request because PowerCap does not  exist or is not applicable for the resource URI.``
+- ome_device_quick_deploy - Issue(216352) - The module does not display a proper error message if an unsupported value is provided for the ipv6_prefix_length and vlan_id parameters.
+- ome_smart_fabric_uplink - Issue(186024) - The module does not allow the creation of multiple uplinks of the same name even though it is supported by OpenManage Enterprise Modular. If an uplink is created using the same name as an existing uplink, the existing uplink is modified.
+
 v5.0.0
 ======
 

diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
 # Dell EMC OpenManage Ansible Modules
 
-Dell EMC OpenManage Ansible Modules allows data center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration, deployment, and update of Dell EMC PowerEdge Servers and modular infrastructure by leveraging the management automation capabilities in-built into the Integrated Dell Remote Access Controller (iDRAC), OpenManage Enterprise and OpenManage Enterprise Modular.
+Dell EMC OpenManage Ansible Modules allows data center and IT administrators to use RedHat Ansible to automate and orchestrate the configuration, deployment, and update of Dell EMC PowerEdge Servers and modular infrastructure by leveraging the management automation capabilities in-built into the Integrated Dell Remote Access Controller (iDRAC), OpenManage Enterprise (OME) and OpenManage Enterprise Modular (OMEM).
 
 OpenManage Ansible Modules simplifies and automates provisioning, deployment, and updates of PowerEdge servers and modular infrastructure. It allows system administrators and software developers to introduce the physical infrastructure provisioning into their software provisioning stack, integrate with existing DevOps pipelines and manage their infrastructure using version-controlled playbooks, server configuration profiles, and templates in line with the Infrastructure-as-Code (IaC) principles.
 
 ## Supported Platforms
   * iDRAC 7 based Dell EMC PowerEdge Servers with firmware versions 2.63.60.62 and above.
   * iDRAC 8 based Dell EMC PowerEdge Servers with firmware versions 2.81.81.81 and above.
   * iDRAC 9 based Dell EMC PowerEdge Servers with firmware versions 5.00.10.20 and above.
-  * Dell EMC OpenManage Enterprise versions 3.8.0 and above.
-  * Dell EMC OpenManage Enterprise-Modular versions 1.30.10 and above.
+  * Dell EMC OpenManage Enterprise versions 3.8.2 and above.
+  * Dell EMC OpenManage Enterprise Modular versions 1.40.00 and above.
 
 ## Prerequisites
   * [Ansible >= 2.10.0](https://github.com/ansible/ansible)
@@ -42,11 +42,15 @@ To enable SSL certificate validation, perform the following steps:
   * Generate and upload the custom or organizational CA signed certificates on the iDRACs, OpenManage Enterprise, and OpenManage Enterprise-Modular, as required.
     * For iDRAC, see the section `SSL server certificates` in the `Integrated Dell Remote Access Controller Users Guide`.
     * For OpenManage Enterprise, see the section `Security Certificates` in the `OpenManage Enterprise Users Guide`.
-    * For OpenManage Enterprise-Modular Edition, see the section `Managing certificates` in the `OpenManage Enterprise-Modular Edition for PowerEdge MX7000 Chassis Users Guide`.
+    * For OpenManage Enterprise Modular, see the section `Managing certificates` in the `OpenManage Enterprise Modular for PowerEdge MX7000 Chassis Users Guide`.
   * After you have uploaded the custom or organizational CA signed certificate to iDRAC or OME or OME-M, you must have the CA file or bundle available on your Ansible controller. For example, copy the CA file or bundle in the following path: /usr/share/ssl-certs/
     > **_NOTE_**: Ensure that the user running the Ansible modules has permission to access the certificate file or bundle.
-  * In your playbook, set the ca_path argument to the file path of your custom or organization CA certificate file or bundle.
+  * You can then use either of the following methods to specify the custom or organization CA certificate file or bundle path to the module:
+    * In your playbook tasks, set the `ca_path` argument to the file path of your custom or organization CA certificate file or bundle.
     ```ca_path: /usr/share/ssl-certs/ca-cert.pem```
+    * Use any of the following environment variables to specify the custom or organization CA certificate file or bundle path. The modules reads the environment variable in the following order of preference: ```REQUESTS_CA_BUNDLE```, ```CURL_CA_BUNDLE```, ```OMAM_CA_BUNDLE```. 
+     > **_NOTE_**: Use the following command to set the environment variable with the custom or organization CA certificate file or bundle:
+        <br>```export REQUESTS_CA_BUNDLE=/usr/share/ssl-certs/ca-cert.pem```
 
 ### Ignore SSL certificate validation
 It is common to run a test environment without a proper SSL certificate configuration. To disable the certificate validation for a module, set the validate_certs module argument to ```False``` in the playbook.
@@ -88,4 +92,4 @@ To debug OpenManage Ansible Modules using IDE, see [here](https://github.com/del
   * To provide feedback to the development team, send an email to **[email protected]**.
 
 ## Authors
-  * OpenManageAnsible ([email protected])
+  * OpenManageAnsible ([email protected])
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -529,3 +529,44 @@ releases:
       name: ome_device_quick_deploy
       namespace: ''
     release_date: '2022-01-27'
+  5.0.1:
+    changes:
+      major_changes:
+        - All modules can read custom or organizational CA signed certificate from the environment variables.
+          Please refer to `SSL Certificate Validation <https://github.com/dell/dellemc-openmanage-ansible-modules#ssl-certificate-validation>`_ section in the `README.md <https://github.com/dell/dellemc-openmanage-ansible-modules/blob/collections/README.md#SSL-Certificate-Validation>`_ for modification to existing playbooks or setting environment variable.
+      bugfixes:
+        - The ome_application_network_time and ome_application_network_proxy modules are breaking due
+          to the changes introduced for SSL validation.(https://github.com/dell/dellemc-openmanage-ansible-modules/issues/360)
+        - All playbooks require modification because the validate_certs argument is set to True by default
+          (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/357)
+      known_issues:
+        - ome_device_quick_deploy - Issue(216352) - The module does not display a proper error message
+          if an unsupported value is provided for the ipv6_prefix_length and vlan_id parameters.
+        - ome_device_local_access_configuration - Issue(217865) - The module does not
+          display a proper error message if an unsupported value is provided for the
+          user_defined and lcd_language parameters.
+        - ome_device_local_access_configuration - Issue(215035) - The module reports
+          ``Successfully updated the local access setting`` if an unsupported value is
+          provided for the parameter timeout_limit. However, this value is not
+          actually applied on OpenManage Enterprise Modular.
+        - ome_device_network_services - Issue(212681) - The module does not provide a
+          proper error message if unsupported values are provided for the parameters-
+          port_number, community_name, max_sessions, max_auth_retries, and idle_timeout.
+        - ome_application_alerts_syslog - Issue(215374) - The module does not provide a
+          proper error message if the destination_address is more than 255 characters.
+        - ome_application_alerts_smtp - Issue(212310) - The module does not provide a
+          proper error message if the destination_address is more than 255 characters.
+        - idrac_user - Issue(192043) The module may error out with the message ``unable
+          to perform the import or export operation because there are pending attribute
+          changes or a configuration job is in progress``. Wait for the job to complete
+          and run the task again.
+        - ome_smart_fabric_uplink - Issue(186024) - The module does not allow the creation
+          of multiple uplinks of the same name even though it is supported by OpenManage
+          Enterprise Modular. If an uplink is created using the same name as an existing
+          uplink, the existing uplink is modified.
+        - ome_device_power_settings - Issue(212679) - The module errors out with the
+          following message if the value provided for the parameter ``power_cap`` is
+          not within the supported range of 0 to 32767, ``Unable to complete the request
+          because PowerCap does not  exist or is not applicable for the resource URI.``
+      release_summary: Support to provide custom or organizational CA signed certificate for SSL validation from the environment variable.
+    release_date: '2022-02-11'
diff --git a/docs/modules/dellemc_configure_idrac_eventing.rst b/docs/modules/dellemc_configure_idrac_eventing.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -127,8 +127,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/dellemc_configure_idrac_services.rst b/docs/modules/dellemc_configure_idrac_services.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -55,8 +55,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   share_name (True, str, None)
     Network share or a local path.

diff --git a/docs/modules/dellemc_get_firmware_inventory.rst b/docs/modules/dellemc_get_firmware_inventory.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -55,8 +55,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/dellemc_get_system_inventory.rst b/docs/modules/dellemc_get_system_inventory.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -55,8 +55,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/dellemc_idrac_lc_attributes.rst b/docs/modules/dellemc_idrac_lc_attributes.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -75,8 +75,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/dellemc_idrac_storage_volume.rst b/docs/modules/dellemc_idrac_storage_volume.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -139,8 +139,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/dellemc_system_lockdown_mode.rst b/docs/modules/dellemc_system_lockdown_mode.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -75,8 +75,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_bios.rst b/docs/modules/idrac_bios.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -125,8 +125,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_firmware.rst b/docs/modules/idrac_firmware.rst
@@ -26,7 +26,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -107,8 +107,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_firmware_info.rst b/docs/modules/idrac_firmware_info.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -55,8 +55,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_lifecycle_controller_job_status_info.rst b/docs/modules/idrac_lifecycle_controller_job_status_info.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -59,8 +59,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_lifecycle_controller_jobs.rst b/docs/modules/idrac_lifecycle_controller_jobs.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -61,8 +61,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_lifecycle_controller_logs.rst b/docs/modules/idrac_lifecycle_controller_logs.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -73,8 +73,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_lifecycle_controller_status_info.rst b/docs/modules/idrac_lifecycle_controller_status_info.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -55,8 +55,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.

diff --git a/docs/modules/idrac_network.rst b/docs/modules/idrac_network.rst
@@ -20,7 +20,7 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- omsdk
+- omsdk >= 1.2.488
 - python >= 3.8.6
 
 
@@ -147,8 +147,6 @@ Parameters
   ca_path (optional, path, None)
     The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
 
-    *ca_path* is required if *validate_certs* is ``True``
-
 
   timeout (optional, int, 30)
     The socket level timeout in seconds.