Zabbicook Configurations

mediaTypes

(Array object)

The MediaType object

mediaTypes.name

(required) Name of the media type.

mediaTypes.type

(required) Transport used by the media type.

Possible values:

  • 'email' - email
  • 'script' - script
  • 'SMS' - SMS
  • 'Jabber' - Jabber
  • 'EzTexting' - Ez Texting

mediaTypes.scriptName (textLimit)

Script name or text limit.

For script media types scriptName contains the name of the executed script.

For Ez Texting textLimit contains the message text limit.

Possible text limit values:

0 - USA (160 characters);

1 - Canada (136 characters).

Required for script and Ez Texting media types.

mediaTypes.gsmModem

Serial device name of the GSM modem.

Required for SMS media types.

mediaTypes.password

Authentication password.

Required for Jabber and Ez Texting media types.

mediaTypes.SMTPEmail

Email address from which notifications will be sent.

Required for email media types.

mediaTypes.SMTPHELO

SMTP HELO.

Required for email media types.

mediaTypes.SMTPServer

SMTP server.

Required for email media types.

mediaTypes.enabled

Whether the media type is enabled.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

mediaTypes.user (username)

Username or Jabber identifier.

Required for Jabber and Ez Texting media types.

mediaTypes.scriptParameters (params)

Script parameters.

Each parameter ends with a new line feed.

hostGroups

(Array object)

Host group object

hostGroups.name

(required) Name of the host group.

hosts

(Array object)

Host configurations

hosts.host

The host object

hosts.host.hostname (name)

(required) Technical name of the host.

hosts.host.description (desc)

Description of the host.

hosts.host.inventoryMode

Host inventory population mode.

Possible values:

  • 'disabled' - disabled
  • 'manual' - (default) manual
  • 'automatic' - automatic

hosts.host.ipmiAuthAlgorithm

IPMI authentication algorithm.

Possible values:

  • 'default' - default
  • 'none' - none
  • 'MD2' - MD2
  • 'MD5' - MD5
  • 'straight' - straight
  • 'OEM' - OEM
  • 'RMCPPlus' - RMCP+

hosts.host.ipmiPass (ipmiPassword)

IPMI password.

hosts.host.ipmiPrivilegeLevel

IPMI privilege level.

Possible values:

  • 'callback' - callback
  • 'user' - (default)user
  • 'operator' - operator
  • 'admin' - admin
  • 'OEM' - OEM

hosts.host.ipmiUser

IPMI username.

hosts.host.visibleName

Visible name of the host.

|Default: host property value.

hosts.host.enabled

Enabled status of the host.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

hosts.groups (hostGroups)

(Array object)

(required) Host groups to add the host to.

hosts.interfaces

(Array object)

Host interface object

hosts.interfaces.dns

(required if DNS used) DNS name used by the interface.

Can be empty if the connection is made via IP.

hosts.interfaces.ip

(required if IP used) IP address used by the interface.

Can be empty if the connection is made via DNS.

hosts.interfaces.default (main)

(required) boolean Whether the interface is used as default on the host." +

Only one interface of some type can be set as default on a host.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

hosts.interfaces.port

(required, String) Port number used by the interface. Can contain user macros.

hosts.interfaces.type

(required) Interface type.

Possible values:

  • 'agent' - agent
  • 'SNMP' - SNMP
  • 'IPMI' - IPMI
  • 'JMX' - JMX

hosts.interfaces.connectTo (useIP)

(required) Whether the connection should be made via IP.

Possible values:

  • 'dns' - connect using host DNS name
  • 'ip' - connect using host IP address for this host interface.

hosts.interfaces.bulk (useBulk)

Whether to use bulk SNMP requests.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

hosts.templates

(Array object)

Linked template names.

userGroups

(Array object)

Permission of a user group.

userGroups.userGroup

User group object.

userGroups.userGroup.name

(required) Name of the user group.

userGroups.userGroup.debug (debugMode)

Whether debug mode is enabled or disabled.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

userGroups.userGroup.guiAccess (gui)

Frontend authentication method of the users in the group.

Possible values:

  • 'default' - (default) use the system default authentication method
  • 'internal' - use internal authentication
  • 'disable' - disable access to the frontend

