7 Dashboards

Overview

Dashboards are exported with all related objects and object relations.

Exporting

To export dashboards, do the following:

  1. Go to Dashboards > All dashboards.
  2. Mark the checkboxes of the dashboards to export.
  3. Click Export below the list.

Depending on the selected format, dashboards are exported to a local file with a default name:

  • zbx_export_dashboards.yaml - in YAML export (default option for export);
  • zbx_export_dashboards.xml - in XML export;
  • zbx_export_dashboards.json - in JSON export.

Importing

To import dashboards, do the following:

  1. Go to Dashboards > All dashboards.
  2. Click Import in the upper-right corner.
  3. Select the import file.
  4. Mark the required options in import rules.
  5. Click Import in the lower-right corner of the configuration form.

Import rules:

Rule Description
Update existing Existing elements will be updated using data from the import file. Otherwise, they will not be updated.
Create new New elements will be created using data from the import file. Otherwise, they will not be created.

On the next screen, you will be able to view the content of dashboards being imported. If this is a new dashboard, all elements will be listed in green. If updating an existing dashboard, new dashboard elements will be highlighted in green; removed dashboard elements will be highlighted in red; elements that have not changed will be listed on a gray background.

The menu on the left can be used to navigate through the list of changes. The Updated section highlights all changes made to existing dashboard elements. The Added section lists new dashboard elements. The elements in each section are grouped by element type; click the gray arrow to expand or collapse the group of elements.

Review dashboard changes and then click Import to perform the dashboard import. A success or failure message of the import will be displayed in the frontend.

Export format

Export to YAML:

