VhrddlmZmZmZeZdZdZdZddl Z ddl Z ddl Z ddl m Z ddlmZddlmZdd lmZdd lmZddlmcmcmcmcmZGd d eZd Zedk(reyy))absolute_importdivisionprint_functiona --- module: zabbix_template short_description: Create/update/delete Zabbix template description: - This module allows you to create, modify and delete Zabbix templates. - Multiple templates can be created or modified at once if passing JSON or XML to module. author: - "sookido (@sookido)" - "Logan Vig (@logan2211)" - "Dusan Matejka (@D3DeFi)" requirements: - "python >= 3.9" options: template_name: description: - Name of Zabbix template. - Required when I(template_json) or I(template_xml) are not used. - Mutually exclusive with I(template_json) and I(template_xml). required: false type: str template_json: description: - JSON dump of templates to import. - Multiple templates can be imported this way. - Mutually exclusive with I(template_name) and I(template_xml) and I(template_yaml). required: false type: json template_xml: description: - XML dump of templates to import. - Multiple templates can be imported this way. - Mutually exclusive with I(template_name) and I(template_json) and I(template_yaml). required: false type: str template_yaml: description: - Context of exported templates file to import. - Multiple templates can be imported this way. - Mutually exclusive with I(template_name) and I(template_json) and I(template_xml). required: false type: str template_groups: description: - List of template groups to add template to when template is created. - Replaces the current template groups the template belongs to if the template is already present. - Required when creating a new template with C(state=present) and I(template_name) is used. Not required when updating an existing template. required: false type: list elements: str link_templates: description: - List of template names to be linked to the template. - Templates that are not specified and are linked to the existing template will be only unlinked and not cleared from the template. required: false type: list elements: str clear_templates: description: - List of template names to be unlinked and cleared from the template. - This option is ignored if template is being created for the first time. required: false type: list elements: str macros: description: - List of user macros to create for the template. - Macros that are not specified and are present on the existing template will be replaced. - See examples on how to pass macros. required: false type: list elements: dict suboptions: macro: description: - Name of the macro. - Must be specified in {$NAME} format. type: str required: true value: description: - Value of the macro. type: str required: true tags: description: - List of tags to assign to the template. - Providing I(tags=[]) with I(force=yes) will clean all of the tags from the template. required: false type: list elements: dict suboptions: tag: description: - Name of the template tag. type: str required: true value: description: - Value of the template tag. type: str default: "" state: description: - Required state of the template. - On C(state=present) template will be created/imported or updated depending if it is already present. - On C(state=absent) template will be deleted. required: false choices: [present, absent] default: "present" type: str extends_documentation_fragment: - community.zabbix.zabbix a --- # If you want to use Username and Password to be authenticated by Zabbix Server - name: Set credentials to access Zabbix Server API ansible.builtin.set_fact: ansible_user: Admin ansible_httpapi_pass: zabbix # If you want to use API token to be authenticated by Zabbix Server # https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens - name: Set API token ansible.builtin.set_fact: ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895 - name: Create a new Zabbix template linked to groups, macros and templates # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_name: ExampleHost template_groups: - Role - Role2 link_templates: - Example template1 - Example template2 macros: - macro: "{$EXAMPLE_MACRO1}" value: 30000 - macro: "{$EXAMPLE_MACRO2}" value: 3 - macro: "{$EXAMPLE_MACRO3}" value: "Example" state: present - name: Unlink and clear templates from the existing Zabbix template # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_name: ExampleHost clear_templates: - Example template3 - Example template4 state: present - name: Import Zabbix templates from JSON # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_json: "{{ lookup('file', 'zabbix_apache2.json') }}" state: present - name: Import Zabbix templates from XML # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_xml: "{{ lookup('file', 'zabbix_apache2.xml') }}" state: present - name: Import Zabbix template from Ansible dict variable # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_json: zabbix_export: version: "3.2" templates: - name: Template for Testing description: "Testing template import" template: Test Template groups: - name: Templates state: present - name: Configure macros on the existing Zabbix template # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_name: Template macros: - macro: "{$TEST_MACRO}" value: "Example" state: present - name: Add tags to the existing Zabbix template # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_name: Template tags: - tag: class value: application state: present - name: Delete Zabbix template # set task level variables as we change ansible_connection plugin here vars: ansible_network_os: community.zabbix.zabbix ansible_connection: httpapi ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_zabbix_url_path: "zabbixeu" # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http:///zabbixeu ansible_host: zabbix-example-fqdn.org community.zabbix.zabbix_template: template_name: Template state: absent z --- N) AnsibleModule) to_native)PY2) ZabbixBase) LooseVersioncLeZdZdZdZdZdZdZdZdZ d dZ d Z d d Z y ) Templatec~g}|D]}t|jtdk\r,|jjj dgd|id}n+|jj j dgd|id}|r|j d|ddi|jjd|z|S)N6.2groupidnameoutputfilterrzTemplate group not found: %smsg) r _zbx_api_version_zapi templategroupget hostgroupappend_module fail_json)self group_names group_ids group_namegroups t/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/zabbix/plugins/modules/zabbix_template.pyget_group_ids_by_group_namesz%Template.get_group_ids_by_group_names4s % XJD112l56II 0044 X^`jWk5lm ,,00YKTZ\fSg1hi  )U1Xi-@!AB &&+IJ+V&W Xcg}|t|dk(r|S|D]V}|jjjdd|id}t|dkr<|dd}|j d|iX|S)Nrextendhostr templateid)lenrtemplaterr)r template_list template_idsr, template_ids r#get_template_idszTemplate.get_template_idsAs  C $6!$; % AH JJ//33xTZ\dSe4fgM=!A%+A.|< ##\;$?@  Ar%c@|jjr|jjd|||||d}||jdgi||jdgi||jdgi|jj j |y)NTchanged)r(groups templatesmacrostagsr6r7r5)r check_mode exit_jsonupdaterr,create)r template_namer link_template_idsr6r7 new_templates r# add_templatezTemplate.add_templateNs << " " LL " "4 " 0 -QbntCD >   2 / <    -  $   b 1 2 ""<0r%c Zd}|ddddddddddidddddddddddddiddidddddddddddd } d|dd <|jd |d <t|jtd kr+ddi|d <|jdd|jdd|||d}|jjj |}t |dk7rd}|Sy#t$rC}|jjdt|tjYd}~yd}~wwxYw)zitemplate_content has same structure as Zabbix uses (e.g. it was optimally exported via Zabbix GUI or API)FNT createMissingupdateExisting deleteMissingrBrBrC discoveryRulesgraphs host_groups httptestsitemsr5template_groupstemplateLinkagetemplateScreenstriggers valueMapsrMrDrNtemplateDashboardsrr4rIrLformatsourcerulesrzUnable to compare templaterdetails exception) popr rr configuration importcomparer+ Exceptionrrr traceback format_exc)rtemplate_content template_typer3 update_rulesr[compare_resultes r#import_comparezTemplate.import_compare\s  '&*&*%)# &*&*%) $T &*&*%) &*&*%) &*&* $T$$T$&*&*%)$ &*&*%) &*&*Y0Ld ICG ./@5A5E5EFW5X 12  5 56e9LL.=t-DL* $$]D9 $$%6=+8DT_k l !%!9!9!G!G !V~&!+"GA (B I &&+GQZ[\Q]1:1E1E1G'II IsB$C D*'9D%%D*cd}|j|d}|kt|jtdk\r|ddD cgc]} | d } } n|ddD cgc]} | d } } t|t| k7rd }d |dd d vrg|dd d d <|dd d d D cgc]} | d } } |t|t| k7rd }ntgt| k7rd }||D] } | | vsd }nd |dd d vrg|dd d d <||dd d d } || k7rd }d |dd d vrg|dd d d <||dd d d }||k7rd }|Scc} wcc} wcc} w)zECompare template with user provided all parameters via module optionsFjson)r`r zabbix_exportrLrr4Tr5rr6r7) dump_templater rset)rr.rLlink_templatesclear_templatestemplate_macros template_tagsr3existing_templategexisting_groupstexist_child_templatesexisting_macros existing_tagss r#check_template_changedzTemplate.check_template_changeds- ..|6.R  &D112l56II6G6XYj6k"l1V9"l"l6G6XYa6b"c1V9"c"c?#s?';; /@MaP PNP o .{ ;A >{ K5Fo4VWb4cde4fgr4s tq6 t t  %>"c*?&@@2w#344  &$ --"G  ,_=kJ1M MKM o .{ ;A >x H  &/@MaPQYZO/1 *?;KHK KIK o .{ ;A >v F  $-o>{KANvVM -S#m"c!us E( E-. E2ci}||jd|i||jd|in|jdgi||jd|i||jd|in|jdgi||jd|in|jdgi|r:|j|d|jjj|yy)Nr4r5templates_clearr6r7r)r:rr,)rr.r r=clear_template_idsrlrmtemplate_changess r#update_templatezTemplate.update_templates   # #Xy$9 :  (  # #[2C$D E  # #["$5 6  )  # #%68J$K L  &  # #X$? @  # #XrN 3  $  # #V]$; <  # #VRL 1   # #LO 4 JJ   & &'7 8 r%c|jjr|jjd|Dcgc]}|jd}}|jj j |ycc}w)NTr2r*)rr8r9rrr,delete)r templateidsrqtemplateids_lists r#delete_templatezTemplate.delete_templates` << " " LL " "4 " 09DEAAEE,/EE ""#34FsA7c*|Dcgc]}|jd}} |jjj|d|id}|j |Scc}w#t $r)}|j jd|zYd}~yd}~wwxYw)Nr*r5)rSoptionszUnable to export template: %sr)rrrZexportload_json_templater\rr)rr.r`rqtemplate_ids_listdumprcs r#rhzTemplate.dump_templates:FGQQUU<0GG L::++22mYdfwXx3yzD**40 0H  L LL " "'F'J " K K LsA:A B)B  Bc tj|}|S#t$rC}|jj dt |t jYd}~yd}~wwxYw)NzInvalid JSON providedrV)rfloads ValueErrorrrrr]r^)r template_jsonjsondocrcs r#rzTemplate.load_json_templatesY xjj/GN x LL " "'> RS `i`t`t`v " w w xs A%9A  A%c |jjr|jjdddddddddddidddddddddddddiddidddddddddddd } d|dd<|jd |d <t |j t d kr+ddi|d <|jd d|jddt rtjdd|}|||d}|jjj|y#t$rC}|jjdt|tj Yd}~yd}~wwxYw)NTr2rArBrErFrMrDrNrQrr4rIrLz\\\\u([0-9a-z]{,4})z\\u\1rRzUnable to import templaterV)rr8r9rYr rrresubrrZimport_r\rrr]r^)rr_r`ra import_datarcs r#import_templatezTemplate.import_template s << " " LL " "4 " 0 "&"&!% "&"&!%  "&"&!% "&"&!% "&"&     "&"&!%  "&"&!% "&"&Y0 d E?CL* +O <1=1A1ABS1TL- .D112\%5HH*94)@ X&  5  !2D9 #%66*@(L\#] %2>NYefK JJ $ $ , ,[ 9 E LL " "'BIVWL-6-A-A-C # E E Es&B0D E# 9EE#N)rf) __name__ __module__ __qualname__r$r0r?rdrurzrrhrrr%r#r r 2s<   1GIR0d985LxLEr%r ctj}|jttddtddtddtddtdddtdddtdddtddttddtdd  tddttddtdd   tddddg t |gdggdgdddgggd}|j d}|j d}|j d}|j d}|j d}|j d}|j d}|j d} |j d} |j d} t |} d\} }}|d}|} n"|d}|} n|d }|} n|g}| j|}| dk(r@|s|jdd!|z"| j||jdd#|z$y| dk(r| l| j| |}|s|j|d%$y|jr|j|&| j| ||j|d'$yd}|| j|}d}|| j|}d}|| j|}| | D]}|D]}t||||<| | D]}|D]}t||||<|s@||jd()| j!|||| | |jdd*|z$y| j#||||| | }|jr|j|&|r+|| j| |n| j%||||| | |j|d+$yy),NstrF)typerequiredrflist)rrelementsdictT)macrovalue)rrr)rdefault)tagrpresentabsent)rrchoices) r<r template_xml template_yamlrLrjrkr6r7state)r<rrrrr<) argument_specrequired_one_ofmutually_exclusive required_ifsupports_check_moderrrrLrjrkr6r7)NNNxmlyamlz"Template not found. No changed: %s)r3rz Successfully deleted template %s)r3resultzTemplate is up-to dater2zTemplate import successfulz@template_groups are required when creating a new Zabbix templaterzSuccessfully added template: %szTemplate successfully updated) zabbix_utilszabbix_common_argument_specr:rrparamsr r0r9rrdr8rr$rrr?rurz)rmoduler<rrrrLrjrkrlrmrr,r_r`r.template_namesr3r r=rx macroitemkeytagitems r#mainrYsw <<>M67uu56&55I%%H&55I55 ed3r2 y9h:OP14# O  P h 1 2 ! FMM/2MMM/2M==0LMM/2Mmm$56O]]#34Nmm$56OmmH-OMM&)M MM' "EH5E1m\  (  ! '  " ((00@     U0TWd0d  e  ..PS`.`a )   '--.> NG  9Q R$$$$W$5(()9=I  9U VI*$AA/R $ )$,$=$=n$M!!% *%-%>%>%O"*!0=I(=),Ys^)< #==(,9G&9'*73<'8 99 $$$)k$l%%mY@QSbdqr  6WZg6g h#99,Ygix:I=Z$$$$W$5$0 001A=Q 00yJ[]o1@-Q  9X Ys r%__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrfr]ransible.module_utils.basicransible.module_utils._textransible.module_utils.sixr>ansible_collections.community.zabbix.plugins.module_utils.baser #ansible.module_utils.compat.versionr Aansible_collections.community.zabbix.plugins.module_utils.helpers communityzabbixplugins module_utilshelpersrr rrrr%r#rs|A@ t n[ z    40(U<XXXdEzdEN KZ\ zFr%