Release 5.1.0 (#366)

* Release 5.1.0
dell · Feb 23, 2022 · d8e7173 · d8e7173
1 parent 14064b2
commit d8e7173
Show file tree

Hide file tree

Showing 34 changed files with 2,563 additions and 179 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,49 @@ Dell EMC OpenManage Ansible Modules Release Notes
 .. contents:: Topics
 
 
+v5.1.0
+======
+
+Release Summary
+---------------
+
+Support for OpenManage Enterprise Modular server interface management.
+
+Minor Changes
+-------------
+
+- ome_application_network_address - The module is enhanced to support check mode and idempotency.
+- ome_device_info - The module is enhanced to return a blank list when devices or baselines are not present in the system.
+- ome_firmware_baseline_compliance_info - The module is enhanced to return a blank list when devices or baselines are not present in the system.
+- ome_firmware_baseline_info - The module is enhanced to return a blank list when devices or baselines are not present in the system.
+- ome_identity_pool - The iSCSI Initiator and Initiator IP Pool attributes are not mandatory to create an identity pool. (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/329)
+- ome_identity_pool - The module is enhanced to support check mode and idempotency. (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/328)
+- ome_template_identity_pool - The module is enhanced to support check mode and idempotency.
+- redfish_event_subscription - The module is enhanced to support check mode and idempotency.
+
+Bugfixes
+--------
+
+- idrac_firmware - Issue (220130) The socket.timout issue that occurs during the wait_for_job_completion() job is fixed.
+
+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_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.
+
+New Modules
+-----------
+
+- dellemc.openmanage.ome_server_interface_profile_info - Retrieves the information of server interface profile on OpenManage Enterprise Modular.
+- dellemc.openmanage.ome_server_interface_profiles - Configures server interface profiles on OpenManage Enterprise Modular.
+
 v5.0.1
 ======
 

diff --git a/README.md b/README.md
@@ -38,19 +38,18 @@ Install the collection from the github repository using the latest commit on the
 **By default, SSL certificate validation is enabled in all modules to enforce secure communication.**
 
 ### Enable SSL certificate validation
-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, 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.
-  * 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```
+  - 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, 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. 
+   - 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:
+       ```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.

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -569,4 +569,64 @@ releases:
           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'
+    release_date: '2022-02-11'
+  5.1.0:
+    changes:
+      bugfixes:
+        - idrac_firmware - Issue (220130) The socket.timout issue that occurs 
+          during the wait_for_job_completion() job is fixed.
+      minor_changes:
+        - ome_identity_pool - The module is enhanced to support check mode and
+          idempotency.
+          (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/328)
+        - ome_template_identity_pool - The module is enhanced to support check
+          mode and idempotency.
+        - ome_application_network_address - The module is enhanced to support
+          check mode and idempotency.
+        - redfish_event_subscription - The module is enhanced to support check
+          mode and idempotency.
+        - ome_identity_pool - The iSCSI Initiator and Initiator IP Pool
+          attributes are not mandatory to create an identity pool.
+          (https://github.com/dell/dellemc-openmanage-ansible-modules/issues/329)
+        - ome_device_info - The module is enhanced to return a blank list when
+          devices or baselines are not present in the system.
+        - ome_firmware_baseline_compliance_info - The module is enhanced to
+          return a blank list when devices or baselines are not present in the system.
+        - ome_firmware_baseline_info - The module is enhanced to return a blank
+          list when devices or baselines are not present in the system.
+      known_issues:
+        - 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 for OpenManage Enterprise Modular server interface management.
+    modules:
+    - description: Configures server interface profiles on OpenManage Enterprise Modular.
+      name: ome_server_interface_profiles
+      namespace: ''
+    - description: Retrieves the information of server interface profile on OpenManage Enterprise Modular.
+      name: ome_server_interface_profile_info
+      namespace: ''
+    release_date: '2022-02-24'
diff --git a/docs/README.md b/docs/README.md
@@ -71,6 +71,8 @@ OpenManage Ansible Modules simplifies and automates provisioning, deployment, an
 - [ome_network_vlan_info](modules/ome_network_vlan_info.rst)
 - [ome_powerstate](modules/ome_powerstate.rst)
 - [ome_profile](modules/ome_profile.rst)
+- [ome_server_interface_profile_info](modules/ome_server_interface_profile_info.rst)
+- [ome_server_interface_profiles](modules/ome_server_interface_profiles.rst)
 - [ome_smart_fabric](modules/ome_smart_fabric.rst)
 - [ome_smart_fabric_uplink](modules/ome_smart_fabric_uplink.rst)
 - [ome_template](modules/ome_template.rst)

diff --git a/docs/modules/ome_server_interface_profile_info.rst b/docs/modules/ome_server_interface_profile_info.rst
@@ -0,0 +1,145 @@
+.. _ome_server_interface_profile_info_module:
+
+
+ome_server_interface_profile_info -- Retrieves the information of server interface profile on OpenManage Enterprise Modular.
+============================================================================================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+This module allows to retrieves the information of server interface profile on OpenManage Enterprise Modular.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- python >= 3.8.6
+
+
+
+Parameters
+----------
+
+  device_id (optional, list, None)
+    The ID of the device.
+
+    *device_id* is mutually exclusive with *device_service_tag*.
+
+
+  device_service_tag (optional, list, None)
+    The service tag of the device.
+
+    *device_service_tag* is mutually exclusive with *device_id*.
+
+
+  hostname (True, str, None)
+    OpenManage Enterprise Modular IP address or hostname.
+
+
+  username (True, str, None)
+    OpenManage Enterprise Modular username.
+
+
+  password (True, str, None)
+    OpenManage Enterprise Modular password.
+
+
+  port (optional, int, 443)
+    OpenManage Enterprise Modular HTTPS port.
+
+
+  validate_certs (optional, bool, True)
+    If ``False``, the SSL certificates will not be validated.
+
+    Configure ``False`` only on personally controlled sites where self-signed certificates are used.
+
+    Prior to collection version ``5.0.0``, the *validate_certs* is ``False`` by default.
+
+
+  ca_path (optional, path, None)
+    The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.
+
+
+  timeout (optional, int, 30)
+    The socket level timeout in seconds.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Run this module from a system that has direct access to OpenManage Enterprise Modular.
+   - This module supports ``check_mode``.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+    ---
+    - name: Retrieves the server interface profiles of all the device using device ID.
+      dellemc.openmanage.ome_server_interface_profile_info:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        device_id:
+          - 10001
+          - 10002
+
+    - name: Retrieves the server interface profiles of all the device using device service tag.
+      dellemc.openmanage.ome_server_interface_profile_info:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        device_service_tag:
+          - 6GHH6H2
+          - 6KHH6H3
+
+
+
+Return Values
+-------------
+
+msg (on success, str, Successfully retrieved the server interface profile information.)
+  Overall status of the server interface profile information.
+
+
+server_profiles (success, list, [AnsibleMapping([('BondingTechnology', 'LACP'), ('Id', '6KZK6K2'), ('ServerInterfaceProfile', [AnsibleMapping([('FabricId', '1ea6bf64-3cf0-4e06-a136-5046d874d1e7'), ('Id', 'NIC.Mezzanine.1A-1-1'), ('NativeVLAN', 0), ('Networks', [AnsibleMapping([('CreatedBy', 'system'), ('CreationTime', '2018-11-27 10:22:14.140'), ('Description', 'VLAN 1'), ('Id', 10001), ('InternalRefNWUUId', 'add035b9-a971-400d-a3fa-bb365df1d476'), ('Name"', 'VLAN 1'), ('Type', 2), ('UpdatedBy', None), ('UpdatedTime', '2018-11-27 10:22:14.140'), ('VlanMaximum', 1), ('VlanMinimum', 1)])]), ('NicBonded', True), ('OnboardedPort', '59HW8X2:ethernet1/1/1')]), AnsibleMapping([('FabricId', '3ea6be04-5cf0-4e05-a136-5046d874d1e6'), ('Id', 'NIC.Mezzanine.1A-2-1'), ('NativeVLAN', 0), ('Networks', [AnsibleMapping([('CreatedBy', 'system'), ('CreationTime', '2018-09-25 14:46:12.374'), ('Description', None), ('Id', 10155), ('InternalRefNWUUId', 'f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d'), ('Name', 'jagvlan'), ('Type', 1), ('UpdatedBy', None), ('UpdatedTime', '2018-09-25 14:46:12.374'), ('VlanMaximum', 143), ('VlanMinimum', 143)])]), ('NicBonded', False), ('OnboardedPort', '6H7J6Z2:ethernet1/1/1')])])])])
+  Returns the information of collected server interface profile information.
+
+
+error_info (on HTTP error, dict, AnsibleMapping([('error', AnsibleMapping([('code', 'Base.1.0.GeneralError'), ('message', 'A general error has occurred. See ExtendedInfo for more information.'), ('@Message.ExtendedInfo', [AnsibleMapping([('MessageId', 'GEN1234'), ('RelatedProperties', []), ('Message', 'Unable to process the request because an error occurred.'), ('MessageArgs', []), ('Severity', 'Critical'), ('Resolution', 'Retry the operation. If the issue persists, contact your system administrator.')])])]))]))
+  Details of the HTTP Error.
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Felix Stephen (@felixs88)
+