Documentation
Table of Contents
host.get
Beschrijving
integer/array host.get(object parameters)
Deze methode maakt het mogelijk om hosts op te halen op basis van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste output definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| groupids | string/array | Geef alleen hosts terug die tot de opgegeven groepen behoren. |
| dserviceids | string/array | Geef alleen hosts terug die gerelateerd zijn aan de opgegeven ontdekte services. |
| graphids | string/array | Geef alleen hosts terug die de opgegeven grafieken hebben. |
| hostids | string/array | Geef alleen hosts terug met de opgegeven gast-ID's. |
| httptestids | string/array | Geef alleen hosts terug die de opgegeven webcontroles hebben. |
| interfaceids | string/array | Geef alleen hosts terug die de opgegeven interfaces gebruiken. |
| itemids | string/array | Geef alleen hosts terug die de opgegeven items hebben. |
| maintenanceids | string/array | Geef alleen hosts terug die beïnvloed worden door de opgegeven onderhoudstaken. |
| monitored_hosts | flag | Geef alleen gemonitorde hosts terug. |
| proxy_hosts | flag | Geef alleen proxies terug. |
| proxyids | string/array | Geef alleen hosts terug die gemonitord worden door de opgegeven proxies. |
| templated_hosts | flag | Geef zowel hosts als sjablonen terug. |
| templateids | string/array | Geef alleen hosts terug die gekoppeld zijn aan de opgegeven sjablonen. |
| triggerids | string/array | Geef alleen hosts terug die de opgegeven triggers hebben. |
| with_items | flag | Geef alleen hosts terug die items hebben. Overschrijft de parameters with_monitored_items en with_simple_graph_items. |
| with_item_prototypes | flag | Geef alleen hosts terug die item-prototypes hebben. Overschrijft de parameter with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | flag | Geef alleen hosts terug die item-prototypes hebben die ingeschakeld zijn voor creatie en een numeriek informatietype hebben. |
| with_graphs | flag | Geef alleen hosts terug die grafieken hebben. |
| with_graph_prototypes | flag | Geef alleen hosts terug die grafiek-prototypes hebben. |
| with_httptests | flag | Geef alleen hosts terug die webcontroles hebben. Overschrijft de parameter with_monitored_httptests. |
| with_monitored_httptests | flag | Geef alleen hosts terug die ingeschakelde webcontroles hebben. |
| with_monitored_items | flag | Geef alleen hosts terug die ingeschakelde items hebben. Overschrijft de parameter with_simple_graph_items. |
| with_monitored_triggers | flag | Geef alleen hosts terug die ingeschakelde triggers hebben. Alle items die in de trigger worden gebruikt, moeten ook ingeschakeld zijn. |
| with_simple_graph_items | flag | Geef alleen hosts terug die items hebben met een numeriek informatietype. |
| with_triggers | flag | Geef alleen hosts terug die triggers hebben. Overschrijft de parameter with_monitored_triggers. |
| withProblemsSuppressed | boolean | Geef hosts terug die onderdrukte problemen hebben. Mogelijke waarden: null - (standaard) alle hosts;true - alleen hosts met onderdrukte problemen;false - alleen hosts met niet-onderdrukte problemen. |
| evaltype | integer | Regels voor tag-zoeken. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of. |
| severities | integer/array | Geef hosts terug die alleen problemen hebben met gegeven ernst. Geldt alleen als het probleemobject een trigger is. |
| tags | object/array | Geef alleen hosts terug met gegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de waarde van de operator. Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array geeft alle hosts terug. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - Is gelijk aan; 2 - Niet als; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet. |
| inheritedTags | boolean | Geef hosts terug die de opgegeven tags ook hebben in al hun gekoppelde sjablonen. Standaard:Mogelijke waarden: true - gekoppelde sjablonen moeten ook de opgegeven tags hebben;false - (standaard) gekoppelde sjabloontags worden genegeerd. |
| selectDiscoveries | query | Geef een eigenschap ontdekkingen terug met regels voor het laag-niveau ontdekken van hosts. Ondersteunt count. |
| selectDiscoveryRule | query | Geef een eigenschap discoveryRule terug met de laag-niveau ontdekkingsregel die de host heeft aangemaakt (vanuit een gastprototype in VMware-bewaking). |
| selectGraphs | query | Geef een eigenschap grafieken terug met grafiekgegevens van hosts. Ondersteunt count. |
| selectHostDiscovery | query | Geef een eigenschap hostDiscovery terug met gegevens van het host discovery-object.Het host discovery-object koppelt een ontdekte host aan een gastprototype of gastprototypes aan een LLD-regel en heeft de volgende eigenschappen: host - (string) host van het gastprototype;hostid - (string) ID van de ontdekte host of gastprototype;parent_hostid - (string) ID van het gastprototype waaruit de host is gemaakt;parent_itemid - (string) ID van de LLD-regel die de ontdekte host heeft gemaakt;lastcheck - (tijdstempel) tijdstip waarop de host voor het laatst is ontdekt;ts_delete - (tijdstempel) tijdstip waarop een host die niet meer wordt ontdekt, wordt verwijderd. |
| selectHostGroups | query | Geef een eigenschap hostgroups terug met gegevens van hostgroepen waar de host toe behoort. |
| selectHttpTests | query | Geef een eigenschap httpTests terug met web-scenario's van host. Ondersteunt count. |
| selectInterfaces | query | Geef een eigenschap interfaces terug met gegevens van hostinterfaces. Ondersteunt count. |
| selectInventory | query | Geef een eigenschap inventory terug met gegevens van hostinventaris. |
| selectItems | query | Geef een eigenschap items terug met gegevens van gastitems. Ondersteunt count. |
| selectMacros | query | Geef een eigenschap macros terug met gegevens van gastmacros. |
| selectParentTemplates | query | Geef een eigenschap parentTemplates terug met sjablonen waaraan de host is gekoppeld.Naast de velden van het sjabloongegevenselement bevat het link_type - (integer) de manier waarop het sjabloon aan de host is gekoppeld.Mogelijke waarden: 0 - (standaard) handmatig gekoppeld; 1 - automatisch gekoppeld door LLD. Ondersteunt count. |
| selectDashboards | query | Geef een eigenschap dashboards terug. Ondersteunt count. |
| selectTags | query | Geef een eigenschap tags terug met gegevens van gasttags. |
| selectInheritedTags | query | Geef een eigenschap inheritedTags terug met tags die op alle sjablonen staan die aan de host zijn gekoppeld. |
| selectTriggers | query | Geef een eigenschap triggers terug met gegevens van gasttriggers. Ondersteunt count. |
| selectValueMaps | query | Geef een eigenschap valuemaps terug met gegevens van waardeoverzichten van gasten. |
| filter | object | Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter. <brAccepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde of een array van waarden zijn om mee te vergelijken. <brHiermee kunt u filteren op interface-eigenschappen. Werkt niet voor tekst-velden. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. <brVan toepassing op de volgende subselecties: selectParentTemplates - resultaten worden gesorteerd op host;selectInterfaces;selectItems - gesorteerd op name;selectDiscoveries - gesorteerd op name;selectTriggers - gesorteerd op description;selectGraphs - gesorteerd op name;selectDashboards - gesorteerd op name. |
| search | object | Geef resultaten terug die overeenkomen met het opgegeven patroon (hoofdletterongevoelig). <brAccepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden strings zijn om naar te zoeken. Als er geen extra opties zijn opgegeven, wordt er een zoekopdracht LIKE "%…%" uitgevoerd.<brHiermee kunt u zoeken op interface-eigenschappen. Werkt alleen voor string- en tekst-velden. |
| searchInventory | object | Geef alleen hosts terug met inventarisgegevens die overeenkomen met de opgegeven wildcard-zoekopdracht. <brDeze parameter wordt beïnvloed door dezelfde aanvullende parameters als search. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. <brMogelijke waarden: hostid, host, name, status. |
| countOutput | boolean | Deze parameters zijn gemeenschappelijk voor alle get-methoden en worden uitvoerig beschreven in de referentietoelichting. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (verouderd) |
query | Deze parameter is verouderd, gebruik in plaats daarvan selectHostGroups.Geef een eigenschap groups terug met gegevens van hostgroepen waar de host toe behoort. |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Gegevens ophalen op naam
Haal alle gegevens op over twee hosts met de namen "Zabbix-server" en "Linux-server".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Zabbix-server",
"Linux-server"
]
}
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"proxy_hostid": "0",
"host": "Zabbix-server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Zabbix-server",
"flags": "0",
"description": "De Zabbix monitoring server.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1",
"active_available": "1"
},
{
"hostid": "10167",
"proxy_hostid": "0",
"host": "Linux-server",
"status": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux-server",
"flags": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1",
"active_available": "1"
}
],
"id": 1
}Hostgroepen ophalen
Haal hostgroepen op waar de host "Zabbix-server" lid van is.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectHostGroups": "extend",
"filter": {
"host": [
"Zabbix-server"
]
}
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"hostgroups": [
{
"groupid": "2",
"name": "Linux-servers",
"flags": "0",
"uuid": "dc579cd7a1a34222933f24f52a68bcd8"
},
{
"groupid": "4",
"name": "Zabbix-servers",
"flags": "0",
"uuid": "6f6799aa69e844b4b3918f779f2abf08"
}
]
}
],
"id": 1
}Gekoppelde sjablonen ophalen
Haal de ID's en namen op van sjablonen die gekoppeld zijn aan host "10084".
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Retrieving hosts by template
Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Zoeken op hostinventarisgegevens
Haal hosts op die "Linux" bevatten in het veld "Besturingssysteem" van de hostinventaris.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Zabbix-server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux-server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}Zoeken op hosttags
Haal hosts op die de tag "Hostnaam" gelijk aan "Linux-server" hebben.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Hostnaam",
"value": "Linux-server",
"operator": 1
}
]
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "Hostnaam",
"value": "Linux-server"
},
{
"tag": "Besturingssysteem",
"value": "RHEL 7"
}
]
}
],
"id": 1
}Haal hosts op die deze tags niet alleen op hostniveau hebben, maar ook in hun gekoppelde ouder-sjablonen.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [
{
"tag": "A",
"value": "1",
"operator": 1
}
],
"inheritedTags": true
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "Ruimte PC 1"
},
{
"hostid": "10601",
"name": "Kantoor"
}
],
"id": 1
}Host zoeken met tags en sjabloontags
Haal een host op met tags en alle tags die zijn gekoppeld aan ouder-sjablonen.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "A",
"value": "1"
}
],
"inheritedTags": [
{
"tag": "B",
"value": "2"
}
]
}
],
"id": 1
}Zoeken naar hosts op probleemernst
Haal hosts op die "Rampzalige" problemen hebben.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"id": 1
}Reactie:
Haal hosts op die "Gemiddelde" en "Hoge" problemen hebben.
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "Werkstation"
}
],
"id": 1
}Zie ook
Bron
CHost::get() in ui/include/classes/api/services/CHost.php.