hostgroup.getobjects

Description

array hostgroup.getobjects(object filter)

This method allows to retrieve host groups that match the given filter criteria.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter	Type	Description
groupid	string/array	Host group IDs.
name	string/array	Names of the host groups.
node	string	Name of the node the host groups must belong to. This will override the `nodeids` parameter.
nodeids	string/array	IDs of the nodes the host groups must belong to.

Return values

(array) Returns an array of objects with all properties.

Examples

Retrieve a host group by name

Retrieve a host group called "Zabbix servers."

Request:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.getobjects",
           "params": {
               "name": "Linux servers"
           },
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

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

Source

CHostGroup::getObject() in frontends/php/api/classes/CHostGroup.php.

Documentation