community.zabbix.zabbix_itemprototype module – Create/delete Zabbix item prototypes
Note
This module is part of the community.zabbix collection (version 3.1.1).
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 |
---|---|
Name of the LLD rule that the item belongs to. |
|
Name of host to add item prototype to. Required when template_name is not used. Mutually exclusive with template_name. |
|
Basic Auth password |
|
Basic Auth login |
|
Name of item prototype to create or delete. |
|
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 |
|
Status of the item prototype. Overrides “status” in API docs Choices:
|
|
Update interval of the item prototype. Alias for “delay” in API docs |
|
Item prototype key. Alias for “key_” in API docs |
|
item that is the master of the current one Overrides “master_itemid” in API docs |
|
name of the discovery rule the master item belongs to |
|
name of the host the master item belongs to Required when template_name is not used. Mutually exclusive with template_name. |
|
name of the master item |
|
name of the template the master item belongs to Required when host_name is not used. Mutually exclusive with host_name. |
|
Item preprocessing options. Parameters as defined at Additionally supported parameters are below |
|
Action type used in case of preprocessing step failure. Choices:
|
|
The preprocessing option type. Choices:
|
|
Status of the item prototype. Choices:
|
|
Type of the item prototype. Required if state is “present”. Choices:
|
|
Type of information of the item prototype. Required if state is “present”. Choices:
|
|
Create or delete item prototype. Choices:
|
|
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