28 トップホスト

説明

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

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

パラメータ

Top hosts ウィジェットでサポートされているパラメータは以下の通りです。

パラメータ type name value
更新間隔 0 rf_rate 0 - 更新なし;
10 - 10秒;
30 - 30秒;
60 - (デフォルト) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
ホストグループ 2 groupids.0 ホストグループ ID。

注: 複数のホストグループを設定するには、各ホストグループごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホストグループ (ウィジェット) 1 groupids._reference ホストグループ IDの代わりに:
ABCDE._hostgroupids - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をホストグループのデータソースとして設定します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト 3 hostids.0 ホスト ID。

注: 複数のホストを設定するには、各ホストごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成します。複数のホストを指定する場合、ホストグループパラメータは未設定、または指定したホストが属するホストグループが少なくとも1つ設定されている必要があります。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト (ウィジェット/ダッシュボード) 1 hostids._reference ホスト IDの代わりに:
DASHBOARD.hostids - ダッシュボードのホストセレクタをホストのデータソースとして設定します;
ABCDE._hostids - 互換性のあるウィジェット（Referenceパラメータを"ABCDE"に設定）をホストのデータソースとして設定します。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホストタグ
評価タイプ 0 evaltype 0 - (デフォルト) And/Or;
2 - Or。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
タグ名 1 tags.0.tag 任意の文字列値。

注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。

パラメータの動作:
- 必須 ホストタグを設定する場合

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
演算子 0 tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。

パラメータの動作:
- 必須 ホストタグを設定する場合

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
タグ値 1 tags.0.value 任意の文字列値。

注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。

パラメータの動作:
- 必須 ホストタグを設定する場合

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
メンテナンス中のホストを表示 0 maintenance 0 - (デフォルト) 無効;
1 - 有効。
カラム (下記参照)
並び順 0 column 設定されたカラムの数値。
順序 0 order 2 - (デフォルト) Top N;
3 - Bottom N。
ホスト数上限 0 show_lines 1-1000の範囲で指定可能。

デフォルト: 10。

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。

列

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

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

以下のパラメーターはすべての列でサポートされています。

パラメーター type name value
Name 1 columns.0.name 任意の文字列値

パラメーターの動作:
- 必須
Data 0 columns.0.data 1 - 項目値
2 - ホスト名
3 - テキスト

パラメーターの動作:
- 必須
基本色 1 columns.0.base_color 16進数カラーコード（例：FF0000）

パラメータの動作:
- 必須
アイテム値

Dataが「アイテム値」に設定されている場合、以下のパラメータがサポートされます。

Thresholdsプロパティ名の最初の数字(例: columnsthresholds.0.color.0)は、しきい値が設定されている列を参照し、2番目の数字は昇順で並べ替えられたリスト内のしきい値の位置を参照します。 ただし、しきい値が異なる順序で設定されている場合、Zabbix Webインターフェースでウィジェットの設定を更新した後、値は昇順に並べ替えられます(例: "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").

パラメータ type name value
アイテム 1 columns.0.item 有効なアイテム名。

テンプレートダッシュボードでウィジェットを設定する場合、テンプレートで設定されたアイテムのみを設定する必要があります。
アイテム値の表示形式 0 columns.0.display_value_as 0 - (デフォルト) 数値;
1 - テキスト;
2 - バイナリ。
表示 0 columns.0.display 1 - (デフォルト) そのまま;
2 - バー;
3 - インジケーター;
6 - スパークライン。

パラメータの動作:
- アイテム値の表示形式が「数値」の場合にサポート
最小値 1 columns.0.min 任意の数値。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「バー」または「インジケーター」の場合にサポート
最大値 1 columns.0.max 任意の数値。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「バー」または「インジケーター」の場合にサポート
小数点以下の桁数 0 columns.0.decimal_places 0-10の範囲で指定可能。

デフォルト: 2。

パラメータの動作:
- アイテム値の表示形式が「数値」の場合にサポート
スパークライン
幅 0 columns.0.sparkline.width 0-10の範囲で指定可能。