userGroups.userGroup.enabled (usersStatus)

Whether the user group is enabled or disabled.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

userGroups.permissions

(Array object)

Permission of ths host group.

userGroups.permissions.hostgroup (hostGroup)

Name of the host group

userGroups.permissions.permission

Access level to the host group.

Possible values:

  • 'denied' - access denied
  • 'readOnly' - read-only access
  • 'readWrite' - read-write access

users

(Array object)

User settings.

users.user

User object.

users.user.alias

(required) User alias.

users.user.autoLogin (autologin)

Whether to enable auto-login.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

users.user.lang (language)

Language code of the user's language.

Default: en_GB.

users.user.name

Name of the user.

users.user.refresh

Automatic refresh period in seconds.

Default: 30.

users.user.rowsPerPage (rows)

Amount of object rows to show per page.

Default: 50.

users.user.surName (surname, sur)

Surname of the user.

users.user.theme

User's theme.

Possible values:

  • 'default' - default
  • 'blue' - Blue
  • 'dark' - Dark

users.user.type

Type of the user.

Possible values:

  • 'user' - (default) Zabbix user
  • 'admin' - Zabbix admin
  • 'superAdmin' - Zabbix super admin

users.user.url

URL of the page to redirect the user to after logging in.

users.groups

(Array object)

(required) User groups to add the user to.

users.password

(required) User's password.

users.initialPassword

(required) Whether the password is used only when the user is created.

If set false, zabbicook always set the password.

users.media

(Array object)

The Media object

users.media.enabled

(required) Whether the media is enabled.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

users.media.type

(required) The media type used by the media.

users.media.whenActive (period)

(required) Time when the notifications can be sent as a time period.

ex. "1-7,00:00-24:00"

users.media.sendTo

(required) Address, user name or other identifier of the recipient.

users.media.severity

(Array object)

(required) Array of trigger severities to send notifications about.

Notifications will be sent from triggers with severities as followed this setting.

Possible values:

  • 'classified' - (default) not classified
  • 'information' - information
  • 'warning' - warning
  • 'average' - average
  • 'high' - high
  • 'disaster' - disaster

actions

(Array object)

Action object.

actions.name

(required) string Name of the action.

actions.defaultStepDuration (stepDuration)

(required) integer Default operation step duration. Must be greater than 60 seconds.

actions.event

(required)(constant) Type of events that the action will handle. This value is not changeable.

Possible values:

  • 'trigger' - event created by a trigger
  • 'discovery' - event created by a discovery rule
  • 'registration' - event created by active agent auto-registration
  • 'internal' - internal event

actions.message (defaultMessage)

Problem message text.

actions.subject (defaultSubject)

Problem message subject.

actions.recoveryMessage

Recovery message text.

actions.recoverySubject

Recovery message subject

actions.recoveryMessageEnabled

Whether recovery messages are enabled. (Zabbix version <= 3.0.x)

Possible values:

  • 'false' - Disable
  • 'true' - Enable

actions.enabled

Whether the action is enabled or disabled.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

actions.filter

The action filter object defines a set of conditions that must be met to perform the configured action operations.

actions.filter.conditions

(Array object)

Set of filter conditions to use for filtering results.

actions.filter.conditions.type

(required) Type of filter condition.

