Vh3ddlmZmZmZeZdZdZdZdZ dZ dZ dZ d Z d Zd Zd Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!dZ"dZ#d Z$d!Z%d"Z&d#Z'd$Z(d%Z)d&Z*d'Z+d(Z,dd)l-Z-dd)l.Z.dd*l/m0Z0dd+l1m2Z2m3Z3dd,l4m5Z5m6Z6dd-l7m8Z8m9Z9dd.l:m;Z;dd/lm?Z?m@Z@d1ZAd2ZBd3ZCd4ZDd5ZEd6ZFd7ZGd8ZHd9ZIe+e,fd:ZJd;ZKd<ZLd=ZMd>ZNd?ZOd@ZPdAZQdBZRdCZSdDZTdEZUdFZVdGZWdHZXdIZYeZdJk(reYy)y))K)absolute_importdivisionprint_functiona  --- module: idrac_bios short_description: Modify and clear BIOS attributes, reset BIOS settings and configure boot sources version_added: "2.1.0" description: - This module allows to modify the BIOS attributes. Also clears pending BIOS attributes and resets BIOS to default settings. - Boot sources can be enabled or disabled. Boot sequence can be configured. extends_documentation_fragment: - dellemc.openmanage.idrac_auth_options options: share_name: type: str description: (deprecated)Network share or a local path. share_user: type: str description: "(deprecated)Network share user name. Use the format 'user@domain' or domain//user if user is part of a domain. This option is mandatory for CIFS share." share_password: type: str description: (deprecated)Network share user password. This option is mandatory for CIFS share. aliases: ['share_pwd'] share_mnt: type: str description: "(deprecated)Local mount path of the network share with read-write permission for ansible user. This option is mandatory for network shares." apply_time: type: str description: - Apply time of the I(attributes). - This is applicable only to I(attributes). - "C(Immediate) Allows the user to immediately reboot the host and apply the changes. I(job_wait) is applicable." - C(OnReset) Allows the user to apply the changes on the next reboot of the host server. - "C(AtMaintenanceWindowStart) Allows the user to apply at the start of a maintenance window as specified in I(maintenance_window). A reboot job will be scheduled." - "C(InMaintenanceWindowOnReset) Allows to apply after a manual reset but within the maintenance window as specified in I(maintenance_window)." choices: [Immediate, OnReset, AtMaintenanceWindowStart, InMaintenanceWindowOnReset] default: Immediate maintenance_window: type: dict description: - Option to schedule the maintenance window. - This is required when I(apply_time) is C(AtMaintenanceWindowStart) or C(InMaintenanceWindowOnReset). suboptions: start_time: type: str description: - The start time for the maintenance window to be scheduled. - "The format is YYYY-MM-DDThh:mm:ss" - " is the time offset from UTC that the current timezone set in iDRAC in the format: +05:30 for IST." required: true duration: type: int description: - The duration in seconds for the maintenance window. required: true attributes: type: dict description: - "Dictionary of BIOS attributes and value pair. Attributes should be part of the Redfish Dell BIOS Attribute Registry. Use U(https://I(idrac_ip)/redfish/v1/Systems/System.Embedded.1/Bios) to view the Redfish URI." - This is mutually exclusive with I(boot_sources), I(clear_pending), and I(reset_bios). boot_sources: type: list elements: raw description: - (deprecated)List of boot devices to set the boot sources settings. - I(boot_sources) is mutually exclusive with I(attributes), I(clear_pending), and I(reset_bios). - I(job_wait) is not applicable. The module waits till the completion of this task. - This feature is deprecated, please use M(dellemc.openmanage.idrac_boot) for configuring boot sources. clear_pending: type: bool description: - Allows the user to clear all pending BIOS attributes changes. - C(true) will discard any pending changes to bios attributes or remove job if in scheduled state. - This operation will not create any job. - C(false) will not perform any operation. - This is mutually exclusive with I(boot_sources), I(attributes), and I(reset_bios). - C(Note) Any BIOS job scheduled due to boot sources configuration will not be cleared. reset_bios: type: bool description: - Resets the BIOS to default settings and triggers a reboot of host system. - This is applied to the host after the restart. - This operation will not create any job. - C(false) will not perform any operation. - This is mutually exclusive with I(boot_sources), I(attributes), and I(clear_pending). - When C(true), this action will always report as changes found to be applicable. reset_type: type: str description: - C(force_restart) Forcefully reboot the host system. - C(graceful_restart) Gracefully reboot the host system. - This is applicable for I(reset_bios), and I(attributes) when I(apply_time) is C(Immediate). choices: [graceful_restart, force_restart] default: graceful_restart job_wait: type: bool description: - Provides the option to wait for job completion. - This is applicable for I(attributes) when I(apply_time) is C(Immediate). 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: 1200 requirements: - "omsdk >= 1.2.490" - "python >= 3.9.6" author: - "Felix Stephen (@felixs88)" - "Anooja Vardhineni (@anooja-vardhineni)" - "Jagadeesh N V (@jagadeeshnv)" - "Shivam Sharma (@shivam-sharma)" notes: - omsdk is required to be installed only for I(boot_sources) operation. - This module requires 'Administrator' privilege for I(idrac_user). - Run this module from a system that has direct access to Dell iDRAC. - This module supports both IPv4 and IPv6 address for I(idrac_ip). - This module supports C(check_mode). ac --- - name: Configure generic attributes of the BIOS dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" attributes: BootMode: "Bios" OneTimeBootMode: "Enabled" BootSeqRetry: "Enabled" - name: Configure PXE generic attributes dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" attributes: PxeDev1EnDis: "Enabled" PxeDev1Protocol: "IPV4" PxeDev1VlanEnDis: "Enabled" PxeDev1VlanId: 1 PxeDev1Interface: "NIC.Embedded.1-1-1" PxeDev1VlanPriority: 2 - name: Configure BIOS attributes at Maintenance window dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" apply_time: AtMaintenanceWindowStart maintenance_window: start_time: "2022-09-30T05:15:40-05:00" duration: 600 attributes: BootMode: "Bios" OneTimeBootMode: "Enabled" BootSeqRetry: "Enabled" - name: Clear pending BIOS attributes dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" clear_pending: true - name: Reset BIOS attributes to default settings. dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" validate_certs: false reset_bios: true - name: Configure boot sources dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_sources: - Name: "NIC.Integrated.1-2-3" Enabled: true Index: 0 - name: Configure multiple boot sources dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_sources: - Name: "NIC.Integrated.1-1-1" Enabled: true Index: 0 - Name: "NIC.Integrated.2-2-2" Enabled: true Index: 1 - Name: "NIC.Integrated.3-3-3" Enabled: true Index: 2 - name: Configure boot sources - Enabling dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_sources: - Name: "NIC.Integrated.1-1-1" Enabled: true - name: Configure boot sources - Index dellemc.openmanage.idrac_bios: idrac_ip: "192.168.0.1" idrac_user: "user_name" idrac_password: "user_password" ca_path: "/path/to/ca_cert.pem" boot_sources: - Name: "NIC.Integrated.1-1-1" Index: 0 a --- status_msg: description: Overall status of the bios operation. returned: success type: str sample: Successfully cleared pending BIOS attributes. msg: description: Status of the job for I(boot_sources) or status of the action performed on bios. returned: success type: dict sample: { "CompletionTime": "2020-04-20T18:50:20", "Description": "Job Instance", "EndTime": null, "Id": "JID_873888162305", "JobState": "Completed", "JobType": "ImportConfiguration", "Message": "Successfully imported and applied Server Configuration Profile.", "MessageArgs": [], "MessageId": "SYS053", "Name": "Import Configuration", "PercentComplete": 100, "StartTime": "TIME_NOW", "Status": "Success", "TargetSettingsURI": null, "retval": true } invalid_attributes: type: dict description: Dict of invalid attributes provided. returned: on invalid attributes or values. sample: { "PxeDev1VlanId": "Not a valid integer.", "AcPwrRcvryUserDelay": "Integer out of valid range.", "BootSeqRetry": "Invalid value for Enumeration.", "Proc1Brand": "Read only Attribute cannot be modified.", "AssetTag": "Attribute does not exist." } 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." } ] } } z%/redfish/v1/Systems/System.Embedded.1z%/redfish/v1/Managers/iDRAC.Embedded.1z*/redfish/v1/Systems/System.Embedded.1/Biosz7/redfish/v1/Systems/System.Embedded.1/Bios/BiosRegistryzX/redfish/v1/Systems/System.Embedded.1/Bios/Settings/Actions/Oem/DellManager.ClearPendingzA/redfish/v1/Systems/System.Embedded.1/Bios/Actions/Bios.ResetBiosz3/redfish/v1/Systems/System.Embedded.1/Bios/SettingszB/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Resetz*/redfish/v1/Managers/iDRAC.Embedded.1/Jobsz?/redfish/v1/Managers/iDRAC.Embedded.1/Jobs?$expand=*($levels=1)z3/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/{job_id}z7/redfish/v1/Managers/iDRAC.Embedded.1/LogServices/Lclogz?/redfish/v1/Managers/iDRAC.Embedded.1/LogServices/Lclog/Entriesz0/redfish/v1/Managers/iDRAC.Embedded.1/Logs/Lclogz$?$filter=MessageId%20eq%20'UEFI0157'z#?$filter=MessageId%20eq%20'SYS1003'z9BIOS Config job is running. Wait for the job to complete.zNo changes found to be applied.zChanges found to be applied.z1Successfully cleared the pending BIOS attributes.z0Successfully applied the BIOS attributes update.z>Successfully scheduled the job for the BIOS attributes update.z\Successfully committed changes. The job is in pending state. The changes will be applied {0}z)Reset BIOS action triggered successfully.zPUnable to restart the host. Check the host status and restart the host manually.zSThe BIOS reset action has been triggered successfully. The host reboot is complete.z7BIOS reset to defaults has been completed successfully.z_Pending attributes to be applied. Clear or apply the pending changes before resetting the BIOS.zGThe BIOS configuration job is scheduled. Use 'force' to delete the job.z4The values specified for the attributes are invalid.z Apply time {0} is not supported.zAThe maintenance time must be post-fixed with local offset to {0}.zsThe specified maintenance time window occurs in the past, provide a future time to schedule the maintenance window.z@The parameter job_wait_timeout value cannot be negative or zero. N)recursive_diff)URLError HTTPError)ConnectionErrorSSLValidationError)iDRACConnectionidrac_auth_params)iDRACRedfishAPI) AnsibleModule)idrac_redfish_job_trackingstrip_substr_dictci}d|_t|jd|jr|jj |jj |jd}|S)NT boot_sources)input_boot_devices) use_redfish_validate_paramsparams check_mode config_mgris_change_applicableconfigure_boot_sources)idracmodulemsgs q/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/idrac_bios.pyrun_server_bios_configr!lsc CEV]]>23  --/    1 1V]]SaEb 1 cC JcZdtdddtddddtddg}gd |D]w}t|tsd j |t |}|cStfd |jDrt||}|cSd j }|cSt|}|S) zk Validate list of dict params. :param params: Ansible list of dict :return: bool or error. NameT)nametyperequiredIndexFr)r%r&r'minEnabled)r$r(r*z;attribute values must be of type: dict. {0} ({1}) provided.c3&K|]}|v yw)N).0kdefaults r z#_validate_params..s3!g3sz&attribute keys must be one of the {0}.) strintbool isinstancedictformatr&allkeys check_params _validate_name_index_duplication)rfieldsattrrr/s @r rrvs$7#5CDe<F +G $%OVVW[]abf]ghCJ 3tyy{3 3tV,CJ:AA'JCJ  +6 2C Jr"cd}tt|dz D]M}t|dzt|D]0}||d||dk(sdj||d}|ccSO|S)zw Validate for duplicate names and indices. :param params: Ansible list of dict :return: bool or error. r$zduplicate name {0})rangelenr6)rrijs r r:r:s C 3v;? #q1uc&k* Aay F1If$55+226!9V3DE   Jr"c d}|D]}|d|vr|ddur|d|vr |ddurdj|d|d}9t||d|ds0dj|d|d||dt||d}~|d|vst||dtsd |vs||d|d ksd j|d|d }|S) z Each dictionary parameters validation as per the rule defined in fields. :param each: validating each dictionary :param fields: list of dictionary which has the set of rules. :return: tuple which has err and message r>r%r'FTz({0} is required and must be of type: {1}r&z-{0} must be of type: {1}. {2} ({3}) provided.r)z){0} must be greater than or equal to: {1})r6r4r&r2)eachr;rfs r r9r9s C  ^ V9D Qz]e%; yD Qz]d%:<CCAfIqQWyYCD6OQvY7AHH& 1V9d1V9otD6O7LNC vY$ :d1V9os#CQR AfI5)AHH6TUV[T\] ^ Jr"c |jtd}|jjdg}d}d}|D]E}|jddk(s|jddvs,|d}|jd}||fS||fS) NGETMembersUnknownJobTypeBIOSConfigurationJobState) ScheduledRunningStartingId)invoke_requestiDRAC_JOBS_EXP json_dataget) redfish_objjob_respjob_listsch_jbjb_statejbs r check_scheduled_bios_jobr\s)).%@H!!%%i4H FH 66)  3 3z8JNr8rXFvvj)H  8   8 r"cR|jtj|d}|S)Njob_idDELETE)rR iDRAC_JOB_URIr6)rVr_resps r delete_scheduled_bios_jobrcs'  % %m&:&:&&:&I8 TD Kr"c |jtd}|jjd}|S#t$ri}Y|SwxYw)NrH Attributes)rR BIOS_SETTINGSrTrU Exception)rVrbr<s r get_pending_attributesrhsO))-?~~!!,/ K  Ks15 AAcd}d}|dkDr5 |jtd}|jjd} |S|S#t$r|dz }YnwxYw|dkDrQ)NrJrrH PowerStater?)rR SYSTEM_URIrTrUrg)rVretriespstaterbs r get_power_staterospG F A+ "--j%@D^^'' 5F  M6M "kG " A+s1AAAcd |jtdd|id}|S#t$rd}Y|SwxYw)NPOST ResetTypedataTF)rRPOWER_HOST_URIr )rVp_statep_acts r power_act_hostrxsH"">6g@V"W L  Ls  //ct|}|r1t|}||vrd} |Stj||dz }|r1d}|S)NTr?F)rotimesleep)rV desired_statermintervalcountpsachieveds r track_power_statersS E  [ )  H  O JJx    Or"cp|jjd}d}t|}dg}||vrUd}d|vrd}t||}|s|j dt t |dg}d}|stjd d }t||}|s|j dt t ||}|S) N reset_typeOnGracefulShutdownforceForceOffTfailed status_msgOffr ForceRestart) rrUrorx exit_jsonHOST_RESTART_FAILEDrrzr{)rrVrrvron_staterwstate_achieveds r reset_hostrs""<0JG  %BvH X~$ j  G{G4   D5H  I*;@ JJrN$G ; 0E 1DE&{H=N r"c |jtd}|jjd}|jjd}||fS#t$rYywxYw)NrHDateTimeDateTimeLocalOffset)NN)rR MANAGER_URIrTrUrg)rVrb curr_time date_offsets r get_current_timer sc))+u=NN&&z2 nn(()>?  k !! sA A AAcd}ttg}d}d|z}tj| |j t d}|j jdjd}g}|D]#}|jdj||%t|} d} |dz} |j jd } |r|j ||| zd}|j jd } | D]}|jd | kDst}n|r |S|dz }tj||| kr| } |rt} |S#t$r t}Y|SwxYw) NihrHEntriesz @odata.idz{0}{1}r?rjrrICreated) LC_LOG_FILTERCPU_RST_FILTERrzr{rRLOG_SERVICE_URIrTrUappendr6rABIOS_RESET_COMPLETEBIOS_RESET_TRIGGEREDrg)rVr filter_listintrvlrmrburi fltr_urisfltrflenflnpvtr logs_listlogs r track_log_entryrss C .1K FVmGJJv#))/5Ann  +// <  9D   X__S$7 8 99~lNN&&z2 --i# .FND**95I  779% 1-C  JkG JJv }'C J #" J#s$C%E  E #E E E E crt|}|r|jtd|jr|jtd|j t dddt||}|s+|jddjttt|}|j|dy) NTrrrchangedrq{}rtdumpz{0} {1}r) rhrBIOS_RESET_PENDINGr CHANGES_MSGrRRESET_BIOS_DEFAULTrr6RESET_TRIGGERREDrr)rrVr< reset_successlog_msgs r reset_biosr=s !+ .D $6tD K>164Pv{3M 1A1ABRTg1hik*G 6r"ct|}|s|jtt|\}}|rg|dvr|jdt|nJ|dvrF|j r|jt dt|||jtd|j r|jt d|jtddd |jtdy) NrrOrPTrrr_rN SchedulingrrqrFr) rhrNO_CHANGES_MSGr\BIOS_JOB_RUNNINGrrrc SUCCESS_CLEARrRCLEAR_PENDING_URI)rrVr<r_ job_states r clear_pending_biosrKs !+ .D N30=FI / /   D5Ef  U 5 5    K F %k6 :    t  D K>0&t%P  t.es@a(!,@s)rR BIOS_REGISTRYrTrUr5rg)rreggyrb attr_lists r get_attributes_registryr`sp E##M59NN&&'89==lK @i@@ L  LsAA A'&A'ci}|jD]\}}||vr|j|}|jdrd||<2|jd}|dk(r8d}|jdgD]}||jdk(sd}n|sd ||<|d k(s t|} |jd | cxkr|jd krnd ||<d||<|S#t$rd||<YwxYw)NReadOnlyz'Read only attribute cannot be modified.Type EnumerationFValue ValueNameTzInvalid value for enumeration.Integer LowerBound UpperBoundzInteger not in a valid range.zInvalid integer.zThe attribute does not exist.)itemsrUr2rg) registry attr_dictinvalidr.vval_dictr&foundvalrBs r validate_vs_registryrksG!91 =||AH||J'F ||F+=(!E'||GR8" 44$(E!"!%E 9$IF!) \ :a ]8<>+ &1C1J1J;1WX y1ABr"cni}d}|rd|vr||vr*|jdtj|||fS||d<|jj d}t |||j d|j d|d<|j d |d <||fS|d k(r||vrd}d }||d<||fS) NF MaintenanceTr ApplyTimemaintenance_window start_timeMaintenanceWindowStartTimeduration"MaintenanceWindowDurationInSeconds ImmediateOnReset)rUNSUPPORTED_APPLY_TIMEr6rrUr)rrVaplytm rf_settingsrf_set reboot_reqm_wins r get_redfish_apply_timers FJ F "[(  9O9V9VW]9^ _ : '-{# ))*>?fk599\3JK7$[1G NN44[A 33  ,-- 3R8<<=RTVWK.v{G[YFO6"6;7    (X(_(_`s(t$(  * ==  Z (3M]111@!'!2!23E!F4H 0JXy  V L   (8M^_gMhrv  w   (9&RV  W  1 8 89J9J<9X Y"D2r"cn|jjddkr|jtyy)Nrrr)rrU fail_jsonNEGATIVE_TIMEOUT_MESSAGE)rs r validate_negative_job_time_outr's1 }}+,1562r"cvddiddiddgddddiddiddd dd gd d dddd ddd ddddiddidddgddddddddd }|jtt|dgdggdgdgd}t| i}|jj dt |j5}t||}d\}}|j ddk(rd}|j d d!k(rd"}n|j dd#k(rd}ddd|j|$yt|jd%5}|jj d&r t|||jj d'r t|||jj d(r t||ddd|jt)y#1swYxYw#1swY,xYw#t$r9}|jt!|t#j$|*Yd}~yd}~wt&$r@}|j(r |j(n t!|}|j|d+Yd}~yd}~wt*t,t.t0t2t4t6f$r%} |jt!| ,Yd} ~ yd} ~ wwxYw)-Nr&r1 share_pwdT)r&aliasesno_logr5listraw)r&elementsr)rrAtMaintenanceWindowStartInMaintenanceWindowOnReset)r&r/choices)r&r'r2)rr)r&optionsr3graceful_restart force_restart)r&r1r/)r&r/i) share_name share_usershare_password share_mntrrr r clear_pendingrrrr)rrr9r)r r/r)r r0r:) argument_specmutually_exclusiverequired_one_of required_ifsupports_check_moder)FFStatusSuccessMessagezNo changes found to commit!FFailed)rrr) req_sessionr9rrr)r error_info)r unreachabler$)rrrr'rrUr r!rrrrr"rr r%r1jsonloadr reason RuntimeErrorr r KeyError ImportError ValueError TypeError) specsrrrrrrVerrmessagees r mainrSsuouo#(k]dSe_v&!'U;$"tv'-BGUY9Z@ESW7X+Z[!&)v&$2Do1Vcuv#5%*trgsCB ~ @i V; z5 5 7I nXE U=RE KQ B 6 6N2, C ETr>hlOU]O;XO] KKIxe44 ,   ;NXl 0"#L 7=*<C,#"02f7 9%x zFr"