デフォルト: 1。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
塗りつぶし 0 columns.0.sparkline.fill 0-10の範囲で指定可能。

デフォルト: 3。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
色 1 columns.0.sparkline.color 16進数のカラーコード(例: FF0000)。

デフォルト: 42A5F5。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
期間 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;
ABCDE._timeperiod - 互換性のあるウィジェット(referenceパラメータがABCDEのもの)をデータソースとして設定。

デフォルト: DASHBOARD._timeperiod

または、FromおよびToパラメータで期間のみを設定することもできます。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
From 1 columns.0.sparkline.time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時刻構文(now, now/d, now/w-1wなど)の有効な時刻文字列。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
- columns.0.sparkline.time_period.toが設定されている場合は必須
To 1 columns.0.sparkline.time_period.to 絶対(YYYY-MM-DD hh:mm:ss)または相対時刻構文(now, now/d, now/w-1wなど)の有効な時刻文字列。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
- columns.0.sparkline.time_period.fromが設定されている場合は必須
履歴データ 0 columns.0.sparkline.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- アイテム値の表示形式が「数値」かつ表示が「スパークライン」の場合にサポート
しきい値
色 1 columnsthresholds.0.color.0 16進数のカラーコード(例: FF0000)。

パラメータの動作:
- アイテム値の表示形式が「数値」の場合にサポート
しきい値 1 columnsthresholds.0.threshold.0 任意の文字列。

パラメータの動作:
- アイテム値の表示形式が「数値」の場合にサポート
ハイライト
色 1 columns.0.highlights.0.color 16進数のカラーコード(例: FF0000)。

パラメータの動作:
- アイテム値の表示形式が「テキスト」の場合にサポート
パターン 1 columns.0.highlights.0.pattern 任意の文字列。

パラメータの動作:
- アイテム値の表示形式が「テキスト」の場合にサポート
サムネイルの表示 0 columns.0.show_thumbnail 0 - (デフォルト) 無効;
1 - 有効。

パラメータの動作:
- アイテム値の表示形式が「バイナリ」の場合にサポート
集計関数 0 columns.0.aggregate_function 0 - (デフォルト) 使用しない;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last。
期間 1 columns.0.time_period._reference DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;
ABCDE._timeperiod - 互換性のあるウィジェット(referenceパラメータがABCDEのもの)をデータソースとして設定。

デフォルト: DASHBOARD._timeperiod

または、FromおよびToパラメータで期間のみを設定することもできます。

パラメータの動作:
- 集計関数が「min」「max」「avg」「count」「sum」「first」「last」の場合にサポート
From 1 columns.0.time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時刻構文(now, now/d, now/w-1wなど)の有効な時刻文字列。

パラメータの動作:
- 期間が設定されておらず、集計関数が「min」「max」「avg」「count」「sum」「first」「last」の場合にサポート
- columns.0.time_period.toが設定されている場合は必須
To 1 columns.0.time_period.to 絶対(YYYY-MM-DD hh:mm:ss)または相対時刻構文(now, now/d, now/w-1wなど)の有効な時刻文字列。

パラメータの動作:
- 期間が設定されておらず、集計関数が「min」「max」「avg」「count」「sum」「first」「last」の場合にサポート
- columns.0.time_period.fromが設定されている場合は必須
履歴データ 0 columns.0.history 0 - (デフォルト) 自動;
1 - 履歴;
2 - トレンド。

パラメータの動作:
- アイテム値の表示形式が「数値」の場合にサポート
参照 1 reference 5文字からなる任意の文字列(例: ABCDEまたはJBPNL)。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。

パラメータの動作:
- 必須
Text

データが"テキスト"に設定されている場合、以下のパラメーターがサポートされます。

パラメーター type name value
テキスト 1 columns.0.text マクロを含む任意の文字列値
サポートされているマクロ: {HOST.*}、{INVENTORY.*}

パラメーターの動作:
- データがテキスト"に設定されている場合、必須

例

次の例は、上位ホストウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、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
}

参照