VhhddlmZmZmZeZdZdZdZddl Z ddl m Z ddl m Z mZddlmZdd lmZmZd Zd Zd Zd ZdZdZdZdZdZd!dZdZd"dZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)e*d k(re)yy)#)absolute_importdivisionprint_functiona` --- module: ome_firmware short_description: Update firmware on PowerEdge devices and its components through OpenManage Enterprise version_added: "2.0.0" description: This module updates the firmware of PowerEdge devices and all its components through OpenManage Enterprise. extends_documentation_fragment: - dellemc.openmanage.ome_auth_options options: device_service_tag: description: - List of service tags of the targeted devices. - Either I(device_id) or I(device_service_tag) can be used individually or together. - This option is mutually exclusive with I(device_group_names) and I(devices). type: list elements: str device_id: description: - List of ids of the targeted device. - Either I(device_id) or I(device_service_tag) can be used individually or together. - This option is mutually exclusive with I(device_group_names) and I(devices). type: list elements: int device_group_names: description: - Enter the name of the device group that contains the devices on which firmware needs to be updated. - This option is mutually exclusive with I(device_id) and I(device_service_tag). type: list elements: str dup_file: description: - "The path of the Dell Update Package (DUP) file that contains the firmware or drivers required to update the target system device or individual device components." - This is mutually exclusive with I(baseline_name), I(components), and I(devices). type: path baseline_name: description: - Enter the baseline name to update the firmware of all devices or list of devices that are not complaint. - This option is mutually exclusive with I(dup_file) and I(device_group_names). type: str components: description: - List of components to be updated. - If not provided, all components applicable are considered. - This option is case sensitive. - This is applicable to I(device_service_tag), I(device_id), and I(baseline_name). type: list default: [] elements: str devices: description: - This option allows to select components on each device for firmware update. - This option is mutually exclusive with I(dup_file), I(device_group_names), I(device_id), and I(device_service_tag). type: list elements: dict suboptions: id: type: int description: - The id of the target device to be updated. - This option is mutually exclusive with I(service_tag). service_tag: type: str description: - The service tag of the target device to be updated. - This option is mutually exclusive with I(id). components: description: The target components to be updated. If not specified, all applicable device components are considered. type: list default: [] elements: str schedule: type: str description: - Select the schedule for the firmware update. - if C(StageForNextReboot) is chosen, the firmware will be staged and updated during the next reboot of the target device. - if C(RebootNow) will apply the firmware updates immediately. choices: - RebootNow - StageForNextReboot default: RebootNow reboot_type: version_added: '8.3.0' type: str description: - This option provides the choices to reboot the server immediately after the firmware update. - This is applicable when I(schedule) is C(RebootNow). - C(GracefulRebootForce) performs a graceful reboot with forced shutdown. - C(GracefulReboot) performs a graceful reboot without forced shutdown. - C(PowerCycle) performs a power cycle for a hard reset on the device. choices: - GracefulReboot - GracefulRebootForce - PowerCycle default: GracefulRebootForce requirements: - "python >= 3.9.6" author: - "Felix Stephen (@felixs88)" - "Jagadeesh N V (@jagadeeshnv)" - "Abhishek Sinha (@ABHISHEK-SINHA10)" notes: - Run this module from a system that has direct access to Dell OpenManage Enterprise. - This module supports C(check_mode). a --- - name: Update firmware from DUP file using device ids dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_id: - 11111 - 22222 dup_file: "/path/Chassis-System-Management_Firmware_6N9WN_WN64_1.00.01_A00.EXE" - name: Update firmware from a DUP file using a device service tags dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_service_tag: - KLBR111 - KLBR222 dup_file: "/path/Network_Firmware_NTRW0_WN64_14.07.07_A00-00_01.EXE" - name: Update firmware from a DUP file using a device group names dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_group_names: - servers dup_file: "/path/BIOS_87V69_WN64_2.4.7.EXE" - name: Update firmware using baseline name dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices - name: Stage firmware for the next reboot using baseline name dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices schedule: StageForNextReboot - name: "Update firmware using baseline name and components." dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices components: - BIOS - name: Update firmware of device components from a DUP file using a device ids in a baseline dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices device_id: - 11111 - 22222 components: - iDRAC with Lifecycle Controller - name: Update firmware of device components from a baseline using a device service tags under a baseline dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices device_service_tag: - KLBR111 - KLBR222 components: - IOM-SAS - name: Update firmware using baseline name with a device id and required components dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices devices: - id: 12345 components: - Lifecycle Controller - id: 12346 components: - Enterprise UEFI Diagnostics - BIOS - name: "Update firmware using baseline name with a device service tag and required components." dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices devices: - service_tag: ABCDE12 components: - PERC H740P Adapter - BIOS - service_tag: GHIJK34 components: - OS Drivers Pack - name: "Update firmware using baseline name with a device service tag or device id and required components." dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices devices: - service_tag: ABCDE12 components: - BOSS-S1 Adapter - PowerEdge Server BIOS - id: 12345 components: - iDRAC with Lifecycle Controller - name: "Update firmware using baseline name and components and perform Powercycle." dellemc.openmanage.ome_firmware: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" baseline_name: baseline_devices components: - BIOS reboot_type: PowerCycle a --- msg: type: str description: "Overall firmware update status." returned: always sample: Successfully submitted the firmware update job. update_status: type: dict description: The firmware update job and progress details from the OME. returned: success sample: { 'LastRun': None, 'CreatedBy': 'user', 'Schedule': 'startnow', 'LastRunStatus': { 'Id': 1111, 'Name': 'NotRun' }, 'Builtin': False, 'Editable': True, 'NextRun': None, 'JobStatus': { 'Id': 1111, 'Name': 'New' }, 'JobName': 'Firmware Update Task', 'Visible': True, 'State': 'Enabled', 'JobDescription': 'dup test', 'Params': [{ 'Value': 'true', 'Key': 'signVerify', 'JobId': 11111}, { 'Value': 'false', 'Key': 'stagingValue', 'JobId': 11112}, { 'Value': 'false', 'Key': 'complianceUpdate', 'JobId': 11113}, { 'Value': 'INSTALL_FIRMWARE', 'Key': 'operationName', 'JobId': 11114}], 'Targets': [{ 'TargetType': { 'Id': 1000, 'Name': 'DEVICE'}, 'Data': 'DCIM:INSTALLED#701__NIC.Mezzanine.1A-1-1=1234567654321', 'Id': 11115, 'JobId': 11116}], 'StartTime': None, 'UpdatedBy': None, 'EndTime': None, 'Id': 11117, 'JobType': { 'Internal': False, 'Id': 5, 'Name': 'Update_Task'} } 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)SSLError)RestOMEOmeAnsibleModule)ConnectionError)URLError HTTPErrorz4UpdateService/Baselines({0})/DeviceComplianceReportszUpdateService/BaselineszIFirmware update task initiated from OpenManage Ansible Module collectionszzNo changes found to be applied. Either there are no updates present or components specified are not found in the baseline.z!Failed to read compliance report.zdParameter 'dup_file' to be provided along with 'device_id'|'device_service_tag'|'device_group_names'z(Unable to get applicable components DUP.zChanges found to be applied.cldi}}|jd||}|jdk(r |j}|S)z1Spawns an update job and tracks it to completion.zJobService/JobsPOST)data)invoke_request status_code json_data)rest_obj job_payloadjob_uri job_detailsjob_resps s/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/ome_firmware.pyspawn_update_jobrrsA,b[G&&vw[&IHs"(( c ||jd}||jdddd}|jd}dd d d ||d d dd g}|d k(r,dddd}|jd} |jd|| d ddtdd|dd||d} || djddj |dd | djddj |dd | djd dj |d!d | djd"dd | S| djdd"dd#| S)$z8Formulate the payload to initiate a firmware update job. Update_Taskz Unable to fetch the job type Id.msgtruefalse)StageForNextReboot RebootNowschedule operationNameINSTALL_FIRMWARE)KeyValue stagingValue signVerifyr"123 PowerCycleGracefulRebootGracefulRebootForce reboot_type rebootTyperzFirmware Update TaskstartnowEnabledIdName)r6JobNameJobDescriptionScheduleStateJobTypeTargetsParamsr>complianceReportIdz{0} baseline_id repositoryIdrepo_id catalogId catalog_idcomplianceUpdate)JobIdr&r')get_job_type_id fail_jsonparamsappend FW_JOB_DESCformat) rmodule target_databaselineresp stage_dictr#rI reboot_dictr1payloads rjob_payload_for_updaterT{s  # #M 2D |?@(.WEJ}}Z(H%0BC$z(/CD"V46F;%(),.13 mmM2  l[5MNO2%:dM'J G  )= U]^kUlHm!no  %,,xXaObBc!de  u||HUaLb?c!de  );f!MN N   15GRY!Z[ Nrcg}d}ddd}|jd|||d}|jdk(r|j}t|d}|D]u} | d d D]h} i} | d | d <d j | d|| d<i| d<t | d d| dd <t| d d| dd<|j | jw|S|jt|S)zS4TV`#a )+&/26.3I.3Y/Z&t,14VN5KL\5]1^&v.""8, - -  ^, rc $ggg|d}|,|jdttt|i|S|,|jdttt|i|S|*|jdttt|i|S)z+Returns the DUP applicability JSON payload.)SingleUpdateReportBaselineSingleUpdateReportGroupSingleUpdateReportTargetsr\rtrsrr)updatelistmaprf)rl device_ids group_ids baseline_idsdup_applicability_payloads rget_dup_applicability_payloadr|s?A<>>@@J!L!((*EtCPSU_L`Ga)bc %$  !((*CT#cS\J]E^)_` %$  !!((*FSQTVbMcHd)ef $$rc d}ddd}d\}}|jd}t|d5}|j}|jd|||dd }|jd k(rd }t |j }n/|jd j||jdddd||fS#1swY||fSxYw)z,Upload DUP file to OME and get a file token.z.UpdateService/Actions/UpdateService.UploadFilezapplication/octet-streamrV)FNdup_filerbr dF)rrYrZdumpr[TzUnable to upload {0} to {1}hostnamerN) rIopenreadrrrerrHrL) rrM upload_urirYupload_successtokenr~rSresponses rupload_dup_filersAJ9E_`G'NE}}Z(H h l,,.**6:GU\7:+H   3 &!N**+E   !>!E!EhPVP]P]^hPi!j  kl 5  l 5  s A>B22B>c g}|jd}|jdr t|dDcgc]}t|d|dfc}}t t|}g}|D]} | |j vr|j | '| |jvrTt|j t|jj| } |j | |j | |r9|jdjdjt|||fS|jd|fScc}w) zBGetting the list of device ids filtered from the device inventory.zDeviceService/Devices report_listr6DeviceServiceTagztUnable to complete the operation because the entered target device service tag(s) or device id(s) '{0}' are invalid.,rz!Failed to fetch the device facts.)get_all_report_detailsgetdictrerwkeysrJvaluesrvindexrHrLjoinset) rrMdevice_id_tags device_idrPrm device_resp device_tags invalid_tagstagidss rget_device_idsrs^I  * *+B CD xx Z^_lZmnPVS.7I0JKno #~.   )Ck&&((  % **,,;++-.tK4F4F4H/I/O/OPS/TU  %##C( )    AAGQTUaQbHcAd  f k !! @A k !!#osEc |jd}|jjd}|dr|dDcgc]}|D]}|d|k(s |d}}}tt |tt |k7r9|j dj djt |Scc}}w) 7Getting the list of group ids filtered from the groups.zGroupService/Groupsdevice_group_namesrr7r6zcUnable to complete the operation because the entered target device group name(s) '{0}' are invalid.rr)rrIrlenrrHrLr)rrMrP group_namegrpgrpnamegrp_idss r get_group_idsrs  * *+@ AD""#78J M(,](;p:pY\]cYdhoYo3t9p9pp s: 3s7|#4 4   **0&#j/1J*K  M N qs B= B=c8|jt}|jjdi}}|drP|dD]#}|d|k(s |d|d<|d|d<|d|d <%|s!|j d j | |S|j d |S) r baseline_namerr7r6r@ RepositoryIdrB CatalogIdrDz[Unable to complete the operation because the entered target baseline name '{0}' is invalid.rzYUnable to complete the operation because the entered target baseline name does not exist.)r BASELINE_URIrIrrHrL)rrMrPrObaseline_detailsbses rget_baseline_idsrs  * *< 8D!'!2!2?!CRH M & BC6{h&25d) /.1..A +14[1A .  B    ))/)9  ;  D E rc>d\}}}}|jjd t||}nt|}t |||\}}|j r|j tdt||\}} |rt| |||} | r t|| |}|S)N)NNNNrTrchanged)rxryrz) rIrr_validate_device_attributesr check_mode exit_json CHANGES_FOUNDrr|rp) rrMrNrxryrzr id_tag_map upload_statusrreport_payloads rsingle_dup_updaters7M4KY  }}-.:!(F3 4V<!/&.!Q J ]D9*8V<M56u_hDPR 3HnfUK rc 4 tj|d}|j|}g}ddg|dr g |sE|jj d t |dDcgc]}t |d fc}}|dD]}|d} t | |vs|j t | g |j d} | Ei} g} stfd| D} nt fd | D} | sx| | d <t d j| | d <|d |dd| d<|j| n|jt|s|jt|jr|jtd|Scc}w)Nr@UPGRADE DOWNGRADEr componentsr_ComponentComplianceReportsc36K|]}|dvr|dyw) UpdateAction SourceNameN).0icompupdate_actionss r z(baseline_based_update..6s,)U,1.,A^,S*/|)<)Usc3\K|]#}|dvr|jdvr|d%yw)rr7rN)r)rrcompsrs rrz(baseline_based_update..9s=)H.3N.C~.U*/))F*;u*D*/|)<)Hs),r6;rarcrdr5rbrTr)COMPLIANCE_URIrLrrIrrrervrrJrHCOMPLIANCE_READ_FAILrNO_CHANGES_MSGrr)rrMrO dev_comp_mapcompliance_urirPcompliance_report_listdevdvcdev_idcompliance_report data_dict comp_listrrs @@rbaseline_based_updater#s#**8M+BCN  * *> :D-N MMM%%l3E$}J] ^3#c*o"6!> ^_L & AC_F6{l*$((Vb9$'GG,H$I!$0 "I "I $()UJ[)U%U %))HJ[)H%H !*0 $,/HMM),D &)9<^9LVYZjVk2l ,/.55i@' A* 12 !^, ]D9 !!7!_s#Fcg}|jjd}|jjd}|jjd}|rY|D]T}|jdr!|j|jd5|j|jdV||j|||j||S)Ndevice_service_tagrdevicesid service_tag)rIrrJextend)rMrrrrrs rrrJsN--##$89K !!+.Imm *G >Cwwt}%%cggdm4%%cggm&<=  > i(k* rcZt|}t|||\}}|jjd}i}|rt |Dcgc]}||fc}}|jjd}|r|D]}|jdr-|jd|t |jd<At |jt |jj|jd} |jd|t | <|Scc}w)Nrrrr) rrrIrrrervrrr) rrMrrxrrrrrrs rget_device_component_mapr\s08N+HfnMJ MM  l +ELZ@cc5\@A mm *G >Cwwt}3677<3H S/0*//+,T*2C2C2E-F-L-LSWWUbMc-de(+ (= SW%  > As D(c|j}|jdrSt|jd|jd|jdgs|jtyyy)Nr~rrrr)rIranyrH DUP_REQ_MSG)rMparams rvalidate_inputsrns_ MME yyEIIk*EII6J,KUYYWkMlmn     -orcddddddddidddddgdddiddd gdd dgd d d dd ddiddiddgdddgdgdd }t|ddggddggdgdddggdgd}t|id}} t|jd5}|jj dr't ||}t ||}t||||}n t||}t||||}t||}ddd|j#d|d y#1swYxYw#t$r9}|jt|tj|Yd}~^d}~wt $r&}|j#t|dYd}~d}~wt$t&t(t*t,t.t0f$r%}|jt|Yd}~d}~wwxYw)!Nrvre)typeelementsrfrpath)rrdefaultr"r!)rchoicesrr-r0r)rrr)rr)rroptionsmutually_exclusiverequired_one_of) rrr~rrrr#r1rr~r)rrr)rrrr)r~rrT) argument_specrrsupports_check_mode) req_session)rO)r error_info)r unreachablerz/Successfully submitted the firmware update job.)r update_statusr)rrrrIrrrrrrTrr rHrejsonloadr rIOError ValueErrorr TypeErrorr AttributeErrorOSError) specsrMrrrdevice_comp_maprNrerrs rmainrus'-5A$%8V$'-5A%5RH %" =Q/R_jk %#Z#8:uo &'-5RP $9"9 56   E.$o67 j ) : C 2 3 1 3 ! FF&($#M' V]] 5 D}}  1#3Hf#E ":8V"L3HfFVXgh /&A 06;YijK,X{CM D JZgquv D D BSX$))C.AA 9SX488 Z9o~W^ _'SX&&'sI/DA*D 0D DD G"/E G"F+G.GG__main__)N)NNN)+ __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrsslr?ansible_collections.dellemc.openmanage.plugins.module_utils.omerransible.module_utils.urlsr +ansible.module_utils.six.moves.urllib.errorr r rrrKrrrrgrrrTrpr|rrrrrrrrrr__name__rrrr sCB i VQ fO d e5KH( Y +:t ;.  F0 %!$"2 ($$"N$$.5wp zFr