Possible values:

  • 'hostGroup' - host group (possible for trigger and internal actions)
  • 'host' - host (possible for trigger and internal actions)
  • 'trigger' - trigger (possible for trigger actions)
  • 'triggerName' - trigger name (possible for trigger actions)
  • 'triggerSeverity' - trigger severity (possible for trigger actions). For this type, set a number according to the level at the 'value'.0 - classified, 1 - information, 2 - warning, 3 - average, 4 - high, 5 - disaster
  • 'triggerValue' - trigger value (possible for trigger actions) (Zabbix Ver <= 3.0.x)
  • 'timePeriod' - time period (possible for trigger actions)
  • 'hostIP' - host IP (possible for discovery actions)
  • 'descoveredServiceType' - discovered service type (possible for discovery actions)
  • 'discoveredServicePort' - discovered service port (possible for discovery actions)
  • 'discoveredStatus' - discovery status (possible for discovery actions)
  • 'uptimeOrDowntimeDuration' - uptime or downtime duration (possible for discovery actions)
  • 'receivedValue' - received value (possible for discovery actions)
  • 'hostTemplate' - host template (possible for trigger and internal actions)
  • 'application' - application (possible for trigger and internal actions)
  • 'maintenanceStatus' - maintenance status. (possible for trigger actions)
  • 'discoveryRule' - discovery rule (possible for discovery actions)
  • 'discoveryCheck' - discovery check (possible for discovery actions)
  • 'proxy' - proxy (possible for discovery and auto-registration actions)
  • 'discoveryObject' - discovery object. (possible for discovery actions)
  • 'hostName' - host name (possible for auto-registration actions)
  • 'eventType' - event type. (possible for internal actions)
  • 'hostMetadata' - host metadata. (possible for auto-registration actions)
  • 'eventTag' - event tag (possible for trigger actions) (Zabbix Ver >= 3.2.x)
  • 'eventTagValue' - event tag value (possible for trigger actions) (Zabbix Ver >= 3.2.x)

actions.filter.conditions.value

(required) Value to compare with.

actions.filter.conditions.value2

Secondary value to compare with. Requried for trigger actions when condition type is 'eventTagValue'

actions.filter.conditions.label (formulaid)

Arbitrary unique ID that is used to reference the condition from a custom expression.

Can only contain capital-case letters.

The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.

actions.filter.conditions.operator

Filter condition operator.

Possible values:

  • 'equal' - = (default)
  • 'notEqual' - <>
  • 'like' - like
  • 'notLike' - not like
  • 'in' - in
  • 'greaterEqual' - >=
  • 'lessEqual' - <=
  • 'notIn' - not in

actions.filter.type (typeOfCalculation)

(required) Filter condition evaluation method.

When conditions is empty array this does not affect but it should be set 'AndOr'.

Possible values:

  • 'AndOr' - (default) AND / OR
  • 'And' - AND
  • 'Or' - OR
  • 'customExpression' - custom expression

actions.filter.customExpression (formula)

User-defined expression to be used for evaluating conditions of filters with a 'customExpression'.

The expression must contain IDs that reference specific filter conditions by its formulaid(i.e. 'label').

The IDs used in the expression must exactly match the ones defined in the filter conditions:

no condition can remain unused or omitted.

Required for 'customExpression' filters.

actions.operations

(Array object)

The action operation object defines an operation that will be performed when an action is executed.

actions.operations.type (operationType)

Type of operation.

Possible values:

  • 'sendMessage' - send message

actions.operations.operationCondition

Operation condition evaluation method.

Possible values:

  • 'AndOr' - (default) AND / OR
  • 'And' - AND
  • 'Or' - OR

actions.operations.message

Object containing the data about the message sent by the operation.

Required for message operations.

actions.operations.message.defaultMessage

Whether to use the default action message text and subject.

When set 'true', use the data from the operation;

When set 'false', use the data from the action.

Default: false.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

actions.operations.message.mediaType

Name of the media type that will be used to send the message.

actions.operations.message.message

Operation message text. It is used when defaultMessage is false.

actions.operations.message.subject

Operation message subject. It is used when defaultMessage is false.

actions.operations.sendToUserGroups

(Array object)

User groups to send messages to.

Required for message operations if 'sendToUsers' is not set.

actions.operations.sendToUsers

(Array object)

Users to send messages to.

Required for message operations if 'sendToUserGroups' is not set.

actions.operations.stepDuration

Duration of an escalation step in seconds. Must be greater than 60 seconds.

If set to 0, the default action escalation period will be used.

Default: 0.

actions.operations.stepFrom

Step to start escalation from. Default: 1.

actions.operations.stepTo

Step to end escalation at. Default: 1.

actions.recoveryOperations

(Array object)

The action recovery operation object defines an operation that will be performed when a problem is resolved.

Recovery operations are possible for trigger actions and internal actions.

(Zabbix version >= 3.2.x)

actions.recoveryOperations.type (operationType)

