このページで
14 Host navigator
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、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つずつ増やします。 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストグループ（ウィジェット） | 1 | groupids._reference | ホストグループ IDの代わりに指定します:ABCDE._hostgroupids - Referenceパラメータに"ABCDE"を設定した互換性のあるウィジェットを、ホストグループのデータソースとして設定します。テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストパターン | 1 | hosts.0 | ホスト名またはパターン。 注: 複数のホストパターンを設定するには、各ホストパターンに対してダッシュボードウィジェットフィールドオブジェクトを作成し、プロパティ名の番号を1つずつ増やします。複数のホストパターンを使用する場合、ホストグループパラメータは未設定にするか、設定したホストパターンに一致するホストが所属するホストグループを少なくとも1つ設定する必要があります。 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| ホストのステータス | 0 | status | -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 - 災害。 デフォルト: 空（すべて有効）。 注: 複数の値を設定するには、各値に対してダッシュボードウィジェットフィールドオブジェクトを作成し、プロパティ名の番号を1つずつ増やします。 |
|
| メンテナンス中のホストを表示 | 0 | maintenance | 0 - (デフォルト) 無効; 1 - 有効。 |
|
| 障害を表示 | 0 | show_problems | 0 - すべて; 1 - (デフォルト) 抑制されていない障害; 2 - なし。 |
|
| グループ化基準 | ||||
| 属性 | 0 | group_by.0.attribute | 0 - ホストグループ; 1 - タグの値; 2 - 深刻度。 注: プロパティ名の番号は、グループ化属性リスト内の属性の順序を示します。 パラメータの動作: - グループ化基準を設定する場合は必須 |
|
| 値 | 1 | group_by.0.tag_name | 任意の文字列値。 注: プロパティ名の番号は、属性パラメータで設定されたグループ化属性を示します。 パラメータの動作: - グループ化基準を設定し、属性を「タグの値」に設定する場合は必須 |
|
| ホスト数の上限 | 0 | show_lines | 1～9999の範囲で指定できます。 デフォルト: 100。 テンプレートダッシュボードでウィジェットを設定する場合、このパラメータはサポートされません。 |
|
| Reference | 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
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}