Sidebar
fr:manual:api:reference:hostinterface:get
Table of Contents
hostinterface.get
Description
integer/array hostinterface.get(object parameters)
La méthode permet de récupérer les interfaces 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 |
|---|---|---|
| hostids | string/array | Renvoie uniquement les interfaces hôtes utilisées par les hôtes donnés. |
| interfaceids | string/array | Renvoie uniquement les interfaces hôtes avec les ID donnés. |
| itemids | string/array | Renvoie uniquement les interfaces hôtes utilisées par les éléments donnés. |
| triggerids | string/array | Renvoie uniquement les interfaces hôtes utilisées par les éléments des déclencheurs donnés. |
| selectItems | query | Renvoie les éléments qui utilisent l'interface dans la propriété items. Supporte count. |
| selectHosts | query | Renvoie les hôtes qui utilisent l'interface en tant que tableau dans la propriété hosts. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-requêtes suivantes : selectItems. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : interfaceid, dns, ip. |
| 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 | |
| filter | object | |
| limit | integer | |
| nodeids | string/array | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| 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
countOutputa été utilisé.
Exemples
Récupération des interfaces hôte
Récupérer toutes les données sur les interfaces utilisées par l'hôte “30057”.
Requête :
{ "jsonrpc": "2.0", "method": "hostinterface.get", "params": { "output": "extend", "hostids": "30057" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "interfaceid": "30050", "hostid": "30057", "main": "1", "type": "1", "useip": "1", "ip": "127.0.0.1", "dns": "", "port": "10050", "bulk": "1" }, { "interfaceid": "30067", "hostid": "30057", "main": "0", "type": "1", "useip": "0", "ip": "", "dns": "localhost", "port": "10050", "bulk": "1" }, { "interfaceid": "30068", "hostid": "30057", "main": "1", "type": "2", "useip": "1", "ip": "127.0.0.1", "dns": "", "port": "161", "bulk": "1" } ], "id": 1 }
Voir également
Source
CHostInterface::get() dans frontends/php/include/classes/api/services/CHostInterface.php.