Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

hostgroup.get

説明

integer/array hostgroup.get(object parameters)

このメソッドは、与えられたパラメータに従って、host group を取得することができます。

このメソッドは、どのタイプのユーザーでも利用可能です。このメソッドを呼び出す許可は、ユーザーのロール設定で
取り消すことができます。詳しくはUser rolesをご覧ください。

パラメータ

(object) 目的の出力を定義するパラメーター。

このメソッドは、次のパラメーターをサポートしています。

パラメータ タイプ 説明
graphids string/array 指定されたグラフを持つホストまたはテンプレートを含むホスト グループのみを返します。
groupids string/array 指定されたホスト グループ ID を持つホスト グループのみを返します。
hostids string/array 指定されたホストを含むホスト グループのみを返します。
maintenanceids string/array 指定されたメンテナンスの影響を受けるホスト グループのみを返します。
monitored_hosts flag 監視対象ホストを含むホスト グループのみを返します。
real_hosts flag ホストを含むホスト グループのみを返します。
templated_hosts flag テンプレートを含むホスト グループのみを返します。
templateids string/array 指定されたテンプレートを含むホスト グループのみを返します。
triggerids string/array 指定されたトリガーを持つホストまたはテンプレートを含むホスト グループのみを返します。
with_graphs flag グラフのあるホストを含むホスト グループのみを返します。
with_graph_prototypes flag グラフ プロトタイプを持つホストを含むホスト グループのみを返します。
with_hosts_and_templates flag ホスト または テンプレートを含むホスト グループのみを返します。
with_httptests flag Web チェックのあるホストを含むホスト グループのみを返します。

with_monitored_httptests パラメータをオーバーライドします。
with_items flag アイテムを含むホストまたはテンプレートを含むホスト グループのみを返します。

with_monitored_items および with_simple_graph_items パラメータをオーバーライドします。
with_item_prototypes flag アイテム プロトタイプを持つホストを含むホスト グループのみを返します。

with_simple_graph_item_prototypes パラメータをオーバーライドします。
with_simple_graph_item_prototypes flag アイテム プロトタイプを持つホストを含むホスト グループのみを返します。これは、作成が有効で、数値型の情報を持ちます。
with_monitored_httptests flag Web チェックが有効になっているホストを含むホスト グループのみを返します。
with_monitored_items flag アイテムが有効になっているホストまたはテンプレートを含むホスト グループのみを返します。

with_simple_graph_items パラメータをオーバーライドします。
with_monitored_triggers flag トリガーが有効になっているホストを含むホスト グループのみを返します。 トリガーで使用されるすべての項目も有効にする必要があります。
with_simple_graph_items flag 数値項目を持つホストを含むホスト グループのみを返します。
with_triggers flag トリガーを持つホストを含むホスト グループのみを返します。

with_monitored_triggers パラメータをオーバーライドします。
selectDiscoveryRule query ホスト グループを作成した LLD ルールを含む discoveryRule プロパティを返します。
selectGroupDiscovery query ホストグループディスカバリオブジェクトを含むgroupDiscoveryプロパティを返します。

ホストグループディスカバリオブジェクトは、検出されたホスト グループをホスト グループ プロトタイプにリンクし、次のプロパティを持ちます。
groupid - (string) 検出されたホストグループの ID。
lastcheck - (timestamp) ホスト グループが最後に検出された時刻。
name - (string) ホスト グループ プロトタイプの名前。
parent_group_prototypeid - (string) ホスト グループが作成されたホスト グループ プロトタイプの ID。
ts_delete - (timestamp) 検出されなくなったホスト グループが削除される時刻。
selectHosts query ホスト グループに属するホストを含む hosts プロパティを返します。

count をサポートします。
selectTemplates query ホスト グループに属するテンプレートを含む templates プロパティを返します。

count をサポートします。
limitSelects integer 副選択によって返されるレコードの数を制限します。

次のサブセレクトに適用されます。
selectHosts - 結果は host でソートされます。
selectTemplates - 結果は host でソートされます。
sortfield string/array 指定されたプロパティで結果を並べ替えます。

使用可能な値は次のとおりです: groupidname
countOutput boolean すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) のどちらかを返します:

  • オブジェクトの配列
  • もし countOutput パラメータが使用されている場合は、取得したオブジェクトの数

名前によるデータの取得

"Zabbix servers"と"Linux servers"という名前の 2 つのホスト グループに関するすべてのデータを取得します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Zabbix servers",
                       "Linux servers"
                   ]
               }
           },
           "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0",
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

参照

ソース

CHostGroup::get() in ui/include/classes/api/services/CHostGroup.php.