Documentation
Table of Contents
14 Host 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 に設定) を設定します。このパラメータは、テンプレート ダッシュボード でウィジェットを構成する場合、サポートされません。 |
|
| ホスト パターン | 1 | hosts.0 | ホスト の名前またはパターン 注: 複数のホスト パターンを構成するには、プロパティ名に増分番号を含む、ホスト パターンごとにダッシュボード ウィジェット フィールド オブジェクトを作成します。複数のホストパターンの場合、パラメータ ホストグループ はまったく設定しないか、設定されたホストパターンに一致するホストが属するホストグループを少なくとも 1 つ設定する必要があります。 このパラメータは、テンプレート ダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| ホスト ステータス | 0 | ステータス | -1 - (デフォルト) 任意; 0 - 有効; 1 - 無効 このパラメータは、テンプレート ダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| ホスト タグ | ||||
| 評価タイプ | 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 | 任意の文字列値 注: プロパティ名の数字は、タグ評価リスト内のタグの順序を示します。 パラメータの動作: - ホストタグ を構成する場合は 必須 このパラメータは、テンプレートダッシュボード でウィジェットを構成する場合はサポートされません。 |
|
| 重大度 | 0 | severities.0 | 0 - 分類なし 1 - 情報 2 - 警告 3 - 平均 4 - 高 5 - 災害 デフォルト: 空 (すべて有効) 注: 複数の値を構成するには、プロパティ名に増分番号を付けた各値のダッシュボードウィジェットフィールドオブジェクトを作成します。 |
|
| メンテナンス中のホストを表示 | 0 | maintenance | 0 - (デフォルト) 無効; 1 - 有効 |
|
| 問題を表示 | 0 | show_problems | 0 - すべて; 1 - (デフォルト) 抑制なし; 2 - なし |
|
| グループ化 | ||||
| 属性 | 0 | group_by.0.attribute | 0 - ホストグループ; 1 - タグ値; 2 - 重大度 注: プロパティ名の数字は、グループ化属性リスト内の属性の順序を示します。 パラメータの動作: - グループ化 を構成する場合は 必須 |
|
| 値 | 1 | group_by.0.tag_name | 任意の文字列値 注: プロパティ名に含まれる数字は、Attribute パラメータで設定されたグループ化属性を参照します。 パラメータの動作: - Group by を設定し、Attribute が"タグ値"に設定されている場合は 必須 |
|
| ホスト制限 | 0 | show_lines | 有効な値の範囲は 1～9999 です。 デフォルト: 100 このパラメータは、テンプレートダッシュボード でウィジェットを設定する場合はサポートされません。 |
|
| 参照 | 1 | reference | 5 文字の任意の文字列値 (例: ABCDE または JBPNL)この値は、ウィジェットが属するダッシュボード内で一意である必要があります。パラメータの動作: - 必須 |
|
例
次の例は、ホストナビゲーターウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
ホストナビゲーターウィジェットの設定
ホストグループ別にグループ化されたホストと、"city"タグの値別にグループ化されたホストを表示するホストナビゲーターウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": "30",
"auto_start": "1",
"pages": [
{
"widgets": [
{
"type": "hostnavigator",
"name": "Host navigator",
"x": "0",
"y": "0",
"width": "12",
"height": "5",
"view_mode": "0",
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 2
},
{
"type": 2,
"name": "groupids.1",
"value": 4
},
{
"type": 0,
"name": "group_by.0.attribute",
"value": 0
},
{
"type": 0,
"name": "group_by.1.attribute",
"value": 1
},
{
"type": 1,
"name": "group_by.1.tag_name",
"value": "city"
},
{
"type": 1,
"name": "reference",
"value": "SWKLB"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: