VhKf NddlmZmZmZeZdZdZdZddl Z ddl Z ddl m Z m Z ddlmZmZddlmZmZdd lmZmZmZmZd Zd Zd Zd ZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dddZ)dddd Z*d!d"d#d$d%d&d'd(d)d*d+ Z+d,d-dd.Z,d/Z-d0Z.d1Z/d9d2Z0d3Z1d4Z2d5Z3d6Z4d7Z5e6d8k(re5yy):)absolute_importdivisionprint_functionu --- module: idrac_boot short_description: Configure the boot order settings. version_added: "6.1.0" description: - This module allows to configure the boot order settings. extends_documentation_fragment: - dellemc.openmanage.idrac_x_auth_options options: boot_options: type: list elements: dict description: - Options to enable or disable the boot devices. - This is mutually exclusive with I(boot_order), I(boot_source_override_mode), I(boot_source_override_enabled) I(boot_source_override_target), and I(uefi_target_boot_source_override). suboptions: boot_option_reference: type: str description: - FQDD of the boot device. - This is mutually exclusive with I(display_name). display_name: type: str description: - Display name of the boot source device. - This is mutually exclusive with I(boot_option_reference). enabled: type: bool required: true description: Enable or disable the boot device. boot_order: type: list elements: str description: - This option allows to set the boot devices in the required boot order sequences. - This is mutually exclusive with I(boot_options). boot_source_override_mode: type: str description: - The BIOS boot mode (either Legacy or UEFI) to be used when I(boot_source_override_target) boot source is booted from. - C(legacy) The system boot in non-UEFI(Legacy) boot mode to the I(boot_source_override_target). - C(uefi) The system boot in UEFI boot mode to the I(boot_source_override_target). - This is mutually exclusive with I(boot_options). choices: [legacy, uefi] boot_source_override_enabled: type: str description: - The state of the Boot Source Override feature. - C(disabled) The system boots normally. - C(once) The system boots (one time) to the I(boot_source_override_target). - C(continuous) The system boots to the target specified in the I(boot_source_override_target) until this property is set to Disabled. - The state is set to C(once) for the one-time boot override and C(continuous) for the remain-active-until—canceled override. If the state is set C(once) or C(continuous), the value is reset to C(disabled) after the I(boot_source_override_target) actions have completed successfully. - Changes to this options do not alter the BIOS persistent boot order configuration. - This is mutually exclusive with I(boot_options). choices: [continuous, disabled, once] boot_source_override_target: type: str description: - The boot source override target device to use during the next boot instead of the normal boot device. - C(pxe) performs PXE boot from the primary NIC. - C(floppy), C(cd), C(hdd), C(sd_card) performs boot from their devices respectively. - C(bios_setup) performs boot into the native BIOS setup. - C(utilities) performs boot from the local utilities. - C(uefi_target) performs boot from the UEFI device path found in I(uefi_target_boot_source_override). - If the I(boot_source_override_target) is set to a value other than C(none) then the I(boot_source_override_enabled) is automatically set to C(once). - Changes to this options do not alter the BIOS persistent boot order configuration. - This is mutually exclusive with I(boot_options). choices: [uefi_http, sd_card, uefi_target, utilities, bios_setup, hdd, cd, floppy, pxe, none] uefi_target_boot_source_override: type: str description: - The UEFI device path of the device from which to boot when I(boot_source_override_target) is C(uefi_target). - I(boot_source_override_enabled) cannot be set to c(continuous) if I(boot_source_override_target) set to C(uefi_target) because this settings is defined in UEFI as a one-time-boot setting. - Changes to this options do not alter the BIOS persistent boot order configuration. - This is required if I(boot_source_override_target) is C(uefi_target). - This is mutually exclusive with I(boot_options). reset_type: type: str description: - C(none) Host system is not rebooted and I(job_wait) is not applicable. - C(force_restart) Forcefully reboot the Host system. - C(graceful_restart) Gracefully reboot the Host system. choices: [graceful_restart, force_restart, none] default: graceful_restart job_wait: type: bool description: - Provides the option to wait for job completion. - This is applicable when I(reset_type) is C(force_reset) or C(graceful_reset). default: true job_wait_timeout: type: int description: - The maximum wait time of I(job_wait) in seconds. The job is tracked only for this duration. - This option is applicable when I(job_wait) is C(true). default: 900 resource_id: type: str description: Redfish ID of the resource. requirements: - "python >= 3.9.6" author: - "Felix Stephen (@felixs88)" notes: - Run this module from a system that has direct access to Dell iDRAC. - This module supports C(check_mode). a --- - name: Configure the system boot options settings. dellemc.openmanage.idrac_boot: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_options: - display_name: Hard drive C enabled: true - boot_option_reference: NIC.PxeDevice.2-1 enabled: true - name: Configure the boot order settings. dellemc.openmanage.idrac_boot: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_order: - Boot0001 - Boot0002 - Boot0004 - Boot0003 - name: Configure the boot source override mode. dellemc.openmanage.idrac_boot: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_source_override_mode: legacy boot_source_override_target: cd boot_source_override_enabled: once - name: Configure the UEFI target settings. dellemc.openmanage.idrac_boot: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_source_override_mode: uefi boot_source_override_target: uefi_target uefi_target_boot_source_override: "VenHw(3A191845-5F86-4E78-8FCE-C4CFF59F9DAA)" - name: Configure the boot source override mode as pxe. dellemc.openmanage.idrac_boot: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_source_override_mode: legacy boot_source_override_target: pxe boot_source_override_enabled: continuous a --- msg: description: Successfully updated the boot settings. returned: success type: str sample: Successfully updated the boot settings. job: description: Configured job details. returned: success type: dict sample: { "ActualRunningStartTime": "2019-06-19T00:57:24", "ActualRunningStopTime": "2019-06-19T01:00:27", "CompletionTime": "2019-06-19T01:00:27", "Description": "Job Instance", "EndTime": "TIME_NA", "Id": "JID_609237056489", "JobState": "Completed", "JobType": "BIOSConfiguration", "Message": "Job completed successfully.", "MessageArgs": [], "MessageId": "PR19", "Name": "Configure: BIOS.Setup.1-1", "PercentComplete": 100, "StartTime": "2019-06-19T00:55:05", "TargetSettingsURI": null } boot: description: Configured boot settings details. returned: success type: dict sample: { "BootOptions": { "Description": "Collection of BootOptions", "Members": [{ "BootOptionEnabled": false, "BootOptionReference": "HardDisk.List.1-1", "Description": "Current settings of the Legacy Boot option", "DisplayName": "Hard drive C:", "Id": "HardDisk.List.1-1", "Name": "Legacy Boot option", "UefiDevicePath": "VenHw(D6C0639F-C705-4EB9-AA4F-5802D8823DE6)"}], "Name": "Boot Options Collection" }, "BootOrder": [ "HardDisk.List.1-1"], "BootSourceOverrideEnabled": "Disabled", "BootSourceOverrideMode": "Legacy", "BootSourceOverrideTarget": "None", "UefiTargetBootSourceOverride": null } error_info: description: Details of the HTTP Error. returned: on HTTP error type: dict sample: { "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." } ] } } N)URLError HTTPError)ConnectionErrorSSLValidationError)iDRACRedfishAPIIdracAnsibleModule)strip_substr_dictidrac_system_resetget_system_res_idwait_for_idrac_job_completionz/redfish/v1/Systemsz8/redfish/v1/Systems/{0}/BootOptions?$expand=*($levels=1)z?/redfish/v1/Managers/iDRAC.Embedded.1/Jobs?$expand=*($levels=1)z./redfish/v1/Managers/iDRAC.Embedded.1/Jobs/{0}z#/redfish/v1/Systems/{0}/BootSourcesz,/redfish/v1/Systems/{0}/BootSources/SettingszNo changes found to be applied.zChanges found to be applied.zwUnable to complete the request because the BIOS configuration job already exists. Wait for the pending job to complete.z{0} boot_options provided.z"{0} boot order reference provided.z'Successfully updated the boot settings.z#Failed to update the boot settings.z4The system does not support the BootOptions feature.z@The boot settings operation is triggered/submitted successfully.zUnable to communicate with iDRAC {0}. This may be due to one of the following: Incorrect username or password, unreachable iDRAC IP or a failure in TLS/SSL handshake.LegacyUEFI)legacyuefi ContinuousDisabledOnce continuousdisabledonceNonePxeFloppyCdHdd BiosSetup Utilities UefiTargetSDCardUefiHttp) nonepxefloppycdhdd bios_setup utilities uefi_targetsd_card uefi_httpGracefulRestart ForceRestartgraceful_restart force_restartr%c|jdjt|d}|jd}|j dd|j dd|j dd|j d1|j j d|jt |jj d "|jd d d }d |vr dtd<|S)N{0}/{1}GETBoot CertificateszBootOrder@odata.countz0BootSourceOverrideTarget@Redfish.AllowableValues BootOptions boot_optionsmsgActionsz#ComputerSystem.Resetz!ResetType@Redfish.AllowableValuesr/r0r2) invoke_requestformat SYSTEM_URI json_datapopgetparams fail_jsonUNSUPPORTED_MSG RESET_TYPE)moduleidracres_idresp resp_data type_resets q/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/idrac_boot.pyget_response_attributesrO-s    0 0V De LDv&I MM.$' MM)40 MMDdK}}]#+ 0A0A.0Q0]_- ~~)$0^^I./FGHkl J .-;J) * c|jtj|d}t|j}g}|dD]}|j t|||d<|S)Nr6Members)r>BOOT_OPTIONS_URIr?r rAappend)rIrJrKrL strip_memberseachs rNget_existing_boot_optionsrW<sk    0 7 7 ? GD!$..1IM)$6.t456(Ii rPcddd|jjdif\}}}}}|E|dk(s@dt|i}t|||d\}}}}tdd k(rd}|d k(rtdd k(rd}||||fS) NFT reset_typer% ResetType)payloadjob_waitr2r0r3r/)rDrCrGr ) rHrIrJ reset_msg track_failedresetrZjob_respdatas rN system_resetrcFs;=udFMML]L]^jLkmo;o8I|UJjF&:Z 343EeV]alp3q0|Y ( )^ ;E  (Z8J-KO`-`E , 8 33rPcgdddgc}}tjd|jtd}|jd}|r4t t fd|}t t fd|}|rd }||fS) N) ScheduledNewRunningFBIOSConfiguration r6rRc,|jdfvS)NJobTyperC)d job_type_names rNz#get_scheduled_job..Zsi0@]O0SrPc*|jdvS)NJobStaterl)rm job_states rNroz#get_scheduled_job..[sQUU:->)-KrPT)timesleepr>JOB_URIrAlistfilter)rIrris_job progress_jobrajob_resp_memberbios_config_jobrns ` @rNget_scheduled_jobr|Rs3 */1Db'FM<JJrN##GU3H((3Ov&SUdefF#K_]^ F < rPc ~t|\}}i|jd}}t|||}|d} |jddk(rd}|r|jt|j t j|d} | dk(rd nd } | jd | } | D cgc];} |j| d %| jd |j| d i=c} | | iddid}| d k(rdtt| D]E}|j|d|| |jd |j|d|iG| |d | <|j tj|d|}|jdk(r|jd}|j!dd}t#|||\}}}}|r |j}|rTt%|t&j|||jd\}}|r|j||j}|S|j||Scc} w)Nr]BootSourceOverrideModerZr%Fr;r6rBootSeq UefiBootSeq AttributesNameEnabled ApplyTimeOnReset)rz@Redfish.SettingsApplyTime BootOrderPATCHrbLocation/job_wait_timeoutr] wait_timeout)r|rDrOrE JOB_EXISTSr> BOOT_SEQ_URIr?rArCupdaterangelenPATCH_BOOT_SEQ_URI status_codeheaderssplitrcr JOB_URI_ID)rHrIrJr\rxryjob_datar]rL override_mode boot_seq_respseq_key boot_seq_datarV seq_payloadirKlocationjob_idr`r_r^reset_job_respra error_msgs rNconfigure_boot_optionsrasn,U3FLV]]:6hH'v>I67M }}\"f, Z((()<)r?r@rrcrAr|rrrE)rHrIr\rJrr]rKr`r_r^rrxryrars rNapply_boot_settingsrsV]]:6hH }}\"f,    0 0V DgT[  \D 39EfeU[9\6|Y %//H07 &CE:K\K\]ijk]lmq]rKsMUQWQ^Q^_qQr't#)$$$3#-- O  Y / OrPcxidii}}|jjd}|jjd}|jjd}|jjd}t|||} || jd} |D cgc] } | | vs|  } } | r&|jtj d| t t|t |k(sO|dd} | D cgc]} | | vs| j| c} |jtj d | t |t | k(s|jd || k(s|djd|i|Ptj|| jd k(s)|djd tj|i|Ptj|| jdk(s)|djdtj|i|tj|| jdk(ss|djdtj|i|jjd}|dk(r*|| jdk(s|djd|i|jr|dr|jtd|S|js |js|ds|jt |St#||||}|Scc} wcc} w)Nr7 boot_orderboot_source_override_modeboot_source_override_enabledboot_source_override_targetrInvalid)r<invalid_boot_order Duplicate)r<duplicate_boot_orderzZUnable to complete the operation because all boot devices are required for this operation.r;r~BootSourceOverrideEnabledBootSourceOverrideTarget uefi_target_boot_source_overrider,UefiTargetBootSourceOverrideTr<changed)rDrCrOrEINVALID_BOOT_OPTr?rsetremoverBS_OVERRIDE_MODEBS_OVERRIDE_ENABLEDBS_OVERRIDE_TARGET check_mode exit_json CHANGES_MSGNO_CHANGES_MSGr)rHrIrJrar\rroverride_enabledoverride_targetresponseexist_boot_orderbor dup_orderuefi_override_targets rNconfigure_boot_settingsrsVRLgH""<0JMM%%&ABM}}(()GHmm''(EFO&vuf=H#<< 4+5TRCS9SbTT    !1!8!8!CXj  k3z?#s:6"1 I,< PbiY  b ! P   !1!8!8!E2;  =:#&6"77   "D  E-- FO " "K#< = !%%m4 E]8^^ 8:J:N:N}:]^_#$(()9:hllKf>gg ;=P=T=TUe=fgh"#''8HLLIc.s1X;8*+DrPrRBootOptionEnabledenabledrrr)r<invalid_boot_optionsr)r<duplicate_boot_optionsTrFr;)rDrCrWrvrwrTboolritemsrEBOOT_OPT_ERROR_MSGr?rranyrrallrrr)rHrIrJr:inv_boot_options diff_changer\raboot_option_datarVreportact_valext_valrrs @@rNconfigure_idrac_bootrs==$$^4L792r2~4k7H4UFC ;D/3xx/G/StN+Y]YaYabyYzH(,(@(L}RgH&!DFVW`FabcF ''-.Y@.q :M0NO""4GMMO(? b !F% V]] = _]]&&}5F$5e$<! $$$3+FE6BH-h7M8G /vFI'7Im $"&&z26PP!2!29!=!C!C!EE  Z] CMM*-|1LPV1V%))*59JJ  \}9 U   -iY]  ^% _ _ _& O 88s?   !6!6v}}Z7P!Q  RSX$))C.NN a^226==3LM[_` \3E Xy* >%SV$$%sJ(F=?D)F1(F=1F:6F=:F== KA1H<rs5CB r j7 tE P KIynn # M K = 4 C2, = 177 2 HQ k'7%1zSYZ$Uhd"+K%1hU_a#4n^b c   4  $N.(V>F%R zFrP