Template dashboardオブジェクト

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

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

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

Property Type Description
dashboardid ID テンプレートダッシュボードのID。

Property behavior:
- read-only
- 更新操作で required
name string テンプレートダッシュボードの名前。

Property behavior:
- 作成操作で required
templateid ID このダッシュボードが属するテンプレートのID。

Property behavior:
- constant
- 作成操作で required
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 - 深刻度別の障害;
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 説明
type integer ウィジェットフィールドのタイプ。

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

Property behavior:
- required
name string ウィジェットフィールド名。

使用可能な値: Dashboard widget fields を参照してください。なお、一部のホスト関連パラメータ（例: Problems ウィジェットの Host groups、Exclude host groups、Hosts、Host availability ウィジェットの Host groups など）は、テンプレートダッシュボード上でウィジェットを設定する際には使用できません。これは、テンプレートダッシュボードが、テンプレートがリンクされているホストのデータのみを表示するためです。

Property behavior:
- required
value mixed タイプに応じたウィジェットフィールドの値。

使用可能な値: Dashboard widget fields を参照してください。なお、一部のホスト関連パラメータ（例: Problems ウィジェットの Host groups、Exclude host groups、Hosts、Host availability ウィジェットの Host groups など）は、テンプレートダッシュボード上でウィジェットを設定する際には使用できません。これは、テンプレートダッシュボードが、テンプレートがリンクされているホストのデータのみを表示するためです。

Property behavior:
- required