zabbix_export:
  version: '8.0'
  dashboards:
    - name: 'Global view'
      pages:
        - widgets:
            - type: tophosts
              name: 'Top hosts by CPU utilization'
              width: '25'
              height: '4'
              fields:
                - type: INTEGER
                  name: column
                  value: '1'
                - type: INTEGER
                  name: columns.0.data
                  value: '2'
                - type: STRING
                  name: columns.0.item
                  value: 'System name'
                - type: STRING
                  name: columns.0.name
                  value: 'Host name'
                - type: STRING
                  name: columns.1.base_color
                  value: 4CAF50
                - type: INTEGER
                  name: columns.1.data
                  value: '1'
                - type: INTEGER
                  name: columns.1.display
                  value: '3'
                - type: STRING
                  name: columns.1.item
                  value: 'CPU utilization'
                - type: STRING
                  name: columns.1.max
                  value: '100'
                - type: STRING
                  name: columns.1.min
                  value: '0'
                - type: STRING
                  name: columns.1.name
                  value: Utilization
                - type: INTEGER
                  name: columns.2.data
                  value: '1'
                - type: STRING
                  name: columns.2.item
                  value: 'Load average (1m avg)'
                - type: STRING
                  name: columns.2.name
                  value: '1m avg'
                - type: INTEGER
                  name: columns.3.data
                  value: '1'
                - type: STRING
                  name: columns.3.item
                  value: 'Load average (5m avg)'
                - type: STRING
                  name: columns.3.name
                  value: '5m avg'
                - type: INTEGER
                  name: columns.4.data
                  value: '1'
                - type: STRING
                  name: columns.4.item
                  value: 'Load average (15m avg)'
                - type: STRING
                  name: columns.4.name
                  value: '15m avg'
                - type: INTEGER
                  name: columns.5.data
                  value: '1'
                - type: INTEGER
                  name: columns.5.decimal_places
                  value: '0'
                - type: STRING
                  name: columns.5.item
                  value: 'Number of processes'
                - type: STRING
                  name: columns.5.name
                  value: Processes
                - type: STRING
                  name: columnsthresholds.1.color.0
                  value: FFFF00
                - type: STRING
                  name: columnsthresholds.1.color.1
                  value: FF8000
                - type: STRING
                  name: columnsthresholds.1.color.2
                  value: FF4000
                - type: STRING
                  name: columnsthresholds.1.threshold.0
                  value: '50'
                - type: STRING
                  name: columnsthresholds.1.threshold.1
                  value: '80'
                - type: STRING
                  name: columnsthresholds.1.threshold.2
                  value: '90'
                - type: STRING
                  name: reference
                  value: NLVMO
            - type: hostavail
              'y': '4'
              width: '25'
              fields:
                - type: INTEGER
                  name: interface_type.0
                  value: '1'
            - type: problems
              name: 'Current problems'
              'y': '6'
              width: '48'
              height: '5'
              fields:
                - type: STRING
                  name: reference
                  value: BRUQE
                - type: INTEGER
                  name: show
                  value: '3'
                - type: INTEGER
                  name: show_tags
                  value: '3'
            - type: systeminfo
              x: '25'
              width: '23'
              height: '4'
            - type: problemsbysv
              name: 'Problems by severity'
              x: '25'
              'y': '4'
              width: '23'
              fields:
                - type: STRING
                  name: reference
                  value: LBSVB
                - type: INTEGER
                  name: show_type
                  value: '1'
            - type: gauge
              name: 'Zabbix server'
              x: '48'
              width: '12'
              height: '4'
              hide_header: 'YES'
              fields:
                - type: INTEGER
                  name: angle
                  value: '270'
                - type: INTEGER
                  name: desc_size
                  value: '8'
                - type: ITEM
                  name: itemid.0
                  value:
                    host: 'Zabbix server'
                    key: vm.memory.utilization
                - type: STRING
                  name: max
                  value: '100'
                - type: STRING
                  name: min
                  value: '0'
                - type: INTEGER
                  name: scale_size
                  value: '11'
                - type: INTEGER
                  name: show.0
                  value: '1'
                - type: INTEGER
                  name: show.1
                  value: '2'
                - type: INTEGER
                  name: show.2
                  value: '3'
                - type: INTEGER
                  name: show.3
                  value: '4'
                - type: INTEGER
                  name: show.4
                  value: '5'
                - type: STRING
                  name: thresholds.0.color
                  value: 42A5F5
                - type: STRING
                  name: thresholds.0.threshold
                  value: '0'
                - type: STRING
                  name: thresholds.1.color
                  value: 9CCC65
                - type: STRING
                  name: thresholds.1.threshold
                  value: '20'
                - type: STRING
                  name: thresholds.2.color
                  value: FFEE58
                - type: STRING
                  name: thresholds.2.threshold
                  value: '40'
                - type: STRING
                  name: thresholds.3.color
                  value: FFA726
                - type: STRING
                  name: thresholds.3.threshold
                  value: '60'
                - type: STRING
                  name: thresholds.4.color
                  value: FF7043
                - type: STRING
                  name: thresholds.4.threshold
                  value: '80'
                - type: INTEGER
                  name: th_arc_size
                  value: '9'
                - type: INTEGER
                  name: th_show_arc
                  value: '1'
                - type: INTEGER
                  name: th_show_labels
                  value: '1'
                - type: INTEGER
                  name: units_bold
                  value: '1'
                - type: INTEGER
                  name: units_size
                  value: '24'
                - type: INTEGER
                  name: value_arc_size
                  value: '30'
                - type: INTEGER
                  name: value_bold
                  value: '1'
                - type: INTEGER
                  name: value_size
                  value: '24'
            - type: svggraph
              x: '48'
              'y': '4'
              width: '24'
              height: '3'
              hide_header: 'YES'
              fields:
                - type: INTEGER
                  name: axisx
                  value: '0'
                - type: STRING
                  name: ds.0.color
                  value: AB47BC
                - type: INTEGER
                  name: ds.0.fill
                  value: '0'
                - type: STRING
                  name: ds.0.hosts.0
                  value: 'Zabbix server'
                - type: STRING
                  name: ds.0.items.0
                  value: 'Available memory'
                - type: INTEGER
                  name: ds.0.transparency
                  value: '2'
                - type: INTEGER
                  name: ds.0.type
                  value: '2'
                - type: INTEGER
                  name: ds.0.width
                  value: '2'
                - type: INTEGER
                  name: ds.1.axisy
                  value: '1'
                - type: STRING
                  name: ds.1.color
                  value: 42A5F5
                - type: INTEGER
                  name: ds.1.fill
                  value: '0'
                - type: STRING
                  name: ds.1.hosts.0
                  value: 'Zabbix server'
                - type: STRING
                  name: ds.1.items.0
                  value: 'CPU utilization'
                - type: INTEGER
                  name: ds.1.transparency
                  value: '0'
                - type: INTEGER
                  name: ds.1.type
                  value: '2'
                - type: INTEGER
                  name: ds.1.width
                  value: '2'
                - type: STRING
                  name: reference
                  value: TOYGS
            - type: geomap
              x: '48'
              'y': '7'
              width: '24'
              height: '4'
              hide_header: 'YES'
              fields:
                - type: STRING
                  name: default_view
                  value: '56.95225,24.11301,11'
                - type: HOST
                  name: hostids.0
                  value:
                    host: 'Zabbix server'
                - type: STRING
                  name: reference
                  value: TDYJO
            - type: clock
              name: 'Local time'
              x: '60'
              width: '12'
              hide_header: 'YES'
              fields:
                - type: INTEGER
                  name: clock_type
                  value: '1'
                - type: INTEGER
                  name: show.0
                  value: '1'
                - type: INTEGER
                  name: show.1
                  value: '2'
                - type: INTEGER
                  name: show.2
                  value: '3'
                - type: INTEGER
                  name: time_sec
                  value: '0'
                - type: INTEGER
                  name: tzone_format
                  value: '1'
            - type: item
              name: 'Server performance'
              x: '60'
              'y': '2'
              width: '12'
              hide_header: 'YES'
              fields:
                - type: INTEGER
                  name: aggregate_function
                  value: '2'
                - type: INTEGER
                  name: decimal_size
                  value: '32'
                - type: STRING
                  name: description
                  value: 'Values per second'
                - type: INTEGER
                  name: desc_h_pos
                  value: '0'
                - type: INTEGER
                  name: desc_v_pos
                  value: '0'
                - type: ITEM
                  name: itemid.0
                  value:
                    host: 'Zabbix server'
                    key: 'zabbix[wcache,values]'
                - type: INTEGER
                  name: show.0
                  value: '1'
                - type: INTEGER
                  name: show.1
                  value: '2'
                - type: INTEGER
                  name: show.2
                  value: '5'
                - type: INTEGER
                  name: sparkline.fill
                  value: '2'
                - type: INTEGER
                  name: sparkline.width
                  value: '2'
                - type: STRING
                  name: thresholds.0.color
                  value: DCEDC8
                - type: STRING
                  name: thresholds.0.threshold
                  value: '20'
                - type: STRING
                  name: thresholds.1.color
                  value: FFF9C4
                - type: STRING
                  name: thresholds.1.threshold
                  value: '40'
                - type: STRING
                  name: thresholds.2.color
                  value: FFCCBC
                - type: STRING
                  name: thresholds.2.threshold
                  value: '60'
                - type: INTEGER
                  name: units_bold
                  value: '0'
                - type: INTEGER
                  name: units_show
                  value: '0'
                - type: INTEGER
                  name: value_h_pos
                  value: '0'
                - type: INTEGER
                  name: value_size
                  value: '32'

