17 アイテムナビゲーター

説明

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

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

パラメーター

アイテムナビゲーターウィジェットでサポートされているパラメーターは以下の通りです。

パラメーター		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。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
	タグ名	1	host_tags.0.tag	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Host tagsを設定する場合) このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
	演算子	0	host_tags.0.operator	0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Host tagsを設定する場合) このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
	タグ値	1	host_tags.0.value	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Host tagsを設定する場合) このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
アイテムパターン		1	items.0	アイテム名またはパターン。注: 複数のアイテムパターンを設定するには、プロパティ名の番号を増やして各アイテムパターンごとにダッシュボードウィジェットフィールドオブジェクトを作成します。
アイテムタグ
	評価タイプ	0	item_tags_evaltype	0 - (デフォルト) And/Or; 2 - Or。
	タグ名	1	item_tags.0.tag	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Item tagsを設定する場合)
	演算子	0	item_tags.0.operator	0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Item tagsを設定する場合)
	タグ値	1	item_tags.0.value	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須 (Item tagsを設定する場合)
状態		0	state	-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	任意の文字列値。注: プロパティ名の番号は属性パラメーターで設定したグループ化属性を参照します。パラメーターの動作: - 必須 (Group byを設定し、属性が「ホストタグ値」または「アイテムタグ値」に設定されている場合)
アイテム数上限		0	show_lines	1-9999の範囲で指定可能。デフォルト: 100。
Reference		1	reference	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
       }

レスポンス:

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

Documentation

17 アイテムナビゲーター

説明

パラメーター

例

アイテムナビゲーターウィジェットの設定

参照