Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

host.get

Description

integer/array host.get(object parameters)

La méthode permet de récupérer les hôtes en fonction des paramètres donnés.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
groupids string/array Renvoie uniquement les hôtes appartenant aux groupes donnés.
dserviceids string/array Renvoie uniquement les hôtes associés aux services découverts donnés.
graphids string/array Renvoie uniquement les hôtes qui ont les graphiques donnés.
hostids string/array Renvoyer uniquement les hôtes avec les ID d'hôte donnés.
httptestids string/array Renvoie uniquement les hôtes ayant les surveillances Web données.
interfaceids string/array Renvoie uniquement les hôtes qui utilisent les interfaces données.
itemids string/array Renvoie uniquement les hôtes ayant les éléments donnés.
maintenanceids string/array Renvoie uniquement les hôtes affectés par les maintenances données.
monitored_hosts flag Renvoyer uniquement les hôtes surveillés.
proxy_hosts flag Renvoie uniquement les proxies.
proxyids string/array Renvoie uniquement les hôtes surveillés par les proxies donnés.
templated_hosts flag Renvoie les hôtes et les modèles.
templateids string/array Renvoie uniquement les hôtes liés aux modèles donnés.
triggerids string/array Renvoie uniquement les hôtes ayant les déclencheurs donnés.
with_items flag Renvoie uniquement les hôtes qui ont des éléments.

Surcharge les paramètres with_monitored_items et with_simple_graph_items.
with_item_prototypes flag Renvoie uniquement les hôtes qui ont des prototypes élément.

Surcharge le paramètre with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes flag Renvoie uniquement les hôtes qui ont des prototypes d'éléments, qui sont activés pour la création et qui ont des informations de type numérique.
with_graphs flag Renvoie uniquement les hôtes dotés de graphiques.
with_graph_prototypes flag Renvoie uniquement les hôtes dotés de prototypes de graphique.
with_httptests flag Renvoie uniquement les hôtes disposant de surveillance Web.

Écrase le paramètre with_monitored_httptests.
with_monitored_httptests flag Renvoie uniquement les hôtes ayant des surveillances Web actives.
with_monitored_items flag Renvoie uniquement les hôtes ayant des éléments actifs.

Écrase le paramètre with_simple_graph_items.
with_monitored_triggers flag Renvoie uniquement les hôtes ayant des déclencheurs actifs. Tous les éléments utilisés dans le déclencheur doivent également être activés.
with_simple_graph_items flag Renvoie uniquement les hôtes contenant des éléments contenant des informations de type numérique.
with_triggers flag Renvoie uniquement les hôtes ayant des déclencheurs.

Écrase le paramètre with_monitored_triggers.
withProblemsSuppressed boolean Renvoie les hôtes qui ont des problèmes supprimés.

Valeurs possibles :
null - (par défaut) tous les hôtes ;
true - uniquement les hôtes avec des problèmes supprimés ;
false - uniquement hôtes avec des problèmes non supprimés.
evaltype integer Règles de recherche de tags.

Valeurs possibles :
0 - (par défaut) Et/Ou ;
2 - Ou.
severities integer/array Renvoie les hôtes qui n'ont que des problèmes avec des sévérités données. S'applique uniquement si l'objet problématique est un déclencheur.
tags array/object Renvoie uniquement les hôtes avec des tags donnés. Correspondance exacte par tag et recherche sensible ou insensible à la casse par valeur de tag en fonction de la valeur de l'opérateur.
Format : [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].
Un tableau vide renvoie tous les hôtes.

Valeurs d'opérateur possibles :
0 - (par défaut) Contient ;
1 - Égal ;
2 - Pas comme ;
3 - Pas égal
4 - Existe ;
5 - N'existe pas.
inheritedTags boolean Renvoie les hôtes qui ont tags donnés ainsi que dans tous leurs modèles liés. Par défaut :

Valeurs possibles :
true - les modèles liés doivent également avoir les tags donnés ;
false - (par défaut) les tags de modèles liés sont ignorées.
selectDiscoveries query Renvoie une propriété discoveries contenant les règles de découverte bas niveau.

