целое число/массив hostgroup.get(объект параметры)
Этот метод позволяет получать группы узлов сети в соответствии с заданными параметрами.
(объект)
Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
Параметр | Тип | Описание |
---|---|---|
graphids | строка/массив | Возврат только тех групп узлов сети, которые содержат узлы сети или шаблоны с заданными графиками. |
groupids | строка/массив | Возврат групп узлов сети только с заданными ID групп узлов сети. |
hostids | строка/массив | Возврат только тех групп узлов сети, которые содержат заданные узлы сети. |
maintenanceids | строка/массив | Возврат только тех групп узлов сети, которые задействованы в заданных обслуживаниях. |
monitored_hosts | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети под наблюдением. |
real_hosts | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети. |
templated_hosts | флаг | Возврат только тех групп узлов сети, которые содержат шаблоны. |
templateids | строка/массив | Возврат только тех групп узлов сети, которые содержат заданные шаблоны. |
triggerids | строка/массив | Возврат только тех групп узлов сети, которые узлы сети или шаблоны с заданными триггерами. |
with_applications | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с группами элементов данных. |
with_graphs | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с графиками. |
with_hosts_and_templates | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети или шаблоны. |
with_httptests | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с веб проверками. Переопределяет параметр with_monitored_httptests . |
with_items | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети или шаблоны с элементами данных. Переопределяет параметры with_monitored_items и with_simple_graph_items . |
with_monitored_httptests | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с активированными веб проверками. |
with_monitored_items | флаг | Возврат только тех групп узлов сети, которые узлы сети или шаблоны с активированными элементами данных. Переопределяет параметр with_simple_graph_items . |
with_monitored_triggers | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с активированными триггерами. Все элементы данных, используемые в триггере, также должны быть активированы. |
with_simple_graph_items | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с элементами данных числового типа. |
with_triggers | флаг | Возврат только тех групп узлов сети, которые содержат узлы сети с триггерами. Переопределяет параметр with_monitored_triggers . |
selectDiscoveryRule | запрос | Возврат LLD правила, которое создало группу узлов сети, в свойстве discoveryRule . |
selectGroupDiscovery | запрос | Возврат объекта обнаружения группы узлов сети в свойстве groupDiscovery . Объект обнаружения групп узлов сети связывает обнаруженную группу узов сети с прототипом групп узлов сети и имеет следующие свойства: groupid - (строка) ID обнаруженной группы узлов сети; lastcheck - (штамп времени) время, когда группа узлов сети была в последний раз обнаружена; name - (строка) имя прототипа групп узлов сети; parent_group_prototypeid - (строка) ID прототипа групп узлов сети с которого была создана группа узлов сети; ts_delete - (штамп времени) время, когда более необнаруживаемая группа узлов сети будет удалена.. |
selectHosts | запрос | Возврат узлов сети, которые принадлежат группе узлов сети, в свойстве hosts . Поддерживается count . |
selectTemplates | запрос | Возврат шаблонов, которые принадлежат группе узлов сети, в свойстве templates . Поддерживается count . |
limitSelects | целое число | Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: selectHosts - все результаты сортируются по host ; selectTemplates - все результаты сортируются по host . |
sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: groupid , name . |
countOutput | флаг | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
editable | логический | |
excludeSearch | флаг | |
filter | объект | |
limit | целое число | |
output | запрос | |
preservekeys | флаг | |
search | объект | |
searchByAny | логический | |
searchWildcardsEnabled | логический | |
sortorder | строка/массив | |
startSearch | флаг |
(целое число/массив)
Возвращает либо:
countOutput
.Получение всех данных по двум группам узлов сети с именами “Zabbix servers” и “Linux servers”.
Запрос:
{ "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() в frontends/php/include/classes/api/services/CHostGroup.php.