Documentation
Table of Contents
hostprototype.get
Description
integer/array hostprototype.get(object parameters)
La méthode permet de récupérer des prototypes d'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 |
|---|---|---|
| hostids | string/array | Renvoie uniquement les prototypes d'hôte avec les identifiants donnés. |
| discoveryids | string/array | Renvoie uniquement les prototypes d'hôte appartenant aux règles de découverte bas niveau données. |
| inherited | boolean | Si défini à true, ne renvoie que les éléments hérités d'un modèle. |
| selectDiscoveryRule | query | Renvoie une propriété discoveryRule contenant la règle de découverte bas niveau à laquelle appartient le prototype d'hôte. |
| selectInterfaces | query | Renvoie une propriété interfaces contenant les interfaces personnalisée du prototype d'hôte. |
| selectGroupLinks | query | Renvoie une propriété groupLinks contenant les liens de groupe du prototype d'hôte. |
| selectGroupPrototypes | query | Renvoie une propriété groupPrototypes contenant les prototypes de groupe du prototype d'hôte. |
| selectMacros | query | Renvoie une propriété macros contenant les macros du prototype d'hôte. |
| selectParentHost | query | Renvoie une propriété parentHost contenant l'hôte auquel appartient le prototype d'hôte. |
| selectTags | query | Renvoie une propriété tags contenant les tags du prototype d'hôte. |
| selectTemplates | query | Renvoie une propriété templates contenant les modèles liés au prototype d'hôte. Supporte count. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : hostid, host, name et 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 | |
| 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
countOutputa été utilisé.
Exemples
Récupération de prototypes d'hôtes à partir d'une règle LLD
Récupérez tous les prototypes d'hôtes, leurs liens de groupe, prototypes de groupe et tags à partir d'une règle LLD.
Requête :
{
"jsonrpc": "2.0",
"method": "hostprototype.get",
"params": {
"output": "extend",
"selectInterfaces": "extend",
"selectGroupLinks": "extend",
"selectGroupPrototypes": "extend",
"selectTags": "extend",
"discoveryids": "23554"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10092",
"host": "{#HV.UUID}",
"name": "{#HV.UUID}",
"status": "0",
"templateid": "0",
"discover": "0",
"custom_interfaces": "1",
"inventory_mode": "-1",
"groupLinks": [
{
"group_prototypeid": "4",
"hostid": "10092",
"groupid": "7",
"templateid": "0"
}
],
"groupPrototypes": [
{
"group_prototypeid": "7",
"hostid": "10092",
"name": "{#CLUSTER.NAME}",
"templateid": "0"
}
],
"tags": [
{
"tag": "Datacenter",
"value": "{#DATACENTER.NAME}"
},
{
"tag": "Instance type",
"value": "{#INSTANCE_TYPE}"
}
],
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
}
],
"id": 1
}Voir également
Source
CHostPrototype::get() dans ui/include/classes/api/services/CHostPrototype.php.