> Script object

The following objects are directly related to the script API.

Script

The script object has the following properties.

PropertyTypeDescription
scriptidstring(readonly) ID of the script.
command
(required)
stringCommand to run.
name
(required)
stringName of the script.
confirmationstringConfirmation pop up text. The pop up will appear when trying to run the script from the Zabbix frontend.
descriptionstringDescription of the script.
execute_onintegerWhere to run the script.

Possible values:
0 - run on Zabbix agent;
1 - run on Zabbix server.
2 - (default) run on Zabbix server (proxy).
groupidstringID of the host group that the script can be run on. If set to 0, the script will be available on all host groups.

Default: 0.
host_accessintegerHost permissions needed to run the script.

Possible values:
2 - (default) read;
3 - write.
typeintegerScript type.

Possible values:
0 - (default) script;
1 - IPMI.
usrgrpidstringID of the user group that will be allowed to run the script. If set to 0, the script will be available for all user groups.

Default: 0.