[ome_configuration_compliance_baseline] - Added support for scheduling or staging the job (#678)

* added support for scheduling or staging

* added cron validation and updated message
---------

Co-authored-by: Rajshekar P <31881341+rajshekarp87@users.noreply.github.com>

Author: ShivamSh3

docs/modules/ome_configuration_compliance_baseline.rst

@@ -93,6 +93,32 @@ Parameters
     This option is applicable when \ :emphasis:`command`\  is \ :literal:`create`\ , or \ :literal:`modify`\ .
 
 
+  run_later (optional, bool, None)
+    Indicates whether to remediate immediately or in the future.
+
+    This is applicable when \ :emphasis:`command`\  is \ :literal:`remediate`\ .
+
+    If \ :emphasis:`run\_later`\  is \ :literal:`true`\ , then \ :emphasis:`staged\_at\_reboot`\  is ignored.
+
+    If \ :emphasis:`run\_later`\  is \ :literal:`true`\ , then \ :emphasis:`job\_wait`\  is not applicable.
+
+    If \ :emphasis:`run\_later`\  is \ :literal:`true`\ , then \ :emphasis:`cron`\  must be specified.
+
+
+  cron (optional, str, None)
+    Provide a cron expression based on Quartz cron format.
+
+    Time format is "%S %M %H %d %m ? %Y".
+
+    This is applicable when \ :emphasis:`run\_later`\  is \ :literal:`true`\ .
+
+
+  staged_at_reboot (optional, bool, None)
+    Indicates whether remediate has to be executed on next reboot.
+
+    If \ :emphasis:`staged\_at\_reboot`\  is \ :literal:`true`\ , then remediation will occur during the next reboot.
+
+
   job_wait (optional, bool, True)
     Provides the option to wait for job completion.
 
@@ -271,6 +297,32 @@ Examples
         command: "remediate"
         names: "baseline1"
 
+    - name: Remediate specific non-compliant devices to a configuration compliance baseline using device IDs at scheduled time
+      dellemc.openmanage.ome_configuration_compliance_baseline:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        command: "remediate"
+        names: "baseline1"
+        device_ids:
+          - 1111
+        run_later: true
+        cron: "0 10 11 14 02 ? 2032"  # Feb 14,2032 11:10:00
+
+    - name: Remediate specific non-compliant devices to a configuration compliance baseline using device service tags on next reboot
+      dellemc.openmanage.ome_configuration_compliance_baseline:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        command: "remediate"
+        names: "baseline1"
+        device_service_tags:
+          - "SVCTAG1"
+          - "SVCTAG2"
+        staged_at_reboot: true
+
 
 
 Return Values
@@ -292,6 +344,10 @@ job_id (when I(command) is C(remediate), int, 14123)
   Task ID created when \ :emphasis:`command`\  is \ :literal:`remediate`\ .
 
 
+job_details (on job failure, list, [{'ElapsedTime': '00:22:17', 'EndTime': '2024-06-19 13:42:41.285', 'ExecutionHistoryId': 797320, 'Id': 14123, 'IdBaseEntity': 19559, 'JobStatus': {'Id': 2070, 'Name': 'Failed'}, 'Key': 'SVCTAG1', 'Progress': '100', 'StartTime': '2024-06-19 13:20:23.495', 'Value': 'Starting Pre-checks....LC status is : InUse, wait for 30 seconds and retry ...(1)'}])
+  Details of the failed job.
+
+
 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.
 
@@ -311,4 +367,5 @@ Authors
 
 - Sajna Shetty(@Sajna-Shetty)
 - Abhishek Sinha(@Abhishek-Dell)
+- Shivam Sharma(@ShivamSh3)
 

playbooks/ome/compliance/ome_configuration_compliance_baseline.yml

@@ -121,3 +121,33 @@
         job_wait_timeout: 2000
         names: "baseline1"
       delegate_to: localhost
+
+    - name: Remediate specific non-compliant devices to a configuration
+       compliance baseline using device IDs at scheduled time
+      dellemc.openmanage.ome_configuration_compliance_baseline:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        command: "remediate"
+        names: "baseline1"
+        device_ids:
+          - 1111
+        run_later: true
+        cron: "0 00 11 14 02 ? 2032"  # Feb 14,2032 4:30:00 PM
+      delegate_to: localhost
+
+    - name: Remediate specific non-compliant devices to a configuration
+       compliance baseline using device service tags on next reboot
+      dellemc.openmanage.ome_configuration_compliance_baseline:
+        hostname: "192.168.0.1"
+        username: "username"
+        password: "password"
+        ca_path: "/path/to/ca_cert.pem"
+        command: "remediate"
+        names: "baseline1"
+        device_service_tags:
+          - "SVCTAG1"
+          - "SVCTAG2"
+        staged_at_reboot: true
+      delegate_to: localhost

plugins/module_utils/ome.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 # Dell OpenManage Ansible Modules
-# Version 9.3.0
+# Version 9.4.0
 # Copyright (C) 2019-2024 Dell Inc. or its subsidiaries. All Rights Reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -38,6 +38,7 @@
 from ansible.module_utils.six.moves.urllib.error import URLError, HTTPError
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible_collections.dellemc.openmanage.plugins.module_utils.utils import config_ipv6
+from ansible_collections.dellemc.openmanage.plugins.module_utils.utils import strip_substr_dict
 from ansible.module_utils.basic import AnsibleModule
 
 ome_auth_params = {
@@ -58,6 +59,7 @@
 JOB_URI = "JobService/Jobs({job_id})"
 JOB_SERVICE_URI = "JobService/Jobs"
 HOST_UNRESOLVED_MSG = "Unable to resolve hostname or IP {0}."
+JOB_EXEC_HISTORY = "JobService/Jobs({job_id})/ExecutionHistories"
 
 
 class OpenURLResponse(object):
@@ -406,6 +408,24 @@ def _get_omam_ca_env(self):
         """Check if the value is set in REQUESTS_CA_BUNDLE or CURL_CA_BUNDLE or OMAM_CA_BUNDLE or returns None"""
         return os.environ.get("REQUESTS_CA_BUNDLE") or os.environ.get("CURL_CA_BUNDLE") or os.environ.get("OMAM_CA_BUNDLE")
 
+    def get_job_execution_details(self, job_id):
+        try:
+            job_detail_status = []
+            resp = self.invoke_request('GET', JOB_EXEC_HISTORY.format(job_id=job_id))
+            ex_hist = resp.json_data.get('value')
+            # Sorting based on startTime and to get latest execution instance.
+            tmp_dict = dict((x["StartTime"], x["Id"]) for x in ex_hist)
+            sorted_dates = sorted(tmp_dict.keys())
+            ex_url = JOB_EXEC_HISTORY.format(job_id=job_id) + "({0})/ExecutionHistoryDetails".format(tmp_dict[sorted_dates[-1]])
+            all_exec = self.get_all_items_with_pagination(ex_url)
+            for jb_ip in all_exec.get('value'):
+                jb_ip = strip_substr_dict(jb_ip)
+                jb_ip.get('JobStatus', {}).pop('@odata.type', None)
+                job_detail_status.append(jb_ip)
+        except Exception:
+            pass
+        return job_detail_status
+
 
 class OmeAnsibleModule(AnsibleModule):
     def __init__(self, argument_spec, bypass_checks=False, no_log=False,