Zabbix Documentation 1.8

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

api:screen

Screen

Methods

Class containing methods for operations with Screens.

MethodsDescription
get() Get screen details
exists() Check if screen exists
create() Create screens
update() Update screen details
delete() Delete screens

Object details

The table contains complete list of Screen attributes.

screen

ParameterTypeDescriptionDetails
screenidintegerScreen ID
nameinteger Name
hsizeinteger Horizontal size
vsizeinteger Vertical size

screenitem

ParameterTypeDescriptionDetails
screenidinteger
resourcetypeinteger Screen item type
xinteger X position
yinteger Y position
resourceidinteger Depends on screen item type
widthinteger Width
heightinteger Height
colspaninteger Column span
rowspaninteger Row span
elementsinteger Number of displayed lines
valigninteger Vertical align
haligninteger Horizontal align
styleinteger Depends on screen item type
urlinteger Opens URL on click
dynamicinteger Dynamic screen items

Common tasks

The table contains list of common screen-related tasks and possible implementation using Zabbix API

TaskHOWTO
Add a screen Use method screen.create
Add a bunch of new screens Use method screen.create with array of Screen objects
Remove screen by Screen IDs Use method screen.delete array of Screen IDs
Retrieve screen details by Screen IDs Use method screen.get with parameter screenids
Retrieve screen details by Screen name Use method screen.get with parameter filter, specify “name”:“<your screen>“