You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

Template dashboardオブジェクト

次のオブジェクトは、templatedashboardAPIに直接関連しています。

テンプレートダッシュボード

テンプレートダッシュボードオブジェクトには以下のプロパティがあります。

プロパティ 説明
dashboardid ID テンプレートダッシュボードのID。

プロパティの動作:
- 読み取り専用
- 更新操作時に必須
name string テンプレートダッシュボードの名前。

プロパティの動作:
- 作成操作時に必須
templateid ID ダッシュボードが属するテンプレートのID。

プロパティの動作:
- 定数
- 作成操作時に必須
display_period integer デフォルトのページ表示期間(秒単位)。

指定可能な値: 10, 30, 60, 120, 600, 1800, 3600。

デフォルト: 30。
auto_start integer スライドショーの自動開始。

指定可能な値:
0 - スライドショーを自動開始しない;
1 - (デフォルト) スライドショーを自動開始する。
uuid string インポートされたテンプレートダッシュボードを既存のものにリンクするために使用されるユニバーサル一意識別子。指定されていない場合は自動生成されます。

テンプレートダッシュボードページ

テンプレートダッシュボードページオブジェクトには以下のプロパティがあります。

プロパティ タイプ 説明
dashboard_pageid ID ダッシュボードページのID。

プロパティの動作:
- 読み取り専用
name string ダッシュボードページ名。

デフォルト: 空文字列
display_period integer ダッシュボードページの表示期間(秒単位)。

可能な値: 0, 10, 30, 60, 120, 600, 1800, 3600

デフォルト: 0(デフォルトのページ表示期間を使用)
widgets array テンプレートダッシュボードウィジェットオブジェクトの配列。

テンプレートダッシュボードウィジェット

テンプレートダッシュボードウィジェットオブジェクトには、以下のプロパティがあります。

プロパティ タイプ 説明
widgetid ID ダッシュボードウィジェットのID。

プロパティの動作:
- 読み取り専用
type string ダッシュボードウィジェットのタイプ。

指定可能な値:
actionlog - アクションログ;
clock - 時計;
discovery - ディスカバリーステータス;
favgraphs - お気に入りグラフ;
favmaps - お気に入りマップ;
gauge - ゲージ;
graph - グラフ(クラシック);
graphprototype - グラフプロトタイプ;
honeycomb - ハニカム;
hostavail - ホスト可用性;
hostcard - ホストカード;
hostnavigator - ホストナビゲーター;
itemcard - アイテムカード;
itemnavigator - アイテムナビゲーター;
item - アイテム値;
map - マップ;
navtree - マップナビゲーションツリー;
piechart - 円グラフ;
plaintext - プレーンテキスト;
problemhosts - 問題のあるホスト;
problems - 問題;
problemsbysv - 深刻度別の問題;
scatterplot - 散布図;
slareport - SLAレポート;
svggraph - グラフ;
systeminfo - システム情報;
tophosts - トップホスト;
topitems - トップアイテム;
toptriggers - トップトリガー;
trigover - トリガー概要;
url - URL;
web - Web監視。

プロパティの動作:
- 必須
name string カスタムウィジェット名。
x integer ダッシュボードの左端からの水平位置。

指定可能な値は0から71まで。
y integer ダッシュボードの上端からの垂直位置。

指定可能な値は0から63まで。
width integer ウィジェットの幅。

指定可能な値は1から72まで。
height integer ウィジェットの高さ。

指定可能な値は1から64まで。
view_mode integer ウィジェットの表示モード。

指定可能な値:
0 - (デフォルト) デフォルトのウィジェット表示;
1 - ヘッダーを非表示にする;
fields array テンプレートダッシュボードウィジェットフィールドオブジェクトの配列。
テンプレートダッシュボードウィジェットフィールド

テンプレートダッシュボードウィジェットフィールドオブジェクトには、以下のプロパティがあります。

プロパティ タイプ 説明
type integer ウィジェットフィールドのタイプ。

指定可能な値:
0 - 整数;
1 - 文字列;
4 - アイテム;
5 - アイテムプロトタイプ;
6 - グラフ;
7 - グラフプロトタイプ;
8 - マップ;
9 - サービス;
10 - SLA;
11 - ユーザー;
12 - アクション;
13 - メディアタイプ。

プロパティの動作:
- 必須
name string ウィジェットフィールド名。

指定可能な値: ダッシュボードウィジェットフィールドを参照してください。なお、一部のホスト関連パラメータ(例: 障害ウィジェットのホストグループ除外ホストグループホストホスト可用性ウィジェットのホストグループなど)は、テンプレートダッシュボードでウィジェットを設定する際には利用できません。これは、テンプレートダッシュボードがテンプレートがリンクされているホストからのみデータを表示するためです。

プロパティの動作:
- 必須
value mixed タイプに応じたウィジェットフィールドの値。

指定可能な値: ダッシュボードウィジェットフィールドを参照してください。なお、一部のホスト関連パラメータ(例: 障害ウィジェットのホストグループ除外ホストグループホストホスト可用性ウィジェットのホストグループなど)は、テンプレートダッシュボードでウィジェットを設定する際には利用できません。これは、テンプレートダッシュボードがテンプレートがリンクされているホストからのみデータを表示するためです。

プロパティの動作:
- 必須