You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

25 System information

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the System Information widget in dashboard.create and dashboard.update methods.

Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the System information widget, please refer to the parameter behavior outlined in the tables below.

Parameters

The following parameters are supported for the System Information widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - (default) 15 minutes.
Show 0 info_type 0 - (default) System stats;
1 - High availability nodes.
Show software update check details 0 show_software_update_check_details 0 - (default) Disabled;
1 - Enabled.

Parameter behavior:
- supported if AllowSoftwareUpdateCheck in Zabbix server configuration is enabled and Show is set to "System stats"

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the System information widget. For more information on configuring a dashboard, see dashboard.create.

Configuring a System information widget

Configure a System information widget that displays system stats with a refresh interval of 10 minutes and software update check enabled.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "systeminfo",
                               "name": "System information",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 0,
                                       "name": "rf_rate",
                                       "value": 600
                                   },
                                   {
                                       "type": 0,
                                       "name": "show_software_update_check_details",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

See also