Type of operation.

Possible values:

  • 'sendMessage' - send message

actions.recoveryOperations.operationCondition

Operation condition evaluation method.

Possible values:

  • 'AndOr' - (default) AND / OR
  • 'And' - AND
  • 'Or' - OR

actions.recoveryOperations.message

Object containing the data about the message sent by the operation.

Required for message operations.

actions.recoveryOperations.message.defaultMessage

Whether to use the default action message text and subject.

When set 'true', use the data from the operation;

When set 'false', use the data from the action.

Default: false.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

actions.recoveryOperations.message.mediaType

Name of the media type that will be used to send the message.

actions.recoveryOperations.message.message

Operation message text. It is used when defaultMessage is false.

actions.recoveryOperations.message.subject

Operation message subject. It is used when defaultMessage is false.

actions.recoveryOperations.sendToUserGroups

(Array object)

User groups to send messages to.

Required for message operations if 'sendToUsers' is not set.

actions.recoveryOperations.sendToUsers

(Array object)

Users to send messages to.

Required for message operations if 'sendToUserGroups' is not set.

templates

(Array object)

Template settings and information that belongs to the template

templates.template

Template object

templates.template.name

(required) Technical name of the template.

templates.template.description

Description of the template.

templates.template.visibleName

Visible name of the host.

Default: name property value.

CAUTION: It seems that it can often not be changed due to problems with zabbix.

templates.groups

(Array object)

(required) Names of host groups to add the template to.

templates.linkedTemplates

(Array object)

Names of templates to be linked to the template.

templates.items

(Array object)

Item object

templates.items.interval (delay)

(required) Update interval of the item in seconds.

templates.items.key

(required) Item key.

templates.items.name

(required) Name of the item.

templates.items.type

(required) Type of item.

Possible values:

  • 'ZabbixAgent' - Zabbix agent
  • 'SNMPv1agent' - SNMPv1 agent
  • 'ZabbixTrapper' - Zabbix trapper
  • 'SimpleCheck' - Simple check
  • 'SNMPv2Agent' - SNMPv2 agent
  • 'ZabbixInternal' - Zabbix internal
  • 'SNMPv3Agent' - SNMPv3 agent
  • 'ZabbixAgentActive' - Zabbix agent (active)
  • 'ZabbixAggregate' - Zabbix aggregate
  • 'WebItem' - web item
  • 'ExternalCheck' - external check
  • 'DatabaseMonitor' - database monitor
  • 'IPMIagent' - IPMI agent
  • 'SSHagent' - SSH agent
  • 'TELNETagent' - TELNET agent
  • 'calculated' - calculated
  • 'JMXagent' - JMX agent
  • 'SNMPtrap' - SNMP trap

templates.items.typeOfInformation (valueType)

Type of information of the item.

Possible values:

  • 'float' - numeric float
  • 'character' - character
  • 'log' - log
  • 'unsigned' - numeric unsigned
  • 'text' - text

templates.items.authMethod (authType)

SSH authentication method. Used only by SSH agent items.

Possible values:

  • 'password' - (default) password
  • 'publicKey' - public key

templates.items.dataType

Data type of the item.

Possible values:

  • 'decimal' - (default) decimal
  • 'octal' - octal
  • 'hexadecimal' - hexadecimal
  • 'boolean' - boolean

templates.items.delta

Value that will be stored.

Possible values:

  • 'AsIs' - (default) as is
  • 'SpeedPerSec' - Delta, speed per second.
  • 'SimpleChange' - Delta, simple change

templates.items.description (desc)

Description of the item.

templates.items.multiplier (formula)

(integer/float) Custom multiplier.

Default: 1.

templates.items.history

Number of days to keep item's history data.

Default: 90.

templates.items.hostInventoryField

ID of the host inventory field that is populated by the item.

Refer to the host inventory page for a list of supported host inventory fields and their IDs.

Default: 0.

templates.items.IPMISensor

IPMI sensor. Used only by IPMI items.

templates.items.logTimeFormat

Format of the time in log entries. Used only by log items.

templates.items.multiplierEnabled

Whether to use a custom multiplier.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

templates.items.params

