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.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | 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.