Exported elements

Exported elements are explained in the table below.

Element < < < < Type Description
name < < < < string (required) Dashboard name.
pages < < < < Root element for dashboard pages
< widgets < < < Root element for dashboard pages

See also: Dashboard object (refer to the relevant property with a matching name).

Dashboard widget

Element Type Description
type string (required) Type of the dashboard widget.

Possible values:
actionlog - Action log;
clock - Clock;
discovery - Discovery status;
favgraphs - Favorite graphs;
favmaps - Favorite maps;
gauge - Gauge;
geomap - Geomap;
graph - Graph (classic);
graphprototype - Graph prototype;
honeycomb - Honeycomb;
hostavail - Host availability;
hostcard - Host card;
hostnavigator - Host navigator;
itemcard - Item card;
itemhistory - Item history;
itemnavigator - Item navigator;
item - Item value;
map - Map;
navtree - Map Navigation Tree;
piechart - Pie chart;
problemhosts - Problem hosts;
problems - Problems;
problemsbysv - Problems by severity;
scatterplot - Scatter plot;
slareport - SLA report;
svggraph - Graph;
systeminfo - System information;
tophosts - Top hosts;
topitems - Top items;
toptriggers - Top triggers;
trigover - Trigger overview;
url - URL;
web - Web monitoring.
x integer A horizontal position from the left side of the dashboard.
Possible values:1 0-71.
y integer A vertical position from the top of the dashboard.
Possible values:1 0-63.
name string Custom widget name.
width integer The widget width.
Possible values:1 1-72.
height integer The widget height.
Possible values:1 1-64.
hide_header string Hide widget header.
Possible values:1 NO (0, default), YES (1).
fields Root element for the dashboard widget fields.

See also: Dashboard widget (refer to the relevant property with a matching name).

Dashboard widget field

Element Type Description
type string (required) Widget field type.
Possible values:1 INTEGER (0), STRING (1), HOST_GROUP (2), HOST (3), ITEM (4), ITEM_PROTOTYPE (5), GRAPH (6), GRAPH_PROTOTYPE (7), MAP (8), SERVICE (9), SLA (10), USER (11), ACTION (12), MEDIA_TYPE (13).
name string (required) Widget field name.
value mixed (required) Widget field value, depending on the field type.
host string Item host.
key string Item key.

See also: Dashboard widget field (refer to the relevant property with a matching name).

Footnotes

1 API integer values in brackets, for example, ENABLED (0), are mentioned only for reference. For more information, see the linked API object page in the table entry or at the end of each section.