Supporte count.
selectDiscoveryRule query Renvoie une propriété discoveryRule avec la règle de découverte de bas niveau qui a créé l'hôte (à partir du prototype d'hôte dans la surveillance VMware).
selectGraphs query Renvoie une propriété graphs avec les graphiques d'hôtes.

Supporte count.
selectGroups query Renvoie une propriété groups avec les groupes hôtes auxquels l'hôte appartient.
selectHostDiscovery query Renvoie une propriété hostDiscovery avec les données d'objet de découverte d'hôte.

L'objet de découverte d'hôte lie un hôte découvert à un prototype d'hôte ou un prototype à une règle de découverte bas niveau et possède les propriétés suivantes :
host - (string) hôte du prototype d'hôte ;
hostid - (string) ID de l'hôte découvert ou du prototype d'hôte ;
parent_hostid - (string) ID du prototype d'hôte à partir duquel l'hôte a été créé ;
parent_itemid - (string) ID de la règle de découverte bas niveau qui a créé l'hôte découvert ;
lastcheck - (timestamp) heure de la dernière découverte de l'hôte ;
ts_delete - (timestamp) heure à laquelle un hôte qui n'est plus découvert sera supprimé.
selectHttpTests query Renvoie une propriété httpTests avec les scénarios Web de l'hôte.

Supporte count.
selectInterfaces query Renvoie une propriété interfaces avec les interfaces hôtes.

Supporte count.
selectInventory query Renvoie une propriété inventory avec les données d'inventaire de l'hôte.
selectItems query Renvoie une propriété items avec les éléments de l'hôte.

Supporte count.
selectMacros query Renvoie une propriété macros avec les macros de l'hôte.
selectParentTemplates query Renvoie une propriété parentTemplates avec les modèles auxquels l'hôte est lié.

Supporte count.
selectDashboards query Renvoie une propriété dashboards.

Supporte count.
selectTags query Renvoie une propriété tags avec tous les tags de l'hôte.
selectInheritedTags query Renvoie une propriété inheritedTags avec les tags qui se trouvent sur tous les modèles liés à l'hôte.
selectTriggers query Renvoie une propriété triggers avec les déclencheurs de l'hôte.

Supporte count.
selectValueMaps query Renvoie une propriété valuemaps avec les tables de correspondance de valeur de l'hôte.
filter object Renvoie uniquement les résultats qui correspondent exactement au filtre donné.

Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont une valeur unique ou un tableau de valeurs à comparer.

Permet le filtrage par les propriétés de l'interface.
limitSelects integer Limite le nombre d'enregistrements renvoyés par les sous-requêtes.

S'applique aux sous-requêtes suivantes:
selectParentTemplates - les résultats seront triés par host ;
selectInterfaces ;
selectItems - triés par name ;
selectDiscoveries - triés par name ;
selectTriggers - triés par description ;
selectGraphs - triés par name ;
selectDashboards - triés par name.
search object Renvoie les résultats correspondant à la recherche générique donnée.

Accepte un tableau dans lequel les clés sont des noms de propriétés et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est donnée, cela effectuera une recherche LIKE "%…%".

Permet de rechercher par propriétés de l'interface. Fonctionne uniquement avec les champs de texte.
searchInventory object Renvoie uniquement les hôtes dont les données d'inventaire correspondent à la recherche générique donnée.

Ce paramètre est affecté par les mêmes paramètres supplémentaires que "search".
sortfield string/array Trie le résultat en fonction des propriétés données.

Valeurs possibles : hostid, host, name, status.
countOutput boolean Ces paramètres, communs à toutes les méthodes get, sont décrits dans les commentaires de référence.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des données par nom

