hostgroup_get
Retrieves Zabbix host groups with filters for IDs, names, and pagination. Supports grouping hosts to apply templates, permissions, and maintenance windows collectively.
Instructions
Get host groups from Zabbix.
Retrieves host groups with optional filtering. Host groups are used to organize and manage hosts collectively, applying templates, permissions, and maintenance windows to multiple hosts at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. Default is 100. | |
| offset | No | Number of matching records to skip. Use with 'limit' to page through results; check 'has_more' and 'total' in the response. | |
| output | No | Output format. | extend |
| search | No | Search. | |
| hostids | No | Host IDs. | |
| groupids | No | Group IDs. | |
| sortfield | No | Field to sort by. A deterministic sort is required for paging to be consistent. | groupid |
| sortorder | No | Sort direction - 'ASC' or 'DESC'. | ASC |
| count_output | No | If true, returns only the count of matched objects as an integer. | |
| select_hosts | No | If true, include the hosts in each group in the response (selectHosts=extend). | |
| group_name_contains | No | Shortcut to search for groups by name (constructs search={'name': group_name_contains}). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||