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 uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
graphids	string/array	Retourneer alleen hostgroepen die hosts of sjablonen bevatten met de gegeven grafieken.
groupids	string/array	Retourneer alleen hostgroepen met de opgegeven hostgroep-ID's.
hostids	string/array	Retourneer alleen hostgroepen die de opgegeven hosts bevatten.
maintenanceids	string/array	Retourneer alleen hostgroepen die worden beïnvloed door het gegeven onderhoud.
monitored_hosts	flag	Retourneer alleen hostgroepen die gecontroleerde hosts bevatten.
real_hosts	flag	Retourneer alleen hostgroepen die hosts bevatten.
template_hosts	flag	Retourneer alleen hostgroepen die sjablonen bevatten.
templateids	string/array	Retourneer alleen hostgroepen die de opgegeven sjablonen bevatten.
triggerids	string/array	Retourneer alleen hostgroepen die hosts of sjablonen met de gegeven triggers bevatten.
with_graphs	flag	Retourneer alleen hostgroepen die hosts met grafieken bevatten.
with_graph_prototypes	flag	Retourneer alleen hostgroepen die hosts met grafiekprototypes bevatten.
with_hosts_and_templates	flag	Retourneer alleen hostgroepen die hosts of-sjablonen bevatten.
with_httptests	flag	Retourneert alleen hostgroepen die hosts bevatten met webcontroles. Overschrijft de parameter `with_monitored_httptests`.
with_items	flag	Retourneert alleen hostgroepen die hosts of sjablonen met items bevatten. Overschrijft de parameters `with_monitored_items` en `with_simple_graph_items`.
with_item_prototypes	flag	Retourneert alleen hostgroepen die hosts met itemprototypes bevatten. Overschrijft de parameter `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Retourneer alleen hostgroepen die hosts bevatten met itemprototypes, die kunnen worden gemaakt en numerieke informatie hebben.
with_monitored_httptests	flag	Retourneer alleen hostgroepen die hosts bevatten met ingeschakelde webcontroles.
with_monitored_items	flag	Retourneert alleen hostgroepen die hosts of sjablonen met ingeschakelde items bevatten. Overschrijft de parameter `with_simple_graph_items`.
with_monitored_triggers	flag	Retourneer alleen hostgroepen die hosts bevatten met ingeschakelde triggers. Alle items die in de trigger worden gebruikt, moeten ook zijn ingeschakeld.
with_simple_graph_items	flag	Retourneer alleen hostgroepen die hosts met numerieke items bevatten.
with_triggers	flag	Retourneert alleen hostgroepen die hosts met triggers bevatten. Overschrijft de parameter `with_monitored_triggers`.
selectDiscoveryRule	query	Retourneer een eigenschap discoveryRule met de LLD-regel die de hostgroep heeft gemaakt.
selectGroupDiscovery	query	Retourneer een eigenschap `groupDiscovery` met het hostgroepdetectieobject. Het hostgroepdetectieobject koppelt een gedetecteerde hostgroep aan een hostgroepprototype en heeft de volgende eigenschappen: `groupid` - `(string)` ID van de ontdekte hostgroep; `lastcheck` - `(timestamp)` tijd waarop de hostgroep voor het laatst is ontdekt; `name` - `(string)` naam van de hostgroep-prototype; `parent_group_prototypeid` - `(string)` ID van het hostgroep-prototype waaruit de hostgroep is gemaakt; `ts_delete` - `(timestamp)` tijd waarop een hostgroep die niet meer ontdekt, wordt verwijderd.
selectHosts	query	Retourneer een eigenschap hosts met de hosts die bij de hostgroep horen. Ondersteunt `count`.
selectTemplates	query	Retourneer een eigenschap templates met de sjablonen die bij de hostgroep horen. Ondersteunt `count`.
limitSelects	integer	Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: `selectHosts` - resultaten worden gesorteerd op `host`; `selectTemplates` - resultaten wordt gesorteerd op `host`.
sortfield	string/array	Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: `groupid`, `name`.
countOutput	boolean	Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven op de pagina referentiecommentaar.
editable	booleaans
excludeSearch	boolean
filter	object
limiet	geheel getal
uitvoer	query
preservekeys	boolean
zoeken	object
searchByAny	boolean
searchWildcardsIngeschakeld	boolean
sortorde	string/array
startZoeken	booleaans

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