Sidebar

fr:manual:api:reference:host:get

host.get

Description

integer/array host.get(object parameters)

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

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
groupidsstring/array Renvoie uniquement les hôtes appartenant aux groupes donnés.
applicationidsstring/array Renvoie uniquement les hôtes ayant les applications données.
dserviceidsstring/array Renvoie uniquement les hôtes associés aux services découverts donnés.
graphidsstring/array Renvoie uniquement les hôtes qui ont les graphiques donnés.
hostidsstring/array Renvoyer uniquement les hôtes avec les ID d'hôte donnés.
httptestidsstring/array Renvoie uniquement les hôtes ayant les surveillances Web données.
interfaceidsstring/array Renvoie uniquement les hôtes qui utilisent les interfaces données.
itemidsstring/array Renvoie uniquement les hôtes ayant les éléments donnés.
maintenanceidsstring/array Renvoie uniquement les hôtes affectés par les maintenances données.
monitored_hostsflag Renvoyer uniquement les hôtes surveillés.
proxy_hostsflag Renvoie uniquement les proxies.
proxyidsstring/array Renvoie uniquement les hôtes surveillés par les proxies donnés.
templated_hostsflag Renvoie les hôtes et les modèles.
templateidsstring/array Renvoie uniquement les hôtes liés aux modèles donnés.
triggeridsstring/array Renvoie uniquement les hôtes ayant les déclencheurs donnés.
with_itemsflag Renvoie uniquement les hôtes qui ont des éléments.

Écrase les paramètres with_monitored_items et with_simple_graph_items.
with_applicationsflag Renvoie uniquement les hôtes ayant des applications.
with_graphsflag Renvoie uniquement les hôtes dotés de graphiques.
with_httptestsflag Renvoie uniquement les hôtes disposant de surveillance Web.

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

Écrase le paramètre with_simple_graph_items.
with_monitored_triggersflag 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_itemsflag Renvoie uniquement les hôtes contenant des éléments contenant des informations de type numérique.
with_triggersflag Renvoie uniquement les hôtes ayant des déclencheurs.

Écrase le paramètre with_monitored_triggers.
withInventoryflag Renvoie uniquement les hôtes disposant de données d'inventaire.
selectGroupsquery Renvoie une propriété groups avec les groupes hôtes auxquels l'hôte appartient.
selectApplicationsquery Renvoie une propriété applications avec les applications hôtes.

Supporte count.
selectDiscoveriesquery Renvoie une propriété discoveries avec 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).
selectGraphsquery Renvoie une propriété graphs avec les graphiques d'hôtes.

Supporte count.
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é.
selectHttpTestsquery Renvoie une propriété httpTests avec les scénarios Web de l'hôte.

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

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

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

Supporte count.
selectScreensquery Renvoie une propriété screens avec les écrans d'hôtes.

Supporte count.
selectTriggersquery Renvoie une propriété triggers avec les déclencheurs de l'hôte.

Supporte count.
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 ;
selectApplications - triés par name ;
selectScreens - 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”.
sortfieldstring/array Trie le résultat en fonction des propriétés données.

Valeurs possibles : hostid, host, name, status.
countOutput booleanCes 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érer 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": [
        {
            "maintenances": [],
            "hostid": "10160",
            "proxy_hostid": "0",
            "host": "Zabbix server",
            "status": "0",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Zabbix server",
            "description": "The Zabbix monitoring server.",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": ""
        },
        {
            "maintenances": [],
            "hostid": "10167",
            "proxy_hostid": "0",
            "host": "Linux server",
            "status": "0",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Linux server",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": ""
        }
    ],
    "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 aucun détail sur l'hôte lui-même.

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érer 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": "Template OS Linux",
                    "templateid": "10001"
                },
                {
                    "name": "Template App Zabbix Server",
                    "templateid": "10047"
                }
            ]
        }
    ],
    "id": 1
}

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

Récupérer les hôtes qui contiennent “Linux” dans le champ “OS” de l'inventaire d'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
}

Voir également

Source

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