Merge pull request #330 from felixs88/collections

Release 4.2.0
dell · Oct 27, 2021 · c006cdb · c006cdb
2 parents b1a7d24 + 09c7c0e
commit c006cdb
Show file tree

Hide file tree

Showing 18 changed files with 3,048 additions and 4 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,28 @@ Dell EMC OpenManage Ansible Modules Release Notes
 .. contents:: Topics
 
 
+v4.2.0
+======
+
+Release Summary
+---------------
+
+Support to configure OME Modular devices network, power, and location settings.
+
+Known Issues
+------------
+
+- idrac_user - Issue(192043) 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) ome_smart_fabric_uplink 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 ome_device_power_settings 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.``
+
+New Modules
+-----------
+
+- dellemc.openmanage.ome_device_location - Configure device location settings on OpenManage Enterprise Modular
+- dellemc.openmanage.ome_device_mgmt_network - Configure network settings of devices on OpenManage Enterprise Modular
+- dellemc.openmanage.ome_device_power_settings - Configure chassis power settings on OpenManage Enterprise Modular
+
 v4.1.0
 ======
 

diff --git a/README.md b/README.md
@@ -34,8 +34,9 @@ OpenManage Ansible Modules simplifies and automates provisioning, deployment, an
 Install the collection from the github repository using the latest commit on the branch 'collections'  
 ```ansible-galaxy collection install git+https://github.com/dell/dellemc-openmanage-ansible-modules.git,collections```
 
-## Playbooks
-Latest sample playbooks and examples are available at [playbooks](https://github.com/dell/dellemc-openmanage-ansible-modules/tree/collections/playbooks).
+## Playbooks and Tutorials
+* For the latest sample playbooks and examples, see [playbooks](https://github.com/dell/dellemc-openmanage-ansible-modules/tree/collections/playbooks).
+* For the tutorials and sample use cases, see the tutorials available at [developer.dell.com](https://developer.dell.com/).
 
 ## Documentation
 - For the OpenManage Ansible collection documentation, see [Documentation](https://github.com/dell/dellemc-openmanage-ansible-modules/tree/collections/docs). This documentation page is updated for every major and minor (patch release) and has the latest collection documentation.

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -376,4 +376,32 @@ releases:
     - description: Manage Redfish Subscriptions
       name: redfish_event_subscription
       namespace: ''
-    release_date: '2021-09-28'
+    release_date: '2021-09-28'
+  4.2.0:
+    changes:
+      known_issues:
+      - idrac_user - Issue(192043) 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) ome_smart_fabric_uplink 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 ome_device_power_settings 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 configure OME Modular devices network, power, and location settings.
+    modules:
+    - description: Configure network settings of devices on OpenManage Enterprise Modular
+      name: ome_device_mgmt_network
+      namespace: ''
+    - description: Configure device location settings on OpenManage Enterprise Modular
+      name: ome_device_location
+      namespace: ''
+    - description: Configure chassis power settings on OpenManage Enterprise Modular
+      name: ome_device_power_settings
+      namespace: ''
+    release_date: '2021-10-27'
diff --git a/docs/README.md b/docs/README.md
@@ -45,6 +45,9 @@ OpenManage Ansible Modules simplifies and automates provisioning, deployment, an
 - [ome_configuration_compliance_info](modules/ome_configuration_compliance_info.rst)
 - [ome_device_group](modules/ome_device_group.rst)
 - [ome_device_info](modules/ome_device_info.rst)
+- [ome_device_location](modules/ome_device_location.rst)
+- [ome_device_mgmt_network](modules/ome_device_mgmt_network.rst)
+- [ome_device_power_settings](modules/ome_device_power_settings.rst)
 - [ome_diagnostics](modules/ome_diagnostics.rst)
 - [ome_discovery](modules/ome_discovery.rst)
 - [ome_domain_user_groups](modules/ome_domain_user_groups.rst)

diff --git a/docs/modules/ome_device_location.rst b/docs/modules/ome_device_location.rst
@@ -0,0 +1,175 @@
+.. _ome_device_location_module:
+
+
+ome_device_location -- Configure device location settings on OpenManage Enterprise Modular
+==========================================================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+This module allows to configure the device location settings of the chassis on OpenManage Enterprise Modular.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- python >= 2.7.17
+
+
+
+Parameters
+----------
+
+  device_id (optional, int, None)
+    The ID of the chassis for which the settings need to be updated.
+
+    If the device ID is not specified, this module updates the location settings for the *hostname*.
+
+    *device_id* is mutually exclusive with *device_service_tag*.
+
+
+  device_service_tag (optional, str, None)
+    The service tag of the chassis for which the settings need to be updated.
+
+    If the device service tag is not specified, this module updates the location settings for the *hostname*.
+
+    *device_service_tag* is mutually exclusive with *device_id*.
+
+
+  data_center (optional, str, None)
+    The data center name of the chassis.
+
+
+  room (optional, str, None)
+    The room of the chassis.
+
+
+  aisle (optional, str, None)
+    The aisle of the chassis.
+
+
+  rack (optional, str, None)
+    The rack name of the chassis.
+
+
+  rack_slot (optional, int, None)
+    The rack slot number of the chassis.
+
+
+  location (optional, str, None)
+    The physical location of the chassis.
+
+
+  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.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Run this module from a system that has direct access to Dell EMC OpenManage Enterprise Modular.
+   - This module supports ``check_mode``.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+    ---
+    - name: Update device location settings of a chassis using the device ID.
+      dellemc.openmanage.ome_device_location:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        device_id: 25011
+        data_center: data center 1
+        room: room 1
+        aisle: aisle 1
+        rack: rack 1
+        rack_slot: 2
+        location: location 1
+
+    - name: Update device location settings of a chassis using the device service tag.
+      dellemc.openmanage.ome_device_location:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        device_service_tag: GHRT2RL
+        data_center: data center 2
+        room: room 7
+        aisle: aisle 4
+        rack: rack 6
+        rack_slot: 22
+        location: location 5
+
+    - name: Update device location settings of the host chassis.
+      dellemc.openmanage.ome_device_location:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        data_center: data center 3
+        room: room 3
+        aisle: aisle 1
+        rack: rack 7
+        rack_slot: 10
+        location: location 9
+
+
+
+Return Values
+-------------
+
+msg (always, str, Successfully updated the location settings.)
+  Overall status of the device location settings.
+
+
+location_details (success, dict, {'Aisle': 'aisle 1', 'DataCenter': 'data center 1', 'Location': 'location 1', 'RackName': 'rack 1', 'RackSlot': 2, 'Room': 'room 1', 'SettingType': 'Location'})
+  returned when location settings are updated successfully.
+
+
+error_info (on HTTP error, dict, {'error': {'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.', '@Message.ExtendedInfo': [{'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)
+