Additional parameters depending on the type of the item:

- executed script for SSH and Telnet items;

- SQL query for database monitor items;

- formula for calculated items.

templates.items.password

Password for authentication. Used by simple check, SSH, Telnet, database monitor and JMX items.

templates.items.port

Port monitored by the item. Used only by SNMP items.

templates.items.privateKey

Name of the private key file.

templates.items.publicKey

Name of the public key file.

templates.items.SNMPCommunity

SNMP community. Used only by SNMPv1 and SNMPv2 items.

templates.items.SNMPOID (OID)

SNMP OID.

templates.items.SNMPAuthPassphrase

SNMPv3 auth passphrase. Used only by SNMPv3 items.

templates.items.SNMPAuthProtocol

SNMPv3 authentication protocol. Used only by SNMPv3 items.

Possible values:

  • 'MD5' - (default) MD5
  • 'SHA' - SHA

templates.items.SNMPContextName

SNMPv3 context name. Used only by SNMPv3 items.

templates.items.SNMPPrivacyPassphrase

SNMPv3 priv passphrase. Used only by SNMPv3 items.

templates.items.SNMPPrivacyProtocol

SNMPv3 privacy protocol. Used only by SNMPv3 items.

Possible values:

  • 'DES' - DES
  • 'AES' - AES

templates.items.SNMPSecurityLevel

SNMPv3 security level. Used only by SNMPv3 items.

Possible values:

  • 'noAuthNoPriv' - noAuthNoPriv
  • 'authNoPriv' - authNoPriv
  • 'authPriv' - authPriv

templates.items.SNMPSecurityName

SNMPv3 security name. Used only by SNMPv3 items.

templates.items.status (enabled)

Status of the item.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

templates.items.allowedHosts (trapperHosts)

Allowed hosts. Used only by trapper items.

Number of days to keep item's trends data.

Default: 365.

templates.items.units

Value units.

templates.items.username

Username for authentication. Used by simple check, SSH, Telnet, database monitor and JMX items.

Required by SSH and Telnet items.

templates.items.applications

(Array object)

Application names.

templates.graphs

(Array object)

Graph settings object.

templates.graphs.graph

Graph object.

templates.graphs.graph.height

(required) Height of the graph in pixels.

templates.graphs.graph.name

(required) Name of the graph.

templates.graphs.graph.width

(required) Width of the graph in pixels.

templates.graphs.graph.type

Graph's layout type.

Possible values:

  • 'normal' - (default) normal
  • 'stacked' - stacked
  • 'pie' - pie
  • 'exploded' - exploded

templates.graphs.graph.percentLeft (percentL)

Left percentile.

Default: 0.

templates.graphs.graph.percentRight (percentR)

Right percentile.

Default: 0.

templates.graphs.graph.view3D

Whether to show pie and exploded graphs in 3D.

Default: false

Possible values:

  • 'false' - Disable
  • 'true' - Enable

templates.graphs.graph.showLegend

Whether to show the legend on the graph.

Default: true

Possible values:

  • 'false' - Disable
  • 'true' - Enable

templates.graphs.graph.showWorkingTime

Whether to show the working time on the graph.

Default:true

Possible values:

  • 'false' - Disable
  • 'true' - Enable

templates.graphs.graph.yAxisMax (yMax)

The fixed maximum value for the Y axis.

Default: 100

templates.graphs.graph.yAxisMin (yMin)

The fixed minimum value for the Y axis.

Default: 0

templates.graphs.graph.yAxisMaxType (yMaxType)

Maximum/Minimum value calculation method for the Y axis.

Possible values:

  • 'calculated' - (default) calculated
  • 'fixed' - fixed

templates.graphs.graph.yAxisMinType (yMinType)

Maximum/Minimum value calculation method for the Y axis.

Possible values:

  • 'calculated' - (default) calculated
  • 'fixed' - fixed

templates.graphs.items

(Array object)

Graph item object.

templates.graphs.items.color

(required) Graph item's draw color as a hexadecimal color code.

templates.graphs.items.itemName (item)

Name of the item associated with this graph item.

templates.graphs.items.function

Value of the item that will be displayed.

