Documentation
Table of Contents
26 Top hosts
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドで上位ホストウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 上位ホストウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
上位ホストウィジェットでは、以下のパラメーターがサポートされています。
| パラメーター | 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 つのホスト グループで構成されている必要があります。 このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| ホスト タグ | ||||
| 評価タイプ | 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 | メンテナンス | 0 - (デフォルト) 無効。 1 - 有効 |
|
| 列 (下記参照) | ||||
| 並べ替え | 0 | 列 | 構成された列の数値 | |
| 順序 | 0 | 列 | 構成された列の数値 | |
| 順序 | 0 | 順序 | 2 - (デフォルト) 上位 N 件 3 - 下位 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）パラメータの動作: - 必須 |
アイテム値
データが"アイテム値"に設定されている場合、次のパラメータがサポートされます。
Thresholds プロパティ名の最初の数字 (例: columnsthresholds.0.color.0) はしきい値が設定されている列を参照し、2 番目の数字は昇順に並べられたリスト内のしきい値の場所を参照します。 ただし、しきい値が異なる順序で設定されている場合、Zabbixフロントエンドでウィジェット設定を更新した後、値は昇順で並べ替えられます。 例: "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| パラメーター | type | 名前 | 値 | |
|---|---|---|---|---|
| 項目 | 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 パラメーターの動作: - *項目の値の表示形式** が "数値" に設定されている場合にサポートされます。 |
|
| スパークライン | ||||
| Width | 0 | columns.0.sparkline.width | 有効な値の範囲は 0 ～ 10 です。 デフォルト: 1 パラメーターの動作: - 項目の値の表示方法 が"数値"に設定され、表示 が"スパークライン"に設定されている場合にサポートされます。 |
|
| Fill | 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 など) の有効な時刻文字列パラメーターの動作: - *項目値の表示形式** が "数値" に設定され、表示 が "スパークライン" に設定されている場合にサポートされます。 |
|
| To | 1 | columns.0.sparkline.time_period.to | 絶対時刻 (YYYY-MM-DD hh:mm:ss) または 相対時刻 構文 (now、now/d、now/w-1w など) の有効な時刻文字列パラメーターの動作: - *アイテム値の表示形式** が "数値" に設定され、表示 が "スパークライン" に設定されている場合にサポートされます。 |
|
| 履歴データ | 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 - 最小; 2 - 最大; 3 - 平均; 4 - カウント; 5 - 合計; 6 - 最初; 7 - 最後 |
|
| 期間 | 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" に設定されている場合にサポートされます。 |
|
| 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" に設定されている場合にサポートされます。 |
|
| 履歴データ | 0 | columns.0.history | 0 - (デフォルト) 自動; 1 - 履歴; 2 - 傾向 パラメーターの動作: - 項目の値の表示形式 が "数値" に設定されている場合にサポートされます。 |
|
| 参照 | 1 | 参照 | 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
}レスポンス: