このページで
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 | 任意の文字列値。 注: プロパティ名の番号は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - ホストタグを設定する場合は必須 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| 演算子 | 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 | state | -1 - (デフォルト) すべて; 0 - 正常; 1 - サポートされていない。 |
|
| 障害を表示 | 0 | show_problems | 0 - すべて; 1 - (デフォルト) 抑制されていない障害; 2 - なし。 |
|
| グループ化 | ||||
| 属性 | 0 | group_by.0.attribute | 0 - ホストグループ; 1 - ホスト名; 2 - ホストタグの値; 3 - アイテムタグの値。 注: プロパティ名の番号は、グループ化属性リスト内の属性の順序を示します。 パラメータの動作: - グループ化を設定する場合は必須 |
|
| 値 | 1 | group_by.0.tag_name | 任意の文字列値。 注: プロパティ名の番号は、属性パラメータで設定されたグループ化属性を示します。 パラメータの動作: - グループ化を設定し、属性を「ホストタグの値」または「アイテムタグの値」に設定する場合は必須 |
|
| アイテムの上限 | 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
}