hostinterface.get

Description

integer/array hostinterface.get(object parameters)

Cette méthode permet de récupérer les interfaces d’hôte selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres du rôle 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
hostids ID/array Retourner uniquement les interfaces d'hôte utilisées par les hôtes donnés.
interfaceids ID/array Retourner uniquement les interfaces d'hôte avec les ID donnés.
itemids ID/array Retourner uniquement les interfaces d'hôte utilisées par les éléments de données donnés.
triggerids ID/array Retourner uniquement les interfaces d'hôte utilisées par les éléments de données dans les déclencheurs donnés.
selectItems query Retourner une propriété items avec les éléments de données qui utilisent l'interface.

Prend en charge count.
selectHosts query Retourner une propriété hosts avec un tableau d'hôtes qui utilisent l'interface.
limitSelects integer Limite le nombre d'enregistrements renvoyés par les sous-sélections.

S'applique aux sous-sélections suivantes :
selectItems.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : interfaceid, dns, ip.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
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 countOutput a été utilisé.

Exemples

Récupérer les interfaces de l'hôte

Récupérez toutes les données concernant les interfaces utilisées par l'hôte « 30057 ».

Requête :

{
    "jsonrpc": "2.0",
    "method": "hostinterface.get",
    "params": {
        "output": "extend",
        "hostids": "30057"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "interfaceid": "50039",
            "hostid": "30057",
            "main": "1",
            "type": "1",
            "useip": "0",
            "ip": "",
            "dns": "localhost",
            "port": "10050",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": []
        },
        {
            "interfaceid": "55082",
            "hostid": "30057",
            "main": "1",
            "type": "2",
            "useip": "1",
            "ip": "127.0.0.1",
            "dns": "",
            "port": "161",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": {
                "version": "2",
                "bulk": "0",
                "community": "{$SNMP_COMMUNITY}",
                "max_repetitions": "10"
            }
        }
    ],
    "id": 1
}

Voir également

Source

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