Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

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 Zabbix.| |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 countOutput tiver 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",
           "método": "hostprototype.get",
           "parâmetros": {
               "saída": "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"
                       }
                   ],
                   "grupoProtótipos": [
                       {
                           "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.