Table of Contents
host.get
Beschrijving
integer/array host.get(objectparameters)
De methode maakt het mogelijk om hosts 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 |
|---|---|---|
| groupids | string/array | Geef alleen hosts terug die tot de opgegeven hostgroepen behoren. |
| dserviceids | string/array | Geef alleen hosts terug die verband houden met 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 host-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 worden beïnvloed door de opgegeven onderhoudstaken. |
| monitored_hosts | flag | Geef alleen bewaakte hosts terug. |
| proxy_hosts | flag | Geef alleen proxy's terug. |
| proxyids | string/array | Geef alleen hosts terug die worden bewaakt door de opgegeven proxy's. |
| templated_hosts | flag | Geef zowel hosts als sjablonen terug. |
| templateids | string/array | Geef alleen hosts terug die zijn gekoppeld aan de opgegeven sjablonen. |
| triggerids | string/array | Geef alleen hosts terug die de opgegeven triggernummers 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 zijn ingeschakeld voor creatie en een numeriek gegevenstype hebben. |
| with_graphs | flag | Geef alleen hosts terug die grafieken hebben. |
| with_graph_prototypes | flag | Geef alleen hosts terug die grafieksjablonen 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 triggernummers hebben. Alle items die in de trigger worden gebruikt, moeten ook zijn ingeschakeld. |
| with_simple_graph_items | flag | Geef alleen hosts terug die items hebben met een numeriek gegevenstype. |
| with_triggers | flag | Geef alleen hosts terug die triggernummers 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 het zoeken naar tags. Mogelijke waarden: 0 - (standaard) And/Or; 2 - Of. |
| severities | integer/array | Geef alleen hosts terug die problemen hebben met de opgegeven ernstniveaus. Geldt alleen als het probleemobject een trigger is. |
| tags | object/array | Geef alleen hosts terug met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de operatorwaarde. Indeling: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array geeft alle hosts terug. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - 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) tags van gekoppelde sjablonen worden genegeerd. |
| selectDiscoveries | query | Geef een eigenschap discoveries terug met regels voor laag-niveau ontdekking van hosts. Ondersteunt count. |
| selectDiscoveryRule | query | Geef een eigenschap discoveryRule terug met de regel voor laag-niveau ontdekking die de host heeft gemaakt (vanuit host-sjabloon in VMware-monitoring). |
| selectGraphs | query | Geef een eigenschap graphs terug met hostgrafieken. Ondersteunt count. |
| selectGroups | query | Geef een eigenschap groups terug met gegevens over hostgroepen waartoe de host behoort. |
| selectHostDiscovery | query | Geef een eigenschap hostDiscovery terug met gegevens van het host-ontdekkingobject.Het host-ontdekkingobject koppelt een ontdekte host aan een hostsjabloon of hostsjablonen aan een LLD-regel en heeft de volgende eigenschappen: host - (string) host van het hostsjabloon;hostid - (string) ID van de ontdekte host of hostsjabloon;parent_hostid - (string) ID van het hostsjabloon waaruit de host is gemaakt;parent_itemid - (string) ID van de LLD-regel die de ontdekte host heeft gemaakt;lastcheck - (timestamp) tijdstip waarop de host voor het laatst is ontdekt;ts_delete - (timestamp) tijdstip waarop een niet langer ontdekte host zal worden verwijderd. |
| selectHttpTests | query | Geef een eigenschap httpTests terug met webscenario's van de host. Ondersteunt count. |
| selectInterfaces | query | Geef een eigenschap interfaces terug met hostinterfaces. Ondersteunt count. |
| selectInventory | query | Geef een eigenschap inventory terug met gegevens van hostinventaris. |
| selectItems | query | Geef een eigenschap items terug met host-items. Ondersteunt count. |
| selectMacros | query | Geef een eigenschap macros terug met host-macro's. |
| selectParentTemplates | query | Geef een eigenschap parentTemplates terug met sjablonen waaraan de host is gekoppeld. Ondersteunt count. |
| selectDashboards | query | Geef een eigenschap dashboards terug. Ondersteunt count. |
| selectTags | query | Geef een eigenschap tags terug met host-tags. |
| selectInheritedTags | query | Geef een eigenschap inheritedTags terug met tags die zich bevinden op alle sjablonen die aan de host zijn gekoppeld. |
| selectTriggers | query | Geef een eigenschap triggers terug met host-triggers. Ondersteunt count. |
| selectValueMaps | query | Geef een eigenschap valuemaps terug met host-waardeoverzichten. |
| filter | object | Geef alleen resultaten terug die exact overeenkomen met de opgegeven filter. Accepteert een array, waarbij de sleutels de eigenschapsnamen zijn en de waarden ofwel een enkele waarde ofwel een array van waarden zijn om mee te vergelijken. Maakt filteren op interface-eigenschappen mogelijk. Werkt niet voor text-velden. |
| limitSelects | integer | Beperkt het aantal records dat wordt teruggegeven door subselects. Geldt voor de volgende subselects: 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). Accepteert een array, waarbij de sleutels de eigenschapsnamen zijn en de waarden de strings zijn om naar te zoeken. Als er geen extra opties worden opgegeven, wordt dit een LIKE "%…%"-zoekopdracht.Maakt zoeken op interface-eigenschappen mogelijk. Werkt alleen voor string- en text-velden. |
| searchInventory | object | Geef alleen hosts terug die inventarisgegevens hebben die overeenkomen met de opgegeven wildcard-zoekopdracht. Deze parameter wordt beïnvloed door dezelfde aanvullende parameters als search. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden zijn: hostid, host, name, status. |
| countOutput | boolean | Deze parameters die gemeenschappelijk zijn voor alle get-methoden worden in detail beschreven in de referentiecommentaar. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Gegevens op naam ophalen
Haal alle gegevens op over twee hosts met de naam "Zabbix-server" en "Linux server".
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Zabbix server",
"Linux server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"maintenances": [],
"hostid": "10160",
"proxy_hostid": "0",
"host": "Zabbix server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"snmp_disable_until": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Zabbix server",
"description": "The Zabbix monitoring server.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": ""
},
{
"maintenances": [],
"hostid": "10167",
"proxy_hostid": "0",
"host": "Linux server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"snmp_disable_until": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux server",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": ""
}
],
"id": 1
}Hostgroepen ophalen
Namen ophalen van de groepshost "Zabbix-server" is lid van, maar nee hostdetails zelf.
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectGroups": "extend",
"filter": {
"host": [
"Zabbix server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"groups": [
{
"groupid": "2",
"name": "Linux servers",
"internal": "0",
"flags": "0"
},
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0",
"flags": "0"
}
]
}
],
"id": 2
}Gelinkte sjablonen ophalen
Haal de ID's en namen op van sjablonen die zijn gekoppeld aan host "10084".
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1,
"auth": "70785d2b494a7302309b48afcdb3a401"
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Zabbix Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Hosts ophalen per sjabloon
Haal hosts op waaraan de sjabloon "10001" (Linux by Zabbix agent) is gekoppeld.
Verzoek:
{
"jsonrpc": "2.0",
"methode": "host.get",
"params": {
"output": ["hostid", "naam"],
"templateids": "10001"
},
"auth": "70785d2b494a7302309b48afcdb3a401",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"resultaat": [
{
"templateid": "10001",
"gastheren": [
{
"hostid": "10084",
"name": "Zabbix-server"
},
{
"hostid": "10603",
"naam": "Host 1"
},
{
"hostid": "10604",
"naam": "Host 2"
}
]
}
],
"id": 1
}Zoeken op hostvoorraadgegevens
Haal hosts op die "Linux" bevatten in het veld "OS" van de hostinventaris.
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 2,
"auth": "7f9e00124c75e8f25facd5c093f3e9a0"
}Antwoord:
{
"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 met de tag "Hostnaam" gelijk aan "Linux-server".
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Host name",
"value": "Linux server",
"operator": 1
}
]
},
"auth": "7f9e00124c75e8f25facd5c093f3e9a0",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "Host name",
"value": "Linux server"
},
{
"tag": "OS",
"value": "RHEL 7"
}
]
}
],
"id": 1
}Retrieve hosts that have these tags not only on host level but also in their linked parent templates.
Request:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [{"tag": "A", "value": "1", "operator": "0"}],
"inheritedTags": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}Host zoeken met tags en sjabloontags
Een host ophalen met tags en alle tags die aan ouder zijn gekoppeld Sjablonen.
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "A",
"value": "1"
}
],
"inheritedTags": [
{
"tag": "B",
"value": "2"
}
]
}
],
"id": 1
}Hosts zoeken op ernst van het probleem
Haal hosts op die "Ramp"-problemen hebben.
Verzoek:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
Retrieve hosts that have "Average" and "High" problems.
Request:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}Zie ook
Bron
CHost::get() in ui/include/classes/api/services/CHost.php.