13 Host card
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでホストカードウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。
これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。
ホストカードウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメータ
ホストカードウィジェットでは、以下のパラメータがサポートされています。
| パラメータ | type | name | value | |
|---|---|---|---|---|
| 更新間隔 | 0 | rf_rate | 0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| ホスト | 3 | hostid.0 | ホストのID。 パラメータの動作: - 必須（ホスト（ウィジェット/ダッシュボード）が設定されていない場合） このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| ホスト（ウィジェット/ダッシュボード） | 1 | hostid._reference | ホストのIDの代わりに：DASHBOARD.hostid - ダッシュボードのホストセレクタをホストのデータソースとして設定;ABCDE._hostid - 互換性のあるウィジェット（参照パラメータが"ABCDE"に設定されているもの）をホストのデータソースとして設定。パラメータの動作: - 必須（ホストが設定されていない場合） このパラメータは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
|
| 抑制された障害を表示 | 0 | show_suppressed | 0 - (デフォルト) 無効; 1 - 有効。 |
|
| 表示 | 0 | sections.0 | 0 - ホストグループ; 1 - 説明; 2 - 監視; 3 - 可用性; 4 - 監視サーバー; 5 - テンプレート; 6 - インベントリ; 7 - タグ。 注：プロパティ名の数字はセクションリスト内のセクション順序を参照します。複数のセクションを設定するには、各セクションごとにプロパティ名の数字を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
表示が「インベントリ」に設定されている場合、以下のパラメータがサポートされます。
| パラメータ | type | name | value |
|---|---|---|---|
| インベントリフィールド | 0 | inventory.0 | インベントリのID。 注：複数のインベントリフィールドを設定するには、各インベントリフィールドごとにプロパティ名の数字を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
例
次の例は、Host cardウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。
ダッシュボードの設定の詳細については、dashboard.createを参照してください。
Configuring a Host card widget
"監視"、"可用性"、"監視元"、"インベントリ"、"タグ"の各セクションを表示する ホストカード ウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "hostcard",
"name": "Host card",
"x": 0,
"y": 0,
"width": 14,
"height": 7,
"view_mode": 0,
"fields": [
{
"type": 3,
"name": "hostid.0",
"value": 10084
},
{
"type": 0,
"name": "show_suppressed",
"value": 1
},
{
"type": 0,
"name": "sections.0",
"value": 2
},
{
"type": 0,
"name": "sections.1",
"value": 3
},
{
"type": 0,
"name": "sections.2",
"value": 4
},
{
"type": 0,
"name": "sections.3",
"value": 6
},
{
"type": 0,
"name": "sections.4",
"value": 7
},
{
"type": 0,
"name": "inventory.0",
"value": 25
},
{
"type": 0,
"name": "inventory.1",
"value": 26
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}