Possible values:

  • 'minimum' - minimum value
  • 'average' - (default) average value
  • 'maximum' - maximum value
  • 'all' - all values
  • 'last' - last value, used only by pie and exploded graphs

templates.graphs.items.style (drawStyle)

Draw style of the graph item.

Possible values:

  • 'default' - (defualt) line
  • 'region' - filled region
  • 'bold' - bold line
  • 'dot' - dot
  • 'dashed' - dashed line
  • 'gradient' - gradient line

templates.graphs.items.order

Position of the item in the graph.

Default: starts with 0 and increases by one with each entry.

templates.graphs.items.type

Type of graph item.

Possible values:

  • 'simple' - (default) simple
  • 'sum' - graph sum, used only by pie and exploded graphs.

templates.graphs.items.yAxisSide (yAxis)

Side of the graph where the graph item's Y scale will be drawn.

Possible values:

  • 'left' - (default) left side
  • 'right' - right side

templates.triggers

(Array object)

Trigger setting.

templates.triggers.trigger

Trigger object.

templates.triggers.trigger.name

(required) Name of the trigger.

templates.triggers.trigger.expression

(required) Reduced trigger expression.

templates.triggers.trigger.description (comments)

Additional comments to the trigger.

templates.triggers.trigger.severity (priority)

Severity of the trigger.

Possible values:

  • 'classified' - (default) not classified
  • 'information' - information
  • 'warning' - warning
  • 'average' - average
  • 'high' - high
  • 'disaster' - disaster

templates.triggers.trigger.enabled

Whether the trigger is enabled or disabled.

Possible values:

  • 'true' - Enabled
  • 'false' - Disabled

templates.triggers.trigger.eventGenerationMode (multipleEvents)

Whether the trigger can generate multiple problem events.

Possible values:

  • 'single' - (default) do not generate multiple events.
  • 'multiple' - generate multiple events.

templates.triggers.trigger.url

URL associated with the trigger.

templates.triggers.trigger.okEventGeneration (recoveryMode)

OK event generation mode. (Available in Zabbix Version >= 3.2.0.)

Possible values:

  • 'expression' - (default) Expression
  • 'recoveryExpression' - Recovery expression ('recoveryExpression' required)
  • 'none' - None

templates.triggers.trigger.recoveryExpression

Reduced trigger recovery expression. (available Zabbix version >= 3.2)

templates.triggers.trigger.okEventCloses

OK event closes. (available in Zabbix Version >= 3.2.0.)

Possible values:

  • 'all' - (default) All problems
  • 'tagMatched' - All problems if tag values match.

templates.triggers.trigger.tagForMatching

Tag for matching. (available in Zabbix version >= 3.2.0)

templates.triggers.trigger.manualClose (allowManualClose)

Allow manual close.

Possible values:

  • 'false' - Disable
  • 'true' - Enable

templates.triggers.dependencies

(Array object)

Dependent triggers.

templates.triggers.dependencies.template

Template name to which the trigger belongs.

(default) The template to which this trigger belongs.

templates.triggers.dependencies.name

(required) Trigger name.

templates.triggers.tags

(Array object)

Trigger tags.

templates.triggers.tags.tag

(required) Tag name.

templates.triggers.tags.value

(required) Tag value.

templates.applications

(Array object)

Names of application.

screens

(Array object)

Screen setting.

screens.screen

The screen object.

screens.screen.name

(required) Name of the screen.

screens.screen.columns (width)

Width of the screen. Default: 1.

screens.screen.rows (height)

Height of the screen. Default: 1.

screens.items

(Array object)

The screen item object defines an element displayed on a screen.

screens.items.resourceType (type)

(required) Type of screen item.

Possible values:

  • 'graph' - graph
  • 'simpleGraph' - graph
  • 'plainText' - plain text
  • 'hostsInfo' - hosts info
  • 'triggersInfo' - triggers info
  • 'statusOfZabbix' - status of Zabbix
  • 'clock' - clock
  • 'screen' - screen
  • 'triggersOverview' - triggers overview
  • 'dataOverview' - data overview
  • 'URL' - URL
  • 'historyOfActions' - history of actions
  • 'historyOfEvents' - history of events
  • 'hostGroupIssues' - latest host group issues
  • 'systemStatus' - system status
  • 'hostIssues' - latest host issues

