Documentation
Table of Contents
hostprototype.get
Descri??o
integer/array hostprototype.get(object parameters)
O m¨¦todo permite recuperar prot¨®tipos de host de acordo com o par?metros.
Este m¨¦todo est¨¢ dispon¨ªvel para usu¨¢rios de qualquer tipo. Permiss?es para chamar o m¨¦todo pode ser revogado nas configura??es de fun??o do usu¨¢rio. Veja Usu¨¢rio fun??es Para maiores informa??es.
Par?metros
(object) Par?metros que definem a sa¨ªda desejada.
O m¨¦todo oferece suporte aos seguintes par?metros.
|Par?metro|Tipo|Descri??o| |---------|----------------------------------- ------------|-----------| |hostids|string/array|Retorna apenas prot¨®tipos de host com os IDs fornecidos.| |discoveryids|string/array|Retorna apenas o prot¨®tipo do host que pertence ¨¤s regras LLD fornecidas.| |inherited|boolean|Se definido como true, retornar¨¢ apenas itens herdados de um modelo.| |selectDiscoveryRule|query|Retorne uma propriedade discoveryRule com a regra LLD ¨¤ qual o prot¨®tipo do host pertence.| |selectInterfaces|query|Retorne uma propriedade interfaces com interfaces customizadas de prot¨®tipo de host.| |selectGroupLinks|query|Retorne uma propriedade groupLinks com os links de grupo do prot¨®tipo do host.| |selectGroupPrototypes|query|Retorne uma propriedade groupPrototypes com os prot¨®tipos de grupo do prot¨®tipo do host.| |selectMacros|query|Retorne uma propriedade macros com macros de prot¨®tipo de host.| |selectParentHost|query|Retorne uma propriedade parentHost com o host ao qual o prot¨®tipo do host pertence.| |selectTags|query|Retorne uma propriedade tags com tags de prot¨®tipo do host.| |selectTemplates|query|Retorne uma propriedade templates com os modelos vinculados ao prot¨®tipo do host.
Suporta count.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.
Os valores poss¨ªveis s?o: hostid, host, name e status.| |countOutput|boolean|Estes par?metros sendo comuns para todos os m¨¦todos get s?o descritos em detalhes na p¨¢gina Informa??es gen¨¦ricas da API Áú»¢¶Ä²©.| |edit¨¢vel|booleano|^| |excludePesquisa|boolean|^| |filtro|objeto|^| |limite|inteiro|^| |sa¨ªda|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classifica??o|cadeia/matriz|^| |startSearch|boolean|^|
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputtiver sido usado.
Exemplos
Recuperando prot¨®tipos de host de uma regra LLD
Recupere todos os prot¨®tipos de host, seus links de grupo, prot¨®tipos de grupo e tags de uma regra LLD.
Solicita??o:
{
"jsonrpc": "2.0",
&±ç³Ü´Ç³Ù;³¾¨¦³Ù´Ç»å´Ç&±ç³Ü´Ç³Ù;: "hostprototype.get",
"par?metros": {
&±ç³Ü´Ç³Ù;²õ²¹¨ª»å²¹&±ç³Ü´Ç³Ù;: "estender",
"selectInterfaces": "extender",
"selectGroupLinks": "estender",
"selectGroupPrototypes": "estender",
"selectTags": "estender",
"discoveryids": "23554"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"hostid": "10092",
"host": "{#HV.UUID}",
"name": "{#HV.UUID}",
"estado": "0",
"templateid": "0",
"descobrir": "0",
"custom_interfaces": "1",
"inventory_mode": "-1",
"groupLinks": [
{
"group_prototypeid": "4",
"hostid": "10092",
"groupid": "7",
"templateid": "0"
}
],
&±ç³Ü´Ç³Ù;²µ°ù³Ü±è´Ç±Ê°ù´Ç³Ù¨®³Ù¾±±è´Ç²õ&±ç³Ü´Ç³Ù;: [
{
"group_prototypeid": "7",
"hostid": "10092",
"name": "{#CLUSTER.NAME}",
"templateid": "0"
}
],
"Tag": [
{
"tag": "Datacenter",
"valor": "{#DATACENTER.NAME}"
},
{
"tag": "Tipo de inst?ncia",
"valor": "{#INSTANCE_TYPE}"
}
],
"interfaces": [
{
"principal": "1",
"tipo 2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"porta": "161",
"detalhes": {
"vers?o 2",
"em massa": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
}
],
"id": 1
}Veja tamb¨¦m
Fonte
CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php.