VhZddlmZmZmZeZdZdZdZddl Z ddl Z ddl m Z ddl mZmZddlmZmZdd lmZmZd d d d ZdZdZdZdZdZdZdZdZdZddZ dZ!dZ"dZ#e$dk(re#yy))absolute_importdivisionprint_functiona --- module: ome_diagnostics short_description: Export technical support logs(TSR) to network share location version_added: "3.6.0" description: This module allows to export SupportAssist collection logs from OpenManage Enterprise and OpenManage Enterprise Modular and application logs from OpenManage Enterprise Modular to a CIFS or NFS share. extends_documentation_fragment: - dellemc.openmanage.ome_auth_options options: device_ids: type: list description: - List of target device IDs. - This is applicable for C(support_assist_collection) and C(supportassist_collection) logs. - This option is mutually exclusive with I(device_service_tags) and I(device_group_name). elements: int device_service_tags: type: list description: - List of target identifier. - This is applicable for C(support_assist_collection) and C(supportassist_collection) logs. - This option is mutually exclusive with I(device_ids) and I(device_group_name). elements: str device_group_name: type: str description: - Name of the device group to export C(support_assist_collection) or C(supportassist_collection) logs of all devices within the group. - This is applicable for C(support_assist_collection) and C(supportassist_collection) logs. - This option is not applicable for OpenManage Enterprise Modular. - This option is mutually exclusive with I(device_ids) and I(device_service_tags). log_type: type: str description: - C(application) is applicable for OpenManage Enterprise Modular to export the application log bundle. - C(support_assist_collection) and C(supportassist_collection) is applicable for one or more devices to export SupportAssist logs. - C(support_assist_collection) and C(supportassist_collection) supports both OpenManage Enterprise and OpenManage Enterprise Modular. - C(support_assist_collection) and C(supportassist_collection) does not support export of C(OS_LOGS) from OpenManage Enterprise. If tried to export, the tasks will complete with errors, and the module fails. choices: [application, support_assist_collection, supportassist_collection] default: support_assist_collection mask_sensitive_info: type: bool description: - Select this option to mask the personal identification information such as IPAddress, DNS, alert destination, email, gateway, inet6, MacAddress, netmask etc. - This option is applicable for C(application) of I(log_type). default: false log_selectors: type: list description: - By default, the SupportAssist logs contain only hardware logs. To collect additional logs such as OS logs, RAID logs or Debug logs, specify the log types to be collected in the choices list. - If the log types are not specified, only the hardware logs are exported. - C(OS_LOGS) to collect OS Logs. - C(RAID_LOGS) to collect RAID controller logs. - C(DEBUG_LOGS) to collect Debug logs. - This option is applicable only for C(support_assist_collection) and C(supportassist_collection) of I(log_type). choices: [OS_LOGS, RAID_LOGS, DEBUG_LOGS] elements: str share_address: type: str required: true description: Network share IP address. share_name: type: str required: true description: - Network share path. - Filename is auto generated and should not be provided as part of I(share_name). share_type: type: str required: true description: Network share type choices: [NFS, CIFS] share_user: type: str description: - Network share username. - This option is applicable for C(CIFS) of I(share_type). share_password: type: str description: - Network share password - This option is applicable for C(CIFS) of I(share_type). share_domain: type: str description: - Network share domain name. - This option is applicable for C(CIFS) if I(share_type). job_wait: type: bool description: - Whether to wait for the Job completion or not. - The maximum wait time is I(job_wait_timeout). default: true job_wait_timeout: type: int description: - The maximum wait time of I(job_wait) in minutes. - This option is applicable I(job_wait) is true. default: 60 test_connection: type: bool description: - Test the availability of the network share location. - I(job_wait) and I(job_wait_timeout) options are not applicable for I(test_connection). default: false lead_chassis_only: type: bool description: - Extract the logs from Lead chassis only. - I(lead_chassis_only) is only applicable when I(log_type) is C(application) on OpenManage Enterprise Modular. default: false requirements: - "python >= 3.9.6" author: - "Felix Stephen (@felixs88)" - "Sachin Apagundi(@sachin-apa)" notes: - Run this module from a system that has direct access to OpenManage Enterprise. - This module performs the test connection and device validations. It does not create a job for copying the logs in check mode and always reports as changes found. - This module supports C(check_mode). a --- - name: Export application log using CIFS share location dellemc.openmanage.ome_diagnostics: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" share_type: CIFS share_address: "192.168.0.2" share_user: share_username share_password: share_password share_name: cifs_share log_type: application mask_sensitive_info: false test_connection: true - name: Export application log using NFS share location dellemc.openmanage.ome_diagnostics: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" share_address: "192.168.0.3" share_type: NFS share_name: nfs_share log_type: application mask_sensitive_info: true test_connection: true - name: Export SupportAssist log using CIFS share location dellemc.openmanage.ome_diagnostics: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" share_address: "192.168.0.3" share_user: share_username share_password: share_password share_name: cifs_share share_type: CIFS log_type: support_assist_collection device_ids: [10011, 10022] log_selectors: [OS_LOGS] test_connection: true - name: Export SupportAssist log using NFS share location dellemc.openmanage.ome_diagnostics: hostname: "192.168.0.1" username: "username" password: "password" ca_path: "/path/to/ca_cert.pem" share_address: "192.168.0.3" share_type: NFS share_name: nfs_share log_type: support_assist_collection device_group_name: group_name test_connection: true a --- msg: type: str description: "Overall status of the export log." returned: always sample: "Export log job completed successfully." jog_status: type: dict description: Details of the export log operation status. returned: success sample: { "Builtin": false, "CreatedBy": "root", "Editable": true, "EndTime": None, "Id": 12778, "JobDescription": "Export device log", "JobName": "Export Log", "JobStatus": {"Id": 2080, "Name": "New"}, "JobType": {"Id": 18, "Internal": false, "Name": "DebugLogs_Task"}, "LastRun": "2021-07-06 10:52:50.519", "LastRunStatus": {"Id": 2060, "Name": "Completed"}, "NextRun": None, "Schedule": "startnow", "StartTime": None, "State": "Enabled", "UpdatedBy": None, "UserGenerated": true, "Visible": true, "Params": [ {"JobId": 12778, "Key": "maskSensitiveInfo", "Value": "FALSE"}, {"JobId": 12778, "Key": "password", "Value": "tY86w7q92u0QzvykuF0gQQ"}, {"JobId": 12778, "Key": "userName", "Value": "administrator"}, {"JobId": 12778, "Key": "shareName", "Value": "iso"}, {"JobId": 12778, "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS"}, {"JobId": 12778, "Key": "shareType", "Value": "CIFS"}, {"JobId": 12778, "Key": "shareAddress", "Value": "100.96.32.142"} ], "Targets": [{"Data": "", "Id": 10053, "JobId": 12778, "TargetType": {"Id": 1000, "Name": "DEVICE"}}] } 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)URLError HTTPError)ConnectionErrorSSLValidationError)OS_LOGS RAID_LOGS DEBUG_LOGSzJobService/JobszGroupService/Groupsz GroupService/Groups({0})/DeviceszDeviceService/DeviceszManagementDomainService/Domainsz'JobService/Jobs({0})/ExecutionHistorieszChanges found to be applied.c,|jjdg}}ddj|i}|jdt|}|j d}|rv|dd}|jdt j|}|j d} | r%| D]} | d d k(s |j| d!n4|jd n!|jd j| |s!|jdj| |S)Ndevice_group_name$filterz Name eq '{0}'GET query_paramvaluerIdTypez-There are no device(s) present in this group.msgz_Unable to complete the operation because the entered target device group name '{0}' is invalid.zKThe requested group '{0}' does not contain devices that support export log.) paramsgetformatinvoke_request GROUP_URI json_dataGROUP_DEVICE_URIappend fail_json) modulerest_obj group_name group_devicer group_respgroupgroup_idrespdevice_group_respdevices v/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/openmanage/plugins/modules/ome_diagnostics.pygroup_validationr3s(%}}001DEr Jo44Z@AK(( {(SJ   )E 8D>&&u.>.E.Eh.OP NN73 + 6&>T) ''t 5 6   !P  QCCI6*CU  W 3396*3E  G c  ggg}}}|jjd|jjd}}|jt}|dnd dk(rdnd}||n|} | D] t t fd|d} | r#| d d d k(r|j | d dD| r&| d d d k(s|j t l|j t |r:|jd j|d jt||s<|r:|jdj|d jt||S)N device_idsdevice_service_tagsrDeviceServiceTagidz service tagc|fvSN)deachkeys r2z#device_validation..;sqv$'7r4 report_listrrrz\Unable to complete the operation because the entered target device {0}(s) '{1}' are invalid.,rzDThe requested device {0}(s) '{1}' are not applicable for export log.) rr get_all_report_details DEVICE_URIlistfilterr&strr'r!joinset) r(r) device_lst invalid_lst other_typesdevicestags all_devicer req_devicer1r>r?s @@r2device_validationrQ3sr+-r2[ JMM%%l3V]]5F5FG\5]TG00>DfUCHHUXYdUeLf>g  i r4c gg}}|jd}|dk(r|jd}d}|rl|jt}d} d} |dD]} | ddvs | d} | rc|jd td d j | | i } | j d}n)|jd td d i } | j d}|r&|D] } |j| dd| dddd"n2|jdn|D]}|j|ddddd|jd|jdd|jd|jdd|jddd|jjd!|jd|jdd|jjd !|jd!|jd d|jjd"!|jd#|jd"d|jjd$!|jd%|jd$d|jjd&=|dk(r8|jd't|jd&jd|jjd(|d)k(s|d*k(ru|jd(Dcgc] }t| }}|jd+jtt|}|jd,d-j |d|j!d.d/||d0d1d}|Scc}w)2Nlog_type applicationlead_chassis_onlyrrDomainRoleTypeValue)LEAD STANDALONEDeviceIdrrz {0} eq {1}rz Type eq 2000rCHASSIS)rName)rData TargetTypez:There is no device(s) available to export application log.rrDEVICE shareAddress share_address)KeyValue shareType share_typeOPERATION_NAME EXTRACT_LOGS share_name shareName share_useruserNameshare_passwordpassword share_domain domainNamemask_sensitive_infomaskSensitiveInfo log_selectorssupport_assist_collectionsupportassist_collectionrB logSelectorz0,{0}z Export LogzExport device logDebugLogs_Task)rget_all_items_with_pagination DOMAIN_URIr"rDr!r$r&r'r rGupper LOG_SELECTORsortrHmapjob_submission)r(r)rJpayload_params target_paramsrS lead_only resp_datadomain_detailsr? ch_device_id each_domainr/devr1ilog_lst log_selectorresponses r2extract_log_operationrKs$&MN}}Z(H= MM"56  %CCJONCL-g6 ; 459OO#.z#:L ;..ujv;PY4Z&\] ]   !]  ^  QF  7;X0N"P Q Q.6==;YZ[+ l8STU"2^LM }}&2kFMM,=Z[\ }}./;M@Y&9C VkHlDmDsDsDuvw }})58Gb;bfnsMgM,2MM/,JKq<?KK xxC 12 mgnn\>Z[\&&|5H-'5bJZ7[]H O Ls/M-c |jdtdy#t$rB}tj|}|dddddk(r|j d Yd}~yd}~wwxYw) Nr) api_timeouterrorz@Message.ExtendedInfor MessageIdCGEN1006z>Export log operation is not supported on the specified system.r)r"ryr jsonloadr')r(r)err err_messages r2check_domain_servicersvczqA  ciin w  7 8 ;K HJ V   !a  b cs A&8A!!A&c d\}}|jdtj|d}|jdr|jdd}|jddjtj|d|d}|jdD]"}t j d|drd }||fSd }||fS) N)z%Export log job completed with errors.Frrrrz {0}({1})/ExecutionHistoryDetailsz0Job status for JID_\d+ is Completed with Errors.rcTF)r"EXE_HISTORY_URIr!r$refindall)r/r)rfailhistoryhisthistory_detailshds r2find_failed_jobsrs>IC%%e_-C-CDJ-OPG!  )!,"11  . 5 5o6L6LTRVZ6XZ^_cZd e "++G4 B::QSUV]S^_ 9   D 9r4c idddddddddddddd d ddd gd d ddddddddgddddddd dddd dddddgddddd ddddddddd dddddd ddd!dd"ddddd#dddd}t|d d$dggd d gd%dgd d&gd%dgddddgggd%gd'} t|jd(5}|jd d$k(r t|||j d)\}}|s|j d*+|jd"r|j |jd|jd|jd|jd|jd|jd}|j|jd,d-d-.\}}|r|j d/+g}|jd d k(s|jd d&k(r(|jjd t||}nK|jd d k(s|jd d&k(r'|jjd t||}|jr|jtd0t|||1} d2} |jdr|jd d!z} |j| jd,| d-.\}}d3} |d4j!| k(r|j d5| j6|r8t#| j|\} } | r|j | | j6|j%d7d8j!t&| jd,} | j} | r|j)| } |j| | d9dddy#1swYyxYw#t*$r9}|j t-|t/j0|:Yd}~yd}~wt2$r&}|jt-|d;Yd}~yd}~wt4t6t8t:t<t>t@f$r%}|j t-|+Yd}~yd}~wwxYw)(? @ 4 G O 3 G O 6L2B#C D  WW  FB' V]] 5; I}}Z(M9$VX6$,#D#DEU#V K  %h i}}./$<=Z \ +3*?*? @S@STX@YhiKL+@+N' K$$*e$fL j)-HHFMMZdLejDMDMM%%&9:F/A -- +/JJfmm\fNglFOFMM%%&9:B0B     ]D A-VX,WH>G}}Z( --(:;b@*2*?*?@R@RSW@XMTKL+@+N' KC"N"U"UV]"^^$$s#+#5#5%*:8;M;Mx*X'GZ!((WASAS(T#225*:K:KGU]UgUghlUm:no%%D11$7   T4  Hw; I; I; Ix BSX$))C.AA 9SX488 ZHoGY[b c'SX&&'sO N"7KN N"NN"N"" Q+/O Q+P  +Q7QQ__main__r;)% __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrrsslr?ansible_collections.dellemc.openmanage.plugins.module_utils.omerr+ansible.module_utils.six.moves.urllib.errorr r ansible.module_utils.urlsr r r{rr#r%rDryrrr3rQrrrr__name__r<r4r2rsCB | ~: x= @ eKI1A>  ! 5 $ . ;. 002j $e'P zFr4