Vhc@lddlmZmZmZeZdZdZdZddl Z ddl m Z ddl m Z mZddlmZdd lmZmZdd lmZmZdd lmZmZd Zd ZdZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%gdZ&e&dgdgdZ'ddddZ(ddd Z)d!d"d#d$d%id&d'd(d)d*dZ*d+d,d-dZ+d.Z,d/Z-d0Z.d1Z/d2Z0d3Z1d4Z2d5Z3d6Z4d7Z5e6d8k(re5yy)9)absolute_importdivisionprint_functiona --- module: ome_devices short_description: Perform device-specific operations on target devices description: Perform device-specific operations such as refresh inventory, clear iDRAC job queue, and reset iDRAC from OpenManage Enterprise. version_added: 6.1.0 extends_documentation_fragment: - dellemc.openmanage.oment_auth_options options: device_service_tags: description: - Service tag of the target devices. - This is mutually exclusive with I(device_ids). type: list elements: str device_ids: description: - IDs of the target devices. - This is mutually exclusive with I(device_service_tags). type: list elements: int state: description: - C(present) Allows to perform the I(device_action) on the target devices. - "C(absent) Removes the device from OpenManage Enterprise. Job is not triggered. I(job_wait), I(job_schedule), I(job_name), and I(job_description) are not applicable to this operation." type: str choices: [present, absent] default: present device_action: description: - C(refresh_inventory) refreshes the inventory on the target devices. - C(reset_idrac) Triggers a reset on the target iDRACs. - C(clear_idrac_job_queue) Clears the job queue on the target iDRACs. - A job is triggered for each action. type: str choices: [refresh_inventory, reset_idrac, clear_idrac_job_queue] default: refresh_inventory job_wait: description: - Provides an option to wait for the job completion. - This option is applicable when I(state) is C(present). - This is applicable when I(job_schedule) is C(startnow). type: bool default: true job_wait_timeout: 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). type: int default: 1200 job_schedule: description: Provide the cron string to schedule the job. type: str default: startnow job_name: description: Optional name for the job. type: str job_description: description: Optional description for the job. type: str requirements: - "python >= 3.9.6" author: - Jagadeesh N V(@jagadeeshnv) - ShivamSh3(@ShivamSh3) notes: - For C(idrac_reset), the job triggers only the iDRAC reset operation and does not track the complete reset cycle. - Run this module from a system that has direct access to Dell OpenManage Enterprise. - This module supports C(check_mode). a --- - name: Refresh Inventory dellemc.openmanage.ome_devices: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_action: refresh_inventory device_service_tags: - SVCTAG1 - name: Clear iDRAC job queue dellemc.openmanage.ome_devices: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_action: clear_idrac_job_queue device_service_tags: - SVCTAG1 - name: Reset iDRAC using the service tag dellemc.openmanage.ome_devices: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" device_action: reset_idrac device_service_tags: - SVCTAG1 - name: Remove devices using servicetags dellemc.openmanage.ome_devices: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" state: absent device_service_tags: - SVCTAG1 - SVCTAF2 - name: Remove devices using IDs dellemc.openmanage.ome_devices: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" state: absent device_ids: - 10235 aH --- msg: type: str description: Overall status of the devices operation. returned: always sample: "Successfully removed the device(s)." job: type: dict description: Job details of the devices operation. returned: success sample: { "Id": 14874, "JobName": "Refresh inventory", "JobDescription": "The Refresh inventory task initiated from OpenManage Ansible Modules for devices with the ids '13216'.", "Schedule": "startnow", "State": "Enabled", "CreatedBy": "admin", "UpdatedBy": null, "Visible": true, "Editable": true, "Builtin": false, "UserGenerated": true, "Targets": [ { "JobId": 14874, "Id": 13216, "Data": "", "TargetType": { "Id": 1000, "Name": "DEVICE" } } ], "Params": [ { "JobId": 14874, "Key": "action", "Value": "CONFIG_INVENTORY" }, { "JobId": 14874, "Key": "isCollectDriverInventory", "Value": "true" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(14874)/ExecutionHistories", "LastExecutionDetail": { "@odata.id": "/api/JobService/Jobs(14874)/LastExecutionDetail" } } 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": "CGEN1002", "RelatedProperties": [], "Message": "Unable to complete the operation because the requested URI is invalid.", "MessageArgs": [], "Severity": "Critical", "Resolution": "Enter a valid URI and retry the operation." } ] } } N)SSLError)URLError HTTPError)ConnectionError)RestOMEOmeAnsibleModule)strip_substr_dict job_tracking) CHANGES_MSGNO_CHANGES_MSGzDeviceService/DeviceszJobService/JobszJobService/Jobs({job_id})z%JobService/Actions/JobService.RunJobsz-JobService/Jobs({job_id})/LastExecutionDetailz1DeviceService/Actions/DeviceService.RemoveDevicesz(The devices(s) are removed successfully.zXUnable to complete the operation because the entered target device(s) '{0}' are invalid.zVThe {0} task initiated from OpenManage Ansible Modules for devices with the ids '{1}'.z-Successfully initiated the device action job.z"The job is scheduled successfully.z/The device operation is performed successfully.zBThe parameter `job_wait_timeout` value cannot be negative or zero.)iiiiXi@i)#rrefresh_inventory reset_idracclear_idrac_job_queueDeviceAction_TaskInventory_Task)rrCONFIG_INVENTORYtrue)actionisCollectDriverInventory operationName RESET_IDRACREMOTE_RACADM_EXECz%jobqueue delete -i JID_CLEARALL_FORCE601000)rCommandCommandTimeout deviceTypeszRefresh inventoryz Reset iDRACzClear iDRAC job queuec >t}|jjd}d}d}|s|jjd}d}d}g}|D]}|jdtd|j ||i } | j jd } | s|j|| D]6} | ||k(s | d |vr|j| n|j||j||D cgc]} | jd} } | |fScc} w) N device_idsz {0} eq {1}Iddevice_service_tagsz {0} eq '{1}' IdentifierGET$filter query_paramvalueType) setparamsgetinvoke_request DEVICE_URIformat json_dataaddextend)modulerest_objtypesinvalidsstsparamsrchdevsstrespvalvdvvalidss r/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/ome_devices.py get_dev_idsrH s(uH --  L )C E D mm 56 D &&ujyRWR^R^_cegRhFi&jnn  ) LL  Aw"}V9%KK$LL$   LL  (, ,rvvd| ,F , 8 -s<Dc|jr|jtddt|i}|j dt ||jt dy)NTmsgchanged DeviceIdsPOSTdata) check_mode exit_jsonrlistr3DELETE_DEVICES_URIDELETE_SUCCESS)r9r: valid_idspayloads rGdelete_devicesrX'sU [$7DO,G F$6WE 6c |jjd|d<|jjdr|jjd|d<ntj||d<|jjdr|jjd|d<ytj tj|dj t t||d<y)N job_scheduleSchedulejob_nameJobNamejob_descriptionJobDescription,)r1r2 jobname_mapJOB_DESCr5joinmapstr)r9rWtaskrVs rGupdate_common_jobrh/s --++N;GJ }}$#]]..z: (__T2  }}*+$*MM$5$56G$H !$,OOKOOD4I388TWX[]fTgKh$i !rYcddj|di}|jdt|}|jj dg}|D]}|d|dk(s|d|dk(s|d |d k(s't d |j d D}||j d k(s]t d |j d D}||j d k(s|cSiS)Nr+zJobType/Id eq {0}JobTyper*r,r.r^r`r\c3`K|]&}|jd|jdf(yw)KeyValueNr2).0ks rG z$check_similar_job..Bs%SQ155<w8Ss,.Paramsc3~K|]5}|jd|jdjdf7yw)r' TargetTypeNameNrn)rots rGrqz$check_similar_job..Es1cA!%%+quu\':'>'>v'FGcs;=Targets)r5r3JOBS_URIr6r2dict)r:rWr-job_respjob_listjbjb_prmtrgtss rGcheck_similar_jobr;s1889KLMK&&uhK&PH!!%%gr2H  i=GI. .26F3G7ScKd3d:'*"55S"&&BRSSFW[[22cQSQWQWXaQbccEGKK 22I  IrYc|j}|jddk7r!|jdtt ||jjds"|jdt t |yt }t|tj|d|jjdd \}}}}|rW |jd tj|d} | jjd }|jd d}|j||t |dy#t$r|}Y,wxYw)Nr[startnowT)rLrKjobjob_waitr')job_idjob_wait_timeoutr)max_job_wait_sec initial_waitr*rm  )failedrKrrL)r1r2rR JOB_SCHEDULEDr APPLY_TRIGGERED SUCCESS_MSGr JOB_URIr5r3 LAST_EXECr6replace Exception) r9r:rmparamsjob_msg job_failedrKjob_dict wait_timerzs rGrrLs4mmG{{>"j0=>OPS>TU ==  Z (?@QRU@VW/; gnnCIn6IZIZ[mIn0, C9  #225):J:JRUVZR[:J:\]((,,W5++dC0  =Ns=S]ab  s AE EEci}|jdtj|di|jdtj|ii|S)Nrjrrr)update job_type_mapr2job_params_map)rgtaskloads rGget_task_payloadrasHH OOY 0 0q 9:; OOX~11$;<= OrYcXt|}td|D}||d<|dtfS)Nc3$K|]}|df yw)DEVICEN)rorEs rGrqz%get_payload_method..js6bB>6srwrN)rryrx)rgrVrWtargetss rGget_payload_methodrhs3t$G6I66G GI FH $$rYc 0d|d<d|d<|d}|jDcgc] \}}||d c}}|d<|d}|jDcgc]\}}|dd |d d c}}|d<|d }|tj|d |d <ycc}}wcc}}w) Nrr'EnabledStaterr)rlrmrwr)r'ru)r'Datartrj)items jtype_mapr2)rWprmsrprDr~jtypes rGformalize_job_payloadrosGDM GG 8 D>BjjlKda!a0KGH I Eejepepers]a]^`a!RdTU?VWsGI I E %y}}U/CDGI Lss B Bc~|jjd}t||\}}}t||||t ||}|s_t ||j r|jtd|jdt|d}t|||jy|jjddk(rY|d d d k7rN|j r|jtd|jdtd |d gi }t||||jtt|y)N device_actionTrJrN<)rP api_timeoutr[r LastRunStatusr'iJobIdsrO)rKr)r1r2rrhrrrQrRrr3rxrr6 RUN_JOB_URIrr ) r9r:rVrgrWmethodurirrBs rGperform_device_tasksrzs% ==  _ -D-dI>GVSfgtY7 Hg .C g&      d  ;&&vxgSU&V4>>2 ==  ^ , :s??STX?Y]a?a    [$ ?**6;hQTUYQZP[E\*]D VXs +^1B31GHrYc dddddddddgdddgdd dd d d dd d ddd ddiddid }t|gdgdgd } |jjdr5|jjddkr|jtd t |jd 5}|jjddk(rt ||tj|jjd\}}|rC|jd tjdjtt|t|||n9t ||t\}}|s|jtt!|||dddy#1swYyxYw#t"$r:}|jt|t%j&|d Yd}~yd}~wt($r&}|jt|d Yd}~yd}~wt*t,t.t0t2t4t6t8t:f $r&}|jt|d Yd}~yd}~wwxYw)NrSrf)typeelementsintpresentabsent)rchoicesdefaultrrboolT)rrirr) r(r&staterrrr[r]r_)r(r&) argument_spec required_ifmutually_exclusiverequired_one_ofsupports_check_moderrr)rKr) req_sessionrrra)rrK)rK)rK error_infor)rK unreachable)r r1r2rRTIMEOUT_NEGATIVE_MSGr rHdevice_type_mapINVALID_DEV_STr5rdrerfrall_device_typesrrXrjsonloadrIOError ValueErrorr TypeErrorr AttributeError IndexErrorKeyErrorOSError)specsr9r:rFr<errs rGmainrs:(.EB%59Y,AiX"'4q%8:#5%*tUO"E? E 1 ?? F4 ==  Z (V]]->->?Q-RVW-W   !5d  C V]] 5 9}}  )Y6#.vx/>/B/B6==CTCTUdCe/f$h $$Dn6K6KCHHUXY\^fUgLh6i$j$VXv>#.vxAQ#R $$$8vx8 9 9 9 OSX$))C.NN 9SX488 Z9o~Wack  4SXd334sOA'F"&C'F F"FF"F"" I(+0G  I(,H  5I(I##I(__main__)7 __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrsslr+ansible.module_utils.six.moves.urllib.errorrransible.module_utils.urlsr ?ansible_collections.dellemc.openmanage.plugins.module_utils.omer r Aansible_collections.dellemc.openmanage.plugins.module_utils.utilsr r rrr4rxrrrrTrUrrcrrrrrrrrrrbrHrXrhrrrrrrr__name__rrYrGrsBCB F P4 lW r K5emi $  %5 ; H;k cA4 ? [=(8$kojpq%&qSTU #(8 9 2DDJ(L"1=!A=Q7^>BSY,[\ %8 (?A 87 j"c*%EI(-4` zFrY