Documentation
Table of Contents
hostprototype.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
integer/array hostprototype.get(object parameters)
El m¨¨tode permet recuperar prototipus d'equips segons els par¨¤metres prove?ts.
Aquest m¨¨tode ¨¦s disponible per a usuaris de qualsevol mena. Els permisos per cridar al m¨¨tode es poden revocar a les configuracions de rols d'usuari. Per a m¨¦s informaci¨®, veieu Rols d'usuari.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| hostids | ID/array | Retorna nom¨¦s els prototips d'equips amb els identificadors donats. |
| discoveryids | ID/array | Retorna nom¨¦s els prototips d'equips que pertanyen a les regles de descobriment de baix nivell donades. |
| inherited | boolean | Si s'estableix a true, nom¨¦s retorna els elements heretats d'un model. |
| selectDiscoveryRule | query | Retorna una propietat discoveryRule que cont¨¦ la regla de descoberta de baix nivell a la qual pertany el prototip d'equips. |
| selectInterfaces | query | Retorna una propietat interfaces que cont¨¦ les interf¨ªcies personalitzades del prototip d'equips. |
| selectGroupLinks | query | Retorna una propietat grouplinks que cont¨¦ els enlla?os de grup del prototip d'equips. |
| selectGroupPrototypes | query | Retorna una propietat groupPrototypes que cont¨¦ els prototips de grup del prototip d'equips. |
| selectMacros | query | Retorna una propietat macros que cont¨¦ les macros del prototip d'equips. |
| selectParentHost | query | Retorna una propietat parentHost que cont¨¦ l'equip al qual pertany el prototip d'equips. |
| selectTags | query | Retorna una propietat tags que cont¨¦ les etiquetes del prototip d'equips. |
| selectTemplates | query | Retorna una propietat templates que cont¨¦ plantilles relacionades amb el prototip d'equips.Admet count. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles s¨®n: hostid, host, name, status i discovered. |
| countOutput | boolean | Aquests par¨¤metres es descriuen als comentaris de refer¨¨ncia. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el par¨¤metre
countOutput.
Exemples
recuperar prototips d'equips a partir d'una regla LLD
Recupera tots els prototips d'equips, els seus enlla?os de grups, prototips de grups i etiquetes a partir d'una regla LLD.
{
"jsonrpc": "2.0",
"method": "hostprototype.get",
"params": {
"output": "extend",
"selectInterfaces": "extend",
"selectGroupLinks": "extend",
"selectGroupPrototypes": "extend",
"selectTags": "extend",
"discoveryids": "23554"
},
"id": 1
}Resposta:
{
"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}",
"max_repetitions": "10"
}
}
]
}
],
"id": 1
}Veieu tamb¨¦
Font
CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php.