hostgroup.get

説明

integer/array hostgroup.get(object parameters)

このメソッドは、指定されたパラメータに従ってホストグループを取得することができます。

このメソッドは、すべてのタイプのユーザーが利用できます。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細はユーザーロールを参照してください。

パラメーター

(object) 望ましい出力を定義するパラメーター。

このメソッドは以下のパラメーターをサポートします。

パラメーター 型 説明
graphids ID/array 指定したグラフを持つホストを含むホストグループのみを返します。
groupids ID/array 指定したホストグループIDのホストグループのみを返します。
hostids ID/array 指定したホストを含むホストグループのみを返します。
maintenanceids ID/array 指定したメンテナンスの影響を受けるホストグループのみを返します。
triggerids ID/array 指定したトリガーを持つホストを含むホストグループのみを返します。
with_graphs boolean グラフを持つホストを含むホストグループのみを返します。
with_graph_prototypes boolean グラフのプロトタイプを持つホストを含むホストグループのみを返します。
with_hosts boolean ホストを含むホストグループのみを返します。
with_httptests boolean Web監視を持つホストを含むホストグループのみを返します。

with_monitored_httptestsパラメーターを上書きします。
with_items boolean アイテムを持つホストを含むホストグループのみを返します。

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

with_simple_graph_item_prototypesパラメーターを上書きします。
with_simple_graph_item_prototypes boolean 作成が有効で数値型の情報を持つアイテムのプロトタイプを持つホストを含むホストグループのみを返します。
with_monitored_httptests boolean 有効なWeb監視を持つホストを含むホストグループのみを返します。
with_monitored_hosts boolean 監視対象のホストを含むホストグループのみを返します。
with_monitored_items boolean 有効なアイテムを持つホストを含むホストグループのみを返します。

with_simple_graph_itemsパラメーターを上書きします。
with_monitored_triggers boolean 有効なトリガーを持つホストを含むホストグループのみを返します。トリガーで使用されているすべてのアイテムも有効である必要があります。
with_simple_graph_items boolean 数値アイテムを持つホストを含むホストグループのみを返します。
with_triggers boolean トリガーを持つホストを含むホストグループのみを返します。

with_monitored_triggersパラメーターを上書きします。
selectDiscoveryRules query ホストグループを検出したLLDルールを持つdiscoveryRulesプロパティを返します。
selectDiscoveryData query ホストグループディスカバリオブジェクトを持つdiscoveryDataプロパティを返します。

各ホストグループディスカバリオブジェクトは、検出されたホストグループにリンクされたホストグループプロトタイプであり、以下のプロパティを持ちます:
parent_group_prototypeid - (ID) ホストグループが検出されたホストグループプロトタイプのID;
name - (string) ホストグループプロトタイプの名前;
ts_delete - (timestamp) もはや検出されなくなったホストグループが削除される時刻;
status - (int) ホストグループディスカバリのステータス:
0 - (デフォルト) ホストグループが検出されている,
1 - ホストグループがもはや検出されていない。
selectHostPrototypes query このホストグループを検出したホストプロトタイプを持つhostPrototypesプロパティを返します。
selectHosts query ホストグループに属するホストを持つhostsプロパティを返します。

countをサポートします。
limitSelects integer サブセレクトで返されるレコード数を制限します。

以下のサブセレクトに適用されます:
selectHosts - 結果はhostでソートされます。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: groupid, name.
countOutput boolean これらのパラメーターはリファレンス解説で説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroupDiscoveries query ホストグループディスカバリオブジェクトを持つgroupDiscoveriesプロパティを返します。

各ホストグループディスカバリオブジェクトは、検出されたホストグループにリンクされたホストグループプロトタイプです。

このクエリは非推奨です。代わりにselectDiscoveryDataを使用してください。

戻り値

(integer/array) 次のいずれかを返します。

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

例

名前によるデータの取得

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

リクエスト:

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

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

関連項目

ソース

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