hostgroup.get

Beschrijving

integer/array hostgroup.get(object parameters)

Deze methode maakt het mogelijk om hostgroepen op te halen op basis van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
graphids	string/array	Geef alleen hostgroepen terug die hosts bevatten met de opgegeven grafieken.
groupids	string/array	Geef alleen hostgroepen terug met de opgegeven hostgroep-ID's.
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.
triggerids	string/array	Geef alleen hostgroepen terug die hosts 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 prototypes.
with_hosts	flag	Geef alleen hostgroepen terug die hosts bevatten.
with_httptests	flag	Geef alleen hostgroepen terug die hosts bevatten met web checks. Overschrijft de parameter `with_monitored_httptests`.
with_items	flag	Geef alleen hostgroepen terug die hosts 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 prototypes. Overschrijft de parameter `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Geef alleen hostgroepen terug die hosts bevatten met item prototypes, die zijn ingeschakeld voor aanmaak en een numeriek informatietype hebben.
with_monitored_httptests	flag	Geef alleen hostgroepen terug die hosts bevatten met ingeschakelde web checks.
with_monitored_hosts	flag	Geef alleen hostgroepen terug die gemonitorde hosts bevatten.
with_monitored_items	flag	Geef alleen hostgroepen terug die hosts 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 gemaakt.
selectGroupDiscovery	query	Geef een eigenschap `groupDiscovery` terug met het object voor hostgroep ontdekking. Het object voor hostgroep ontdekking linkt 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, zal worden verwijderd.
selectHosts	query	Geef een eigenschap hosts terug met de hosts die bij de hostgroep horen. Ondersteunt `count`.
limitSelects	integer	Beperkt het aantal records dat wordt teruggegeven door subselecties. Van toepassing op de volgende subselecties: `selectHosts` - resultaten worden gesorteerd op `host`.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: `groupid`, `name`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get` methoden, worden in detail beschreven op de pagina referentie toelichting.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean
monitored_hosts (verouderd)	flag	Deze parameter is verouderd, gebruik in plaats daarvan `with_monitored_hosts`. Geef alleen hostgroepen terug die gemonitorde hosts bevatten.
real_hosts (verouderd)	flag	Deze parameter is verouderd, gebruik in plaats daarvan `with_hosts`. Geef alleen hostgroepen terug die hosts bevatten.

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Gegevens ophalen op basis van naam

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

Aanvraag:

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

Reactie:

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

Zie ook

Host

Bron

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

Documentation