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 テンプレートダッシュボードウィジェットオブジェクトの配列。

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

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

Property Type Description
widgetid ID ダッシュボードウィジェットのIDです。

Property behavior:
- read-only
type string ダッシュボードウィジェットの種類です。

Possible values:
actionlog - Action log;
clock - Clock;
discovery - Discovery status;
favgraphs - Favorite graphs;
favmaps - Favorite maps;
gauge - Gauge;
graph - Graph (classic);
graphprototype - Graph prototype;
honeycomb - Honeycomb;
hostavail - Host availability;
hostcard - Host card;
hostnavigator - Host navigator;
itemcard - Item card;
itemnavigator - Item navigator;
item - Item value;
map - Map;
navtree - Map Navigation Tree;
piechart - Pie chart;
plaintext - Plain text;
problemhosts - Problem hosts;
problems - Problems;
problemsbysv - Problems by severity;
slareport - SLA report;
svggraph - Graph;
systeminfo - System information;
tophosts - Top hosts;
topitems - Top items;
toptriggers - Top triggers;
trigover - Trigger overview;
url - URL;
web - Web monitoring.

Property behavior:
- required
name string カスタムウィジェット名です。
x integer ダッシュボード左端からの水平方向の位置です。

Possible values range from 0 to 71.
y integer ダッシュボード上端からの垂直方向の位置です。

Possible values range from 0 to 63.
width integer ウィジェットの幅です。

Possible values range from 1 to 72.
height integer ウィジェットの高さです。

Possible values range from 1 to 64.
view_mode integer ウィジェットの表示モードです。

Possible values:
0 - (default) default widget view;
1 - with hidden header;
fields array テンプレートダッシュボードウィジェットフィールドオブジェクトの配列です。
テンプレートダッシュボードウィジェットフィールド

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

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

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

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

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

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

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

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