27 上位ホスト

説明

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

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

パラメータ

Top hosts ウィジェットでサポートされるパラメータは次のとおりです。

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
Host groups 2 groupids.0 ホストグループ ID。

注: 複数のホストグループを設定するには、プロパティ名の番号を増やしながら、各ホストグループごとに dashboard widget field オブジェクトを作成してください。

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

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

注: 複数のホストを設定するには、プロパティ名の番号を増やしながら、各ホストごとに dashboard widget field オブジェクトを作成してください。複数のホストを設定する場合、パラメータ Host groups は未設定であるか、設定するホストが属するホストグループを少なくとも 1 つ含むように設定されている必要があります。

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

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Host tags
Evaluation type 0 evaltype 0 - (default) And/Or;
2 - Or.

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

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

パラメータの動作:
- Host tags を設定する場合は required

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

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

パラメータの動作:
- Host tags を設定する場合は required

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

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

パラメータの動作:
- Host tags を設定する場合は required

このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。
Show hosts in maintenance 0 maintenance 0 - (default) 無効;
1 - 有効。
Columns (see below)
Order by 0 column 設定された列の数値。
Order 0 order 2 - (default) 上位 N;
3 - 下位 N。
Host limit 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 が "Item value" に設定されている場合、以下のパラメータがサポートされます。

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

Parameter type name value
Item 1 columns.0.item 有効なアイテム名。

ウィジェットを テンプレートダッシュボード で設定する場合は、テンプレートで設定されているアイテムのみを設定してください。
Display item value as 0 columns.0.display_value_as 0 - (default) 数値;
1 - テキスト;
2 - バイナリ。
Display 0 columns.0.display 1 - (default) そのまま;
2 - バー;
3 - インジケーター;
6 - スパークライン。

Parameter behavior:
- supported if Display item value as is set to "Numeric"
Min 1 columns.0.min 任意の数値。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Bar" or "Indicators"
Max 1 columns.0.max 任意の数値。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Bar" or "Indicators"
Decimal places 0 columns.0.decimal_places 0-10 の範囲の値。

Default: 2.

Parameter behavior:
- supported if Display item value as is set to "Numeric"
Sparkline
Width 0 columns.0.sparkline.width 0-10 の範囲の値。

Default: 1.

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
Fill 0 columns.0.sparkline.fill 0-10 の範囲の値。

Default: 3.

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
Color 1 columns.0.sparkline.color 16進カラーコード(例: FF0000)。

Default: 42A5F5.

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
Time period 1 columns.0.sparkline.time_period._reference DASHBOARD._timeperiod - Time period セレクター をデータソースとして設定します。
ABCDE._timeperiod - reference パラメータが ABCDE に等しい 互換性のあるウィジェット をデータソースとして設定します。

Default: DASHBOARD._timeperiod

また、時間期間は FromTo パラメータのみで設定することもできます。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
From 1 columns.0.sparkline.time_period.from 絶対時刻(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(nownow/dnow/w-1w など)で指定された有効な時刻文字列。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
- required if columns.0.sparkline.time_period.to is set
To 1 columns.0.sparkline.time_period.to 絶対時刻(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(nownow/dnow/w-1w など)で指定された有効な時刻文字列。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
- required if columns.0.sparkline.time_period.from is set
History data 0 columns.0.sparkline.history 0 - (default) 自動;
1 - 履歴データ;
2 - トレンド。

Parameter behavior:
- supported if Display item value as is set to "Numeric" and Display is set to "Sparkline"
Thresholds
Color 1 columnsthresholds.0.color.0 16進カラーコード(例: FF0000)。

Parameter behavior:
- supported if Display item value as is set to "Numeric"
Threshold 1 columnsthresholds.0.threshold.0 任意の文字列値。

Parameter behavior:
- supported if Display item value as is set to "Numeric"
Highlights
Color 1 columns.0.highlights.0.color 16進カラーコード(例: FF0000)。

Parameter behavior:
- supported if Display item value as is set to "Text"
Pattern 1 columns.0.highlights.0.pattern 任意の文字列値。

Parameter behavior:
- supported if Display item value as is set to "Text"
Show thumbnail 0 columns.0.show_thumbnail 0 - (default) 無効;
1 - 有効。

Parameter behavior:
- supported if Display item value as is set to "Binary"
Aggregation function 0 columns.0.aggregate_function 0 - (default) 使用しない;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - last.
Time period 1 columns.0.time_period._reference DASHBOARD._timeperiod - Time period セレクター をデータソースとして設定します。
ABCDE._timeperiod - reference パラメータが ABCDE に等しい 互換性のあるウィジェット をデータソースとして設定します。

Default: DASHBOARD._timeperiod

また、時間期間は FromTo パラメータのみで設定することもできます。

Parameter behavior:
- supported if Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last"
From 1 columns.0.time_period.from 絶対時刻(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(nownow/dnow/w-1w など)で指定された有効な時刻文字列。

Parameter behavior:
- supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last"
- required if columns.0.time_period.to is set
- required if columns.0.time_period.to is set
To 1 columns.0.time_period.to 絶対時刻(YYYY-MM-DD hh:mm:ss)または 相対 時刻構文(nownow/dnow/w-1w など)で指定された有効な時刻文字列。

Parameter behavior:
- supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last"
- required if columns.0.time_period.from is set
History data 0 columns.0.history 0 - (default) 自動;
1 - 履歴データ;
2 - トレンド。

Parameter behavior:
- supported if Display item value as is set to "Numeric"
Reference 1 reference 5文字からなる任意の文字列値(例: ABCDE または JBPNL)。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。

Parameter behavior:
- required
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
}

参照