hostgroup.get

説明

integer/array hostgroup.get(object parameters)

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

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

パラメータ

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

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

Parameter Type Description
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 - (default) ホストグループは検出されている,
1 - ホストグループはすでに検出されていない。
selectHostPrototypes query このホストグループを検出したホストプロトタイプを含む hostPrototypes プロパティを返します。
selectHosts query ホストグループに属するホストを含む hosts プロパティを返します。

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

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

指定可能な値: groupid, name。
countOutput boolean これらのパラメータは reference commentary で説明されています。
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.