This is a translation of the original English documentation page. Help us make it better.

26 Top hosts

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで上位ホストウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 上位ホストウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。

Parameters

The following parameters are supported for the Top Hosts widget.

Parameter type name value
Refresh interval 0 rf_rate 0 - No refresh;
10 - 10 seconds;
30 - 30 seconds;
60 - (default) 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - 15 minutes.
Host groups 2 groupids Host group ID.

Note: To configure multiple host groups, create a dashboard widget field object for each host group.
Hosts 3 hostids Host ID.

Note: To configure multiple hosts, create a dashboard widget field object for each host. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to.
Host Tags (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list)
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.
Tag name 1 tags.tag.0 Any string value.

Parameter Tag name required if configuring Tags.
Operator 0 tags.operator.0 0 - Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.

Parameter Operator required if configuring Tags.
Tag value 1 tags.value.0 Any string value.

Parameter Tag value required if configuring Tags.
Columns (see below)
Order 0 order 2 - (default) Top N;
3 - Bottom N.
Order column 0 column Column numeric value from the configured columns.
Host count 0 count Valid values range from 1-100.

Default: 10.

列には、データパラメーターの設定に応じて、共通パラメーターと追加パラメーターがあります。

列に関連するすべてのパラメーターにおいて、プロパティ名に含まれる番号(例: columns.0.name)は、パラメーターが設定されている列を参照します。

The following parameters are supported for all columns.

Parameter type name value
Name 1 columns.name.0 Any string value.
Data
(required)
0 columns.data.0 1 - Item value;
2 - Host name;
3 - Text.
Base color
(required)
1 columns.base_color.0 Hexadecimal color code (e.g. FF0000).
Item value

The following parameters are supported if Data is set to "Item value".

The first number in the Thresholds property name (e.g. columnsthresholds.color.0.0) references the column for which thresholds are configured, while the second number references threshold place in a list, sorted in ascending order. However, if thresholds are configured in a different order, the values will be sorted in ascending order after updating widget configuration in Zabbix frontend (e.g. "threshold.threshold.0":"5""threshold.threshold.0":"1"; "threshold.threshold.1":"1""threshold.threshold.1": "5").

Parameter type name value
Item 1 columns.item.0 Valid item name.
Time shift
(required)
1 columns.timeshift.0 Valid numeric or time string value (e.g. 3600 or 1h).
You may use time suffixes. Negative values are allowed.
Aggregation function 0 columns.aggregate_function.0 0 - (default) none;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Aggregation interval 1 columns.aggregate_interval.0 Valid time string (e.g. 3600, 1h, etc.).
You may use time suffixes.

Parameter Aggregation interval not available if Aggregation function is set to none.

Default: 1h.
Display 0 columns.display.0 1 - (default) As is;
2 - Bar;
3 - Indicators.
Min 1 columns.min.0 Any numeric value.

Parameter Min not available if Display is set to "As is".
Max 1 columns.max.0 Any numeric value.

Parameter Max not available if Display is set to "As is".
History data 0 columns.history.0 1 - (default) Auto;
2 - History;
3 - Trends.
Thresholds
Color 1 columnsthresholds.color.0.0 Hexadecimal color code (e.g. FF0000).

Default: "" (empty).
Threshold 1 columnsthresholds.threshold.0.0 Any string value.
Text

The following parameters are supported if Data is set to "Text".

Parameter type name value
Text 1 columns.text.0 Any string value, including macros.
Supported macros: {HOST.*}, {INVENTORY.*}.

Parameter Text required if Data is set to "Text".

次の例は、上位ホストウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

上位ホストウィジェットの設定

ホストグループ"4"でCPU使用率上位のホストを表示する上位ホストウィジェットを構成します。 さらに、次のカスタム列を構成します: "Host name", "CPU utilization in %", "1m avg", "5m avg", "15m avg", "Processes"。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "tophosts",
                               "name": "Top hosts",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 2,
                                       "name": "groupids.0",
                                       "value": 4
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.0.name",
                                       "value": "Host"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.0.data",
                                       "value": 2
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.0.base_color",
                                       "value": "FFFFFF"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.1.name",
                                       "value": "CPU utilization in %"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.1.data",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.1.base_color",
                                       "value": "4CAF50"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.1.item",
                                       "value": "CPU utilization"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.1.display",
                                       "value": 3
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.1.min",
                                       "value": "0"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.1.max",
                                       "value": "100"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.color.0",
                                       "value": "FFFF00"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.threshold.0",
                                       "value": "50"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.color.1",
                                       "value": "FF8000"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.threshold.1",
                                       "value": "80"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.color.2",
                                       "value": "FF4000"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columnsthresholds.1.threshold.2",
                                       "value": "90"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.2.name",
                                       "value": "1m avg"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.2.data",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.2.base_color",
                                       "value": "FFFFFF"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.2.item",
                                       "value": "Load average (1m avg)"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.3.name",
                                       "value": "5m avg"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.3.data",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.3.base_color",
                                       "value": "FFFFFF"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.3.item",
                                       "value": "Load average (5m avg)"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.4.name",
                                       "value": "15m avg"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.4.data",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.4.base_color",
                                       "value": "FFFFFF"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.4.item",
                                       "value": "Load average (15m avg)"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.5.name",
                                       "value": "Processes"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.5.data",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.5.base_color",
                                       "value": "FFFFFF"
                                   },
                                   {
                                       "type": 1,
                                       "name": "columns.5.item",
                                       "value": "Number of processes"
                                   },
                                   {
                                       "type": 0,
                                       "name": "columns.5.decimal_places",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "column",
                                       "value": 1
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

レスポンス:

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

参照