screens.items.application

Application or part of application name by which data in screen item can be filtered.

Applies to resource types: 'dataOverview' and 'triggersOverview'

screens.items.columnSpan (column)

Number of columns the screen item will span across. Default: 1.

screens.items.dynamic

Whether the screen item is dynamic.

Default: false (not dynamic)

Possible values:

  • 'false' - Disable
  • 'true' - Enable

screens.items.showLines

Number of lines to display on the screen item. Default: 25.

screens.items.horizontalAlign (halign)

Specifies how the screen item must be aligned horizontally in the cell.

Possible values:

  • 'center' - (default) center
  • 'left' - left
  • 'right' - right

screens.items.height

Height of the screen item in pixels. Default: 200.

screens.items.maxColumns

Specifies the maximum amount of columns a graph prototype or simple graph prototype screen element can have. Default: 3.

screens.items.resource

Resource name of the object displayed on the screen item.

|Depending on the type of a screen item, this property can reference different objects.

|Required for data overview, graph, map, plain text, screen, simple graph, host issues, host group issues and trigger overview screen items.

|Unused by local and server time clocks, history of actions, history of events, hosts info, status of Zabbix, system status and URL screen items.

screens.items.resource.name

(required) Resource name (such as item and graph).

screens.items.resource.template

The name of the template to which the resource belongs.

Required for the following resource types:

graph, simpleGraph, plainText

screens.items.rowSpan (row)

Number or rows the screen item will span across. Default: 1.

screens.items.sortTrigger (sort)

Order in which actions or triggers must be sorted.

Applies to resource types: 'historyOfActions', 'hostIssues', 'hostGroupIssues'

Possible values:

  • 'timeAsc' - time, ascending: for 'historyOfActions'
  • 'timeDesc' - time, descending: for 'historyOfActions'
  • 'typeAsc' - type, ascending: for 'historyOfActions'
  • 'typeDesc' - type, descending: for 'historyOfActions'
  • 'statusAsc' - status, ascending: for 'historyOfActions'
  • 'statusDesc' - status, descending: for 'historyOfActions'
  • 'retriesLeftAsc' - retries left, ascending: for 'historyOfActions'
  • 'retriesLeftDesc' - retries left, descending: for 'historyOfActions'
  • 'recipientAsc' - recipient, ascending: for 'historyOfActions'
  • 'recipientDesc' - recipient, descending: for 'historyOfActions'
  • 'lastChange' - (default) last change, descending: for 'hostIssues', 'hostGroupIssues'
  • 'severity' - severity, descending: for 'hostIssues', 'hostGroupIssues'
  • 'host' - host, ascending: for 'hostIssues', 'hostGroupIssues'

screens.items.style (hostsLocation, timeType, showsAsHtml)

Screen item display option.

Possible values for 'dataOverview' and 'triggersOverview' screen items:

style1 - (default) display hosts on the left side;

style2 - display hosts on the top.

Possible values for 'hostsInfo' and triggersInfo screen elements:

style1 - (default) horizontal layout;

style2 - vertical layout.

Possible values for 'clock' screen items:

style1 - (default) local time;

style2 - server time;

style3 - host time.

Possible values for 'plainText' screen items:

style1 - (default) display values as plain text;

style2 - display values as HTML.

Possible values:

  • 'style1' - (default) style 1
  • 'style2' - style 2
  • 'style3' - style 3

screens.items.url (URL)

URL of the webpage to be displayed in the screen item. Used by URL screen items.

screens.items.verticalAlign (valign)

Specifies how the screen item must be aligned vertically in the cell.

Possible values:

  • 'middle' - (default) middle
  • 'top' - top
  • 'bottom' - bottom

screens.items.width

Width of the screen item in pixels. Default: 320.

screens.items.x (xCoordinates)

X-coordinates of the screen item on the screen, from left to right. Default: 0.

screens.items.y (yCoordinates)

Y-coordinates of the screen item on the screen, from top to bottom. Default: 0.