hostgroup.get

Beschrijving

integer/array hostgroup.get(objectparameters)

De methode maakt het mogelijk om hostgroepen op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste output definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Omschrijving
graphids	string/array	Geef alleen hostgroepen terug die hosts of sjablonen bevatten met de opgegeven grafieken.
groupids	string/array	Geef alleen hostgroepen terug met de opgegeven hostgroep-IDs.
hostids	string/array	Geef alleen hostgroepen terug die de opgegeven hosts bevatten.
maintenanceids	string/array	Geef alleen hostgroepen terug die worden beïnvloed door de opgegeven onderhoudsperioden.
monitored_hosts	flag	Geef alleen hostgroepen terug die bewaakte hosts bevatten.
real_hosts	flag	Geef alleen hostgroepen terug die hosts bevatten.
templated_hosts	flag	Geef alleen hostgroepen terug die sjablonen bevatten.
templateids	string/array	Geef alleen hostgroepen terug die de opgegeven sjablonen bevatten.
triggerids	string/array	Geef alleen hostgroepen terug die hosts of sjablonen bevatten met de opgegeven triggers.
with_graphs	flag	Geef alleen hostgroepen terug die hosts bevatten met grafieken.
with_graph_prototypes	flag	Geef alleen hostgroepen terug die hosts bevatten met grafiek-prototypen.
with_hosts_and_templates	flag	Geef alleen hostgroepen terug die hosts of sjablonen bevatten.
with_httptests	flag	Geef alleen hostgroepen terug die hosts bevatten met webchecks. Overschrijft de parameter `with_monitored_httptests`.
with_items	flag	Geef alleen hostgroepen terug die hosts of sjablonen bevatten met items. Overschrijft de parameters `with_monitored_items` en `with_simple_graph_items`.
with_item_prototypes	flag	Geef alleen hostgroepen terug die hosts bevatten met item-prototypen. Overschrijft de parameter `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Geef alleen hostgroepen terug die hosts bevatten met item-prototypen die zijn ingeschakeld voor creatie en numerieke informatie bevatten.
with_monitored_httptests	flag	Geef alleen hostgroepen terug die hosts bevatten met ingeschakelde webchecks.
with_monitored_items	flag	Geef alleen hostgroepen terug die hosts of sjablonen bevatten met ingeschakelde items. Overschrijft de parameter `with_simple_graph_items`.
with_monitored_triggers	flag	Geef alleen hostgroepen terug die hosts bevatten met ingeschakelde triggers. Alle items die in de trigger worden gebruikt, moeten ook zijn ingeschakeld.
with_simple_graph_items	flag	Geef alleen hostgroepen terug die hosts bevatten met numerieke items.
with_triggers	flag	Geef alleen hostgroepen terug die hosts bevatten met triggers. Overschrijft de parameter `with_monitored_triggers`.
selectDiscoveryRule	query	Geef een eigenschap discoveryRule terug met de LLD-regel die de hostgroep heeft aangemaakt.
selectGroupDiscovery	query	Geef een eigenschap `groupDiscovery` terug met het object voor de ontdekking van de hostgroep. Het object voor de ontdekking van de hostgroep koppelt een ontdekte hostgroep aan een hostgroep-prototype en heeft de volgende eigenschappen: `groupid` - `(string)` ID van de ontdekte hostgroep; `lastcheck` - `(timestamp)` tijdstip waarop de hostgroep voor het laatst is ontdekt; `name` - `(string)` naam van het hostgroep-prototype; `parent_group_prototypeid` - `(string)` ID van het hostgroep-prototype waaruit de hostgroep is gemaakt; `ts_delete` - `(timestamp)` tijdstip waarop een hostgroep die niet langer wordt ontdekt, wordt verwijderd.
selectHosts	query	Geef een eigenschap hosts terug met de hosts die bij de hostgroep horen. Ondersteunt `count`.
selectTemplates	query	Geef een eigenschap templates terug met de sjablonen die bij de hostgroep horen. Ondersteunt `count`.
limitSelects	integer	Beperk het aantal records dat wordt teruggegeven door subselecties. Van toepassing op de volgende subselecties: `selectHosts` - resultaten worden gesorteerd op `host`; `selectTemplates` - resultaten worden gesorteerd op `host`.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden zijn: `groupid`, `name`.
countOutput	boolean	Deze parameters die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven op de pagina met verwijzingen.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Gegevens op naam ophalen

Haal alle gegevens op over twee hostgroepen met de naam "Zabbix-servers" en "Linux-servers".

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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

Documentation