Récupérez toutes les données sur deux hôtes nommés "Zabbix server" et "Linux server".

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "filter": {
                   "host": [
                       "Zabbix server",
                       "Linux server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "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": "The Zabbix monitoring server.",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "inventory_mode": "1"
               },
               {
                   "hostid": "10167",
                   "proxy_hostid": "0",
                   "host": "Linux 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": "Linux server",
                   "flags": "0",
                   "description": "",
                   "tls_connect": "1",
                   "tls_accept": "1",
                   "tls_issuer": "",
                   "tls_subject": "",
                   "inventory_mode": "1"
               }
           ],
           "id": 1
       }

Récupération des groupes d'hôtes

Récupérer les noms des groupes dont l'hôte "Zabbix server" est membre, mais pas les détails des hôtes eux-mêmes.

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectGroups": "extend",
               "filter": {
                   "host": [
                       "Zabbix server"
                   ]
               }
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

Réponse :

{
           "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
       }

Récupération des modèles liés

Récupérez les identifiants et les noms des modèles liés à l'hôte "10084".

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["hostid"],
               "selectParentTemplates": [
                   "templateid",
                   "name"
               ],
               "hostids": "10084"
           },
           "id": 1,
           "auth": "70785d2b494a7302309b48afcdb3a401"
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "parentTemplates": [
                       {
                           "name": "Linux",
                           "templateid": "10001"
                       },
                       {
                           "name": "Zabbix Server",
                           "templateid": "10047"
                       }
                   ]
               }
           ],
           "id": 1
       }

#### Recherche par données d'inventaire de l'hôte

Récupérez les hôtes qui contiennent "Linux" dans le champ "OS" de l'inventaire de l'hôte.

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": [
                   "host"
               ],
               "selectInventory": [
                   "os"
               ],
               "searchInventory": {
                   "os": "Linux"
               }
           },
           "id": 2,
           "auth": "7f9e00124c75e8f25facd5c093f3e9a0"
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10084",
                   "host": "Zabbix server",
                   "inventory": {
                       "os": "Linux Ubuntu"
                   }
               },
               {
                   "hostid": "10107",
                   "host": "Linux server",
                   "inventory": {
                       "os": "Linux Mint"
                   }
               }
           ],
           "id": 1
       }

Recherche par tags d'hôte

Récupérez les hôtes dont le tag "Host name" est égale à "Linux server".

Requête :

{
           "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
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10085",
                   "tags": [
                       {
                           "tag": "Host name",
                           "value": "Linux server"
                       },
                       {
                           "tag": "OS",
                           "value": "RHEL 7"
                       }
                   ]
               }
           ],
           "id": 1
       }

Récupérez les hôtes qui ont ces tags non seulement au niveau de l'hôte, mais également dans leurs modèles parents liés.

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "tags": [{"tag": "A", "value": "1", "operator": "0"}],
               "inheritedTags": true
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10623",
                   "name": "PC room 1"
               },
               {
                   "hostid": "10601",
                   "name": "Office"
               }
           ],
           "id": 1
       }

Recherche d'hôte avec des tags et des tags de modèle

Récupérez un hôte avec des tags et tous les tags liées aux modèles parents.

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "hostids": 10502,
               "selectTags": ["tag", "value"],
               "selectInheritedTags": ["tag", "value"]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10502",
                   "name": "Desktop",
                   "tags": [
                       {
                           "tag": "A",
                           "value": "1"
                       }
                   ],
                   "inheritedTags": [
                       {
                           "tag": "B",
                           "value": "2"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recherche d'hôtes par gravité de problème

Récupérez les hôtes qui ont des problèmes de gravité "désastre".

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": 5
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10160",
                   "name": "Zabbix server"
               }
           ],
           "id": 1
       }

Récupérez les hôtes qui ont des problèmes de gravité "moyenne" et "haute".

Requête :

{
           "jsonrpc": "2.0",
           "method": "host.get",
           "params": {
               "output": ["name"],
               "severities": [3, 4]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "20170",
                   "name": "Database"
               },
               {
                   "hostid": "20183",
                   "name": "workstation"
               }
           ],
           "id": 1
       }

Voir également

Source

CHost::get() dans ui/include/classes/api/services/CHost.php.