Documentation
Table of Contents
16 Item navigator
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでアイテムナビゲーターウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 アイテムナビゲーターウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
Parameters
アイテム ナビゲーター ウィジェットでは次のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - 1分; 120 - 2分; 600 - 10分; 900 - (デフォルト) 15分 |
|
| ホスト グループ | 2 | groupids.0 | ホスト グループ ID 注: 複数のホスト グループを構成するには、プロパティ名に増分番号を含む各ホスト グループのダッシュボード ウィジェット フィールド オブジェクトを作成します。 このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
| ホスト グループ (ウィジェット) | 1 | groupids._reference | ホスト グループ ID:ABCDE._hostgroupids の代わりに、ホスト グループのデータ ソースとして 互換性のあるウィジェット (その Reference パラメーターを "ABCDE に設定) を設定します。このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
| ホスト | 3 | hostids.0 | ホスト ID 注: 複数のホストを設定するには、プロパティ名に増分番号を含むダッシュボードウィジェットフィールドオブジェクトを各ホストに作成します。複数のホストの場合、パラメータ ホストグループ はまったく設定しないか、設定されたホストが属する少なくとも1つのホストグループを設定する必要があります。 このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| ホスト (ウィジェット/ダッシュボード) | 1 | hostids._reference | ホスト ID の代わりに:DASHBOARD.hostid - ホスト セレクター をホストのデータ ソースとして設定します。ABCDE._hostid - 互換性のあるウィジェット (その Reference パラメーターを "ABCDE に設定) をホストのデータ ソースとして設定します。このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
| ホストタグ | ||||
| 評価タイプ | 0 | host_tags_evaltype | 0 - (デフォルト) And/Or; 2 - Or このパラメーターは、テンプレート ダッシュボード でウィジェットを構成する場合にはサポートされません。 |
|
| 評価タイプ | 0 | host_tags_evaltype | 0 - (デフォルト) And/Or; 2 - Or この |
|
| 演算子 | 0 | host_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の数字は、タグ評価リストのタグ順序を参照します。 パラメーターの動作: - ホストタグ を構成する場合は 必須 テンプレートダッシュボード でウィジェットを構成する場合、このパラメーターはサポートされません。 |
|
| タグ値 | 1 | host_tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグ順序を参照します。 パラメーターの動作: - ホストタグ を構成する場合は 必須 テンプレートダッシュボード でウィジェットを構成する場合、このパラメーターはサポートされません。 |
|
| アイテム パターン | 1 | items.0 | アイテム の名前またはパターン 注: 複数のアイテム パターンを構成するには、プロパティ名に増分番号を含む各アイテム パターンのダッシュボード ウィジェット フィールド オブジェクトを作成します。 |
|
| アイテムタグ | ||||
| 評価タイプ | 0 | item_tags_evaltype | 0 - (デフォルト) And/Or; 2 - Or |
|
| タグ名 | 1 | item_tags.0.tag | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| 演算子 | 0 | item_tags.0.operator | 0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| タグ値 | 1 | item_tags.0.value | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を参照します。 パラメーターの動作: - アイテム タグ を構成する場合は 必須 |
|
| 状態 | 0 | 状態 | -1 - (デフォルト) すべて; 0 - 正常; 1 - サポートされていません。 |
|
| 問題を表示 | 0 | show_problems | 0 - すべて; 1 - (デフォルト) 抑制されない; 2 - なし |
|
| グループ化 | ||||
| 属性 | 0 | group_by.0.attribute | 0 - ホスト グループ 1 - ホスト名 2 - ホスト タグ値 3 - 項目タグ値 注: プロパティ名の数字は、グループ化属性リスト内の属性の順序を示します。 パラメーターの動作: - Group by を構成する場合は 必須 |
|
| 値 | 1 | group_by.0.tag_name | 任意の文字列値 注: プロパティ名の数字は、Attribute パラメータで設定されたグループ化属性を参照します。 パラメータの動作: - Group by を構成し、Attribute が"ホスト タグ値"または"アイテム タグ値"に設定されている場合は 必須 |
|
| アイテム制限 | 0 | show_lines | 可能な値の範囲は 1 ～ 9999 です。 デフォルト: 100 |
|
| 参照 | 1 | 参照 | 5文字からなる任意の文字列値（例：ABCDE または JBPNL）この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
|
例
次の例は、アイテムナビゲーターウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
アイテムナビゲーターウィジェットの設定
最大1000個のアイテムをホスト別、さらに"コンポーネント"アイテムタグ値別にグループ化して表示するアイテムナビゲーターウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "itemnavigator",
"name": "Item navigator",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 0,
"name": "group_by.0.attribute",
"value": 0
},
{
"type": 0,
"name": "group_by.1.attribute",
"value": 3
},
{
"type": 1,
"name": "group_by.1.tag_name",
"value": "component"
},
{
"type": 0,
"name": "show_lines",
"value": 1000
},
{
"type": 1,
"name": "reference",
"value": "DFNLK"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: