Vh;[ddlmZmZmZeZdZdZddlm Z ddl m Z ddl m cmcmcmcmZGdde Zd Zed k(reyy) )absolute_importdivisionprint_functionaQ --- module: zabbix_item short_description: Create/delete Zabbix items description: - Create items if they do not exist. - Delete existing items if they exist. author: - "Andrew Lathrop (@aplathrop)" requirements: - "python >= 2.6" options: state: description: - Create or delete item. required: false type: str default: "present" choices: [ "present", "absent" ] name: description: - Name of item to create or delete. required: true type: str host_name: description: - Name of host to add item to. - Required when I(template_name) is not used. - Mutually exclusive with I(template_name). required: false type: str template_name: description: - Name of template to add item to. - Required when I(host_name) is not used. - Mutually exclusive with I(host_name). required: false type: str params: description: - Parameters to create/update item with. - Required if state is "present". - Parameters as defined at https://www.zabbix.com/documentation/current/en/manual/api/reference/item/object - Additionally supported parameters are below required: false type: dict suboptions: key: description: - Item key. - Alias for "key_" in API docs required: false type: str interval: description: - Update interval of the item. - Alias for "delay" in API docs required: false type: str status: description: - Status of the item. required: false type: str choices: [ "enabled", "disabled" ] enabled: description: - Status of the item. - Overrides "status" in API docs required: false type: bool type: description: - Type of the item. - Required if state is "present". required: false type: str choices: - zabbix_agent - zabbix_trapper - simple_check - zabbix_internal - zabbix_agent_active - web_item - external_check - database_monitor - ipmi_agent - ssh_agent - telnet_agent - calculated - jmx_agent - snmp_trap - dependent_item - http_agent - snmp_agent - script value_type: description: - Type of information of the item. - Required if state is "present". required: false type: str choices: - numeric_float - character - log - numeric_unsigned - text new_name: description: - New name for item required: false type: str master_item: description: - item that is the master of the current one - Overrides "master_itemid" in API docs required: false type: dict suboptions: item_name: description: - name of the master item required: true type: str host_name: description: - name of the host the master item belongs to - Required when I(template_name) is not used. - Mutually exclusive with I(template_name). required: false template_name: description: - name of the template the master item belongs to - Required when I(host_name) is not used. - Mutually exclusive with I(host_name). preprocessing: description: - Item preprocessing options. - Parameters as defined at https://www.zabbix.com/documentation/current/en/manual/api/reference/item/object#item-preprocessing - Additionally supported parameters are below required: false type: list elements: dict suboptions: type: description: - The preprocessing option type. required: true type: str choices: - custom_multiplier - right_trim - left_trim - trim - regular_expressions - regex - boolean_to_decimal - octal_to_decimal - hexadecimal_to_decimal - simple_change - change_per_second - xml_xpath - jsonpath - in_range - matches_regular_expression - matches_regex - does_not_match_regular_expression - not_match_regex - check_for_error_in_json - check_for_json_error - check_for_error_in_xml - check_for_xml_error - check_for_error_using_regular_expression - check_for_error_regex - discard_unchanged - discard_unchanged_with_heartbeat - javascript - prometheus_pattern - prometheus_to_json - csv_to_json - replace - check_unsupported - xml_to_json - snmp_walk_value - snmp_walk_to_json error_handler: description: - Action type used in case of preprocessing step failure. required: false type: str choices: - zabbix_server - discard - set_custom_value - set_custom_error_message extends_documentation_fragment: - community.zabbix.zabbix av # 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 # Create ping item on example_host - name: create ping item # 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_item: name: agent_ping host_name: example_host params: type: zabbix_agent key: agent.ping value_type: numeric_unsigned interval: 1m state: present # Create ping item on example_template - name: create ping item # 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_item: name: agent_ping template_name: example_template params: type: zabbix_agent key: agent.ping value_type: numeric_unsigned interval: 1m state: present - name: Add tags to the existing Zabbix item # 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_item: name: agent_ping template_name: example_template params: type: zabbix_agent key: agent.ping value_type: numeric_unsigned interval: 1m tags: - tag: class value: application state: present - name: create a dependent item # 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_item: name: depend_item host_name: example_host params: type: dependent_item key: vfs.fs.pused value_type: numeric_float units: '%' master_item: item_name: example_item host_name: example_host preprocessing: - type: jsonpath params: '$[?(@.fstype == "ext4")]' error_handler: zabbix_server - type: jsonpath params: "$[*].['bytes', 'inodes'].pused.max()" error_handler: zabbix_server state: present - name: Delete Zabbix item # 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_item: name: agent_ping template_name: example_template state: absent - name: Rename Zabbix item # 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_item: name: agent_ping template_name: example_template params: new_name: new_agent_ping state: present ) AnsibleModule) ZabbixBaseNceZdZiddddddddd d d d d ddddddddddddddddddd d!d"d#d$iZdd%ddd&d'Zid(d%d)dd*dd+d&d,dd-dd.d/d0d d1d2d3d d4dd5dd6dd7dd8dd9dd:did;dddd?dd@ddAddBd dCd"dDd$dEdFdGdHdIdJdKdLdMdNdOdPdQdRdSdTiZdd%dddUZdVZdWZdXZ dYZ dZZ d[Z d\Z y])^Item zabbix_agentrzabbix_trapper simple_checkzabbix_internalzabbix_agent_activeweb_item external_check database_monitor ipmi_agent ssh_agent telnet_agent calculated jmx_agent snmp_trapdependent_item http_agent snmp_agentscript) numeric_float characterlognumeric_unsignedtextcustom_multiplier right_trim left_trimtrimregular_expressionsregexboolean_to_decimaloctal_to_decimalhexadecimal_to_decimal simple_changechange_per_second xml_xpathjsonpathin_rangematches_regular_expression matches_regex!does_not_match_regular_expressionnot_match_regexcheck_for_error_in_jsoncheck_for_json_errorcheck_for_error_in_xmlcheck_for_xml_error(check_for_error_using_regular_expressioncheck_for_error_regexdiscard_unchanged discard_unchanged_with_heartbeat javascriptprometheus_patternprometheus_to_json csv_to_jsonreplacecheck_unsupported xml_to_jsonsnmp_walk_valuesnmp_walk_to_json) zabbix_serverdiscardset_custom_valueset_custom_error_messagec|* |jjjdd|iiS |jj jdd|iiS#t$r)}|jj d|zYd}~yd}~wwxYw#t$r)}|jj d|zYd}~yd}~wwxYw)NfilterhostzFailed to get host: %smsgzFailed to get template: %s)_zapirgget Exception_module fail_jsontemplate)self host_name template_namees p/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/zabbix/plugins/modules/zabbix_item.pyget_hosts_templateszItem.get_hosts_templatess   Izz**Hvy6I+JKK Mzz**..6=:Q/RSS  I &&+Ca+G&HH I  M &&+G!+K&LL Ms.(A(B  B  BB  B>B99B>c||}n|}g} |jjjd||di}|S#t$r*}|jj d|zYd}~|Sd}~wwxYw)Nrf)namergFailed to get item: %srhrjitemrkrlrmrn)rp item_namerqrrrgitemsrss rt get_itemszItem.get_itemss}  D D EJJOO''It3T(UVE  E LL " "'?!'C " D D  Es*7 A*A%%A*cd||d<d|vr|d|d<|jdd|vr|j|d}||d<d|vr|j|d}||d<d|vr|d|d<|jdd|vr!|drd|d <nd |d <|jdd |vr:|d }|dk(rd |d <n*|d k(rd |d <n|jj d |zd|vrd|dvrd|dd<d|dvrd|dd<|j |dd|dd|dd}t |d k(r%|jj d|ddz|d d|d<|jdd|vr>|dD]5}|j|d}||d<d|vs|j|d} | |d<7yy)Nrwkeykey_type value_typeintervaldelayenabledstatusdisabledrr-z.Status must be 'enabled' or 'disabled', got %srh master_itemrqrrr{z,No items with the name %s exist to depend onitemid master_itemid preprocessing error_handler) pop ITEM_TYPES VALUE_TYPESrmrnr}lenPREPROCESSING_TYPESPREPROCESSING_ERROR_HANDLERS) rprwparams item_type_intvalue_type_intr master_itemsparampreprocess_type_interror_handler_ints rtsanitize_paramszItem.sanitize_paramss]v F?#E]F6N JJu  V  OOF6N;M*F6N 6 !!--f\.BCN#1F<  $Z0F7O JJz "  i #,x #-x JJy ! v H%F"#$x :%#$x  &&+[^d+d&e F "&"7759}%k2f]&;;9=}%o6>>&*? *LfUbNcdoNprxzGsHIXsYZL< A% &&+Y\bcp\qr}\~+~&&21oh&?F? # JJ} % f $0 ?&*&>&>uV}&M# 3f "e+(,(I(I%P_J`(a%->E/*  ? %c"|jjr|jjd |jjj |}|S#t $r*}|jjd|zYd}~Sd}~wwxYw)NTchangedzFailed to create item: %srh)rm check_mode exit_jsonrjrzcreaterlrnrprresultsrss rtadd_itemz Item.add_item << " " LL " "4 " 0 Hjjoo,,V4G H LL " "'BQ'F " G G H%A B$B  Bc"|jjr|jjd |jjj |}|S#t $r*}|jjd|zYd}~Sd}~wwxYw)NTrzFailed to update item: %srh)rmrrrjrzupdaterlrnrs rt update_itemzItem.update_itemrrc |jjjdd|dzid}||k7S#t$r-}|jj d|zYd}~|k7Sd}~wwxYw)Nitemidsz%srrrxrhry)rpold_itemnew_itemrss rtcheck_item_changedzItem.check_item_changeds Ezz**Ithx>P7P+QRSTUH8## E LL " "'?!'C " D D8## Es07 A-A((A-c"|jjr|jjd |jjj |}|S#t $r*}|jjd|zYd}~Sd}~wwxYw)NTrzFailed to delete item: %srh)rmrrrjrzdeleterlrn)rpitem_idrrss rt delete_itemzItem.delete_item s << " " LL " "4 " 0 Hjjoo,,W5G H LL " "'BQ'F " G G HrN)__name__ __module__ __qualname__rrrrrur}rrrrrrrtr r hs .! "A  ! $Q (  a  #B  %b  r !"  r r #B  ! "B# J&%& !'( K "4."4'"4&"4"1"41! "4 #A "4 0 "4.q"44Q"4+A"4/"4'"4&r"4&r"48"4+B"4 ?!"4"-b#"4$5b%"4&22'"4(4R)"4*1"+"4,Fr-"4.3B/"40/1"42>r3"44(5"4607"4809"4:)";"4<%b="4>/?"4@)"A"4B-bC"4D/E"4H67/089@A$C M ,?\$rr ctj}|jttddtddtddtddtddddg t |d d ggd d ggd dd gggd}|j d}|j d }|j d }|j d }|j d }t |}|dk(rw|j|||}t|dk(r|jddyg} |D]} | j| d|j| } |jd| y|dk(r|j|||j|||}d|vrA|j|d||} t| dkDr|jdd| ddgigg} t|dk(rd|vr|jd|z|j||} | D]N}d|vr |d|d<nd|vr |d|d<n|jd| j|j|P|jd| yd}|D]]} | d|d<d|vr|d|d<|j!d| j|j#||j%| }|s\d}_|j|| yy)NstrT)rrequiredFdictpresentabsent)rdefaultchoices)rwrqrrrstaterqrrrr) argument_specrequired_one_ofmutually_exclusive required_ifsupports_check_moderwrzNo item to delete.)rresultrnew_namerz$Cannot rename item: %s is not foundhostid templateidzhost/template did not return idrh) zabbix_utilszabbix_common_argument_specrrrrr r}rrappendrrrnrurrrr)rmodulerwrqrrrrrzr| delete_idsir new_name_itemhosts_templates host_templater changed_items rtmainrs9 <<>M ut ,EE26%0y9h:OP # / * / * i( , ! F == D k*IMM/2M ]]8 $F MM' "E  u:?   U3G  HJ /!!!H+. /&&z2G   T'  : )  T6*tY >   NN6*+=y-XM=!A%  ]STEUV^E_D`8a7b c u:?V#  !G$!NO"66y-PO!0 6 },'4X'>F8$!]2'4\'BF8$$$)J$Kt}}V45 6   T'  :G ##$X;x '%+J%7F6NJJz*t//78#66q9 "G #   WW  =A r__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESansible.module_utils.basicr>ansible_collections.community.zabbix.plugins.module_utils.baserAansible_collections.community.zabbix.plugins.module_utils.helpers communityzabbixplugins module_utilshelpersrr rrrrrtrs` A@ H TL \5UXXXi:iXJ>Z zFr