W3cubDocs

/Ansible

community.zabbix.zabbix_itemprototype module – Create/delete Zabbix item prototypes

Note

This module is part of the community.zabbix collection (version 3.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.zabbix. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.zabbix.zabbix_itemprototype.

Synopsis

  • Create item prototypes if they do not exist.
  • Delete existing item prototypes if they exist.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter

Comments

discoveryrule_name

string / required

Name of the LLD rule that the item belongs to.

host_name

string

Name of host to add item prototype to.

Required when template_name is not used.

Mutually exclusive with template_name.

http_login_password

string

Basic Auth password

http_login_user

string

Basic Auth login

name

string / required

Name of item prototype to create or delete.

params

dictionary

Parameters to create/update item prototype with.

Required if state is “present”.

Parameters as defined at https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object

Additionally supported parameters are below

enabled

boolean

Status of the item prototype.

Overrides “status” in API docs

Choices:

  • false
  • true

interval

string

Update interval of the item prototype.

Alias for “delay” in API docs

key

string

Item prototype key.

Alias for “key_” in API docs

master_item

dictionary

item that is the master of the current one

Overrides “master_itemid” in API docs

discovery_rule

string / required

name of the discovery rule the master item belongs to

host_name

string

name of the host the master item belongs to

Required when template_name is not used.

Mutually exclusive with template_name.

item_name

string / required

name of the master item

template_name

string

name of the template the master item belongs to

Required when host_name is not used.

Mutually exclusive with host_name.

new_name

string

New name for item

preprocessing

list / elements=dictionary

Item preprocessing options.

Parameters as defined at

https://www.zabbix.com/documentation/current/en/manual/api/reference/itemprototype/object#item-prototype-preprocessing

Additionally supported parameters are below

error_handler

string

Action type used in case of preprocessing step failure.

Choices:

  • "zabbix_server"
  • "discard"
  • "set_custom_value"
  • "set_custom_error_message"

type

string / required

The preprocessing option type.

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"

status

string

Status of the item prototype.

Choices:

  • "enabled"
  • "disabled"

type

string

Type of the item prototype.

Required if state is “present”.

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

string

Type of information of the item prototype.

Required if state is “present”.

Choices:

  • "numeric_float"
  • "character"
  • "log"
  • "numeric_unsigned"
  • "text"

state

string

Create or delete item prototype.

Choices:

  • "present" ← (default)
  • "absent"

template_name

string

Name of template to add item prototype to.

Required when host_name is not used.

Mutually exclusive with host_name.

Examples

# 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 item prototype on example_host using example_rule
- name: create item prototype
  # 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    host_name: example_host
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
    state: present

# Create item prototype on example_template using example_rule
- name: create item prototype
  # 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
    state: present


# Add tags to the existing Zabbix item prototype
- name: update item prototype
  # 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    params:
      type: zabbix_agent
      key: "{% raw %}vfs.fs.size[{#FSNAME},used]{% endraw %}"
      value_type: numeric_unsigned
      interval: 1m
      tags:
          - tag: class
            value: application
    state: present

- name: create 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:example_depend_item_prototype{% endraw %}'
    discoveryrule_name: example_rule
    host_name: example_host
    params:
        type: dependent_item
        key: '{% raw %}vfs.fs.size.half[{#FSNAME}]{% endraw %}'
        value_type: numeric_float
        units: B
        master_item:
          item_name: '{% raw %}{#FSNAME}:example_item_prototype{% endraw %}'
          discoveryrule_name: example_rule
          host_name: example_host
        preprocessing:
          - type: javascript
            params: 'return value / 2;'
            error_handler: zabbix_server
    state: present

- name: Delete Zabbix item prototype
  # 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    state: absent

- name: Rename Zabbix item prototype
  # 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://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_itemprototype:
    name: '{% raw %}{#FSNAME}:Used space{% endraw %}'
    discoveryrule_name: example_rule
    template_name: example_template
    params:
      new_name: '{% raw %}{#FSNAME}:New Used space{% endraw %}'
    state: present

Authors

  • Andrew Lathrop (@aplathrop)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_itemprototype_module.html