11 Honeycomb

説明

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

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

パラメータ

以下のパラメータは Honeycomb ウィジェットでサポートされています。

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。

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

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

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

Note: 複数のホストを設定するには、プロパティ名の番号を増やしながら、各ホストごとに 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_host 0 - (default) And/Or;
2 - Or.

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

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

Parameter behavior:
- Host tags を設定する場合は required

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

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

Parameter behavior:
- Host tags を設定する場合は required

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

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

Parameter behavior:
- Host tags を設定する場合は required

このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
Item patterns 1 items.0 アイテムの名前またはパターン。

Note: 複数の item pattern を設定するには、プロパティ名の番号を増やしながら、各 item pattern ごとに dashboard widget field オブジェクトを作成します。

Parameter behavior:
- required
Item tags
Evaluation type 0 evaltype_item 0 - (default) And/Or;
2 - Or.
Tag name 1 item_tags.0.tag 任意の文字列値。

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

Parameter behavior:
- Item tags を設定する場合は required
Operator 0 item_tags.0.operator 0 - 含む;
1 - 等しい;
2 - 含まない;
3 - 等しくない;
4 - 存在する;
5 - 存在しない。

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

Parameter behavior:
- Item tags を設定する場合は required
Tag value 1 item_tags.0.value 任意の文字列値。

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

Parameter behavior:
- Item tags を設定する場合は required
Show hosts in maintenance 0 maintenance 0 - (default) 無効;
1 - 有効。
Show 0 show.0 1 - 主ラベル;
2 - 副ラベル。

Note: 複数の値を設定するには、プロパティ名の番号を増やしながら、各値ごとに dashboard widget field オブジェクトを作成します。

Default: 1, 2.
Reference 1 reference 5文字からなる任意の文字列値（例: ABCDE または JBPNL）。この値は、ウィジェットが属するダッシュボード内で一意である必要があります。

Parameter behavior:
- required

詳細設定

Honeycomb ウィジェットでは、以下の詳細設定パラメータがサポートされています。

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

Parameter type name value
Primary label
Type 0 primary_label_type 0 - (default) Text;
1 - Value.
Text 1 primary_label マクロを含む任意の文字列値。
サポートされるマクロ: {HOST.*}, {ITEM.*}, {INVENTORY.*}, ユーザーマクロ。

Default: {HOST.NAME}

Parameter behavior:
- supported if Type is set to "Text"
Decimal places 0 primary_label_decimal_places 0-6 の範囲の値を指定できます。

Default: 2.

Parameter behavior:
- supported if Type is set to "Value"
Size (type) 0 primary_label_size_type 0 - (default) Auto;
1 - Custom.
Size 0 primary_label_size 1-100 の範囲の値を指定できます。

Default: 20.

Parameter behavior:
- supported if Size (type) is set to "Custom"
Bold 0 primary_label_bold 0 - (default) Disabled;
1 - Enabled.
Color 1 primary_label_color 16進数のカラーコード（例: FF0000）。

Default: Settings object および User object の theme に基づく:
1F2C33 for "blue-theme" or "hc-light";
EEEEEE for "dark-theme" or "hc-dark".
Units (checkbox) 0 primary_label_units_show 0 - Disabled;
1 - (default) Enabled.

Parameter behavior:
- supported if Type is set to "Value"
Units (value) 1 primary_label_units 任意の文字列値。

"" (empty)

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"
Position 0 primary_label_units_pos 0 - Before value;
1 - (default) After value.

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"

This parameter is ignored if set to one of the following time-related units: unixtime, uptime, s.
Secondary label
Type 0 secondary_label_type 0 - Text;
1 - (default) Value.
Text 1 secondary_label マクロを含む任意の文字列値。
サポートされるマクロ: {HOST.*}, {ITEM.*}, {INVENTORY.*}, ユーザーマクロ。

Default: {{ITEM.LASTVALUE}.fmtnum(2)}

Parameter behavior:
- supported if Type is set to "Text"
Decimal places 0 secondary_label_decimal_places 0-6 の範囲の値を指定できます。

Default: 2.

Parameter behavior:
- supported if Type is set to "Value"
Size (type) 0 secondary_label_size_type 0 - (default) Auto;
1 - Custom.
Size 0 secondary_label_size 1-100 の範囲の値を指定できます。

Default: 30.

Parameter behavior:
- supported if Size (type) is set to "Custom"
Bold 0 secondary_label_bold 0 - Disabled;
1 - (default) Enabled.
Color 1 secondary_label_color 16進数のカラーコード（例: FF0000）。

Default: Settings object および User object の theme に基づく:
1F2C33 for "blue-theme" or "hc-light";
EEEEEE for "dark-theme" or "hc-dark".
Units (checkbox) 0 secondary_label_units_show 0 - Disabled;
1 - (default) Enabled.

Parameter behavior:
- supported if Type is set to "Value"
Units (value) 1 secondary_label_units 任意の文字列値。

"" (empty)

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"
Position 0 secondary_label_position 0 - Before value;
1 - (default) After value.

Parameter behavior:
- supported if Type is set to "Value" and Units (checkbox) is set to "Enabled"

This parameter is ignored if set to one of the following time-related units: unixtime, uptime, s.
Background color
Background color 1 bg_color 16進数のカラーコード（例: FF0000）。

Default: Settings object および User object の theme に基づく:
D9E7ED for "blue-theme";
3D5059 for "dark-theme";
AAD7E9 for "hc-light";
335463 for "hc-dark".
Thresholds
Color interpolation 0 interpolation 0 - Disabled;
1 - (default) Enabled.
Color 1 thresholds.0.color 16進数のカラーコード（例: FF0000）。
Threshold 1 thresholds.0.threshold 任意の数値。サフィックス（Suffixes）（例: "1d", "2w", "4K", "8G"）がサポートされています。

例

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

ハニカムウィジェットの設定

Zabbixサーバープロセスの使用率を表示するハニカムウィジェットを設定します。 さらに、ハニカムセルのプライマリラベルを変更し、しきい値を設定してウィジェットを視覚的に微調整します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": "30",
        "auto_start": "1",
        "pages": [
            {
                "widgets": [
                    {
                        "type": "honeycomb",
                        "name": "Honeycomb",
                        "x": "0",
                        "y": "0",
                        "width": "24",
                        "height": "5",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "items.0",
                                "value": "Zabbix server: Utilization*"
                            },
                            {
                                "type": 1,
                                "name": "primary_label",
                                "value": "{ITEM.NAME}"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "0"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "70"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "90"
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "KSTMQ"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照