community.zabbix.zabbix_script module – Create/update/delete Zabbix scripts
Note
This module is part of the community.zabbix collection (version 1.9.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_script
.
New in community.zabbix 1.7.0
Synopsis
This module allows you to create, update and delete scripts.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
Authentication method used for SSH script type. Used if type is Choices:
|
|
Command to run. |
|
Confirmation pop up text. The pop up will appear when trying to run the script from the Zabbix frontend. Used if scope is |
|
Description of the script. |
|
Where to run the script. Used if type is Choices:
|
|
Host permissions needed to run the script. Used if scope is Choices:
|
|
host group name that the script can be run on. If set to ‘all’, the script will be available on all host groups. Default: |
|
Zabbix user password. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Zabbix user name. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Folders separated by slash that form a menu like navigation in frontend when clicked on host or event. Used if scope is Works only with Zabbix >= 5.4. For lower versions is silently ignored. Prepend menu path to name instead. |
|
Name of the script. |
|
Array of webhook input parameters. Used if type is |
|
Parameter name. |
|
Parameter value. Supports macros. Default: |
|
Password used for SSH scripts with password authentication and Telnet scripts. Used if type is |
|
Port number used for SSH and Telnet scripts. Used if type is |
|
Name of the private key file used for SSH scripts with public key authentication. Used if type is |
|
Name of the public key file used for SSH scripts with public key authentication. Used if type is |
|
Script scope. Works only with Zabbix >= 5.4. For lower versions is silently ignored which is equivalent of Choices:
|
|
Webhook script execution timeout in seconds. Time suffixes are supported, e.g. 30s, 1m. Required if type is Possible values: 1-60s. Default: |
|
Script type. Types Choices:
|
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
State of the script. Choices:
|
|
The timeout of API request (seconds). This option is deprecated with the move to httpapi connection and will be removed in the next release Default: |
|
user group name that will be allowed to run the script. If set to ‘all’, the script will be available for all user groups. Used if scope is Default: |
|
User name used for authentication. Used if type is |
|
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release Choices:
|
Notes
Note
If you use login_password=zabbix, the word “zabbix” is replaced by “********” in all module output, because login_password uses
no_log
. See this FAQ for more information.
Examples
# Set following variables for Zabbix Server host in play or inventory
- name: Set connection specific variables
set_fact:
ansible_network_os: community.zabbix.zabbix
ansible_connection: httpapi
ansible_httpapi_port: 80
ansible_httpapi_use_ssl: false
ansible_httpapi_validate_certs: false
ansible_zabbix_url_path: 'zabbixeu' # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
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
set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: test - Create new action operation script to execute webhook
zabbix_script:
name: Test action operation script
scope: action_operation
script_type: webhook
command: 'return 0'
description: "Test action operation script"
state: present